Skip to main content

Order

The Order entity represents an order placed in your shop system.

Orders have two main states:

  • Placed: order has been accepted and paid but not shipped.
  • Fulfilled: order has been dispatched to a carrier for delivery.
    • Partially fulfilled: for orders with multiple shipments, where not all of its products are sent at the same time.

Shipment​

See Shipment for more information.

Tracking​

Order objects can have a list of trackings, that are inherently belonging to shipments.

The Tracking entity represents a shipment with a valid tracking code (a FulfilledShipment). Such shipments will receive updates from the carriers.

API Reference​