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

Operational status of the organization. Accepted values: draft, awaiting approval, active, inactive, suspended, blacklisted, closed.

Setting inactive pauses the organization: all its relationships are set to inactive and their data is kept. Depending on each solution's settings, the organization may still appear in other Inspectorio solutions. Set it back to active to resume.

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

Example: active
businessPartnerTypesstring[]

Classification of the supplier organization's role in the supply chain. Multiple values allowed and configured by customer taxonomy (Custom ID field).

Example: ["fabric supplier","trim supplier"]
brandTypesstring[]

Indicates whether the supplier owns brands, works with national brands, or both. Values configured by customer taxonomy (Custom ID field).

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
location object

Location coordinates of the organization

longitudenumber<double>

Longitude of the organization's location

Example: 121.4737
latitudenumber<double>

Latitude of the organization's location

Example: 31.2304
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"]
yearEstablishedinteger

Year the organization was founded

Example: 1998
legalBusinessNamestring

Registered name of the organization

Possible values: <= 255 characters

Example: ABC Textiles Co., Ltd.
subsidiariesstring[]

List of subsidiaries under the same corporate group

Possible values: <= 255 characters

Example: ["ABC Vietnam Ltd.","ABC Bangladesh Co., Ltd."]
targetMarketSegmentsstring[]

Key customer/product segments served

Possible values: <= 255 characters

Example: ["Mass Market","Luxury Only"]
industrySegmentsstring[]

Industry vertical(s) the organization operates in.

Possible values: [Apparel & Textiles, Footwear, Beauty & Personal Care & Hygiene, Food & Beverage, Consumer Electronics, Home Appliances & Electrical, Furniture & Home Decorations, Houseware, Sports Equipment & Outdoors, Toys & Games, Stationery & Print & Packaging, Home Improvement & Building, Pet Care & Food, Arts & Crafts & Entertainment, Other]

Example: ["Apparel & Textiles","Food & Beverage"]
geographicMarketsServedstring[]

Primary markets or regions where the organization operates

Possible values: [North America, Europe, Asia-Pacific, Global]

Example: ["Asia-Pacific","Europe"]
primaryLanguagesstring[]

Main languages used for communication, use set 1 from List of ISO 639 language codes

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

Example: ["en","vi"]
timeZonesstring[]

Time zones of operation, from List of tz database time zones

Possible values: <= 100 characters

Example: ["America/Fort_Nelson","Asia/Singapore"]
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"]
tiersinteger[]

Internal identifiers of the tier records to associate with the organization. Distinct from tierLevels, which carries the tier level labels.

Example: [12,15]
tierLevelsstring[]

Tier Level indicates the organization's position within the supply chain hierarchy.

Possible values: [Tier 1, Tier 2, Tier 3, Tier 4, Tier 5+]

Example: ["Tier 2"]
labelsstring[]

A list of custom labels to categorize or group organizations for internal management and filtering purposes (e.g., Preferred Supplier, Vendor, Strategic Partner).

Example: ["Preferred Supplier","Strategic Partner"]
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

    Example: [email protected]
    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",
      "businessPartnerTypes": [
        "fabric supplier",
        "trim supplier"
      ],
      "brandTypes": [
        "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",
      "location": {
        "longitude": 121.4737,
        "latitude": 31.2304
      },
      "maleEmployees": 120,
      "femaleEmployees": 230,
      "customFields": {
        "factoryCode": "GTX001"
      },
      "webLinks": [
        "https://www.linkedin.com/company/abc-supplier",
        "https://facebook.com/abc-supplier"
      ],
      "yearEstablished": 1998,
      "legalBusinessName": "ABC Textiles Co., Ltd.",
      "subsidiaries": [
        "ABC Vietnam Ltd.",
        "ABC Bangladesh Co., Ltd."
      ],
      "targetMarketSegments": [
        "Mass Market",
        "Luxury Only"
      ],
      "industrySegments": [
        "Apparel & Textiles",
        "Food & Beverage"
      ],
      "geographicMarketsServed": [
        "Asia-Pacific",
        "Europe"
      ],
      "primaryLanguages": [
        "en",
        "vi"
      ],
      "timeZones": [
        "America/Fort_Nelson",
        "Asia/Singapore"
      ],
      "nearestAirports": [
        "SGN",
        "HAN",
        "BKK"
      ],
      "nearestSeaports": [
        "VNSGN",
        "THBKK"
      ],
      "tiers": [
        12,
        15
      ],
      "tierLevels": [
        "Tier 2"
      ],
      "labels": [
        "Preferred Supplier",
        "Strategic Partner"
      ],
      "businessUnitCategories": [
        "businessUnitCategory1",
        "businessUnitCategory2"
      ],
      "businessUnits": [
        "businessUnit1",
        "businessUnit2"
      ],
      "contacts": [
        {
          "firstName": "Minh",
          "lastName": "Tran",
          "email": "[email protected]",
          "phoneNumber": "+84 912 345 678",
          "role": "Plant Manager"
        }
      ]
    }