Spendint API - POST /sn_spend_intg/spendint/availability

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：5分

    • サプライヤー製品レコードの可用性を更新します。

    サプライヤー製品レコードが利用可能な場合、API は製品 SKU を使用して既存のサプライヤー製品を検索します。一致するサプライヤー製品が存在する場合、対応する available_units フィールドが更新されます。一致するサプライヤー製品が見つからない場合は、可用性を更新しようとしている製品が存在しないことを示すエラーメッセージが生成されます。

    ステータステーブル

    可用性更新要求のステータスを確認するには、Table 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. クエリパラメーター
    名前 説明
    mode サードパーティ統合のための非同期モードと同期モードのサポート。

    データタイプ：文字列

    有効な値：
    • async:非同期モード。
    • sync:同期モード。

    デフォルト:非同期
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    catalog_id 必須。顧客が購入できるカタログコンテンツの識別子。

    データタイプ：文字列

    最大長:100
    顧客_ID 必須。顧客の識別子。

    データタイプ：文字列

    最大長:100
    製品 更新する製品を定義するオブジェクトのリスト。各トランザクションには 1000 個の製品制限があります。

    データタイプ：アレイ

    "products": [
  {
    "available_units": "String",
    "sku": "String",
    "unit": "String"
  }
]
    products.available_units 在庫のある製品に必要です。この製品で使用可能なユニットの数。

    データタイプ：文字列

    最大長:40
    products.sku 必須。サプライヤーが販売する製品を一意に識別するためにサプライヤーによって生成された番号。

    データタイプ：文字列

    最大長:100
    products.unit 必須。サプライヤーが製品を販売する単位またはレート。たとえば、個数や時間などです。

    データタイプ：文字列

    最大長: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"
                    }
                ]
            }
        ]
    }
}