Unissue Sales Order

Beta

PUT/v1/sales/sales-orders/{id}/actions/unissue

This endpoint is idempotent. Learn more

Unissues a sales order, transitioning it from issued back to estimate.

Deletes the order's pick, discarding any picking progress recorded against it, and releases the inventory reserved when the order was issued. Only an order in issued can be unissued.

Permissions requiredValues:sales_orders:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Sales order ID.

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

Free-form note about the order.

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.

Becomes sent when the order is issued with customer notification requested and the order has acknowledgement contacts to send to. It can also be set directly when an acknowledgement was sent outside OpenMRP.

customercustomernullable

The customer this order is for.

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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

The customer counts as exempt if this field, its type group, or any of its price_groups is commission_exempt. Exempt customers never have a sales rep assigned automatically when an order is created without one.

notestringnullable

Free-form note about the customer.

credit_limitquantitynullable

Maximum credit extended to this customer.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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

General contact details for the customer's business.

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.

Freight is waived when this field, the customer's type group, any of its price_groups, or any product line the ordered products belong to is free_freight, so a shipment can come back freight-exempt even while this field is billed_freight.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among the carriers visible to your account.

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.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

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 updated or 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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

For service levels synced from a connected carrier this is the carrier's own token, which is what rate shopping and label purchase are keyed on; for service levels you create yourself it is the code you supplied.

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

Service level used when an order takes its carrier from this customer's default carrier.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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

Payment term used on this customer's orders when the order does not specify one.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

Payment terms created through the API are always active, and no endpoint changes a term's status. List Payment Terms returns inactive terms alongside active ones, so filter them out yourself if you only want the ones still on offer.

ownerownernullable

Provenance of this payment term.

System-owned payment terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned payment 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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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

Shipping term used on this customer's orders when the order does not specify one.

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: the buyer is never charged for shipping.
flat_rate_freight: the buyer is charged the fixed amount in flat_rate, regardless of what the carrier would have charged.
carrier_rate_freight: the buyer is charged the rate the carrier quotes for the order's carrier and service level.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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.

Used only when type is flat_rate_freight; ignored for other freight pricing models. A flat_rate_freight term with no flat rate falls through to the carrier's quoted rate.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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 total a buyer must exceed for this term's free-shipping rules to apply.

Above this total, freight is free for the service levels in free_shipping_service_levels.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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 once an order exceeds minimum_order_value.

When this list is empty, every service level ships free above the threshold. When it is not empty, an order that picks a service level outside the list is not shipped free even above the threshold.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

Priority used to pre-fill new orders for this customer.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

Other resources refer to a priority by this code rather than by its ID, such as a sales order's priority, and it can be used in place of the ID when retrieving a priority.

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 OpenMRP 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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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

Account user credited as the sales rep on this customer's orders.

Used when an order is created without a sales rep, unless the customer is commission-exempt. With no default set, the rep is resolved from the sales territory matching the order's ship-to postal code or state.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

The current state of this user's membership in the account.

active: the user can sign in to the account and occupies one of the plan's seats.
disabled: the user is locked out of the account and their sessions have been revoked, but the membership is retained.
removed: the membership has been soft-deleted; it is hidden from listings by default and can be restored with the activate action.

rolerolenullable

The role that determines what this user is permitted to do in the account.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles 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.

permissionsarray of stringnullable

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

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentdepartmentnullable

The department this user belongs to within the account.

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

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

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.

labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

userusernullable

The underlying user profile, shared across every account this person belongs to.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address the user signs in with and receives platform email at.

namestringnullable

User's full display name.

usernamestringnullable

Username the user can sign in with instead of their email address.

Usernames are unique across the whole platform, not just within your account.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

Location of the user's profile image.

For photos uploaded through the API this holds an internal path rather than a fetchable image URL; call Get User Photo URL to obtain a temporary link to the image itself.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

is_commission_eligibleboolean

Whether this user can be assigned as a sales representative on orders, territories, and targets.

Independent of the sales_rep role type, which still scopes analytics and hides cost. Users with the sales_rep role are always eligible.

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.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

A promised delivery date is worked back from a day the customer can actually receive on. With none set here the customer inherits its account group's calendar, then the account default, then Monday to Friday.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among the carriers visible to your account.

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.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

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 updated or 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).

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

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

Service level used when an order takes its carrier from this customer's default carrier.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

Payment term used on this customer's orders when the order does not specify one.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

ownerownernullable

Provenance of this payment term.

