Skip to main content

Order

The Order interface represents a customer order with three independent statuses tracking order progress, payment, and shipping.

Definition

OrderStatus Enum

Tracks the overall lifecycle of the order.

PaymentStatus Enum

Tracks whether payment has been collected.

ShippingStatus Enum

Tracks the overall shipping state at the order level.

Usage Examples


OrderItem

The OrderItem interface represents a line item in an order. Each item tracks its own fulfillment status independently.

Definition

FulfillmentStatus Enum

Tracks item-level fulfillment, enabling partial shipments and multi-carrier delivery.

OrderAddress

The OrderAddress interface represents a shipping or billing address for an order.

Definition


OrderShipping

The OrderShipping interface represents a shipment, a physical package sent to the customer. Each shipment tracks its own delivery progress and has a timeline of tracking events.

Definition

ShipmentStatus Enum

Tracks the delivery progress of a single package.

OrderShippingEvent

The OrderShippingEvent interface represents a tracking event in a shipment’s timeline.

Definition


OrderRefund

The OrderRefund interface represents a refund for an order.

Definition

OrderRefundStatus Enum