Sales Orders

The sales_order object

Full sales order resource.

idstring

Sales order ID.

objectstringenumValues:sales_order

Resource type identifier.

numberstring

Human-readable order number, e.g. SO-001.

Assigned automatically when the order is created; unique within your account.

customer_purchase_order_numberstringnullable

The customer's own purchase order number, for cross-referencing.

Unique among this customer's orders.

notestringnullable

Order note.

statusstringenumValues:estimateissuedfulfilled

Order lifecycle status.

  • estimate: a draft quote that has not yet been committed; not counted as a real order.
  • issued: the order has been issued and is being fulfilled.
  • fulfilled: the order has been completed and closed.

Status changes are made through the issue, unissue, close, and reopen action endpoints rather than by updating this field.

prioritystringenumValues:lownormalhigh

Fulfillment priority, used to rank orders on the shop floor.

payment_statusstringenumValues:unpaidpartially_paidpaid

Payment state of the order, derived from settlement allocations, invoices, and Stripe payments.

payment_intent_idsarray of string

Stripe payment intent IDs recorded against this order.

acknowledgment_statusstringenumValues:not_sentsent

Whether an order acknowledgment has been sent to the customer.

customercustomernullable

Associated customer.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

  • normal: standard active account with no restrictions.
  • preferred: active account flagged as preferred.
  • hold_shipment: orders can be placed, but shipments are held.
  • hold_all: all activity is on hold.
edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

  • standalone: no parent or child accounts.
  • parent: has one or more child accounts (see child_accounts).
  • child: belongs to a parent account (see parent_account).
commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

  • commission_exempt: this customer's orders are exempt from sales commission.
  • commission_applied: sales commission is calculated on this customer's orders.
notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

Always returned as null in this endpoint.
contact_infocustomer_contact_infonullable

Contact information.

Always returned as null in this endpoint.
freight_preferencescustomer_freight_preferencesnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.
defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

Always returned as null in this endpoint.
bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
typeaccount_groupnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.
price_groupslistnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.
parent_accountcustomernullable

Parent account.

Present if this is a child account.

Always returned as null in this endpoint.
child_accountslistnullable

Child accounts.

Present if this is a parent account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repactornullable

Sales representative.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

  • user: a human user account.
  • api_key: a programmatic caller authenticating with an API key.
  • agent: an automated agent acting on the account's behalf.
  • group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

  • For user actors: the user's email address.
  • For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

Always returned as null in this endpoint.
created_bycreated_bynullable

Who created this order, and their relation (internal/customer/system).

objectstringenumValues:created_by

Resource type identifier.

relationstringenumValues:internalcustomersystem

The creator's relationship to the account that owns the resource.

  • internal: created by a user of the owning account.
  • customer: created by a customer of the owning account.
  • system: created automatically with no human actor (e.g. an EDI import).
actoractornullable

The actor who created the resource.

Absent when relation is system, since no human or programmatic actor performed the action.

Always returned as null in this endpoint.
bill_to_addressaddressnullable

Billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

  • standard: a normal shipping or billing address.
  • drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
geolocationgeolocationnullable

Geolocation details for the address.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

  • standard: a normal shipping or billing address.
  • drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
geolocationgeolocationnullable

Geolocation details for the address.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

freightfreightnullable

Carrier selection and freight billing for this order.

objectstringenumValues:freight

Resource type identifier.

policystringnullableenumValues:free_freightbilled_freight

How freight is arranged and billed for the record.

Populated where a freight policy applies, such as a customer's default preferences.

  • free_freight: no shipping cost to the buyer.
  • billed_freight: freight is billed to the buyer.
carriercarriernullable

The shipping carrier selected to fulfill the shipment.

Always returned as null in this endpoint.
service_levelservice_levelnullable

The carrier service level selected for the shipment (e.g. ground, overnight).

Always returned as null in this endpoint.
billing_typestringnullableenumValues:senderthird_party

Which party the carrier bills for the shipment.

  • sender: the shipper (your account) is billed.
  • third_party: a third party is billed via billing_account_number.
billing_account_numberstringnullable

Carrier account number to bill, used when billing_type is third_party.

payment_termpayment_termnullable

Payment term.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30).

statusstringenumValues:activeinactive

Lifecycle status of the payment term.

ownerownernullable

Owner of this resource, indicating whether it is an Augno-provided system default or was created by your account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Shipping term.

idstring

Shipping term ID.

objectstringenumValues:shipping_term

Resource type identifier.

namestring

Human-readable name for the shipping term, used to identify it when assigning shipping terms to customers and orders.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Freight pricing model applied by this shipping term.

  • free_freight: no shipping cost to the buyer.
  • flat_rate_freight: a fixed shipping cost regardless of order details (see flat_rate).
  • carrier_rate_freight: shipping cost is determined by the carrier's quoted rate.
ownerownernullable

Provenance of this shipping term.

System-owned shipping terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned shipping terms are custom to your account.

Always returned as null in this endpoint.
flat_ratequantitynullable

Fixed shipping charge applied to the order.

Applied only when type is flat_rate_freight; ignored for other freight pricing models.

Always returned as null in this endpoint.
minimum_order_valuequantitynullable

Order subtotal a buyer must reach before this term's free-shipping rules apply.

