DOCS

Order numbers

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

注文番号

注文番号エンドポイントの動作を学びましょう。

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

リクエストの例: sinceOrderId

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceOrderId": "999-99999"
}

例のリクエスト: sinceDate

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101"
}

例のリクエスト: sinceDate, throughDate

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101",
  "throughDate": "20150601"
}

例のリクエスト: missingMerchantOrderId

1
2
3
4
5
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "missingMerchantOrderId": true
}

例のリクエスト: ステータス

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "sinceDate": "20150101",
  "statuses": true
}

リクエスト JSON 定義

フィールドノート
missingMerchantOrderId オプション、別のパラメータオプションを渡す場合このパラメータは、merchantOrderId が欠落している過去2週間の注文セットをクエリするために使用されます。merchantOrderId が updateMerchantOrderID API エンドポイントを介して送信されると、注文はこのクエリに表示されなくなります。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
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "totalCount": 6,
  "orderCount": 5,
  "testOrderCount": 1,
  "orders": [
    {
      "testOrder": false,
      "id": "999-99991",
      "timestamp": "2015-01-01 00:33:14.0"
    },
    {
      "testOrder": true,
      "id": "999-99992",
      "timestamp": "2015-01-01 05:12:46.0"
    },
    {
      "testOrder": false,
      "id": "999-99993",
      "timestamp": "2015-01-01 14:50:54.0"
    },
    {
      "testOrder": false,
      "id": "999-99994",
      "timestamp": "2015-01-02 20:14:01.0"
    },
    {
      "testOrder": false,
      "id": "999-99995",
      "timestamp": "2015-01-02 20:57:47.0"
    },
    {
      "testOrder": false,
      "id": "999-99996",
      "timestamp": "2015-01-02 22:11:40.0"
    }
  ]
}

成功レスポンスの例 'statuses' パラメータ付き

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "totalCount": 2,
  "orderCount": 1,
  "testOrderCount": 1,
  "orders": [
    {
      "testOrder": false,
      "id": "999-99991",
      "timestamp": "2015-01-01 00:33:14.0",
      "merchantOrderId": null,
      "orderStatus": "IGLOBAL_FRAUD_REVIEW",
      "orderStatusDate": 1420097594000,
      "orderStatusDateString": "2015-01-01 14:16:17.0"
    },
    {
      "testOrder": true,
      "id": "999-99992",
      "timestamp": "2015-01-01 05:12:46.0",
      "merchantOrderId": "abc123",
      "orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
      "orderStatusDate": 1420097594000,
      "orderStatusDateString": "2015-01-01 14:16:17.0"
    }
  ]
}

例外エラー応答

1
2
3
{
  "error": "Couldn't find order for sinceOrderId: 999999"
}

HTTPエラー応答

エラー意味
406 - Not AcceptableHTMLエンティティ。HTTPの“Accept”ヘッダーが無効です。
415 - Unsupported media typeHTMLエンティティ。HTTPの“Content-Type”ヘッダーが無効です。
200“error”:”入力を解析できませんでした”
200“error”:”orderId: 999-99999は有効なorderIdではありません”
200“error”:”orderIdまたはreferenceIdパラメータが必要です。”
200“error”:”orderIdとreferenceIdの両方のパラメータを指定することはできません。”
200“error”:”注文の詳細を処理できませんでした。”
200“error”:”無効なセキュリティ資格情報”

応答JSON定義

フィールドノート
errorこのパラメータはエラーが発生した場合にのみ応答に存在し、原因の説明を含みます。string
orderCount取得したライブ注文の総数。integer
order.testOrderCount取得したテスト注文の総数。integer
orders注文マップのリスト。string
orders[index].idストアIDとダッシュを含む完全なZonos注文ID。string
orders[index].merchantOrderIdupdateMerchantOrderId APIサービスエンドポイントを通じて注文に関連付けられたMerchantOrderId。string
orders[index].orderStatus可能な値の現在の注文ステータス。string
orders[index].orderStatusDateステータスが最後に更新された時を表すエポック。integer
orders[index].orderStatusDateStringステータスが最後に更新された時をUTC/GMTで表すタイムスタンプ。timestamp
orders[index].testOrder注文が“テスト注文”か“ライブ注文”かを示します。boolean
orders[index].timestamp注文がUTC/GMTで行われた時を表すタイムスタンプ。timestamp
totalCount取得したライブ注文とテスト注文の総数。integer

このページは役に立ちましたか？

Zonosを見る

ポリシーと契約
© 2024 Zonoszonos.com
このページには：