Skip to content
/value-chains

Coolset Supply Chain API (1.0)

Manage orders, products, origins, and value chains for supply chain transparency and compliance.

Download OpenAPI description
supply-chain-api.json
supply-chain-api.yaml
Overview
URL
https://coolset.com
E-mail
support@coolset.com
Languages
Servers
Mock server
https://api.coolset.com/_mock/supply-chain-api/
Production server
https://developers-scranton.coolset.com/api/

orders

Operations

orders-items

Operations

origins

Operations

products

Operations

value-chains

Operations

Value Chains List

Request

Security
Bearer
Query
company_namestring

company_name

company_name__icontainsstring

company_name__icontains

company_name__startswithstring

company_name__startswith

company_name__endswithstring

company_name__endswith

descriptionstring

description

description__icontainsstring

description__icontains

description__startswithstring

description__startswith

description__endswithstring

description__endswith

statusstring

status

Enum"revoked""not_invited_yet""invitation_sent""connected"
status__instring

status__in

country_codestring

country_code

country_code__instring

country_code__in

external_idstring

external_id

external_id__icontainsstring

external_id__icontains

external_id__startswithstring

external_id__startswith

external_id__endswithstring

external_id__endswith

external_id__instring

external_id__in

permission_grantedstring

permission_granted

is_self_managedstring

is_self_managed

contact_namestring

contact_name

contact_name__icontainsstring

contact_name__icontains

contact_name__startswithstring

contact_name__startswith

contact_name__endswithstring

contact_name__endswith

contact_emailstring

contact_email

contact_email__icontainsstring

contact_email__icontains

contact_email__startswithstring

contact_email__startswith

contact_email__endswithstring

contact_email__endswith

assessment_statusstring

assessment_status

Enum"pending""passing""failing"
assessment_status__instring

assessment_status__in

passing_percentage_gtestring

passing_percentage_gte

failing_percentage_gtestring

failing_percentage_gte

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/supply-chain-api/value-chains?company_name=string&company_name__icontains=string&company_name__startswith=string&company_name__endswith=string&description=string&description__icontains=string&description__startswith=string&description__endswith=string&status=revoked&status__in=string&country_code=string&country_code__in=string&external_id=string&external_id__icontains=string&external_id__startswith=string&external_id__endswith=string&external_id__in=string&permission_granted=string&is_self_managed=string&contact_name=string&contact_name__icontains=string&contact_name__startswith=string&contact_name__endswith=string&contact_email=string&contact_email__icontains=string&contact_email__startswith=string&contact_email__endswith=string&assessment_status=pending&assessment_status__in=string&passing_percentage_gte=string&failing_percentage_gte=string&ordering=string&search=string&limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(ValueChain)required
results[].​idinteger(ID)read-only
results[].​company_namestring(Company name)[ 1 .. 255 ] charactersrequired
results[].​descriptionstring or null(Description)
results[].​statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
results[].​assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
results[].​country_codestring(Country code)[ 1 .. 2 ] charactersrequired
results[].​external_idstring or null(External id)<= 255 characters
results[].​permission_grantedboolean(Permission granted)
results[].​is_self_managedboolean(Is self managed)
results[].​contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
results[].​contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
results[].​invitation_idstring or null(uuid)(Invitation id)
results[].​reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
results[].​has_accountstring(Has account)read-only
results[].​is_invitedstring(Is invited)read-only
results[].​pulse_paramsstring(Pulse params)read-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
results[].​assessment_summaryobject(Assessment summary)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Value Chains Create

Request

