出荷スケジュール
すべての出荷は、インバウンドまたはアウトバウンド出荷オーダーを作成することにより、事前にスケジュールする必要があります。これを行わないと、出荷が拒否される場合があります。出荷のスケジューリングは、出荷オーダーの権限を持つエクイニクスカスタマーポータルユーザーだけが行えます。エクイニクスカスタマーポータル(ECP)が現在サポートしている出荷の種類は、こちらをご覧ください。
必須条件
-
出荷の詳細を取得するには、ユーザは
出荷の注文権限を持っている必要があります。 -
Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。
-
出荷をスケジュールするには、出荷の正確なケージIDとアカウント番号を決定する必要があります。これらの値はリクエストボディの
cageIdとaccountNumberパラメータに渡されます。 -
ロケーション情報の取得 -
/v1/orders/smarthands/locationsエンドポイントにGETリクエストを送信し、アクセス可能な IBX ロケーションを取得します。ロケーション情報をすでに知っている場合は、この手順を省略できます。
インバウンド出荷のスケジューリング

インバウンド出荷をスケジュールするには、/colocation/v2/orders/shipmentエンドポイントにPOSTリクエストを送信します。パラメータ "type":「INBOUND" パラメータを使用してインバウンド出荷であることを指定し、残りの出荷の詳細をリクエスト本文に記述します。インバウンド貨物のリクエストでは、貨物のタイプ、出荷日、関連するケージ、輸送会社、箱の数が含まれることが最低限必要です。インバウンド出荷リクエストの本文に必要なその他の情報は、以下のとおりです:
- インバウンド貨物が複数のアカウントにリンクされたケージからのものである場合。
- 貨物を配送するキャリアがお客様の組織のキャリアである場合、リストに掲載されているキャリア、またはリストに掲載されていないキャリアです。輸送会社がDHL、FedEx、UPSでない場合、お客様の輸送会社は未上場です。
cURLリクエストの例:
1つのアカウントに関連するケージからのインバウンド貨物は、あなたの組織によって配信されます。
このシナリオでは、インバウンド貨物は、あなたの組織の誰かが1つのアカウントにのみリンクされているあなたのケージに配信されます。このシナリオに最低限必要な情報は、このサンプルリクエストで渡されます。
curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "INBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"details": {
"carrier": "CUSTOMER_CARRIER",
"numberOfBoxes": 2
}
}'
cURLリクエストの例:
複数のアカウントに関連するケージからのインバウンド貨物は、未上場の輸送業者によって配送されます。その他の Smart Hands のリクエスト、情報、連絡先、添付ファイルも含まれます。
添付ファイル付きの注文を作成する前に、Attachments File エンドポイントを呼び出します。
このシナリオでは、インバウンド貨物を促進するために最低限必要な情報を提供し、以下をサポートする追加のボディパラメータが含まれています:
- お客様のケージへの配送のためのSmart Handsの追加リクエスト
- 追加説明
- 添付ファイル
- あなた自身の参照識別子
- 発注情報
- 通知または技術連絡担当者の連絡先
このサンプルリクエストでは、利用可能で適用可能なすべてのボディパラメータが渡されます。
curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "INBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"accountNumber": 901011,
"details": {
"carrier": "OTHER",
"carrierName": "New Carrier",
"numberOfBoxes": 2,
"carrierTrackingNumbers": [
"t1Z294AK92654678989",
"t1Z086DK96424456780"
],
"cageDelivery": true
},
"description": "Package is fragile and heavy. Handle with care. Additional description in attachment.",
"attachments": [
{
"id": "85d9660a-f877-405a-b38e-8e61a4f77f44",
"name": "OrderInstructions.docx"
}
],
"customerReferenceId": "2020/16347",
"purchaseOrder": {
"type": "NEW",
"number": "9654284",
"amount": "10000",
"startDate": "2020-10-01",
"endDate": "2021-09-30",
"attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093"
},
"contacts": [
{
"type": "NOTIFICATION",
"registeredUsers": [
"john_doe1",
"jane_smith1"
]
},
{
"type": "TECHNICAL",
"firstName": "John",
"lastName": "Doe",
"availability": "WORK_HOURS",
"timezone": "America/Los_Angeles",
"details": [
{
"type": "EMAIL",
"value": "johndoe@acme.com""
},
{
"type": "PHONE",
"value": "+1-987654321"
},
{
"type": "MOBILE",
"value": "+1-912345678"
}
]
}
]
}'
HTTPコード201が返され、レスポンスヘッダが返されると、注文は正常に作成されます。レスポンスボディはありません。
この注文を更新したい場合は、APIリファレンスセクションの/v2/orders/shipments/{orderId}で詳細を参照してください。
この注文に対するメモの追加、この注文に対する交渉の取得と回答、またはこの注文のキャンセルを希望する場合は、APIリファレンスセクションのOrdersを参照してください。
出荷のスケジュール

