Shipment | Equinix Product Documentation

Created Outbound Shipment.

Request

This API is used to submit an Outbound Shipment order.

Authorizationstringrequired

Specify the Access token with prefix 'Bearer'.

Bodyapplication/json

contactsArray of objects, non-empty(Contact Info)required

Example:

[
  {
    "contactType": "ORDERING",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "NOTIFICATION",
    "userName": "jondoe@test.com"
  },
  {
    "contactType": "TECHNICAL",
    "userName": "jondoe@test.com"
  }
]

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:

{}

ibxLocationobject(ibxLocation)required

Example:

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

serviceDetailsobject(Outbound Service Detail)required

Example:

{
  "estimatedDateTime": "2018-11-28T19:09:30.211Z",
  "shipmentDetails": {
    "outboundType": "CARRIER",
    "noOfBoxes": 3,
    "carrierName": "DHL",
    "trackingNumber": "33,333",
    "declaredValue": "3",
    "labelExists": false,
    "shipToAddress": { … }
  }
}

attachmentsArray of objects, <= 5 items(Attachment)

Attachments

Example:

[]

Payload

{
  "attachments": [],
  "ibxLocation": {
    "cages": [ … ],
    "ibx": "AM1"
  },
  "purchaseOrder": {},
  "serviceDetails": {
    "estimatedDateTime": "2018-11-28T19:09:30.211Z",
    "shipmentDetails": { … }
  },
  "contacts": [
    { … },
    { … },
    { … }
  ]
}

Responses

Created Outbound Shipment Order Successfully

Bodyapplication/json

OrderReferenceIdstring

Order Reference Id

orderNumberstringrequired

Order Number

Example:"1-108124419634"

Idstring

Order Id

SRNumberstring

SR Number

Response

{
  "OrderNumber": "1-128726682521"
}

Created Outbound Shipment.

Request

Headers

Responses