Retrieve a shipment item

Request

Security

OAuth2(Required scopes: FullAccessShipmentAdminShipmentReader)

Path

shipmentIDstringrequired

ID of the shipment.

orderIDstringrequired

ID of the order.

lineItemIDstringrequired

ID of the line item.

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

Responses

Bodyapplication/json

OrderIDstring

Example:""

LineItemIDstring

Example:""

QuantityShippedinteger, (int32)

Example:0

UnitPricenumber, (float)read-only

Example:0

CostCenterstringread-only

Example:""

DateNeededstring, (date-time)read-only

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

Productobject(LineItemProduct)read-only

Example:

{
  "ID": "",
  "Name": "",
  "Description": "",
  "Returnable": false,
  "QuantityMultiplier": 0,
  "ShipWeight": 0,
  "ShipHeight": 0,
  "ShipWidth": 0,
  "ShipLength": 0,
  "DefaultSupplierID": "",
  "ParentID": "",
  "xp": {}
}

Variantobject(LineItemVariant)read-only

Example:

{
  "ID": "",
  "Name": "",
  "Description": "",
  "ShipWeight": 0,
  "ShipHeight": 0,
  "ShipWidth": 0,
  "ShipLength": 0,
  "xp": {}
}

SpecsArray of objects(LineItemSpec)read-only

Example:

[
  {
    "SpecID": "",
    "Name": "",
    "OptionID": "",
    "Value": "",
    "PriceMarkupType": "NoMarkup",
    "PriceMarkup": 0
  }
]

xpobjectread-only

For reference only, represents line item XP from the given line item ID

Example:

{}

Response

{
  "OrderID": "",
  "LineItemID": "",
  "QuantityShipped": 0,
  "UnitPrice": 0,
  "CostCenter": "",
  "DateNeeded": "2018-01-01T00:00:00-06:00",
  "Product": {
    "ID": "",
    "Name": "",
    "Description": "",
    "Returnable": false,
    "QuantityMultiplier": 0,
    "ShipWeight": 0,
    "ShipHeight": 0,
    "ShipWidth": 0,
    "ShipLength": 0,
    "DefaultSupplierID": "",
    "ParentID": "",
    "xp": {}
  },
  "Variant": {
    "ID": "",
    "Name": "",
    "Description": "",
    "ShipWeight": 0,
    "ShipHeight": 0,
    "ShipWidth": 0,
    "ShipLength": 0,
    "xp": {}
  },
  "Specs": [
    { … }
  ],
  "xp": {}
}