Queries
inboundShipment— Fetch a single inbound shipment by its id.inboundShipments— List inbound shipments, optionally filtered by status.purchaseOrder— Fetch a single purchase order by its id.purchaseOrders— List purchase orders, optionally filtered by supplier or status.supplier— Fetch a single supplier by its id.suppliers— List suppliers.
Objects
- InboundShipment — A shipment of inventory arriving at a location, fulfilling one or more purchase orders.
- InboundShipmentItem — A line item received (or expected) on an inbound shipment.
- PurchaseOrder — An order placed with a supplier to restock inventory.
- PurchaseOrderItem — A line item ordered on a purchase order.
- Supplier — A vendor a merchant buys inventory from, with contacts and purchase orders.
- SupplierContact — A contact person at a supplier.
Enums
- InboundShipmentSortKey
— A field this list can be ordered by; pass to the list’s
orderByargument and pair withreverseto flip direction. - InboundShipmentStatus — The lifecycle status of an inbound shipment.
- PackingMode — How a shipment line item is packed.
- PurchaseOrderSortKey
— A field this list can be ordered by; pass to the list’s
orderByargument and pair withreverseto flip direction. - PurchaseOrderStatus — The lifecycle status of a purchase order.
- SupplierSortKey
— A field this list can be ordered by; pass to the list’s
orderByargument and pair withreverseto flip direction.