Always returned as null in this endpoint.
free_shipping_service_levelslistnullable

Service levels that ship for free under this term (typically once minimum_order_value is met).

Always returned as null in this endpoint.
created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

order_discountorder_discountnullable

Order discount.

idstring

Order discount ID.

objectstringenumValues:order_discount

Resource type identifier.

namestring

Display name of the discount.

codestring

The code entered to apply this discount to an order.

Must be unique within the account.

percentagestring (decimal)

Percent off as a decimal string (e.g. 10 for 10%).

Applies when discount_type is percentage; otherwise 0.

amountstring (decimal)

Fixed amount off as a decimal string.

Applies when discount_type is amount; otherwise 0.

discount_typestringenumValues:percentageamount

How the discount is calculated, determining whether percentage or amount is used.

  • percentage: the discount is a percent off, taken from percentage.
  • amount: the discount is a fixed amount off, taken from amount.
order_countinteger

Number of orders currently using this discount.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

lineslistnullable

Order lines.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of sales_order_line

Resources in this page.

idstring

Sales order line ID.

objectstringenumValues:sales_order_line

Resource type identifier.

line_item_numberinteger

Position of the line on the order.

Assigned automatically in sequence, starting at 1.

product_skustring

Product SKU.

product_descriptionstringnullable

Product description.

productproductnullable

Associated product.

Always returned as null in this endpoint.
quantity_orderedquantitynullable

Quantity ordered.

Always returned as null in this endpoint.
unit_priceratenullable

Price charged per unit.

Always returned as null in this endpoint.
unit_costratenullable

Internal cost per unit.

Reflects what the business pays for the item, not what the customer is charged, and is used to derive line profitability.

Always returned as null in this endpoint.
totalssales_order_totalsnullable

Derived monetary totals for this line.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

line_countinteger

Number of order lines on this order, returned even when the lines list itself is not expanded.

totalssales_order_totalsnullable

Derived monetary totals and per-stage fulfillment progress.

objectstringenumValues:sales_order_totals

Resource type identifier.

orderedstring (decimal)

Total ordered amount as a decimal string (unit price x quantity ordered). This is the baseline the stage completions are measured against.

pickedsales_order_stage_total

Picked amount and completion.

Always returned as null in this endpoint.
packedsales_order_stage_total

Packed amount and completion.

Always returned as null in this endpoint.
invoicedsales_order_stage_total

Invoiced amount and completion.

Always returned as null in this endpoint.
relatedsales_order_relatednullable

Records related to this order (pick, production run, shipments).

objectstringenumValues:sales_order_related

Resource type identifier.

pickrecordnullable

Associated pick.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

production_runrecordnullable

Associated production run.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

shipmentslistnullable

Associated shipments.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of record

Resources in this page.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

invoiceslistnullable

Associated invoices.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of record

Resources in this page.

idstring

Unique identifier for the record.

objectstringenumValues:record

Resource type identifier.

typestringenumValues:sales_orderpurchase_orderreceiving_order

The kind of business record referenced.

Determines how to resolve the record and which status and metadata keys may appear.

  • sales_order: a customer order.
  • purchase_order: an order placed with a supplier.
  • receiving_order: an inbound order being received into inventory.
  • pick: a warehouse pick task.
  • shipment: an outbound shipment.
  • delivery: a delivery of one or more shipments to a destination.
  • production_run: a manufacturing production run.
  • invoice: a customer invoice.
  • transaction: a payment or financial transaction.
  • settlement: a settlement reconciling transactions against invoices.
numberstringnullable

Human-readable record number, when the record has one.

statusstringnullable

Type-specific status code, when applicable.

metadataobject

Type-specific metadata.

The set of keys varies by record type.

contactsorder_contactnullable

Email recipients grouped by notification purpose.

objectstringenumValues:order_contact

Resource type identifier.

invoicearray of string

Email addresses that receive invoices for this order.

acknowledgementarray of string

Email addresses that receive order acknowledgements for this order.

issued_atstring (date-time)nullable

When the order was issued (moved out of estimate).

completed_atstring (date-time)nullable

When the order was fulfilled and closed.

first_ship_atstring (date-time)nullable

When the first shipment against this order went out.

expired_atstring (date-time)nullable

When this estimate expires, if an expiration was set.

promised_atstring (date-time)nullable

Date promised to the customer for delivery, if one was committed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Sales OrderSales OrdersPOSTQuote Sales Order PricesSales OrdersPATCHUpdate Sales OrderSales OrdersGETList Sales OrdersSales OrdersGETRetrieve Sales OrderSales OrdersDELETEDelete Sales OrderSales OrdersPOSTBulk Delete Sales OrdersSales OrdersPOSTCheckout Sales OrderSales OrdersPOSTCreate Sales Order LineSales OrdersPATCHUpdate Sales Order LineSales OrdersDELETEDelete Sales Order LineSales OrdersPUTClose Sales OrderSales OrdersPOSTCreate Production Run from Sales OrderSales OrdersPUTIssue Sales OrderSales OrdersPUTReopen Sales OrderSales OrdersPOSTQuote Sales Order FreightSales OrdersPUTUnissue Sales OrderSales OrdersPOSTReorder Sales Order LinesSales Orders