Issue Sales Order

Beta
PUT/v1/sales/sales-orders/{id}/actions/issue

This endpoint is idempotent. Learn more

Issues a sales order, transitioning it from estimate to issued.

Issuing commits the order for fulfillment: a pick is created for the order's sale lines and inventory is reserved for each line tied to an inventory item.

Permissions requiredValues:sales_orders:update
The role behind your API key or agent must grant every one of these permissions.
idstring

Sales order ID.

notify_customerboolean

Whether to notify the customer.

When true, the order acknowledgement email is sent to the contacts configured on the order and the order's acknowledgment_status is set to sent.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

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

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

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 service_level

Resources in this page.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default 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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Default 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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

minimum_order_valuequantitynullable

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

free_shipping_service_levelslistnullable

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

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 service_level

Resources in this page.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name of the priority level.

ownerownernullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Default sales rep.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

  • active: the user can access the account.
  • disabled: the user is locked out of the account.
  • removed: the user has been removed (soft-deleted) from the account.
rolerolenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

  • admin: full administrative access, including managing API keys.
  • user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
  • scanner: a role for scanning-station operators.
  • sales_rep: a role for sales representatives.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentdepartmentnullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

Location type code, identifying this location's level in the storage hierarchy.

  • building: a building-level location.
  • section: a section within a building.
  • aisle: an aisle within a section.
  • rack: a rack within an aisle.
  • shelf: a shelf within a rack.
  • bin: a bin within a shelf.
parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationslistnullable

Scanning stations in this department.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of scanning_station

Resources in this page.

machineslistnullable

Machines in this department.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of machine

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

userusernullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

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 account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

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

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of service_level

Resources in this page.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default 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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Default 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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

minimum_order_valuequantitynullable

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

free_shipping_service_levelslistnullable

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of service_level

Resources in this page.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name of the priority level.

ownerownernullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Default sales rep.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

  • active: the user can access the account.
  • disabled: the user is locked out of the account.
  • removed: the user has been removed (soft-deleted) from the account.
rolerolenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

  • admin: full administrative access, including managing API keys.
  • user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
  • scanner: a role for scanning-station operators.
  • sales_rep: a role for sales representatives.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentdepartmentnullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

scanning_stationslistnullable

Scanning stations in this department.

machineslistnullable

Machines in this department.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

userusernullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

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 account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

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

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Default 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.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

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

minimum_order_valuequantitynullable

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

free_shipping_service_levelslistnullable

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

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name of the priority level.

ownerownernullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Default sales rep.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

  • active: the user can access the account.
  • disabled: the user is locked out of the account.
  • removed: the user has been removed (soft-deleted) from the account.
rolerolenullable

Assigned role.

departmentdepartmentnullable

Assigned department.

userusernullable

Underlying user.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

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 account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

service_levelservice_levelnullable

Default service level.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default payment term.

shipping_termshipping_termnullable

Default shipping term.

priorityprioritynullable

Default priority.

sales_repaccount_usernullable

Default sales rep.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of account_group

Resources in this page.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

contact_infocustomer_contact_infonullable

Contact information.

freight_preferencescustomer_freight_preferencesnullable

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

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

bill_to_addressaddressnullable

Default billing address.

ship_to_addressaddressnullable

Default shipping address.

typeaccount_groupnullable

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

price_groupslistnullable

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

parent_accountcustomernullable

Parent account.

Present if this is a child account.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of customer

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

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 customer

Resources in this page.

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.

contact_infocustomer_contact_infonullable

Contact information.

freight_preferencescustomer_freight_preferencesnullable

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

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

bill_to_addressaddressnullable

Default billing address.

ship_to_addressaddressnullable

Default shipping address.

typeaccount_groupnullable

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

price_groupslistnullable

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

parent_accountcustomernullable

Parent account.

Present if this is a child account.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

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 customer

Resources in this page.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

service_levelservice_levelnullable

Default service level.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default payment term.

shipping_termshipping_termnullable

Default shipping term.

priorityprioritynullable

Default priority.

sales_repaccount_usernullable

Default sales rep.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of account_group

Resources in this page.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

contact_infocustomer_contact_infonullable

Contact information.

freight_preferencescustomer_freight_preferencesnullable

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

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

bill_to_addressaddressnullable

Default billing address.

ship_to_addressaddressnullable

Default shipping address.

typeaccount_groupnullable

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

price_groupslistnullable

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

parent_accountcustomernullable

Parent account.

Present if this is a child account.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of customer

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

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 customer

Resources in this page.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

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

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Default 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.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

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

minimum_order_valuequantitynullable

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

free_shipping_service_levelslistnullable

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

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name of the priority level.

ownerownernullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Default sales rep.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

  • active: the user can access the account.
  • disabled: the user is locked out of the account.
  • removed: the user has been removed (soft-deleted) from the account.
rolerolenullable

Assigned role.

departmentdepartmentnullable

Assigned department.

userusernullable

Underlying user.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

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 account_group

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

contact_infocustomer_contact_infonullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencescustomer_freight_preferencesnullable

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

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carriercarriernullable

Default carrier.

service_levelservice_levelnullable

Default service level.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termpayment_termnullable

Default payment term.

shipping_termshipping_termnullable

Default shipping term.

priorityprioritynullable

Default priority.

sales_repaccount_usernullable

