Sales orders
A sales order is the customer order as it entered ShipperOne from a sales channel (webshop, marketplace, POS). ShipperOne routes it to one or more locations, producing one fulfillment order per location. The sales order endpoints give you the customer-facing view: what was ordered, and how far each line has progressed.
These endpoints are read-only. Use them for reporting, reconciliation, customer service tools, or to book orders in an ERP.
| Endpoint | Purpose | ACL resource |
|---|---|---|
GET /V1/salesOrders | List sales orders, 100 per page | Shipper_Sales::api_orders_list |
GET /V1/salesOrders/{incrementId} | Fetch one sales order by its number | Shipper_Sales::api_orders_get |
List sales orders
Section titled “List sales orders”GET /rest/{store_code}/V1/salesOrders?page=1&date=2026-10-30%2000:00:00Authorization: Bearer <your-token>Accept: application/jsonQuery parameters — all optional, and combinable:
| Parameter | Description |
|---|---|
page | Page number, starting at 1. Page size is fixed at 100; iterate until you receive an empty array. |
date | yyyy-mm-dd hh:mm:ss — only orders updated at or after this time. Use it for incremental polling. |
channel | Sales channel code — only orders from that channel. |
fulfillment_status | Only orders in this fulfillment status (see Statuses). |
assigning_status | Only orders in this assigning status (see Statuses). |
Orders are returned in creation order (oldest first). An invalid page or date returns 400.
See GET /V1/salesOrders for the full schema.
Fetch one sales order
Section titled “Fetch one sales order”GET /rest/{store_code}/V1/salesOrders/000012345Authorization: Bearer <your-token>Accept: application/json{incrementId} is the ShipperOne order number — the order_number field of the response. An unknown number returns 404.
See GET /V1/salesOrders/{incrementId}.
Order numbers
Section titled “Order numbers”A sales order carries two numbers:
order_number— the ShipperOne order number. Use it to fetch the order and to match it with fulfillment orders (sales_order_numberon a fulfillment order refers to the channel number below,sales_order_idto the sales orderid).sales_order_number— the order number in the sales channel the order came from (e.g. the webshop order number).
Amounts
Section titled “Amounts”All amounts are in the order currency (currency_code). Amounts are including tax unless the field name ends in _excl_tax:
- Order level:
subtotal,shipping_amount,grand_total, each with an_excl_taxvariant, plustax_amount,shipping_tax_amountandshipping_tax_percent. - Item level:
priceis the unit price after discount;price_excl_discountis the unit price before discount, anddiscount_amount/row_discount_amountthe discount per unit / per row.row_totalis the row total after discount.tax_amountis the tax per unit,tax_percentthe rate.
Following quantities per item
Section titled “Following quantities per item”Each item carries the ordered quantity and how much of it has progressed through fulfillment:
| Field | Meaning |
|---|---|
qty | Quantity ordered. |
qty_ship_requested | Quantity assigned to fulfillment orders (accepted or awaiting accept). |
qty_shipped | Quantity shipped. |
qty_invoiced | Quantity invoiced. |
qty_canceled | Quantity canceled. |
qty_refunded | Quantity refunded. |
These fields let you follow partial fulfillment of a customer order line by line: when a sales order is split across fulfillment orders, or a warehouse accepts only part of an item, the quantities move independently per line.
To match a fulfillment order line to its sales order line, use sales_order_item_id on the fulfillment order item — it equals the id of the sales order item. Do not rely on sku: the same SKU can appear on more than one line.
Items also carry erp_sku (the SKU as known to the ERP, when one is mapped) and external_item_id (the line id in the sales channel, when provided).
Statuses
Section titled “Statuses”A sales order exposes four status fields:
status— the overall order status.assigning_status— how far the order has been routed to locations:unassigned,partially_assigned,assigned,assign_failed,retry,canceled.fulfillment_status— how far fulfillment has progressed across all its fulfillment orders:pending,partially_accepted,accepted,partially_processing,processing,partially_complete,complete,canceled.payment_status— the payment state of the order.
Payment, shipping and addresses
Section titled “Payment, shipping and addresses”payment—method_codeandmethod_name.shipping—method_code,method_name,internal_method_code, the customer’scustomer_note, andpickup_point_delivery(location_id,location_name) for deliveries to a pickup point.billing_address/shipping_address— name,email,street,city,postcode,region,country_id,telephone,company,vat_id.