System-owned payment terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned payment 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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

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: the buyer is never charged for shipping.
flat_rate_freight: the buyer is charged the fixed amount in flat_rate, regardless of what the carrier would have charged.
carrier_rate_freight: the buyer is charged the rate the carrier quotes for the order's carrier and service level.

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.

Used only when type is flat_rate_freight; ignored for other freight pricing models. A flat_rate_freight term with no flat rate falls through to the carrier's quoted rate.

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 total a buyer must exceed for this term's free-shipping rules to apply.

Above this total, freight is free for the service levels in free_shipping_service_levels.

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 once an order exceeds minimum_order_value.

When this list is empty, every service level ships free above the threshold. When it is not empty, an order that picks a service level outside the list is not shipped free even above the threshold.

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

Priority used to pre-fill new orders for this customer.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

Other resources refer to a priority by this code rather than by its ID, such as a sales order's priority, and it can be used in place of the ID when retrieving a priority.

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 OpenMRP 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

Account user credited as the sales rep on this customer's orders.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

The current state of this user's membership in the account.

active: the user can sign in to the account and occupies one of the plan's seats.
disabled: the user is locked out of the account and their sessions have been revoked, but the membership is retained.
removed: the membership has been soft-deleted; it is hidden from listings by default and can be restored with the activate action.

rolerolenullable

The role that determines what this user is permitted to do in the account.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

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

permissionsarray of stringnullable

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

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentdepartmentnullable

The department this user belongs to within the account.

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.

labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

userusernullable

The underlying user profile, shared across every account this person belongs to.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address the user signs in with and receives platform email at.

namestringnullable

User's full display name.

usernamestringnullable

Username the user can sign in with instead of their email address.

Usernames are unique across the whole platform, not just within your account.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

Location of the user's profile image.

For photos uploaded through the API this holds an internal path rather than a fetchable image URL; call Get User Photo URL to obtain a temporary link to the image itself.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

is_commission_eligibleboolean

Whether this user can be assigned as a sales representative on orders, territories, and targets.

Independent of the sales_rep role type, which still scopes analytics and hides cost. Users with the sales_rep role are always eligible.

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.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among the carriers visible to your account.

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.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

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 updated or deleted; account-owned carriers are custom to your account.

service_levelslistnullable

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

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Service level used when an order takes its carrier from this customer's default carrier.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

Payment term used on this customer's orders when the order does not specify one.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

ownerownernullable

Provenance of this payment term.

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

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

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: the buyer is never charged for shipping.
flat_rate_freight: the buyer is charged the fixed amount in flat_rate, regardless of what the carrier would have charged.
carrier_rate_freight: the buyer is charged the rate the carrier quotes for the order's carrier and service level.

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.

Used only when type is flat_rate_freight; ignored for other freight pricing models. A flat_rate_freight term with no flat rate falls through to the carrier's quoted rate.

minimum_order_valuequantitynullable

Order total a buyer must exceed for this term's free-shipping rules to apply.

Above this total, freight is free for the service levels in free_shipping_service_levels.

free_shipping_service_levelslistnullable

Service levels that ship for free once an order exceeds minimum_order_value.

When this list is empty, every service level ships free above the threshold. When it is not empty, an order that picks a service level outside the list is not shipped free even above the threshold.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Priority used to pre-fill new orders for this customer.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

Other resources refer to a priority by this code rather than by its ID, such as a sales order's priority, and it can be used in place of the ID when retrieving a priority.

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 OpenMRP system owner.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Account user credited as the sales rep on this customer's orders.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

The current state of this user's membership in the account.

active: the user can sign in to the account and occupies one of the plan's seats.
disabled: the user is locked out of the account and their sessions have been revoked, but the membership is retained.
removed: the membership has been soft-deleted; it is hidden from listings by default and can be restored with the activate action.

rolerolenullable

The role that determines what this user is permitted to do in the account.

departmentdepartmentnullable

The department this user belongs to within the account.

userusernullable

The underlying user profile, shared across every account this person belongs to.

is_commission_eligibleboolean

Whether this user can be assigned as a sales representative on orders, territories, and targets.

Independent of the sales_rep role type, which still scopes analytics and hides cost. Users with the sales_rep role are always eligible.

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.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

service_levelservice_levelnullable

Service level used when an order takes its carrier from this customer's default carrier.

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

Payment term used on this customer's orders when the order does not specify one.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

priorityprioritynullable

Priority used to pre-fill new orders for this customer.

sales_repaccount_usernullable

Account user credited as the sales rep on this customer's orders.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

