OrganizationListResponse

data object[]

Organizations data

Array [

addressstringrequired

Organization address line 1

Possible values: non-empty

Example: 5 Madison Avenue

address2string

Organization address line 2

Example: Suite 101

billing_emailstringnullable

Billing email

Example: [email protected]

citystringnullable

City where the organization locates

Example: New York

contacts object[]required

Organization contact information

Possible values: >= 1

Array [

emailstring

Email of the organization contact

Example: [email protected]

firstNamestringrequired

First name of the organization contact

Possible values: non-empty

Example: John

lastNamestringnullable

Last name of the organization contact

Example: Doe

phonestringnullable

Phone number of the organization contact

Example: 1505123123

workPhonestring

Work phone number of the organization contact

Example: 1505456456

]

countrystringrequired

ISO Alpha-2 country code

Example: US

createdAtstring

Creation date and time of the organization in the system

Example: 2021-06-02 12:34:02.861000+00:00

idstring

Custom identifier for the organization, provided by the client

linkedIdstringnullable

Custom ID of the global organization to link this local organization to

Example: 123123

linkedTostring

Global organization that links to this local organization

Example: 3111222

location objectnullable

Organization location

latitudenumberrequired

Latitude of the organization location

Example: 38.8951

longitudenumberrequired

Longitude of the organization location

Example: -77.0364

namestringrequired

Name of the organization

Possible values: non-empty

Example: Acme Corp

organizationLabelsstring[]nullable

List of organization labels

Example: ["Tier 1","Tier 2"]

phonestringrequired

Organization phone number

Possible values: non-empty

Example: 1505111222

postalstringnullable

Organization postal code

Example: A1B2C3

provincestringnullable

Province where the organization locates

Example: New York

typestringrequired

Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)

Possible values: non-empty

Example: S

updatedAtstring

Last updated date and time of the organization in the system

Example: 2021-06-02 12:34:02.861000+00:00

descriptionstringnullable

description of the local organization

Example: This is a description

]

limitintegerrequired

Limit result of list

offsetintegerrequired

totalintegerrequired

OrganizationListResponse

{
  "data": [
    {
      "address": "5 Madison Avenue",
      "address2": "Suite 101",
      "billing_email": "[email protected]",
      "city": "New York",
      "contacts": [
        {
          "email": "[email protected]",
          "firstName": "John",
          "lastName": "Doe",
          "phone": "1505123123",
          "workPhone": "1505456456"
        }
      ],
      "country": "US",
      "createdAt": "2021-06-02 12:34:02.861000+00:00",
      "linkedId": "123123",
      "linkedTo": "3111222",
      "name": "Acme Corp",
      "organizationLabels": [
        "Tier 1",
        "Tier 2"
      ],
      "phone": "1505111222",
      "postal": "A1B2C3",
      "province": "New York",
      "type": "S",
      "updatedAt": "2021-06-02 12:34:02.861000+00:00",
      "description": "This is a description"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}