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

A unique 6-character code that can be used to join or reference this Company.

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

namestring

Company name.

addresses object[]nullable

An array of delivery addresses associated with this Company. Each address can have specific delivery fees and store information.

Array [

idstring

Unique identifier for the address.

labelstringnullable

A friendly label or name for this address (e.g., "Main Office", "Warehouse").

streetNamestringnullable

The street name of the address.

streetNumberstringnullable

The street number of the address.

citystringnullable

The city of the address.

provincestringnullable

The province or state of the address.

postalCodestringnullable

The postal or ZIP code of the address.

countrystringnullable

The country code of the address (e.g., "IT" for Italy).

deliveryFeeAmountinteger<int32>

The delivery fee amount for this address, in cents.

storeIdstring

The unique identifier of the store associated with this address.

]

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"
    }
  ]
}