contact_infocustomer_contact_infonullable

General contact details for the customer's business.

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

Which document emails this customer is set up to receive.

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

The customer this account belongs to, when it is a child account.

child_accountslistnullable

The customers belonging to this account, when it is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

The customers belonging to this account, when it 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

The customers belonging to this account, when it 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

contact_infocustomer_contact_infonullable

General contact details for the customer's business.

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

Which document emails this customer is set up to receive.

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

The customer this account belongs to, when it is a child account.

child_accountslistnullable

The customers belonging to this account, when it 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

The customers belonging to this account, when it 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

service_levelservice_levelnullable

Service level used when an order takes its carrier from this customer's default carrier.

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

Payment term used on this customer's orders when the order does not specify one.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

priorityprioritynullable

Priority used to pre-fill new orders for this customer.

sales_repaccount_usernullable

Account user credited as the sales rep on this customer's orders.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

contact_infocustomer_contact_infonullable

General contact details for the customer's business.

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

Which document emails this customer is set up to receive.

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

The customer this account belongs to, when it is a child account.

child_accountslistnullable

The customers belonging to this account, when it is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

The customers belonging to this account, when it 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

The customers belonging to this account, when it 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among the carriers visible to your account.

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.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

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 updated or deleted; account-owned carriers are custom to your account.

service_levelslistnullable

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

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelservice_levelnullable

Service level used when an order takes its carrier from this customer's default carrier.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

Payment term used on this customer's orders when the order does not specify one.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

ownerownernullable

Provenance of this payment term.

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

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

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: the buyer is never charged for shipping.
flat_rate_freight: the buyer is charged the fixed amount in flat_rate, regardless of what the carrier would have charged.
carrier_rate_freight: the buyer is charged the rate the carrier quotes for the order's carrier and service level.

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.

Used only when type is flat_rate_freight; ignored for other freight pricing models. A flat_rate_freight term with no flat rate falls through to the carrier's quoted rate.

minimum_order_valuequantitynullable

Order total a buyer must exceed for this term's free-shipping rules to apply.

Above this total, freight is free for the service levels in free_shipping_service_levels.

free_shipping_service_levelslistnullable

Service levels that ship for free once an order exceeds minimum_order_value.

When this list is empty, every service level ships free above the threshold. When it is not empty, an order that picks a service level outside the list is not shipped free even above the threshold.

created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityprioritynullable

Priority used to pre-fill new orders for this customer.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

Other resources refer to a priority by this code rather than by its ID, such as a sales order's priority, and it can be used in place of the ID when retrieving a priority.

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 OpenMRP system owner.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repaccount_usernullable

Account user credited as the sales rep on this customer's orders.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

The current state of this user's membership in the account.

active: the user can sign in to the account and occupies one of the plan's seats.
disabled: the user is locked out of the account and their sessions have been revoked, but the membership is retained.
removed: the membership has been soft-deleted; it is hidden from listings by default and can be restored with the activate action.

rolerolenullable

The role that determines what this user is permitted to do in the account.

departmentdepartmentnullable

The department this user belongs to within the account.

userusernullable

The underlying user profile, shared across every account this person belongs to.

is_commission_eligibleboolean

Whether this user can be assigned as a sales representative on orders, territories, and targets.

Independent of the sales_rep role type, which still scopes analytics and hides cost. Users with the sales_rep role are always eligible.

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.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountcustomernullable

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

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

General contact details for the customer's business.

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.

carriercarriernullable

Carrier used on this customer's orders when the order does not specify one.

service_levelservice_levelnullable

Service level used when an order takes its carrier from this customer's default carrier.

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

Payment term used on this customer's orders when the order does not specify one.

shipping_termshipping_termnullable

Shipping term used on this customer's orders when the order does not specify one.

priorityprioritynullable

Priority used to pre-fill new orders for this customer.

sales_repaccount_usernullable

Account user credited as the sales rep on this customer's orders.

lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship.

Sets each order's ship_by_date when it is issued. With none set here the customer inherits its parent account's lead time, then its account group's, then the account default.

receive_calendar_idstringnullable

The operating calendar naming the days this customer's dock accepts freight.

notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether anyone is set up to receive invoice emails for this customer.

Derived from the customer's notification recipients: true when at least one of them is configured for invoice notifications.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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".

A group's type is fixed when it is created and cannot be changed afterwards.

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.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

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

The customer this account belongs to, when it 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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

contact_infocustomer_contact_infonullable

General contact details for the customer's business.

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

Which document emails this customer is set up to receive.

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