Default sales rep.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeaccount_groupnullable

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

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupslistnullable

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of account_group

Resources in this page.

parent_accountcustomernullable

Parent account.

Present if this is a child account.

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.

contact_infocustomer_contact_infonullable

Contact information.

freight_preferencescustomer_freight_preferencesnullable

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

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

bill_to_addressaddressnullable

Default billing address.

ship_to_addressaddressnullable

Default shipping address.

typeaccount_groupnullable

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

price_groupslistnullable

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

parent_accountcustomernullable

Parent account.

Present if this is a child account.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of customer

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

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 customer

Resources in this page.

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.

contact_infocustomer_contact_infonullable

Contact information.

freight_preferencescustomer_freight_preferencesnullable

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

defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

notification_preferencescustomer_notification_preferencesnullable

Notification preferences.

bill_to_addressaddressnullable

Default billing address.

ship_to_addressaddressnullable

Default shipping address.

typeaccount_groupnullable

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

price_groupslistnullable

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

parent_accountcustomernullable

Parent account.

Present if this is a child account.

child_accountslistnullable

Child accounts.

Present if this is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

  • admin: full administrative access, including managing API keys.
  • user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
  • scanner: a role for scanning-station operators.
  • sales_rep: a role for sales representatives.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

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.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

  • admin: full administrative access, including managing API keys.
  • user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
  • scanner: a role for scanning-station operators.
  • sales_rep: a role for sales representatives.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

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.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerownernullable

Provenance of this carrier.

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

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelslistnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

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 service_level

Resources in this page.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

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

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default 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.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

flat_ratequantitynullable

Fixed shipping charge applied to the order.

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

minimum_order_valuequantitynullable

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

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

free_shipping_service_levelslistnullable

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

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 service_level

Resources in this page.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerownernullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

default_shipping_addressaddressnullable

Default shipping address.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

idstring

Product ID.

objectstringenumValues:product

Resource type identifier.

typestringenumValues:saleserviceshipping

Product type code, which determines how the product behaves on orders and invoices.

  • sale: a standard sellable product.
  • service: a non-physical service line, such as labor or installation.
  • shipping: a shipping charge applied to an order.
  • credit: a credit applied against an order or invoice.
  • return: a returned product (RMA).
  • tax: a tax line.
portal_visibilitystringenumValues:visiblehidden

Whether the product is shown to buyers in the customer portal.

  • visible: buyers can see and order the product in the portal.
  • hidden: the product is concealed from the portal but remains usable internally.
product_lineproduct_linenullable

The product line this product is assigned to, if any.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

descriptionstringnullable

Free-form description of the product line.

notesstringnullable

Free-form notes about the product line.

commission_policystringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

  • commission_exempt: no commission applies to these products.
  • commission_applied: commission applies to these products, unless overridden elsewhere.
freight_policystringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

  • free_freight: these products do not incur a freight charge.
  • billed_freight: freight is billed for these products, unless overridden elsewhere.
ownerownernullable

Owner of the product line.

System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

unit_groupunit_groupnullable

Unit group associated with this product line.

The unit group determines the set of units available to products in this product line.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

Physical dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group.

base_unitunitnullable

The reference unit designated for this group.

associated_unitslistnullable

Units associated with this group, each with its own discount and customer portal visibility settings.

ownerownernullable

Owner of this resource.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

itemitemnullable

The inventory item backing this product, which holds its SKU, description, pricing, and attributes.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code, unique within the account.

descriptionstringnullable

Item description.

notesstringnullable

Free-form notes about the item.

typestringenumValues:productmaterialpart

What kind of item this is.

  • product: a finished product.
  • material: a raw material or component consumed in production.
  • part: a part used in production.
categoryitem_categorynullable

The category this item belongs to.

The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name of the item category.

notesstringnullable

Free-form notes about the item category.

typestringenumValues:material_categoryproduct_category

What kind of items this category groups.

An item can only be assigned to a category whose type matches the item's type.

  • material_category: groups raw materials and components (items of type material).
  • product_category: groups finished products and parts (items of type product or part).
ownerownernullable

Owner of the item category.

System-owned categories are platform defaults (the owner.type is system and owner.account is null); account-owned categories were created by your organization.

propertieslistnullable

Properties associated with this item category.

unit_groupunit_groupnullable

Unit group associated with this item category.

This unit group determines the units of measure available to items in this category throughout your production process.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_valueratenullable

Selling value per unit, expressed as a rate (e.g. $25.50 / kg).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_costratenullable

Cost per unit, expressed as a rate (e.g. $10.00 / kg).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

burn_rateratenullable

Rate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

attributeslistnullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of attribute

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

quantity_orderedquantitynullable

Quantity ordered.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

unit_priceratenullable

Price charged per unit.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

totalssales_order_totalsnullable

Derived monetary totals for this line.

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.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

packedsales_order_stage_total

Packed amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

invoicedsales_order_stage_total

Invoiced amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

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.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

packedsales_order_stage_total

Packed amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

invoicedsales_order_stage_total

Invoiced amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount for this stage as a decimal string (unit price x quantity at this stage).

completionnumber

Progress to completion for this stage, as a fraction between 0 and 1: quantity at this stage divided by quantity ordered. 0 when nothing has reached this stage yet.

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.

Responses

200

Successful response for Issue Sales Order