Checkout APIのHTTPSリクエスト形式は？

Checkout APIのHTTPSリクエストには、HTTPメソッド（POST）、エンドポイント、プロトコル（HTTPS）、メッセージ形式（JSON）、HTTPヘッダー（Accept: application/json、Content-Type: application/json）が含まれます。

Checkout APIのリクエスト本文のJSONキー/値ペアは？

Checkout APIのリクエスト本文のJSONキー/値ペアには、store、secret、sinceOrderId、sinceDate、throughDate、missingMerchantOrderId、statusesなどのパラメータが含まれます。

Checkout APIのHTTPSレスポンス形式は？

Checkout APIのHTTPSレスポンスはJSON形式です。totalCount、orderCount、testOrderCount、orders、および（ある場合）errorなどのパラメータが含まれます。

Checkout APIの取り得るエラーHTTPレスポンスは？

Checkout APIの取り得るエラーHTTPレスポンスには、406（Not Acceptable）、415（Unsupported media type）、およびさまざまなエラーメッセージ付きの200が含まれます。

Checkout•

ホームAPIリファレンス Checkout REST API 注文番号

注文番号

Q: Checkout APIとは？

Checkout APIは、Zonos Checkout経由で完了した注文番号の一覧を安全に取得するために使用します。通常は、特定日またはorderID時点、および日付範囲内の注文がすべてインポートされたことを確認する注文照合に使います。

注文番号エンドポイントの仕組みを学びます。

orderNumbersエンドポイントは、Zonos Checkout経由で完了した注文番号の一覧を安全に取得するために使用します。通常は、特定日またはorderID時点、および日付範囲内の注文がすべてインポートされたことを確認する注文照合に使います。

エンドポイント

POST | https://api.iglobalstores.com/v1/orderNumbers

HTTPSリクエスト

フィールド↕	備考↕
HTTPメソッド	POST
エンドポイント	`https://api.iglobalstores.com/v1/orderNumbers`
プロトコル	HTTPS
メッセージ形式	JSON
Accept HTTPヘッダー	Accept: application/json
Content-Type HTTPヘッダー	Content-Type: application/json

リクエスト本文のJSONキー/値

メッセージ形式: JSON

1{

2 "store": "999",

3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",

4 "sinceOrderId": "999-99999"

5}

リクエストJSON定義

フィールド↕	備考↕
`missingMerchantOrderId` 任意（他のパラメータオプションを渡す場合）	このパラメータは、`merchantOrderId`が設定されていない過去2週間以内の注文セットを照会するために使用します。`updateMerchantOrderID` APIエンドポイント経由で`merchantOrderId`が送信されると、それ以降このクエリには表示されなくなります。`boolean: true/false`
`secret` 必須	Zonosが提供するAPIシークレットGUID。 `string`
`sinceDate` 任意（`sinceOrderId`パラメータを渡す場合）	このパラメータは、特定の日付以降の注文セットを照会するために使用します。`sinceDate`と`sinceOrderId`を同時に送信することはできません。`string` - UTC/GMTの日付; 形式: `yyyymmdd`
`sinceOrderId` 任意（`sinceDate` / `throughDate`パラメータを渡す場合）	Zonosの注文IDです。ストアIDとハイフンを付けて、または付けずに渡すことができます（例: 123-45678または45678）。注: このパラメータは、特定のZonos注文以降の注文セットを照会するために使用します。`sinceDate`と`sinceOrderId`を同時に送信することはできません。`integer / string`
`statuses` 任意	このパラメータは、レスポンスに現在の注文ステータスと`merchantOrderId`を含めるために使用します。値に関係なくリクエストに存在する場合、ステータスが含まれます。`boolean: true`
`store` 必須	Zonosが提供するストアID。`integer`
`throughDate` 任意	このパラメータは、特定の日付範囲内の注文セットを照会するために使用します。`sinceDate`パラメータと合わせて渡す必要があります。`string` - UTC/GMTの日付; 形式: `yyyymmdd`

HTTPSレスポンス

メッセージ形式: JSON

1{

2 "totalCount": 6,

3 "orderCount": 5,

4 "testOrderCount": 1,

5 "orders": [

6 {

7 "testOrder": false,

8 "id": "999-99991",

9 "timestamp": "2015-01-01 00:33:14.0"

10 },

11 {

12 "testOrder": true,

13 "id": "999-99992",

14 "timestamp": "2015-01-01 05:12:46.0"

15 },

16 {

17 "testOrder": false,

18 "id": "999-99993",

19 "timestamp": "2015-01-01 14:50:54.0"

20 },

21 {

22 "testOrder": false,

23 "id": "999-99994",

24 "timestamp": "2015-01-02 20:14:01.0"

25 },

26 {

27 "testOrder": false,

28 "id": "999-99995",

29 "timestamp": "2015-01-02 20:57:47.0"

30 },

31 {

32 "testOrder": false,

33 "id": "999-99996",

34 "timestamp": "2015-01-02 22:11:40.0"

35 }

36 ]

37}

エラーHTTPレスポンス

エラー↕	意味↕
406 - Not Acceptable	HTMLエンティティ。HTTPの「Accept」ヘッダーが無効です。
415 - Unsupported media type	HTMLエンティティ。HTTPの「Content-Type」ヘッダーが無効です。
200	“error”:”could not parse input”
200	“error”:”orderId: 999-99999 is not a valid orderId”
200	“error”:”Parameter orderId or referenceId is required.”
200	“error”:”Cannot specify both Parameters orderId and referenceId.”
200	“error”:”Could not process order details.”
200	“error”:”Invalid security credentials”

レスポンスJSON定義

フィールド↕	備考↕
`error`	このパラメータはエラー発生時にのみレスポンスに存在し、原因の説明を含みます。`string`
`orderCount`	取得した本番注文の合計件数。`integer`
`order.testOrderCount`	取得したテスト注文の合計件数。`integer`
`orders`	注文マップのリスト。`string`
`orders[index].id`	ストアIDとハイフンを含む完全なZonos注文ID。`string`
`orders[index].merchantOrderId`	`updateMerchantOrderId` APIサービスエンドポイントを通じて注文に関連付けられた`MerchantOrderId`。`string`
`orders[index].orderStatus`	現在の注文ステータス（設定可能な値）。`string`
`orders[index].orderStatusDate`	ステータスが最後に更新された時刻を表すepoch。`integer`
`orders[index].orderStatusDateString`	ステータスが最後に更新された時刻をUTC/GMTで表すタイムスタンプ。`timestamp`
`orders[index].testOrder`	注文が「テスト注文」か「本番注文」かを示します。`boolean`
`orders[index].timestamp`	注文が行われた時刻をUTC/GMTで表すタイムスタンプ。`timestamp`
`totalCount`	取得した本番注文とテスト注文の合計件数。`integer`

デモを予約する