Skip to main content
Create a supplier
curl --request POST \
  --url https://api.responsibly.tech/v1/suppliers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Embudo Valley Organics",
  "countryIso3Code": "USA",
  "website": "https://example.com",
  "industryCodes": [
    "10101010",
    "10101020"
  ],
  "categoryIds": [
    "01h57nhc4sapk2v8c7tq..."
  ],
  "contacts": [
    {
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe"
    }
  ],
  "customerSupplierId": "SUPP-12345"
}
'
{
  "id": "01h57nhc4sapk2v8c7tq[...]",
  "name": "Embudo Valley Organics",
  "countryIso3Code": "USA",
  "website": "https://example.com",
  "status": "current",
  "customerSupplierId": "SUPP-12345"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

The name of the supplier

Required string length: 1 - 255
Example:

"Embudo Valley Organics"

​
countryIso3Code
string

ISO 3166-1 alpha-3 country code

Required string length: 3
Example:

"USA"

​
website
string<uri>

The supplier's website URL

Example:

"https://example.com"

​
industryCodes
string[]

GICS industry codes to assign to the supplier

Example:
["10101010", "10101020"]
​
categoryIds
string[]

Category IDs to assign to the supplier. Use GET /v1/categories to list available categories.

Example:
["01h57nhc4sapk2v8c7tq..."]
​
contacts
object[]

Contacts for this supplier. The first contact will be set as the default.

​
customerSupplierId
string

Your internal supplier ID for reference

Maximum string length: 255
Example:

"SUPP-12345"

Response

Supplier created successfully.

​
id
string
required
Example:

"01h57nhc4sapk2v8c7tq[...]"

​
name
string
required
Example:

"Embudo Valley Organics"

​
countryIso3Code
string | null
required
Example:

"USA"

​
website
string | null
required
Example:

"https://example.com"

​
status
string
required
Example:

"current"

​
customerSupplierId
string | null
required
Example:

"SUPP-12345"