Skip to main content

Integration attributes for third-party connections

name
string
required

Integration name

integration_type
enum<string>
required

Type of integration

Available options:
ecommerce,
carrier,
marketplace,
erp,
accounting,
custom
provider
enum<string> | null

Integration provider

Available options:
shopify,
woocommerce,
magento,
bigcommerce,
amazon,
ebay,
brightpearl,
xero,
quickbooks,
dhl,
dpd,
fedex,
ups,
royal_mail,
custom
is_active
boolean | null

If false, integration is disabled

account_id
integer | null

Default account ID for imported orders

warehouse_id
integer | null

Default warehouse ID for imported orders

configuration
object

Provider-specific configuration settings

external_system_reference1
string | null

External system reference 1

external_system_reference2
string | null

External system reference 2

external_system_reference3
string | null

External system reference 3

string1
string | null

Custom string field 1

string2
string | null

Custom string field 2

string3
string | null

Custom string field 3

string4
string | null

Custom string field 4

string5
string | null

Custom string field 5