Skip to main content

Fields reference

This page defines every field on a sales order: the header (order-level) details, the shipping and billing addresses, the line-item fields, the calculated quantity states each line carries, and the totals footer at the bottom of the order. It uses the demo order SO-DOCS-0001 — customer Blue Bottle Retail, store Main Store, warehouse Main Warehouse, three product lines (Stainless Water Bottle 750ml, Insulated Tumbler 500ml, Reusable Straw 4-Pack) — in examples.

Three fields on a sales order are statusesorder, fulfillment, and payment status. They're calculated, not entered, and each moves on its own axis, so they have their own page: see the status reference and the concept How sales order status works. For where these fields appear as sortable columns on the list, see List columns and filters.

Header fields

These fields live in the Order Details and Shipping cards on the order page. You set them when you create an order and change them when you edit one. Fields marked required must have a value before you can save.

FieldRequiredWhat it holds
CustomerThe customer the order is for, for example Blue Bottle Retail. Selecting a customer auto-fills the store, currency, addresses, shipping method, and sales rep from that customer's defaults. Leave it blank for a walk-in or blank order.
Order #The order's reference number (sales_order_number). Leave it blank and SKU.io generates the next number in sequence. It must be unique within its sales channel.
Customer PO#The customer's own purchase-order reference for this order (customer_po_number). Free text; prints on customer-facing documents.
Order DateYesThe date of the order. When set to today, it's stamped with the current time. Also the default accounting-period date for the order's transactions.
StoreThe store (sales channel outlet) this order belongs to, for example Main Store.
Sub ChannelAn optional sub-channel under the store, used for finer revenue and nominal-code routing.
Sales RepThe sales representative credited with the order. Search an existing rep or create one inline.
CurrencyYesThe currency the order is priced and billed in. Defaults from the customer, then the site default.
Currency rateThe exchange rate from the order currency to your base (home) currency, captured for accounting so a later market move doesn't restate the order. See How order financials flow to accounting.
Tax IncludedWhen on, line unit prices are treated as already including tax. When off, tax is added on top.
Tax RateThe default tax rate applied to new lines. It doesn't retag existing lines.
Memo for customerAn optional note that appears on customer-facing documents such as the invoice PDF.
TagsLabels for grouping and filtering. Organizational only — tags drive list filters and have no financial or fulfillment effect. See Add notes, tags, and custom fields.
Custom fieldsAny account-defined fields configured for sales orders.

You can create a Customer, Currency, Sales Rep, or Shipping Method inline from these fields without leaving the order — see Create a sales order.

Shipping and scheduling fields

These live in the Shipping card and drive fulfillment routing and scheduling.

FieldWhat it holds
Method / Shipping MethodThe carrier or service for the order. Choose a Predefined method or type a custom method name. A predefined method links to the account's shipping-method list; a custom method is free text.
Requested shipping methodThe raw shipping method as it arrived from a sales channel, before mapping.
Ship ToThe ship-to address (see Address fields).
Hold UntilA date before which the order shouldn't ship.
Ship ByThe date the order should ship by.
Deliver ByThe date the order should be delivered by.

Context-specific header fields

Some header fields appear only for particular order types:

  • FBA (is_fba) — marks an order fulfilled by Amazon rather than from your own stock. FBA orders ship outside SKU.io and record no local inventory movement or COGS. See Amazon FBA, MCF, and externally fulfilled orders.
  • Replacement order (is_replacement_order) — set automatically on a free-replacement resend (-R-) or an exchange (-E-) created from another order. See Resend and exchange an order.
  • Sales channel (sales_channel_id) and Last synced (last_synced_from_sales_channel_at) — shown on orders imported from a marketplace, recording the source channel and when SKU.io last reconciled with it. See How channel orders sync.

Address fields

A sales order carries a full shipping address and a full billing address. Each address stores its own name, company, contact details, and postal fields, so an order keeps a stable snapshot even if the underlying customer record changes later.

FieldWhat it holds
NameThe recipient (shipping) or bill-to (billing) contact name.
CompanyThe recipient or bill-to company.
Email / Phone / FaxContact details for the address.
Address 1 / 2 / 3The street address lines.
CityThe city or town.
Province / Province codeThe state, province, or region and its code.
ZipThe postal or ZIP code.
Country / Country codeThe country and its ISO code.
LabelAn optional label for the saved address (for example, Warehouse or Head Office).
Billing can mirror shipping

In the Billing card, turn on Same as shipping to keep the billing address in step with the shipping address. Turn it off to enter a separate bill-to address.

Ship-to override protects your correction

When you edit the ship-to address on a channel order, SKU.io records that it was manually overridden (shipping_overridden_at). While that override is in place, later channel resyncs (for example, from Amazon) leave your corrected shipping, billing, and customer details alone instead of overwriting them. Changing the ship-to address on an order that already has a live fulfillment also re-pushes the new address to the shipping provider — see Order events and automation.

Line-item fields

Each product or charge on the order is a line. Product lines carry a product; non-product lines carry only a description and post to a nominal code as a charge or revenue line. Edit lines while the order is in edit mode — see Manage order lines.

Identity and pricing

FieldWhat it holds
SKU / ProductThe product on the line. Empty on non-product lines.
DescriptionThe line description. On a product line it defaults from the product; on a non-product line it's the only identifier.
Qty (Quantity)The ordered quantity for the line.
Unit PriceThe per-unit selling price (amount).
DiscountA per-line discount (percentage or fixed amount). Add it with Add discount on the line. See Add discounts and charges.
Tax RateThe tax rate applied to the line. Taxable (is_taxable) controls whether tax applies at all.
Nominal codeThe nominal (general-ledger / GL) code the line's revenue posts to. See How order financials flow to accounting.
WarehouseThe warehouse the line ships from. Each line carries its own warehouse, so one order can ship from several. See Warehouse routing and the warehouse lock.
Line totalQuantity × unit price, less the line's discount, before order-level discounts and tax.
A line's warehouse locks once fulfillment begins

