Shipment | Equinix Product Documentation

Inbound Shipment Order

Request

This API is used to submit an Inbound Shipment order.

Authorizationstringrequired

Specify the Access token with prefix 'Bearer'.

Bodyapplication/json

contactsArray of objects, >= 2 items(Contact Info)required

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.

Example:

[
  {
    "contactType": "ORDERING",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "NOTIFICATION",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "TECHNICAL",
    "name": "John Doe",
    "workPhone": "1111111",
    "workPhonePrefToCall": "ANYTIME",
    "mobilePhone": "1111111",
    "mobilePhonePrefToCall": "ANYTIME"
  }
]

customerReferenceNumberstring, [ 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.

Example:"cust-ref-123"

purchaseOrderobject(Purchase Order)

Example:

{
  "startDate": "2018-04-09T02:47:42.320Z",
  "endDate": "2018-10-19T20:29:25.682Z",
  "number": "6",
  "price": {
    "amount": 12.5
  }
}

ibxLocationobject(ibxLocation)required

Example:

{
  "ibx": "PA2",
  "cages": [
    { … }
  ]
}

attachmentsArray of objects, <= 5 items(Attachment)

Attachments

Example:

[]

serviceDetailsobject(Inbound Service Detail)required

Example:

{
  "estimatedDateTime": "2018-10-15T05:00:00.420-08:00",
  "shipmentDetails": {
    "noOfBoxes": 10,
    "isOverSized": true,
    "description": "hello",
    "trackingNumber": [ … ],
    "inboundType": "CARRIER",
    "carrierName": "OTHER",
    "otherCarrierName": "test"
  },
  "deliverToCage": true,
  "inboundRequestDescription": "hello"
}

Payload

{
  "attachments": [],
  "contacts": [
    { … },
    { … },
    { … }
  ],
  "customerReferenceNumber": "RQT0036422",
  "ibxLocation": {
    "ibx": "LD8",
    "cages": [ … ]
  },
  "purchaseOrder": {
    "startDate": "2018-04-09T02:47:42.320Z",
    "endDate": "2018-10-19T20:29:25.682Z",
    "number": "6",
    "price": { … }
  },
  "serviceDetails": {
    "estimatedDateTime": "2018-10-15T05:00:00.420-08:00",
    "shipmentDetails": { … },
    "deliverToCage": true,
    "inboundRequestDescription": "hello"
  }
}

Responses

Created Inbound Shipment Order Successfully

Bodyapplication/json

OrderReferenceIdstring

Order Reference Id

orderNumberstringrequired

Order Number

Example:"1-108124419634"

Idstring

Order Id

SRNumberstring

SR Number

Response

{
  "OrderNumber": "1-128726682522"
}

Inbound Shipment Order

Request

Headers

Responses