Spendint API - POST /sn_spend_intg/spendint/availability

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

サプライヤー製品レコードが利用可能な場合、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. クエリパラメータ

名前	説明
mode	サードパーティ統合のための非同期モードと同期モードのサポート。 データタイプ：文字列 有効な値： 非同期：非同期モード。 同期：同期モード。 デフォルト：非同期

表 : 3. 要求本文パラメーター (XML または JSON)

名前	説明
catalog_id	必須です。顧客が購入できるカタログコンテンツの識別子。 データタイプ：文字列 最大長：100
customer_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

注:

Procurement Integration Framework では application/json データ形式のみがサポートされています。

表 : 5. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。

表 : 6. ステータスコード

ステータスコード	説明
success	成功。要求が正常に処理されました。
failure	不成功。要求が処理されました (エラーあり)。

応答本文のパラメーター (JSON)

これらの応答本文パラメーターは、同期モードで照会されたときに受信されます。

名前	説明
error_response_body	SKU およびエラーメッセージ別にリストされたエラーの説明。 データタイプ：アレイ
error_response_body.error_message	詳細なエラーメッセージ。 データタイプ：文字列
status_code	「success」や「failure」などの応答ステータス。 データタイプ：文字列

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"
                    }
                ]
            }
        ]
    }
}