The organization object

A comprehensive list of the organization resource's attributes and relationships

The organization object is returned as part of the response body of each successful retrieve API call to the /api/organization endpoint.

Fields

Field	Type	Description
type	string	organization
id	string	The organization unique identifier
links.self	string	The organization endpoint URL
attributes.addresses_phone_required	boolean	Indicates if the phone attribute is required for addresses, default is true.
attributes.bundles_max_items_count	integer	The maximum number of SKUs allowed for bundles, default is 10.
attributes.cleanups_max_concurrent_count	integer	The maximum number of concurrent cleanups allowed for your organization, default is 10.
attributes.config	object	The organization's configuration.
attributes.coupons_max_code_length	integer	The maximum length for coupon code, default is 40.
attributes.coupons_min_code_length	integer	The minimum length for coupon code, default is 8.
attributes.created_at	datetime	Time at which the resource was created.
attributes.domain	string	The organization's domain.
attributes.exports_max_concurrent_count	integer	The maximum number of concurrent exports allowed for your organization, default is 10.
attributes.external_promotions_errors	boolean	Enables raising of API errors in case of external promotion failure, default is false.
attributes.favicon_url	string	The URL to the organization's favicon.
attributes.gtm_id	string	The organization's Google Tag Manager ID.
attributes.gtm_id_test	string	The organization's Google Tag Manager ID for test.
attributes.imports_max_concurrent_count	integer	The maximum number of concurrent imports allowed for your organization, default is 10.
attributes.logo_url	string	The URL to the organization's logo.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes.name	string	The organization's internal name.
attributes.orders_number_editable_live	boolean	Enables orders number editing as a string in live (for enterprise plans only).
attributes.orders_number_editable_test	boolean	Enables orders number editing as a string in test (for enterprise plans only).
attributes.primary_color	string	The organization's primary color.
attributes.promotions_max_concurrent_count	integer	The maximum number of active concurrent promotions allowed for your organization, default is 10.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.slug	string	The organization's slug name.
attributes.support_email	string	The organization's support email.
attributes.support_phone	string	The organization's support phone.
attributes.tax_calculators_errors	boolean	Enables raising of API errors in case of tax calculation failure, default is false.
attributes.updated_at	datetime	Time at which the resource was last updated.
meta.mode	string	The resource environment (can be one of test or live)