Retrieve a shipment

Request

Only available to Buyer Users.

Security

OAuth2(Required scopes: FullAccessShopper)

Path

shipmentIDstringrequired

ID of the shipment.

curl -i -X GET \
  'https://api.ordercloud.io/v1/me/shipments/{shipmentID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Only available to Buyer Users.

Bodyapplication/json

IDstring, <= 100 characters

Example:""

BuyerIDstring

Example:""

Shipperstring

For reference only, does not influence any OrderCloud behavior.

Example:""

DateShippedstring, (date-time)

In order to properly trigger OrderShipped emails, this date must be NULL on initial create. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped populated the OrderShipped message sender will trigger and Order.Status will be updated to Complete.

Example:"2018-01-01T00:00:00-06:00"

DateDeliveredstring, (date-time)

Example:"2018-01-01T00:00:00-06:00"

TrackingNumberstring, <= 3000 characters

Example:""

Costnumber, (float)

For reference only, does not influence any OrderCloud behavior.

Example:0

OwnerIDstring

ID of the organization that owns the shipment. Only the marketplace owner can override the OwnerID on create.

Example:""

xpobject

Example:

{}

Accountstring

Example:""

FromAddressIDstring

Marketplace owner or supplier AddressID where the product will be shipped from.

Example:""

ToAddressIDstring

Example:""

FromAddressobject(Address)read-only

Example:

{
  "ID": "",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}

ToAddressobject(Address)read-only

Example:

{
  "ID": "",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}

Response

{
  "ID": "",
  "BuyerID": "",
  "Shipper": "",
  "DateShipped": "2018-01-01T00:00:00-06:00",
  "DateDelivered": "2018-01-01T00:00:00-06:00",
  "TrackingNumber": "",
  "Cost": 0,
  "OwnerID": "",
  "xp": {},
  "Account": "",
  "FromAddressID": "",
  "ToAddressID": "",
  "FromAddress": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  },
  "ToAddress": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  }
}