The customer this account belongs to, when it is a child account.

child_accountslistnullable

The customers belonging to this account, when it is a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountslistnullable

The customers belonging to this account, when it 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

The customers belonging to this account, when it 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

Unique within your account.

statusstringenumValues:normalpreferredhold_shipment

The customer's account standing.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the customer should be held.

The hold statuses are advisory: OpenMRP flags the customer's orders as being on credit hold, but requests to create orders or shipments for the customer are not rejected.

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.

Used to flag orders once the customer's outstanding balance approaches or passes the limit; orders that exceed it are not rejected.

contact_infocustomer_contact_infonullable

General contact details for the customer's business.

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

Which document emails this customer is set up to receive.

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

The customer this account belongs to, when it is a child account.

child_accountslistnullable

The customers belonging to this account, when it 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

The sales representative credited with the order.

Chosen automatically at creation when none is supplied, from the customer's default rep or the sales territory covering the ship-to address.

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

The role the actor holds in the account, which determines what it is permitted to do.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles 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

The address billed by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

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 {permission}:{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

The role the actor holds in the account, which determines what it is permitted to do.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles 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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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 {permission}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

bill_to_addressaddressnullable

Address the order is billed to.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

Address the order ships to.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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.

The freight charge itself is carried as a line on the order, not on this object.

objectstringenumValues:freight

Resource type identifier.

policystringnullableenumValues:free_freightbilled_freight

How freight is arranged and billed for the record.

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

Sales orders, purchase orders, and shipments do not carry a policy of their own. Freight on those records is waived when the customer's freight preferences, the customer's type group, any of its pricing groups, the customer's shipping term, or any product line on the order is free_freight.

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 the carriers visible to your account.

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.

UPS and USPS carrier accounts are connected to Shippo using this number; FedEx carriers authorize through OAuth instead, so their account number is not used to connect them.

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 updated or 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

The address billed by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

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

At most 10 service levels are returned inline; use the carrier's service levels endpoint to page through the full set.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

The address billed by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

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 terms agreed for this order.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

ownerownernullable

Provenance of this payment term.

System-owned payment terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned payment 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

The address billed by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The address shipped to by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

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 terms agreed for this order.

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: the buyer is never charged for shipping.
flat_rate_freight: the buyer is charged the fixed amount in flat_rate, regardless of what the carrier would have charged.
carrier_rate_freight: the buyer is charged the rate the carrier quotes for the order's carrier and service level.

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

The address billed by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The address shipped to by default on orders for this account.

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.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location 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

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

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.

Used only when type is flat_rate_freight; ignored for other freight pricing models. A flat_rate_freight term with no flat rate falls through to the carrier's quoted rate.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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 total a buyer must exceed for this term's free-shipping rules to apply.

Above this total, freight is free for the service levels in free_shipping_service_levels.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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 once an order exceeds minimum_order_value.

When this list is empty, every service level ships free above the threshold. When it is not empty, an order that picks a service level outside the list is not shipped free even above the threshold.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

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. A default service level cannot be deleted until another service level takes its place or the flag is cleared.

default_transit_daysintegernullable

Business days this service typically takes in transit, used to work an order's ship-by date back from a promised delivery date.

A fallback for lanes the carrier has not quoted. Null means transit is unknown for this service rather than instant, so a ship-by date falls back to the promised delivery date itself.

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

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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-level discount applied to this order.

The discount is charged through a negative-priced line on the order, so it is already reflected in the order totals.

idstring

Order discount ID.

objectstringenumValues:order_discount

Resource type identifier.

namestring

Display name of the discount.

codestring

The code a buyer enters to apply this discount to an order.

Codes are unique within your account and are matched without regard to letter case.

percentagestring (decimal)

The fraction of the order total taken off, as a decimal string.

This is a multiplier, not a whole percent: 0.1 takes 10% off. Only read when discount_type is percentage.

amountstring (decimal)

The flat amount taken off the order total, as a decimal string.

Only read when discount_type is amount.

discount_typestringenumValues:percentageamount

How the discount is calculated.

percentage: the order total is reduced by the fraction in percentage.
amount: the order total is reduced by the flat amount in amount.

order_countinteger

How many sales orders this discount has been applied to, across all buyers.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

lineslistnullable

The order's lines, including the automatically generated freight and discount lines.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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 lines are numbered first and the automatically generated freight and discount lines always sit at the bottom; removing a line renumbers the rest so the sequence stays contiguous.

product_skustring

SKU recorded on this line.

Taken from the product unless the line supplies its own, and editable afterwards, so it preserves what was sold even if the product's SKU later changes.

product_descriptionstringnullable

Description recorded on this line, taken from the product unless the line supplies its own.

itemitemnullable

The item this line sells, identified by the SKU recorded when the line was created.

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.

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

An item can only be assigned to a category whose type matches the item's type, and the category's type is fixed at creation.

ownerownernullable

Provenance of the item category.

System-owned categories are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned categories 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.

propertieslistnullable

Properties associated with this item category, such as Color or Size.

These describe the dimensions along which items in the category vary, and are also what the customer-facing catalog shows for the category. Attach and detach them with the Add Item Category Property and Remove Item Category Property endpoints.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of property

Resources in this page.

unit_groupunit_groupnullable

Unit group associated with this item category.

Items in this category are measured in units belonging to this group, and can only be ordered in those units unless the item's product line defines its own unit group, which takes precedence.

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

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

Only units of this dimension can belong to the group, and the dimension is fixed once the group is created.

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.

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

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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

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

For items a production flow produces, retrieving the item's costs recomputes this from the flow and stores the result here, so it can change without the item having been edited.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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.

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

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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.

attributeslistnullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of attribute

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's or a volume discount's attributes list.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

productproductnullable

The product being sold on this line.

The product's type tells you what kind of line this is: the freight and discount lines an order generates for itself reference the account's built-in shipping and credit products, so their type is shipping or credit rather than sale.

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.

Visibility alone is not enough to expose a product: a buyer only sees it if their account has also been granted access to the product's product line.

product_lineproduct_linenullable

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

Customer accounts are granted access to whole product lines, so this assignment is what decides which buyers can see and order the product. A product with no product line is never visible in the customer portal. The line also supplies the default commission and freight policies for the product.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

Unique among the product lines visible to your account, which includes the shared system lines.

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. Only account-owned product lines can be updated, deleted, or granted to customers and account groups.

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

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

Only units of this dimension can belong to the group, and the dimension is fixed once the group is created.

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.

default_lotquantitynullable

The lot products in this line are made in — a doff, a pallet.

Sizes the campaigns a production schedule plans, and defaults the quantity when a batch is added to a production run. The unit is part of the value — 60 counted in pairs and 60 counted in eaches are different lots — and is drawn from this product line's unit group.

An item's own lot override still takes precedence over the line's. When the line has no lot convention, planning falls back to the lot of the line the item feeds into, and then to the account-wide default lot size.

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

fulfillment_policystringnullableenumValues:make_to_stockmake_to_order

How products in this line are produced when they do not say for themselves.

make_to_stock: built to the forecast, holding a safety stock against its variability.
make_to_order: built only against orders already on the book, holding no buffer.

Null falls through to the account default.

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.

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

An item can only be assigned to a category whose type matches the item's type, and the category's type is fixed at creation.

ownerownernullable

Provenance of the item category.

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

propertieslistnullable

Properties associated with this item category, such as Color or Size.

unit_groupunit_groupnullable

Unit group associated with this item category.

Items in this category are measured in units belonging to this group, and can only be ordered in those units unless the item's product line defines its own unit group, which takes precedence.

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

For items a production flow produces, retrieving the item's costs recomputes this from the flow and stores the result here, so it can change without the item having been edited.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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 that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

packedsales_order_stage_total

Packed amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

invoicedsales_order_stage_total

Invoiced amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

line_countinteger

Number of lines on this order.

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 that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

packedsales_order_stage_total

Packed amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

invoicedsales_order_stage_total

Invoiced amount and completion.

objectstringenumValues:sales_order_stage_total

Resource type identifier.

amountstring (decimal)

Amount that has reached this stage, as a decimal string (unit price times the quantity at this stage).

completionnumber

Progress through this stage, as a fraction between 0 and 1.

Calculated as the quantity that has reached this stage divided by the quantity ordered, so 1 means the whole order has cleared the stage and 0 means nothing has reached it yet.

relatedsales_order_relatednullable

Fulfillment records produced from this order.

objectstringenumValues:sales_order_related

Resource type identifier.

pickrecordnullable

The pick created when the order was issued.

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

The production run created for this order, if one was started.

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

Shipments made against this order.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

Invoices raised against this order.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

lead_time_override_daysintegernullable

Days between issue and the ship-by date, set on this order alone in place of the customer's standing lead time.

ship_by_override_datestring (date-time)nullable

The ship date pinned on this order, bypassing transit and the customer's receiving days.

ship_by_datestring (date-time)nullable

Date this order is contractually due to ship.

Stamped when the order is issued. With a promised delivery date, this is that date less the carrier's transit for the order's lane and less any day the customer cannot receive on — the day the order has to leave to arrive when promised. Otherwise it comes from a lead time, whether this order's own or the one on the customer, its parent account, its account group, or the account.

Always a day the plant actually ships on, whichever rule produced it.

It is not recomputed afterwards, so neither renegotiating a customer's lead time, nor a later carrier estimate, nor a holiday added to a calendar moves commitments already made. Cleared if the order is unissued.

ship_by_cutoff_atstring (date-time)nullable

The ship-by date at the plant's pickup cutoff — the moment freight has to be tendered by, not just the day.

Only set when the account's shipping calendar carries a cutoff time.

calendar_adjustment_daysintegernullable

Days the customer's receiving calendar and the plant's shipping calendar pulled the ship-by date back, beyond what carrier transit accounted for.

Zero means every date along the way already fell on an open day. This is what explains a ship-by date that is earlier than transit alone would suggest.

lead_time_daysintegernullable

Calendar days between issue and the ship-by date.

lead_time_sourcestringnullableenumValues:customerparent_customeraccount_group

Which rule produced the ship-by date.

transit_daysintegernullable

Business days the carrier needs to cover this order's lane, subtracted from the promised delivery date to reach the ship-by date.

Only set when a delivery date was promised and the lane could be priced. Without it the ship-by date falls back to the promised date itself.

transit_sourcestringnullableenumValues:carrier_laneservice_level

Where the transit estimate came from.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Unissue Sales Order

Unissue Sales Order

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const salesOrder = await client.sales.salesOrders.actions.unissue('or_9lqo07quiwyb');

console.log(salesOrder.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const salesOrder = await client.sales.salesOrders.actions.unissue('or_9lqo07quiwyb');

console.log(salesOrder.id);

200 example

{
  "id": "or_9lqo07quiwyb",
  "object": "sales_order",
  "number": "SO-001",
  "customer_purchase_order_number": "PO-12345",
  "note": "Rush order",
  "status": "estimate",
  "priority": "normal",
  "payment_status": "unpaid",
  "payment_intent_ids": [],
  "acknowledgment_status": "not_sent",
  "customer": null,
  "sales_rep": null,
  "created_by": null,
  "bill_to_address": null,
  "ship_to_address": null,
  "freight": null,
  "payment_term": null,
  "shipping_term": null,
  "order_discount": null,
  "lines": null,
  "line_count": 1,
  "totals": null,
  "related": {
    "object": "sales_order_related",
    "pick": null,
    "production_run": null,
    "shipments": null,
    "invoices": null
  },
  "contacts": null,
  "issued_at": null,
  "completed_at": null,
  "first_ship_at": null,
  "expired_at": null,
  "promised_at": "2026-06-10T00:00:00Z",
  "lead_time_override_days": null,
  "ship_by_override_date": null,
  "ship_by_date": null,
  "ship_by_cutoff_at": null,
  "calendar_adjustment_days": null,
  "lead_time_days": null,
  "lead_time_source": null,
  "transit_days": null,
  "transit_source": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "or_9lqo07quiwyb",
  "object": "sales_order",
  "number": "SO-001",
  "customer_purchase_order_number": "PO-12345",
  "note": "Rush order",
  "status": "estimate",
  "priority": "normal",
  "payment_status": "unpaid",
  "payment_intent_ids": [],
  "acknowledgment_status": "not_sent",
  "customer": null,
  "sales_rep": null,
  "created_by": null,
  "bill_to_address": null,
  "ship_to_address": null,
  "freight": null,
  "payment_term": null,
  "shipping_term": null,
  "order_discount": null,
  "lines": null,
  "line_count": 1,
  "totals": null,
  "related": {
    "object": "sales_order_related",
    "pick": null,
    "production_run": null,
    "shipments": null,
    "invoices": null
  },
  "contacts": null,
  "issued_at": null,
  "completed_at": null,
  "first_ship_at": null,
  "expired_at": null,
  "promised_at": "2026-06-10T00:00:00Z",
  "lead_time_override_days": null,
  "ship_by_override_date": null,
  "ship_by_date": null,
  "ship_by_cutoff_at": null,
  "calendar_adjustment_days": null,
  "lead_time_days": null,
  "lead_time_source": null,
  "transit_days": null,
  "transit_source": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Unissue Sales Order

Authorization

Path Parameters

Returns

Responses