Shipment (1.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

To submit a Shipment order.

Shipment

Created Outbound Shipment.

This API is used to submit an Outbound Shipment order.

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json

required

Array of objects (Contact Info) non-empty

Array (non-empty)

contactType required	string Enum: "TECHNICAL" "ORDERING" "NOTIFICATION" Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL
userName	string non-empty User Name
name	string^[\s.]([^\s.][\s.]){0,100}$ Technical Contact Name
email	string (emailDef) ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@... Contact Email
workPhoneCountryCode	string^\+[0-9]{1,6}$ Primary Phone of the contact
workPhone	string <= 40 characters Primary Phone of the contact
workPhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
mobilePhoneCountryCode	string^\+[0-9]{1,6}$ Mobile Phone of the contact
mobilePhone	string <= 40 characters Mobile Phone of the contact
mobilePhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
workPhoneTimeZone	string <= 40 characters Work Phone TimeZone
mobilePhoneTimeZone	string <= 40 characters Mobile Phone TimeZone

customerReferenceNumber

string [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

startDate

string <date-time>

Purchase Order Start Date

endDate

string <date-time>

Purchase Order End Date

number

string^(.{1,30})$

Purchase Order Number

object (Price)

The "amount" attribute denotes how much money the Purchase Order contains. This "amount" is measured in the currency type listed in the customer's account.

amount

number [ 0 .. 999999999999999 ]

Price

required

object (ibxLocation)

ibx

required

string [ 1 .. 10 ] characters

required

Array of objects non-empty

Array (non-empty)

cage required	string non-empty
accountNumber required	string

required

object (Outbound Service Detail)

outboundRequestDescription

string [ 1 .. 4000 ] characters

estimatedDateTime

required

string <date-time>

Date and time of received event (ISO Date)
Cannot in Past.

required

object

outboundType required	string Enum: "CARRIER" "CUSTOMER_CARRY" Outbound Type
carrierName	string Enum: "UPS" "FEDEX" "DHL" "OTHER"
trackingNumber	string [ 1 .. 100 ] characters
noOfBoxes	integer [ 1 .. 100000 ]
declaredValue	string [ 1 .. 20 ] characters
labelExists	boolean
	object
otherCarrierName	string [ 1 .. 50 ] characters
	object (Attachment)
insureShipment	boolean
pickUpFromCageSuite	boolean
description	string [ 1 .. 100 ] characters

Array of objects (Attachment) <= 5 items

Attachments

Array (<= 5 items)

id required	string non-empty Attachment ID
name required	string non-empty Attachment filename

Responses

Response Schema: application/json

OrderReferenceId	string Order Reference Id
orderNumber required	string Order Number
Id	string Order Id
SRNumber	string SR Number

Request samples

Payload

Content type

application/json

{"attachments": [ ],
"ibxLocation": {"cages": [{"cage": "AM1:0G:00EQ11-1",
"cabinets": [ ],
"accountNumber": "108812"
}
],
"ibx": "AM1"
},
"purchaseOrder": { },
"serviceDetails": {"estimatedDateTime": "2018-11-28T19:09:30.211Z",
"shipmentDetails": {"outboundType": "CARRIER",
"noOfBoxes": 3,
"carrierName": "DHL",
"trackingNumber": "33,333",
"declaredValue": "3",
"labelExists": false,
"shipToAddress": {"address": "1188 test address",
"carrierAccountNumber": "111",
"city": "Sunnyvale",
"country": "US",
"name": "test",
"state": "CALIFORNIA",
"zipCode": "94085",
"phoneNumber": "+1 1331313"
}
}
},
"contacts": [{"contactType": "ORDERING",
"userName": "jondoe@test.com"
},
{"contactType": "NOTIFICATION",
"userName": "jondoe@test.com"
},
{"contactType": "TECHNICAL",
"userName": "jondoe@test.com"
}
]
}

Response samples

201
400
403
500

Content type

application/json

{"OrderNumber": "1-128726682521"
}

Get Locations(ibx, cage) Details for Shipment Based on Place Shipment Permission for User

This API is use to check user's permission's & access to ibx

query Parameters

detail	boolean When enable this flag returns detailed permission with Cage & Cabinets. Default value is false
ibxs	string
cages	string

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json

Array of objects (Location)

Array

ibx required	string Ibx Name
required	Array of objects (Cage) List of cage

Response samples

200
400
403
500

Content type

application/json

{"locations": [{"ibx": "AM1",
"cages": [{"cage": "AM1:02:002MC1",
"cageTypes": ["Shared"
],
"accounts": [{"number": "1111",
"name": "ABC Network Services",
"isCreditHold": false,
"isPOBearing": true,
"isMonetAccount": false,
"cabinets": [{"cabinet": "AM1:02:002MC1:0601",
"cabinetType": "Shared"
},
{"cabinet": "AM1:02:002MC1:0602",
"cabinetType": "Shared"
}
]
}
]
}
]
}
]
}

Inbound Shipment Order

This API is used to submit an Inbound Shipment order.

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json

required

Array of objects (Contact Info) >= 2 items

Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.

Array (>= 2 items)

contactType required	string Enum: "TECHNICAL" "ORDERING" "NOTIFICATION" Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL
userName	string non-empty User Name
name	string^[\s.]([^\s.][\s.]){0,100}$ Technical Contact Name
email	string (emailDef) ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@... Contact Email
workPhoneCountryCode	string^\+[0-9]{1,6}$ Primary Phone of the contact
workPhone	string <= 40 characters Primary Phone of the contact
workPhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
mobilePhoneCountryCode	string^\+[0-9]{1,6}$ Mobile Phone of the contact
mobilePhone	string <= 40 characters Mobile Phone of the contact
mobilePhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
workPhoneTimeZone	string <= 40 characters Work Phone TimeZone
mobilePhoneTimeZone	string <= 40 characters Mobile Phone TimeZone

customerReferenceNumber

string [ 1 .. 50 ] characters

You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.

object (Purchase Order)

startDate

string <date-time>

Purchase Order Start Date

endDate

string <date-time>

Purchase Order End Date

number

string^(.{1,30})$

Purchase Order Number

object (Price)

The "amount" attribute denotes how much money the Purchase Order contains. This "amount" is measured in the currency type listed in the customer's account.

amount

number [ 0 .. 999999999999999 ]

Price

required

object (ibxLocation)

ibx

required

string [ 1 .. 10 ] characters

required

Array of objects non-empty

Array (non-empty)

cage required	string non-empty
accountNumber required	string

Array of objects (Attachment) <= 5 items

Attachments

Array (<= 5 items)

id required	string non-empty Attachment ID
name required	string non-empty Attachment filename

required

object (Inbound Service Detail)

required

object

noOfBoxes required	integer <= 10000000000000000000 No of boxes
isOverSized	boolean if Box is oversized
description	string [ 1 .. 100 ] characters description of inbound shipment
trackingNumber	Array of strings [ 0 .. 10 ] items [ items [ 0 .. 100 ] characters ] Tracking number
inboundType required	string Enum: "CARRIER" "CUSTOMER_CARRY" Inbound Type
carrierName	string Enum: "FEDEX" "DHL" "UPS" "OTHER" Carrier Name of shipment
otherCarrierName	string [ 1 .. 50 ] characters Other Carrier Name

deliverToCage

boolean

Deliver To cage

inboundRequestDescription

string [ 1 .. 4000 ] characters

Scope of work

storageId

string

Storage ID

estimatedDateTime

required

string <date-time>

estimatedDateTime of Shipment (ISO Date)
Cannot in Past.

Responses

Response Schema: application/json

OrderReferenceId	string Order Reference Id
orderNumber required	string Order Number
Id	string Order Id
SRNumber	string SR Number

Request samples

Payload

Content type

application/json

{"attachments": [ ],
"contacts": [{"contactType": "ORDERING",
"userName": "jondoe@test.com"
},
{"contactType": "NOTIFICATION",
"userName": "jondoe@test.com"
},
{"contactType": "TECHNICAL",
"userName": "jondoe@test.com"
}
],
"customerReferenceNumber": "RQT0036422",
"ibxLocation": {"ibx": "LD8",
"cages": [{"cage": "LD8:02:02MC2T",
"accountNumber": "111"
}
]
},
"purchaseOrder": {"startDate": "2018-04-09T02:47:42.320Z",
"endDate": "2018-10-19T20:29:25.682Z",
"number": "6",
"price": {"amount": 12.5
}
},
"serviceDetails": {"estimatedDateTime": "2018-10-15T05:00:00.420-08:00",
"shipmentDetails": {"noOfBoxes": 10,
"isOverSized": true,
"description": "hello",
"trackingNumber": ["1",
"2"
],
"inboundType": "CARRIER",
"carrierName": "OTHER",
"otherCarrierName": "test"
},
"deliverToCage": true,
"inboundRequestDescription": "hello"
}
}

Response samples

201
400
403
500

Content type

application/json

{"OrderNumber": "1-128726682522"
}

Pending Storage Order

This API is used to submit the Pending Inbound Shipment order.

header Parameters

Authorization

required

string

Specify the Access token with prefix 'Bearer'.

Request Body schema: application/json

required

Array of objects

Array

storageId required	string
cage required	string
accountNumber required	string
deliverToCage required	boolean
additionalDetails	string [ 1 .. 4000 ] characters Scope of work
customerReferenceNumber	string [ 1 .. 50 ] characters You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.
purchaseInformation	string [ 1 .. 30 ] characters Purchase Order Number

required

Array of objects (Contact Info) non-empty

Array (non-empty)

contactType required	string Enum: "TECHNICAL" "ORDERING" "NOTIFICATION" Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL
userName	string non-empty User Name
name	string^[\s.]([^\s.][\s.]){0,100}$ Technical Contact Name
email	string (emailDef) ^(([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@... Contact Email
workPhoneCountryCode	string^\+[0-9]{1,6}$ Primary Phone of the contact
workPhone	string <= 40 characters Primary Phone of the contact
workPhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
mobilePhoneCountryCode	string^\+[0-9]{1,6}$ Mobile Phone of the contact
mobilePhone	string <= 40 characters Mobile Phone of the contact
mobilePhonePrefToCall	string Enum: "NEVER" "ANYTIME" "MY_BUSINESS_HOURS" "IBX_BUSINESS_HOURS" "BUSINESS_HOURS" Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release
workPhoneTimeZone	string <= 40 characters Work Phone TimeZone
mobilePhoneTimeZone	string <= 40 characters Mobile Phone TimeZone

Responses

Response Schema: application/json

Array

OrderReferenceId	string Order Reference Id
orderNumber required	string Order Number
Id	string Order Id
SRNumber	string SR Number
storageID required	string
Ibx required	string
cage required	string
accountNumber required	string
trackingNumber required	string

Request samples

Payload

Content type

application/json

{"contacts": [{"contactType": "ORDERING",
"userName": "jondoe@test.com"
},
{"contactType": "NOTIFICATION",
"userName": "jondoe@test.com"
}
],
"shipmentDetails": [{"storageId": "1-275PQCAS",
"cage": "CH1:05:313",
"deliverToCage": true,
"accountNumber": "133333"
},
{"storageId": "1-275PQCGBF",
"cage": "SV1:05:31113",
"deliverToCage": false,
"accountNumber": "133335"
}
]
}

Response samples

201
400
403
500

Content type

application/json

{"OrderNumber": "1-128726682522"
}