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

FieldTypeDescription

type

string

organizations

id

string

The organization unique identifier

links.self

string

The organization endpoint URL

attributes.name

string

The organization's internal name.

attributes.slug

string

The organization's slug name.

attributes.domain

string

The organization's domain.

attributes.support_phone

string

The organization's support phone.

attributes.support_email

string

The organization's support email.

attributes.logo_url

string

The URL to the organization's logo.

attributes.favicon_url

string

The URL to the organization's favicon.

attributes.primary_color

string

The organization's primary color.

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

object

The organization's configuration.

attributes.api_auth_redirect

boolean

Enables the redirect on the new Auth API.

attributes.api_rules_engine

boolean

Enables the rules engine for flex promotions and price list rules.

attributes.api_new_auth

boolean

Forces the usage of the new Authentication API.

attributes.api_purge_single_resource

boolean

Enables the purge of cached single resources when list is purged.

attributes.api_max_regex_length

integer

The maximum length for the regular expressions, default is 5000.

attributes.addresses_phone_required

boolean

Indicates if the phone attribute is required for addresses, default is true.

attributes.orders_autorefresh_cutoff_test

integer

The maximum number line items allowed for a test order before disabling the autorefresh option.

attributes.orders_autorefresh_cutoff_live

integer

The maximum number line items allowed for a live order before disabling the autorefresh option.

attributes.orders_number_editable_test

boolean

Enables orders number editing as a string in test (for enterprise plans only).

attributes.orders_number_editable_live

boolean

Enables orders number editing as a string in live (for enterprise plans only).

attributes.orders_number_as_reference

boolean

Enables to use the order number as payment reference on supported gateways.

attributes.bundles_max_items_count

integer

The maximum number of SKUs allowed for bundles, default is 10.

attributes.coupons_min_code_length

integer

The minimum length for coupon code, default is 8.

attributes.coupons_max_code_length

integer

The maximum length for coupon code, default is 40.

attributes.gift_cards_min_code_length

integer

The minimum length for gift card code, default is 8.

attributes.gift_cards_max_code_length

integer

The maximum length for gift card code, default is 40.

attributes.cleanups_max_concurrent_count

integer

The maximum number of concurrent cleanups allowed for your organization, default is 10.

attributes.exports_max_concurrent_count

integer

The maximum number of concurrent exports allowed for your organization, default is 10.

attributes.imports_max_concurrent_count

integer

The maximum number of concurrent imports allowed for your organization, default is 10.

attributes.imports_purge_cache

boolean

Enables purging of cached resources upon succeeded imports.

attributes.imports_skip_errors

boolean

Disables the interruption of the import in case its errors exceeds the 10% threshold, default is false.

attributes.promotions_max_concurrent_count

integer

The maximum number of active concurrent promotions allowed for your organization, default is 10.

attributes.imports_trigger_webhooks

integer

Enables triggering of webhooks during imports, default is false.

attributes.discount_engines_enabled

boolean

Enables the use of an external discount engine in place of the standard one, default is false.

attributes.discount_engines_errors

boolean

Enables raising of API errors in case of discount engine failure, default is false.

attributes.tags_max_name_length

integer

The maximum length for the tag name, default is 25.

attributes.tax_calculators_errors

boolean

Enables raising of API errors in case of tax calculation failure, default is false.

attributes.external_promotions_errors

boolean

Enables raising of API errors in case of external promotion failure, default is false.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

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

meta.mode

string

The resource environment (can be one of test or live)

Last updated