ご注文 API
ご注文の作成
テスト用エンドポイント:
https://transact.ti.com/v2/store/orders/test
正式運用エンドポイント:
https://transact.ti.com/v2/store/orders/
ご注文 API を使用すると、貴社システムを介して直接ご注文の作成、管理が可能です。追跡と管理をさらに改善するために、詳細な注文情報を検索取得できます。
作業を開始する前に:
- 在庫と価格設定を確認します。 ご注文を作成する前に、在庫と価格設定 API を使用して個別の品目の在庫状況と価格設定を確認します。
- API チェックアウト (購入手続き) プロファイルを有効にします。 貴社の法人アカウント内で、API を使用する資格のあるチェックアウト (購入手続き) プロファイルのセットアップが必要です。アカウントとプロファイルの作成の詳細については、「はじめに」ガイドを参照してください。
- チェックアウト プロファイルが見つからなかった場合、チェックアウト プロファイルが完成していること、および承認済みのお支払い方法が既に追加済みであることを確認してください。詳細については、お支払い情報をご覧ください。
テスト:
テスト用エンドポイント (https://transact.ti.com/v2/store/orders/test) を使用して、ご注文の作成プロセスと応答のシミュレーションを実行します。なお、このデータはデモのみを目的としています。
ご注文に関するコメント:
- 「customerOrderComments」(顧客のご注文に関する備考) と「customerItemComments」(顧客の製品に関する備考) の各フィールドを使用すると、ご注文の際に追加情報を送信できます。
- このデータは顧客のみが使用することを意図しており、TI はその内容を検証しません。
- 以下の例では、customerOrderComments 配列を使用して、複数の文字列を区切り記号パイプ (|) で区切った 1 個の配列を渡し、ジョブ番号と、ご注文を確定する人物の名前を指定します。
例:
"customerOrderComments": [
{
"message": "jobNumber|54851-50"
},
{
"message": "orderedBy|John Smith"
}
]
ご注文の作成フロー:
- 貴社への割り当て済み API キーとシークレットを使用して、認証を受けます。
- 在庫と価格設定 API を使用して、製品の在庫状況と現在の価格設定を確認します。
- ステータス コード (200 OK) と、要求した製品データを含む JSON 形式の応答を受信します。
- TI の在庫と価格設定 API を使用して在庫状況を確認した後、希望のペイロードを使用してご注文を作成し、ご注文 API に対して post (送信) を実行します。
- ステータス コード (201 OK) と、ご注文の JSON 受信確認を含む応答を受信します。
#!/bin/bash
curl --request POST \
--url 'https://transact.ti.com/v2/store/orders/test' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <
応答の例:
{
"orderNumber": 0,
"orderStatus": "string",
"customerPurchaseOrderNumber": "string",
"subTotal": 0,
"totalPrice": 0,
"lineItems": [
{
"tiPartNumber": "string",
"tiPartDescription": "string",
"quantity": "string",
"status": "string",
"unitPrice": 0,
"customReelIndicator": true
}
],
"shippingAddress": [
{
"addressType": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"email": "string",
"phoneNumber": "string",
"companyURL": "string"
}
],
"billingAddress": [
{
"addressType": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"email": "string",
"phoneNumber": "string",
"companyURL": "string"
}
],
"orderMessages": [
{
"code": "string",
"type": "string",
"Message": "string"
}
],
"customerOrderComments": [
{
"message": "string"
}
],
"orderPlacedTime": "string",
"paymentType": "string",
"currencyISO": "string",
"totalTax": 0,
"checkoutProfileIdentifier": "string",
"totalDeliveryCost": 0,
"totalDiscount": 0,
"couponCodes": "string"
}