安排发货
必须通过创建入库或出库货件订单提前安排所有货件。否则可能会导致货件被拒绝。只有具有货件订购权限的Equinix Customer Portal用户才能安排这些货件。Equinix Customer Portal API当前支持的货件类型可在此处找到。
先决条件
-
要获取货件详细信息,用户必须具有
Shipments订购权限。 -
身份验证-提交您的用户凭据,客户端ID和客户端机密以进行OAuth2身份验证。有关如何调用OAuth API以验证和验证凭据的说明,请参阅API身份验证。
-
要安排货件,您需要确定货件的确切笼编号和账号。将在请求正文中为和
accountNumber参数传递这些值cageId。 -
获取位置信息-向端点发送
GET请求/v1/orders/smarthands/locations以检索您有权访问的可用IBX位置。如果您已经知道位置信息,则可以跳过此步骤。
安排入境货件

要安排入库货件,请向端点发送POST请求/colocations/v2/orders/shipments。使用"type": "INBOUND"参数指定为入库货件,并在请求正文中提供其余货件详细信息。入库货件请求至少要求提供货件类型,货件日期,相关笼,承运人和要包含的箱子数量。您需要在入库货件请求正文中传递的其他必要信息取决于以下因素:
- 如果您的入站货物来自与多个账户关联的机笼。
- 如果配送货件的承运人来自贵组织,列出的承运人或未列出的承运人。如果您的承运人不是DHL,FedEx,UPS,则您的承运人未列出。
cURL 请求示例:
您的组织将运送来自与单个帐户关联的机笼的入站货物。
在这种情况下,您的入库货件仅由您所在组织的某人配送至链接至一个账户的货箱。此示例请求中传递了此方案所需的最低信息。
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且返回响应标头时,将成功创建订单。没有响应主体。
如果要更新此顺序,请参阅/v2/orders/shipments/{orderId}API参考部分中的以了解更多信息。
如果您要为此订单添加备注,检索和回复此订单的协商或取消此订单,请参阅API参考部分中的订单以了解更多信息。
安排出站货物

要安排出库货件,请向端点发送POST请求/colocations/v2/orders/shipments。使用"type": "OUTBOUND"参数指定为出库货件,并在请求正文中提供其余货件详细信息。出库货件请求至少要求包含货件类型,货件日期,关联笼和承运人。您需要在出库货件
请求正文中传递的其他必要信息取决于以下因素:
- 如果您的出站运输来自与多个账户关联的机笼。
- 如果配送货件的承运人来自贵组织,列出的承运人或未列出的承运人。如果您的承运人不是DHL,FedEx,UPS,则您的承运人未列出。
- 如果您需要 Equinix 打印运输标签。
cURL 请求示例:
从与单个帐户关联的机笼中出站运输将由您组织的人员运送。
在这种情况下,您的出库货件仅由您所在组织的某人发送到与一个账户链接的货箱。此示例请求中传递了此方案所需的最低信息。
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"
}
]
}
]
}'
当返回HTTP代码201且返回响应标头时,将成功创建订单。没有响应主体。
如果要更新此顺序,请参阅/v2/orders/shipments/{orderId}API参考部分中的以了解更多信息。
如果您要为此订单添加备注,检索和回复此订单的协商或取消此订单,请参阅API参考部分中的订单以了解更多信息。