出荷スケジュール
すべての荷物は、入荷または発送のオーダーを作成して事前にスケジュールする必要があります。これを怠ると、荷物が拒否される可能性があります。これらの荷物を予約できるのは、荷物の発注権限を持つEquinix Customer Portalユーザーのみです。Equinix Customer Portal APIで現在サポートされている荷物の種類は、こちらをご覧ください。
前提条件
-
荷物の詳細を取得するには、ユーザーに発注権限が必要です。
Shipments -
認証-ユーザー認証情報、クライアントID、クライアントシークレットを送信してOauth2認証を行います。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、「API認証」を参照してください。
-
荷物の配送をスケジュールするには、荷物のケージIDとアカウント番号を正確に決定する必要があります。これらの値はリクエスト本文のと
accountNumberパラメータに渡されます。cageId -
ロケーション情報の取得-エンドポイントにリクエストを
/v1/orders/smarthands/locations送信して、GETアクセス可能なIBXロケーションを取得します。ロケーション情報がすでにわかっている場合は、この手順をスキップしても構いません。
インバウンド出荷のスケジューリング

荷物受取をスケジュールするには、エンドポイントにリクエストを/colocations/v2/orders/shipments送信します。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"
}
]
}
]
}'
201のHTTPコードが返され、応答ヘッダーが返されると、オーダーが正常に作成されます。応答本文はありません。
このオーダーを更新する場合は、APIリファレンスセクションのを参照してください。/v2/orders/shipments/{orderId}
このオーダーにメモを追加する、このオーダーの交渉を取得して返信する、またはこのオーダーをキャンセルする場合は、APIリファレンスセクションのオーダーを参照してください。
出荷のスケジュール

荷物発送をスケジュールするには、エンドポイントにリクエストを/colocations/v2/orders/shipments送信してください。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リクエストの例:
リストにない運送業者によって配送される複数のカウントに関連付けられたケージからの荷物発送で、 Equinixが配送ラベルを印刷する必要があります。関連する配送ラベルの詳細は添付ファイルとして提供されています。その他の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"
}
]
}
]
}'
201のHTTPコードが返され、応答ヘッダーが返されると、オーダーが正常に作成されます。応答本文はありません。
このオーダーを更新する場合は、APIリファレンスセクションのを参照してください。/v2/orders/shipments/{orderId}
このオーダーにメモを追加する、このオーダーの交渉を取得して返信する、またはこのオーダーをキャンセルする場合は、APIリファレンスセクションのオーダーを参照してください。