object Shipment

Fields

FieldTypeDescription
idString
legacy_idInt
order_idString
user_idString
warehouse_idString
pending_shipment_idString
addressAddress
profileString
picked_upBoolean
needs_refundBoolean
refundedBoolean
deliveredBoolean
shipped_off_shipheroBoolean
dropshipmentBoolean
completedBoolean

This field indicates if store was notified about the shipment. It should be 'true' by default and 'false' when using the Bulk Ship UI.

created_dateISODateTime
line_itemsShipmentLineItemConnection
ArgumentTypeRequiredDefaultDescription
sortStringNo
beforeStringNo
afterStringNo
firstIntNo
lastIntNo
shipping_labels[ShippingLabel]
warehouseWarehouse
orderOrder
total_packagesInt
ready_to_shipString

Referenced By

Example

{
  "id": "abc123",
  "legacy_id": 987,
  "order_id": "abc123",
  "user_id": "abc123",
  "warehouse_id": "abc123",
  "pending_shipment_id": "abc123",
  "address": Address,
  "profile": "abc123",
  "picked_up": true,
  "needs_refund": true,
  "refunded": true,
  "delivered": true,
  "shipped_off_shiphero": true,
  "dropshipment": true,
  "completed": true,
  "created_date": "abc123",
  "line_items": ShipmentLineItemConnection,
  "shipping_labels": ShippingLabel,
  "warehouse": Warehouse,
  "order": Order,
  "total_packages": 987,
  "ready_to_ship": "abc123"
}