属性
リクエストボディ内のJSONキー/バリューペア
POST | https://api.zonos.com/v1/orders
HEADER zonos-version: 2021-01-01
上記のヘッダーは、この注文完了リクエストが成功裏に完了するために必要な入力です。
フィールド | ノート |
---|---|
account_order_id オプション | 注文の番号文字列。 |
landed_cost_id 必須 | 商人または輸出者のためのユニークなlanded cost識別子。 |
parties 必須 | 出荷に関与する当事者のリスト。このリストには、パッケージを発送する当事者、パッケージを受け取る当事者、パッケージを仲介する当事者、および関税や税金の支払いを担当する当事者の情報が含まれます。ship_from およびship_to の当事者を提供することが必須です。 |
parties.city 必須 | リストされた当事者の住所の都市、町、地区、郊外、または村の文字列。 |
parties.contact_email 必須 | 連絡用メールアドレスの文字列。 |
parties.contact_name 必須 | 連絡先名の文字列。 |
parties.contact_phone 必須 | 連絡先電話番号。 |
parties.company_name オプション | 会社名。 |
parties.country 必須 | 2文字のISOコードで表される国。 |
parties.line1 必須 | 住所の行1の文字列。 |
parties.line2 必須 | 住所の行2の文字列。 |
parties.postal_code 必須 | 郵便番号の文字列。輸入国によってはship_to に対してオプションです。 |
parties.state オプション | 利用可能な場合の州コードの文字列。ship_to に対してカナダとブラジルでのみ必須です。 |
parties.tax_id オプション | ship_to 当事者は、ブラジルなどの国に輸入するために税IDを提供する必要があります。ブラジルへの出荷に対して提供されない場合、出荷は税IDを提供するために受取人に連絡できるまで税関で保留されます。受取人に連絡できない場合、配達が遅れる可能性があり、返送または放棄されたパッケージが発生する可能性があります。 |
parties.type 必須 | 提供された情報が表す当事者のタイプ。可能な値には、ship_to 、ship_from 、shipper 、sold_to 、duties_taxes_payor 、およびbroker が含まれます。 |
test オプション | true の値で入力された場合、この注文に関連する料金が請求されません。 |
tracking_numbers オプション | 注文追跡番号のリスト。 |
リクエストの例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_order_id": "123456",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"parties": [
{
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
例の応答
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
{
"id": "ordr_5LwjnR9AW6L9eXs9lfeMC7",
"landed_cost_id": "ldct_1LOYliG6NmEu31cVkvGHvv",
"account_order_id": "123456",
"zonos_order_id": "1000151",
"parties": [
{
"id": "prty_12165151351",
"city": "Campinas",
"contact_email": "info@example.com",
"contact_name": "Jean-Luc Picard",
"contact_phone": "1234567890",
"company_name": "Starfleet",
"country": "BR",
"line1": "49 Chapadao Rua",
"line2": null,
"line3": null,
"postal_code": "75828-000",
"state": "SP",
"tax_id": "12-3456789",
"type": "ship_to"
}
],
"tracking_numbers": ["1Z12345E0205271688"]
}
注文完了のリクエスト
注文完了リクエストのキー/バリューペアを探る。Order Complete APIを使用すると、完了した注文情報の新しいリクエストを作成でき、正確な処理に必要な詳細を提供します。このAPIは、関係者や追跡番号に関する重要な情報を指定することにより、注文の完了を確実にします。