Skip to main content

BulkUpsertOrganizationRequest

idinteger

System-generated primary key. If provided, the resource is identified and updated using this internal id. Can be used alone or together with externalId (to update the external identifier).

Example: 123
externalIdstring

Client-provided external identifier. Required when id is not provided. Used as the lookup key for upsert. When id is provided, supplying externalId will update the stored external identifier.

Possible values: <= 255 characters

Example: SUP-00123
typestringrequired

Classification of the organization. Support F(Factory), S(Supplier), B(Brand), R(Retailer), I(Inspection Agency)

Possible values: [F, S, B, R, I]

Example: S
externalStatusstring

Status of the organization as defined by the API consumer

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed]

Example: active
businessPartnerTypestring

Classification of the supplier organization's role in the supply chain

Possible values: [fabric supplier, trim supplier, merchandise vendor, packaging supplier, production/storage facility owner]

Example: fabric supplier
brandTypestring

Indicates whether the supplier owns brands, works with national brands, or both

Possible values: [owned brand, national brand, both]

Example: owned brand
namestringrequired

Official name of the organization

Possible values: <= 255 characters

Example: GreenTextile Co., Ltd.
capabilitiesstring[]

List of capabilities or services the organization offers, can refer from List Capabilities API

Possible values: <= 255 characters

Example: ["Dyeing","Knitting"]
phoneNumberstring

The phone number of the organization

Possible values: <= 50 characters

Example: +84 28 1234 5678
addressstringrequired

Street address of the organization

Possible values: <= 255 characters

Example: 123 National Road 13
citystring

City where the organization is located

Possible values: <= 100 characters

Example: Ho Chi Minh City
provincestring

Province or state where the organization is located

Possible values: <= 100 characters

Example: Binh Duong
postalCodestring

Postal or ZIP code of the address

Possible values: <= 20 characters

Example: 700000
countrystringrequired

Country where the organization is located (ISO 3166-1 alpha-2)

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: VN
longitudenumber<double>

The longitude component of the organization's geolocation

Example: 106.6297
latitudenumber<double>

The latitude component of the organization's geolocation

Example: 10.8231
maleEmployeesinteger

Number of male employees

Example: 120
femaleEmployeesinteger

Number of female employees

Example: 230
customFieldsobject

Additional key-value attributes defined per customer setup

Example: {"factoryCode":"GTX001"}
webLinksstring[]

List of official website/social network URLs for the organization. Each entry must be a valid URL

Example: ["https://www.linkedin.com/company/abc-supplier","https://facebook.com/abc-supplier"]
nearestAirportsstring[]

List of nearest commercial airports to the organization. Accepts IATA 3-letter airport codes. Max 200 characters total.

Possible values: <= 200 characters

Example: ["SGN","HAN","BKK"]
nearestSeaportsstring[]

List of nearest maritime seaports near the organization. Accepts UN/LOCODE 5-character port codes. Max 200 characters total.

Possible values: <= 200 characters

Example: ["VNSGN","THBKK"]
businessUnitCategoriesstring[]

High-level grouping of business activities for the organization. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["businessUnitCategory1","businessUnitCategory2"]
businessUnitsstring[]

Defines the operational unit(s) within the organization. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["businessUnit1","businessUnit2"]
contacts object[]

List of primary contact persons for the organization

  • Array [
    • firstNamestringrequired

    First name of the contact person

    Possible values: <= 100 characters

    Example: Minh
    lastNamestring

    Last name of the contact person

    Possible values: <= 100 characters

    Example: Tran
    emailstring<email>required

    Email address of the contact person

    Possible values: <= 255 characters

    phoneNumberstring

    Phone number of the contact person

    Possible values: <= 50 characters

    Example: +84 912 345 678
    rolestring

    Job title or role of the contact person within the organization, can refer from List Contact Roles API

    Possible values: <= 100 characters

    Example: Plant Manager
  • ]
    • BulkUpsertOrganizationRequest
    {
      "id": 123,
      "externalId": "SUP-00123",
      "type": "S",
      "externalStatus": "active",
      "businessPartnerType": "fabric supplier",
      "brandType": "owned brand",
      "name": "GreenTextile Co., Ltd.",
      "capabilities": [
        "Dyeing",
        "Knitting"
      ],
      "phoneNumber": "+84 28 1234 5678",
      "address": "123 National Road 13",
      "city": "Ho Chi Minh City",
      "province": "Binh Duong",
      "postalCode": "700000",
      "country": "VN",
      "longitude": 106.6297,
      "latitude": 10.8231,
      "maleEmployees": 120,
      "femaleEmployees": 230,
      "customFields": {
        "factoryCode": "GTX001"
      },
      "webLinks": [
        "https://www.linkedin.com/company/abc-supplier",
        "https://facebook.com/abc-supplier"
      ],
      "nearestAirports": [
        "SGN",
        "HAN",
        "BKK"
      ],
      "nearestSeaports": [
        "VNSGN",
        "THBKK"
      ],
      "businessUnitCategories": [
        "businessUnitCategory1",
        "businessUnitCategory2"
      ],
      "businessUnits": [
        "businessUnit1",
        "businessUnit2"
      ],
      "contacts": [
        {
          "firstName": "Minh",
          "lastName": "Tran",
          "email": "[email protected]",
          "phoneNumber": "+84 912 345 678",
          "role": "Plant Manager"
        }
      ]
    }