Shipments (2.0)
Download OpenAPI specification:Download
All inbound and outbound shipments must be scheduled 24 hours in advance. Deliveries during non-standard business hours (after hours or weekend deliveries) require prior approval and will be billed to your account as an Equinix Smart Hands charge. You must communicate in writing any special shipping or packing instructions and if special packaging material is required. If your shipments are international, Equinix recommends that you hire a U.S. Customs Broker before shipping your equipment to and from our facilities. It is your responsibility to arrange for delivery to and from our facilities and customs clearance at the port of entry.
Schedule inbound or outbound shipment
This method schedules an inbound or outbound shipment for a user with shipments ordering permission.
Authorizations:
Request Body schema: application/json
| type required | string Enum: "INBOUND" "OUTBOUND" Type of shipment to be scheduled. | ||||||||||||
| requestedDateTime required | string <date-time> Date and time of shipment schedule in UTC timezone in ISO 8601 format. | ||||||||||||
| cageId required | string ID of cage where shipment is to be delivered to or retrieve from. | ||||||||||||
required | InboundShipments (object) or OutboundShipments (object) | ||||||||||||
One of
| |||||||||||||
| accountNumber | string Customer account number. This is required if cage is shared. | ||||||||||||
| description | string [ 10 .. 4000 ] characters Any additional information that the technician may need to complete your request | ||||||||||||
| customerReferenceId | string [ 1 .. 40 ] characters Customer Reference Number / External Reference Number | ||||||||||||
object (purchaseOrder) Purchase order required only when the Account PO Bareing | |||||||||||||
| |||||||||||||
Array of objects (Attachment) <= 5 items Additional attachments that is required to facilitate scheduled shipments such as instruction manual or photos. To learn about including attachments in your request, see POST Attachment API. | |||||||||||||
Array (<= 5 items)
| |||||||||||||
Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, provide the Techical contact and Notificition contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users). | |||||||||||||
Array Any of
| |||||||||||||
Responses
| Location | string Example: "/orders/1-23232322" Location on newly shipment request |
Request samples
- Payload
{- "customerReferenceId": "Customer Reference information free text",
- "description": "Please provide any additonal details the technician may need to complete your request.",
- "details": {
- "carrier": "DHL",
- "carrierTrackingNumbers": [
- "DHL930182000"
], - "numberOfBoxes": 1
}, - "attachments": [
- {
- "id": "85d9660a-f877-405a-b38e-8e61a4f77f44",
- "name": "additionalattachment.docx"
}
], - "contacts": [
- {
- "type": "TECHNICAL",
- "firstName": "John",
- "lastName": "Doe",
- "availability": "WORK_HOURS",
- "timezone": "America/New_York",
- "details": [
- {
- "value": "johndoe@acme.com",
- "type": "EMAIL"
}, - {
- "value": "+65-1111111",
- "type": "PHONE"
}, - {
- "value": "+65-1111111",
- "type": "MOBILE"
}
]
}, - {
- "registeredUsers": [
- "john_doe"
], - "type": "NOTIFICATION"
}
]
}Response samples
- 400
- 403
- 500
[- {
- "errorCode": "EQ-2016011",
- "errorMessage": "One or more mandatory properties are missing.",
- "correlationId": "100707114876163",
- "additionalInfo": [
- {
- "property": "type",
- "reason": "type is required"
}
]
}
]Update inbound or outbound shipment
This method modifies an inbound or outbound shipment for a user with shipments ordering permission.
Authorizations:
path Parameters
| orderId required | string Identifier of the shipments order |
Request Body schema: application/jsonrequired
The Shipment to be updated
Array of objects (ContactRequestRegisteredUser_Update) <= 1 items | |||||||||||
Array (<= 1 items)
| |||||||||||
| requestedDateTime | string <date-time> Date the requested date and time. | ||||||||||
InboundShipmentsUpdate (object) or OutboundShipmentsUpdate (object) | |||||||||||
One of
| |||||||||||
Responses
Request samples
- Payload
{- "contacts": [
- {
- "registeredUsers": [
- "john_doe"
], - "type": "NOTIFICATION"
}
], - "requestedDateTime": "2020-05-22T19:23:51.000Z",
- "details": {
- "carrier": "DHL",
- "carrierTrackingNumbers": [
- "123466ABCXYZ"
], - "carrierName": "carrier_name",
- "numberOfBoxes": 10,
- "cageDelivery": true
}
}Response samples
- 400
- 403
- 500
[- {
- "errorCode": "EQ-2016010",
- "errorMessage": "One or more properties are invalid",
- "correlationId": "99740129126918",
- "additionalInfo": [
- {
- "property": "requestedDateTime",
- "reason": "timestamp is invalid",
- "value": "2020-06-18T06:41:10.562sdasZ"
}
]
}
]