Security
Bearer
Bodyapplication/json
company_namestring(Company name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
external_idstring or null(External id)<= 255 characters
permission_grantedboolean(Permission granted)
is_self_managedboolean(Is self managed)
contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
invitation_idstring or null(uuid)(Invitation id)
reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
curl -i -X POST \
  https://api.coolset.com/_mock/supply-chain-api/value-chains \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_name": "string",
    "description": "string",
    "status": "revoked",
    "country_code": "st",
    "external_id": "string",
    "permission_granted": true,
    "is_self_managed": true,
    "contact_name": "string",
    "contact_email": "user@example.com",
    "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
    "reciprocal_company_id": 2147483647
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
company_namestring(Company name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
external_idstring or null(External id)<= 255 characters
permission_grantedboolean(Permission granted)
is_self_managedboolean(Is self managed)
contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
invitation_idstring or null(uuid)(Invitation id)
reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
has_accountstring(Has account)read-only
is_invitedstring(Is invited)read-only
pulse_paramsstring(Pulse params)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
assessment_summaryobject(Assessment summary)read-only
Response
application/json
{
  "id": 0,
  "company_name": "string",
  "description": "string",
  "status": "revoked",
  "assessment_status": "pending",
  "country_code": "st",
  "external_id": "string",
  "permission_granted": true,
  "is_self_managed": true,
  "contact_name": "string",
  "contact_email": "user@example.com",
  "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
  "reciprocal_company_id": 2147483647,
  "has_account": "string",
  "is_invited": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {}
}

Value Chains Read

Request

Security
Bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.coolset.com/_mock/supply-chain-api/value-chains/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger(ID)read-only
company_namestring(Company name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
external_idstring or null(External id)<= 255 characters
permission_grantedboolean(Permission granted)
is_self_managedboolean(Is self managed)
contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
invitation_idstring or null(uuid)(Invitation id)
reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
has_accountstring(Has account)read-only
is_invitedstring(Is invited)read-only
pulse_paramsstring(Pulse params)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
assessment_summaryobject(Assessment summary)read-only
Response
application/json
{
  "id": 0,
  "company_name": "string",
  "description": "string",
  "status": "revoked",
  "assessment_status": "pending",
  "country_code": "st",
  "external_id": "string",
  "permission_granted": true,
  "is_self_managed": true,
  "contact_name": "string",
  "contact_email": "user@example.com",
  "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
  "reciprocal_company_id": 2147483647,
  "has_account": "string",
  "is_invited": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {}
}

Value Chains Partial Update

Request

Security
Bearer
Path
idstringrequired
Bodyapplication/json
company_namestring(Company name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
external_idstring or null(External id)<= 255 characters
permission_grantedboolean(Permission granted)
is_self_managedboolean(Is self managed)
contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
invitation_idstring or null(uuid)(Invitation id)
reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
curl -i -X PATCH \
  'https://api.coolset.com/_mock/supply-chain-api/value-chains/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_name": "string",
    "description": "string",
    "status": "revoked",
    "country_code": "st",
    "external_id": "string",
    "permission_granted": true,
    "is_self_managed": true,
    "contact_name": "string",
    "contact_email": "user@example.com",
    "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
    "reciprocal_company_id": 2147483647
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
company_namestring(Company name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
statusstring(Status)
Enum"revoked""not_invited_yet""invitation_sent""connected"
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
external_idstring or null(External id)<= 255 characters
permission_grantedboolean(Permission granted)
is_self_managedboolean(Is self managed)
contact_namestring(Contact name)[ 1 .. 255 ] charactersrequired
contact_emailstring(email)(Contact email)[ 1 .. 254 ] charactersrequired
invitation_idstring or null(uuid)(Invitation id)
reciprocal_company_idinteger or null(Reciprocal company id)[ 0 .. 2147483647 ]
has_accountstring(Has account)read-only
is_invitedstring(Is invited)read-only
pulse_paramsstring(Pulse params)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
assessment_summaryobject(Assessment summary)read-only
Response
application/json
{
  "id": 0,
  "company_name": "string",
  "description": "string",
  "status": "revoked",
  "assessment_status": "pending",
  "country_code": "st",
  "external_id": "string",
  "permission_granted": true,
  "is_self_managed": true,
  "contact_name": "string",
  "contact_email": "user@example.com",
  "invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
  "reciprocal_company_id": 2147483647,
  "has_account": "string",
  "is_invited": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {}
}

Value Chains Delete

Request

Security
Bearer
Path
idstringrequired
curl -i -X DELETE \
  'https://api.coolset.com/_mock/supply-chain-api/value-chains/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses