Customers

The customer object

A business you sell to, with its contact details, default fulfillment settings, and order policies.

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.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
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).

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.

Always returned as null in this endpoint.
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.

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

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termshipping_termnullable

Shipping term 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.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
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.

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

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

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.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
departmentdepartmentnullable

The department this user belongs to within the account.

Always returned as null in this endpoint.
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.

Always returned as null in this endpoint.
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.

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.

Always returned as null in this endpoint.
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.

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.

Always returned as null in this endpoint.
contact_infocustomer_contact_infonullable

General contact details for the customer's business.

Always returned as null in this endpoint.
freight_preferencescustomer_freight_preferencesnullable

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

Always returned as null in this endpoint.
defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

Always returned as null in this endpoint.
bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
typeaccount_groupnullable

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

Always returned as null in this endpoint.
price_groupslistnullable

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

Always returned as null in this endpoint.
parent_accountcustomernullable

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

Always returned as null in this endpoint.
child_accountslistnullable

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

Always returned as null in this endpoint.
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.

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.

Always returned as null in this endpoint.
contact_infocustomer_contact_infonullable

General contact details for the customer's business.

Always returned as null in this endpoint.
freight_preferencescustomer_freight_preferencesnullable

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

Always returned as null in this endpoint.
defaultscustomer_defaultsnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencescustomer_notification_preferencesnullable

Which document emails this customer is set up to receive.

Always returned as null in this endpoint.
bill_to_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
typeaccount_groupnullable

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

Always returned as null in this endpoint.
price_groupslistnullable

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

Always returned as null in this endpoint.
parent_accountcustomernullable

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

Always returned as null in this endpoint.
child_accountslistnullable

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

Always returned as null in this endpoint.
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.

Used by

POSTCreate Account PriceAccount PricesPATCHUpdate Account PriceAccount PricesGETList Account PricesAccount PricesGETRetrieve Account PriceAccount PricesPOSTCreate CustomerCustomersPATCHUpdate CustomerCustomersGETList CustomersCustomersGETRetrieve CustomerCustomersDELETEDelete CustomerCustomersGETRetrieve Customer Lead TimeCustomersPOSTMerge CustomersCustomersPOSTCreate Sales OrderSales OrdersPATCHUpdate Sales OrderSales OrdersGETList Sales OrdersSales OrdersGETRetrieve Sales OrderSales OrdersPUTClose Sales OrderSales OrdersPUTIssue Sales OrderSales OrdersPUTReopen Sales OrderSales OrdersPUTUnissue Sales OrderSales Orders