Spendint API - POST /sn_spend_intg/spendint/availability

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 소요 시간: 4분

    • 공급자 제품 기록의 가용성을 업데이트합니다.

    공급자 제품 기록을 사용할 수 있는 경우 API는 제품 SKU를 사용하여 기존 공급자 제품을 찾습니다. 일치하는 공급자 제품이 있으면 해당 available_units 필드가 업데이트됩니다. 일치하는 공급자 제품을 찾을 수 없으면 가용성을 업데이트하려는 제품이 없다는 오류 메시지가 생성됩니다.

    상태 테이블

    가용성 업데이트 요청의 상태를 알아보려면 테이블 REST API를 사용하여 데이터베이스에 ServiceNow 대한 REST 호출을 수행합니다. API의 응답에는 가용성 업데이트 요청이 실패한 기록이 나열됩니다. 가용성 업데이트 응답의 경우 다음 매개변수를 사용하여 가용성 오류 테이블을 쿼리합니다.

    sysparm_query=outbound_error.supplier_id=<supplier_id>^outbound_error.state=20

    고객 ID, 공급자 ID, 오류 유형, 고유 임포트 세트 ID 및 상태에 대한 세부 정보는 상위 오류 테이블인 아웃바운드 상태 테이블에서 찾을 수 있습니다.

    URL 형식

    /api/sn_spend_intg/spendint/availability

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    모드 타사 통합을 위한 비동기식 및 동기식 모드를 지원합니다.

    데이터 유형: 문자열

    유효한 값:
    • async: 비동기 모드입니다.
    • sync: 동기 모드입니다.

    기본값: 비동기
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    catalog_id 필수 고객이 구매할 수 있는 카탈로그 콘텐츠의 식별자입니다.

    데이터 유형: 문자열

    최대 길이: 100
    customer_id 필수 고객의 식별자입니다.

    데이터 유형: 문자열

    최대 길이: 100
    제품 업데이트할 제품을 정의하는 객체의 목록입니다. 각 트랜잭션의 제품 제한은 1,000개입니다.

    데이터 유형: 배열

    "products": [
  {
    "available_units": "String",
    "sku": "String",
    "unit": "String"
  }
]
    products.available_units 재고가 유지되는 제품에 필요합니다. 이 제품에 사용할 수 있는 단위 수입니다.

    데이터 유형: 문자열

    최대 길이: 40
    제품.SKU 필수 해당 공급자가 판매하는 제품을 고유하게 식별하는 공급자가 생성한 번호입니다.

    데이터 유형: 문자열

    최대 길이: 100
    제품.단위 필수 공급자가 제품을 판매하는 단위 또는 요율입니다. 예를 들어 조각, 시간 등이 있습니다.

    데이터 유형: 문자열

    최대 길이: 100
    supplier_id 고객이 주문할 수 있는 리셀러 또는 공급자의 식별자입니다.

    데이터 유형: 문자열

    최대 길이: 100
    third_party_import_id 외부 공급업체가 문자열 값을 전달하여 임포트한 데이터 세트를 고유하게 식별할 수 있습니다.

    데이터 유형: 문자열

    최대 길이: 100

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다.

    표 4. 요청 헤더
    머리글 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/xml.

    기본값: application/json
    주:
    구매 통합 프레임워크에는 데이터 형식만 application/json 지원됩니다.
    표 5. 응답 헤더
    머리글 설명
    없음

    상태 코드

    이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다.

    표 6. 상태 코드
    상태 코드 설명
    성공 성공. 요청이 성공적으로 처리되었습니다.
    실패 실패. 요청이 오류와 함께 처리되었습니다.

    응답 본문 매개변수(JSON)

    이러한 응답 본문 매개변수는 동기 모드에서 쿼리될 때 수신됩니다.
    이름 설명
    error_response_body SKU와 오류 메시지별로 나열된 오류에 대한 설명입니다.

    데이터 유형: 배열
    error_response_body.error_message 자세한 오류 메시지입니다.

    데이터 유형: 문자열
    status_code "성공" 또는 "실패"와 같은 응답 상태입니다.

    데이터 유형: 문자열

    cURL 요청

    curl "https://instance.servicenow.com/api/sn_spend_intg/spendint/availability" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
{"root": [{
  "customer_id": "AB-1234323",
  "catalog_id": "ACME CORP",
  "supplier_id": "SUP-123456",
  "third_party_import_id": "DEL6789876",
  "products": [
    {
      "sku": "5578874",
      "unit": "Each",
      "available_units": "20"
    }
  ]
}
]}

    가능한 응답:

    // Success response:
{
    "result": {
        "response": "success"
    }
}

Error response: 
{
    "result": {
        "response": [
            {
                "customer_id": "AB-1234323",
                "supplier_id": "SUP-123456",
                "third_party_import_id": "DEL6789876",
                "status_code": "failure",
                "error_response_body": [
                    {
                        "sku": "5578874",
                        "error_message": "The product for which you are trying to update availability does not exist\nField Value empty/Formatting issue Unit\n"
                    }
                ]
            }
        ]
    }
}