Orders

The Order object represents a customer order containing one or more items to be fulfilled. Orders serve as the foundation for the fulfillment process in Carriyo.

Key Concepts

Order Structure

Each order contains:

• Customer Information : Shipping address, billing address, and customer details
• Line Items : Products ordered with quantities and prices
• Fulfillment Orders : Groups of line items assigned to specific locations for fulfillment
• Payment Information : Payment status and method details

Order Status

Orders progress through the following statuses:

• pending : Order created, awaiting fulfillment
• partially_fulfilled : Some items have been fulfilled
• fulfilled : All items have been fulfilled
• cancelled : Order has been cancelled

Reference Keys

Orders can be retrieved using:

• order_id : Carriyo's unique identifier for the order
• partnerorderreference : Your system's order reference (with key=partner_order_reference )

This allows flexible integration with your existing order management systems.

Fulfillment Orders

When an order is created, Carriyo automatically generates fulfillment orders based on:

• Inventory availability across locations
• Location-based allocation rules
• Explicit fulfillment order specifications in the request

Each fulfillment order represents items to be shipped from a single location.