Skip to content

Shipment line items

Open .md

API reference Shipping Shipments

The lines of a shipment: quantities of order lines, and shipping cost lines.

Learn more: Ship an order

7 operations

  • POSTAdd a line to a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}/itemAdds one line to a shipment and recalculates it.
  • POSTAdd, change and remove shipment lines at once/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/bulkApplies several line changes to one shipment in one transaction: all of them are saved, or none.
  • GETList the lines of a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}/itemReturns every line of a shipment: shipped order lines and shipping cost lines.
  • GETGet a shipment line/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}Returns one shipment line: product (for order_item, _meta.parent holds the order line), pricing, quantity, weight, position and lock_version.
  • POSTFix up shipment line positions/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/sortMakes room around a line whose position you just changed, so positions stay unique and spaced.
  • PUTUpdate a shipment line/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}Changes one shipment line and recalculates the shipment.
  • DELETERemove a line from a shipment/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}Removes one line from a shipment and recalculates it.