Skip to main content

Company

The Company object

idId (string)

Unique identifier for the object.

tenantTenantMode (string)

Has the value "live" if the object exists in live mode, or "sand" if it exists in test mode.

Possible values: [sand, live]

joinCodestring

Possible values: >= 6 characters and <= 6 characters

namestring

Company name.

addresses object[]nullable
  • Array [
  • idstring
    labelstringnullable
    streetNamestringnullable
    streetNumberstringnullable
    citystringnullable
    provincestringnullable
    postalCodestringnullable
    countrystringnullable
    deliveryFeeAmountint32
    storeIdstring
  • ]
  • Company
    {
    "id": "string",
    "tenant": "sand",
    "joinCode": "string",
    "name": "string",
    "addresses": [
    {
    "id": "string",
    "label": "string",
    "streetName": "string",
    "streetNumber": "string",
    "city": "string",
    "province": "string",
    "postalCode": "string",
    "country": "string",
    "deliveryFeeAmount": 0,
    "storeId": "string"
    }
    ]
    }