Once a line has been shipped (has an inventory movement, or is covered by an in-flight fulfillment order), its Warehouse is frozen and can't be changed by an ordinary edit. To reship from elsewhere, void the shipment first. Full detail in Warehouse routing and the warehouse lock.

Quantity states (calculated)

A sales order line has no status column. Its state is derived entirely from a set of quantities, so a single line can be part-shipped, part-allocated, and part-backordered at once. These values are calculated for you; you don't enter them.

QuantityWhat it counts
Fulfilled quantityUnits shipped from your own stock.
Submitted quantityUnits on an in-flight shipment that hasn't shipped yet.
Externally fulfilled quantityUnits shipped outside SKU.io (Amazon FBA / MCF).
AWD fulfilled quantityUnits fulfilled from Amazon Warehousing and Distribution.
Cancelled quantityUnits cancelled off the line; they reduce the effective ordered quantity.
Remaining to fulfillOrdered quantity still to ship, after cancellations and everything already fulfilled.
Available to fulfillOrdered units not yet committed to a shipment and not backordered — the ordered quantity less everything already on a fulfillment (submitted or shipped), less externally fulfilled and cancelled units, less backordered units. It's not the on-hand-allocated figure.
Allocated quantityUnits committed to the line from stock. On-hand allocated counts only the portion backed by physical on-hand inventory.
Unallocated quantityOrdered units with no allocation yet.
Backordered quantityUnits short of stock. Active backordered is the portion that's a true shortage — demand with no incoming purchase order to cover it.
Returned quantityUnits returned against the line. Unreturned is the shippable remainder.
Dropshipped quantityUnits routed to a supplier dropship instead of your own warehouse.

A line reads as fulfilled when its shipped, externally fulfilled, and AWD-fulfilled quantities together cover the ordered quantity minus any cancelled quantity. Non-product lines are always treated as fulfilled. Active backorders on any line block the order from closing. For how allocation and backorders move, see Inventory allocation and backorders; for how these quantities roll up into the order's fulfillment status, see the status reference.

Channel, mapping, and routing

These fields appear on lines that came from a sales channel or that you have restructured.

FieldWhat it holds
Sales channel line idThe line's id on the originating channel order. Ties the SKU.io line back to the channel so fulfillment writes back correctly.
Product mapping overriddenSet when you map or replace a channel line's product by hand; a later channel resync then won't revert your mapping. Unmapped channel lines block fulfillment until you map them to a product.
Out of sync (sales_channel_fulfillment_out_of_sync)Flags a line whose fulfillment in SKU.io no longer matches what the channel shows. See How channel orders sync.
Split from linePoints a line back to the line it was split from — when you split a line across warehouses or otherwise divide it.
Warehouse routing methodRecords how the line's warehouse was chosen (for example, a routing suggestion versus a manual pick).

Bundle and subscription lines

FieldWhat it holds
BundlePresent on lines that are part of a bundle or kit. The bundle caches (component and quantity) and proration basis let SKU.io split the bundle's price and stock across its components.
Subscription editionThe subscription edition a line was generated for. Edition override (with an optional reason) marks that you swapped the edition or product by hand for this order.

Physical attributes

FieldWhat it holds
Extended weightThe line's total weight (unit weight × quantity), used for the order's combined weight.
Extended volumeThe line's total volume, used for the order's combined volume.
DecorationsArtwork and decoration instructions on the line, with an estimated and actual decoration cost that can re-price it. Niche to branded / decorated products — see Manage order lines.

Discounts and charges

Beyond per-line discounts, an order carries order-level discounts and financial (charge) lines. Both are calculated into the totals footer.

FieldWhat it holds
Order discountA discount applied to the whole order rather than one line, as a percentage or a fixed amount, before or after tax.
Apply order discount onWhether the order-level discount is taken before or after tax.
Financial (charge) lineA shipping, handling, or miscellaneous charge with its own type, tax allocation, and proration across lines.

Full instructions are in Add discounts and charges.

The footer at the bottom of the order rolls up the current totals in the order's own currency.

ItemMeaning
SubtotalThe product subtotal before discounts and tax.
Line Item DiscountsTotal of the per-line discounts.
Order DiscountsTotal of the order-level discounts.
DiscountsCombined discount total (line plus order), when a single line is shown.
TaxTotal tax. Open the Tax Breakdown to see tax per rate.
Revenue Lines BreakdownThe contribution of non-product charge / revenue lines, when present.
TotalThe order total. Open the Total Breakdown for the full build-up.
PaidTotal payments recorded against the order. See Record payments and apply store credit.
Sales Credits Applied / CreditsTotal sales credits (credit notes) applied to the order. See Process returns: RMAs and credits.
Balance DueOrder total minus payments and applied credits — what the customer still owes.

Lifecycle timestamps

A sales order stamps several dates as it moves through its lifecycle. These are set for you by the actions that trigger them.

TimestampSet when
Approved atThe order is approved to Open.
Reserved atThe order is approved with reserve on, committing stock without shipping.
Fulfilled atEvery line has shipped and the order closes as fulfilled.
Fully paid atPayments cover the order total in full.
Cancelled atThe order is cancelled. The order's stored status stays closed; the cancelled-at stamp is what surfaces it as cancelled.
Archived atThe order is archived off the working list.
Packing slip printed atA packing slip is printed or the order is marked as printed. Drives a list column and filter.

Next steps

Last verified: