Spendint API - POST /sn_spend_intg/spendint/shipment

Yokohama の金融・サプライチェーン

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama の金融・サプライチェーン

ft:clusterId

stpop

bundleId

stpop

workflow

Creator

Spendint API - POST /sn_spend_intg/spendint/shipment

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：11分

このエンドポイントを使用して、サードパーティからの購入に関する更新を受け入れます。

データを受け取ったら、受注明細行番号を使用して出荷データを発注明細と照合する必要があります。トラッキング番号を使用して、発注明細に関連する既存の出荷詳細レコードを見つけることができます。該当するレコードが見つからない場合は、新しい出荷詳細レコードを作成します。出荷データの発注書または発注明細が存在しない場合、この出荷の発注書が存在しないことを示すエラーメッセージが表示されます。

注:

発注書と発注明細が [保留中の送信] ステータスで、発注書と発注明細が設定されていない場合、サードパーティリセラーからの出荷と請求書の転記は許可されません。これは、発注書および発注明細のステータスが [オーダー] の場合にのみ許可されます。また、出荷と請求書の転記に連続した制限はありません。

ステータステーブル

出荷要求のステータスを確認するには、テーブル 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/shipment

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

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

表 : 3. 要求本文パラメーター (XML または JSON)
名前	説明
customer_id	顧客に対する識別子。データタイプ：文字列最大長：100
order_number	必須です。この注文に対して顧客から提供された発注書番号。データタイプ：文字列最大長：40
sales_order_number	必須です。この注文についてサプライヤーが生成した番号または値。データタイプ：文字列最大長：40
shipment_lines	資産のシリアル番号、IMEI 番号、および資産タグの詳細を含めることができる出荷明細のリスト。データタイプ：アレイ `"shipment_lines": [ { "actual_shipment_date": "String", "estimated_arrival_date": "String", "line_number": "String", "planned_shipment_date": "String", "product_details": [Array], "sales_order_line_number": "String", "shipping_address": {Object}, "shipping_carrier": "String", "shipment_quantity": "String", "ship_to": "String", "tracking_number": "String" } ]`
shipment_lines.actual_shipment_date	貨物がサプライヤーの場所を離れる日。データタイプ：文字列最大長：40 形式：YYYY-MM-DD
shipment_lines.estimated_arrival_date	貨物が指定された場所に到着する予定日。データタイプ：文字列最大長：40 形式：YYYY-MM-DD
shipment_lines.line_number	必須です。特定の購入について顧客で生成される発注書明細行番号。データタイプ：文字列最大長：40
shipment_lines.planned_shipment_date	貨物がサプライヤーの場所を離れる予定日。データタイプ：文字列最大長：40 形式：YYYY-MM-DD
shipment_lines.product_details	出荷される製品の詳細を定義するオブジェクトのリスト。オプションには、シリアル番号、IMEI 番号、および資産タグの詳細が含まれます。データタイプ：アレイ `"product_details": [ { "asset_tag": "String", "imei": "String", "serial_number": "String" } ]`
shipment_lines.product_details.asset_tag	出荷された製品の資産タグ。データタイプ：文字列最大長：100
shipment_lines.product_details.imei	出荷された製品の IMEI 番号。データタイプ：文字列最大長：100
shipment_lines.product_details.serial_number	必須です。出荷された製品のシリアル番号。データタイプ：文字列最大長：100
shipment_lines.sales_order_line_number	サプライヤーによって生成される受注明細行番号。この番号は、この購入のリビジョンにのみ必要です。データタイプ：文字列最大長：40
shipment_lines.shipping_address	製品の出荷先住所。データタイプ：オブジェクト `"shipping_address": { "city": "String", "country": "String", "name": "String", "state": "String", "street": "String", "zip_code": "String" }`
shipment_lines.shipping_address.city	製品の出荷先住所の市町村名。データタイプ：文字列最大長：1000
shipment_lines.shipping_address.country	製品の出荷先の国。データタイプ：文字列最大長：40
shipment_lines.shipping_address.name	製品の出荷先の顧客の名前。データタイプ：文字列最大長：1000
shipment_lines.shipping_address.state	製品の出荷先の州/都道府県。データタイプ：文字列最大長：1000
shipment_lines.shipping_address.street	製品の出荷先住所の番地名。データタイプ：文字列最大長：1000
shipment_lines.shipping_address.zip_code	製品の出荷先の郵便番号または PIN コード。データタイプ：文字列最大長：40
shipment_lines.shipment_quantity	必須です。物品として出荷されている製品の数。この数には、出荷されている製品の数量が含まれている必要があります。データタイプ：文字列最大長：40
shipment_lines.shipping_carrier	FedEx、UPS、USPS など、指定された場所に製品を配送する配送業者。データタイプ：文字列最大長：100
shipment_lines.ship_to	製品の出荷先の受取人の名前。データタイプ：文字列最大長：100
shipment_lines.tracking_number	購入の全体または一部について配送業者から提供された追跡番号。データタイプ：文字列最大長：100
supplier_id	必須です。顧客が注文できるリセラーまたはサプライヤーの識別子。データタイプ：文字列最大長：100
supplier_shipment_number	必須です。この出荷に対して生成された識別番号。通常、この番号は、エンタープライズリソースプランニング (ERP) または注文トラッキングシステムによって生成されます。データタイプ：文字列最大長：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	受注明細行番号、受注番号、サプライヤー出荷番号、およびエラーメッセージ別にリストされたエラーの説明。データタイプ：アレイ
error_response_body.error_message	詳細なエラーメッセージ。データタイプ：文字列
status_code	「success」や「failure」などの応答ステータス。データタイプ：文字列

cURL 要求

curl "https://instance.service-now.com/api/sn_spend_intg/spendint/shipment" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
{"root":[{
  "customer_id" : "ACME CORP",
  "supplier_id" : "SUP-123456",
  "third_party_import_id": "DEL2134324",
  "supplier_shipment_number" : "TN-YU67898723",
  "order_number": "PO0001002",
  "sales_order_number": "SO00223002",
  "shipment_lines": [
    {
      "line_number": "POL0001005",
      "sales_order_line_number": "SOL0231325",
      "shipment_quantity": "4",
      "shipping_carrier": "FedEx",
      "tracking_number": "E-901290092",
      "shipping_address":
        {
          "name" : "1640 Camino Del Rio North #202, San Diego,CA",
          "street" : "1640 Camino Del Rio North",
          "city" : "San Diego",
          "state" : "CA",
          "zip_code" : "92108-1512",
          "country" : "US"
        },
      "ship_to": "John doe",
      "planned_shipment_date": "YYYY-MM-DD",
      "actual_shipment_date": "YYYY-MM-DD",
      "estimated_arrival_date": "YYYY-MM-DD",
      "product_details": [
        {
          "serial_number": "FL1234-23242319001",
          "imei": "2134890294",
          "asset_tag": ""
        },{
          "serial_number": "FL1234-23242319110",
          "imei": "245499003",
          "asset_tag": ""
        }
      ]
    }
  ]
}
]}

考えられる応答：

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

// Error response:
{
    "result": {
        "response": [
            {
                "customer_id": "ACME CORP",
                "supplier_id": "SUP-123456",
                "third_party_import_id": "DEL2134324",
                "status_code": "failure",
                "error_response_body": [
                    {
                        "sales_order_line_number": "SOL0231325",
                        "sales_order_number": "SO00223002",
                        "supplier_shipment_number": "TN-YU67898723",
                        "error_message": "The purchase order for this shipment does not exist\nThe purchase order line for this shipment does not exist\n"
                    }
                ]
            }
        ]
    }
}