アウトバウンド出荷をスケジュールするには、/colocation/v2/orders/shipmentエンドポイントにPOSTリクエストを送信します。パラメータ "type":「OUTBOUND" パラメータを使用して発送であることを指定し、残りの発送の詳細をリクエスト本文に記述します。出荷依頼は、出荷タイプ、出荷日、関連するケージ、輸送会社を含むことが最低限必要です。その他に必要な情報は、下記の通りです:
- 複数のアカウントにリンクされたケージからの出荷の場合。
- 貨物を配送するキャリアがお客様の組織のキャリアである場合、リストに掲載されているキャリア、またはリストに掲載されていないキャリアです。お客様の輸送会社がDHL、FedEx、UPSでない場合、お客様の輸送会社は未上場です。
- エクイニクスによる配送ラベルの印刷が必要な場合。
cURLリクエストの例:
1つのアカウントに関連付けられたケージから、お客様の組織の誰かが配送する出荷。
このシナリオでは、お客様の発送貨物は、お客様の組織の誰かによって、1つのアカウントにリンクされたお客様のケージに配送されます。このシナリオに最低限必要な情報は、このサンプルリクエストで渡されます。
curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "OUTBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"details": {
"carrier": "CUSTOMER_CARRIER"
]
}
}'
cURLリクエストの例:
複数のカウントに関連するケージから出荷される貨物は、未上場の輸送業者によって配送されるため、エクイニクスが出荷ラベルを印刷する必要があります。関連する出荷ラベルの詳細は、添付ファイルとして提供されます。その他のSmart Handsリクエスト、情報、連絡先、添付ファイルも含まれています。
添付ファイル付きの注文を作成する前に、Attachments File エンドポイントを呼び出します。
このシナリオでは、発送依頼を円滑に進めるために最低限必要な情報をプロバイダに提供し、以下をサポートする追加のボディパラメータを含めました:
- 米ドル以外の通貨で申告された出荷額
- Smart Handsのケージからのお荷物の引き取り、またはお荷物の保険に関する追加のご依頼
- 追加説明
- 添付ファイル
- あなた自身の参照識別子
- 発注情報
- 通知または技術連絡担当者の連絡先
このサンプルリクエストでは、利用可能で適用可能なすべてのボディパラメータが渡されます。
curl -X
POST "https://api.equinix.com/colocations/v2/orders/shipments"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"type": "OUTBOUND",
"requestedDateTime": "2020-11-02T10:45:41Z",
"cageId": "AM1:01:000111",
"accountNumber": 901011,
"details": {
"carrier": "OTHER",
"carrierName": "New Carrier",
"numberOfBoxes": 2,
"declaredValue": 1000,
"declaredValueCurrency": "EUR",
"carrierTrackingNumbers": [
"t1Z294AK92654678989",
"t1Z086DK96424456780"
],
"shipmentLabelRequired": true,
"shipmentAttachmentId": "f49891fc-d9a5-4b4b-bc65-150b1c5e6dff",
"requirePickup": true,
"insureShipment": true
},
"description": "Package is fragile and heavy. Handle with care. Additional description in attachment.",
"attachments": [
{
"id": "85d9660a-f877-405a-b38e-8e61a4f77f44",
"name": "OrderInstructions.docx"
}
],
"customerReferenceId": "2020/16347",
"purchaseOrder": {
"type": "NEW",
"number": "9654284",
"amount": "10000",
"startDate": "2020-10-01",
"endDate": "2021-09-30",
"attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093"
},
"contacts": [
{
"type": "NOTIFICATION",
"registeredUsers": [
"john_doe1",
"jane_smith1"
]
},
{
"type": "TECHNICAL",
"firstName": "John",
"lastName": "Doe",
"availability": "WORK_HOURS",
"timezone": "America/Los_Angeles",
"details": [
{
"type": "EMAIL",
"value": "johndoe@acme.com"
},
{
"type": "PHONE",
"value": "+1-987654321"
},
{
"type": "MOBILE",
"value": "+1-912345678"
}
]
}
]
}'
HTTPコード201が返され、レスポンスヘッダが返されると、注文は正常に作成されます。レスポンスボディはありません。
この注文を更新したい場合は、APIリファレンスセクションの/v2/orders/shipments/{orderId}で詳細を参照してください。
この注文に対するメモの追加、この注文に対する交渉の取得と回答、またはこの注文のキャンセルを希望する場合は、APIリファレンスセクションのOrdersを参照してください。