Skip to content
/origins

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

Origins List

Request

Security
Bearer
Query
namestring

name

name__icontainsstring

name__icontains

name__startswithstring

name__startswith

name__endswithstring

name__endswith

descriptionstring

description

description__icontainsstring

description__icontains

description__startswithstring

description__startswith

description__endswithstring

description__endswith

country_codestring

country_code

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

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/origins?name=string&name__icontains=string&name__startswith=string&name__endswith=string&description=string&description__icontains=string&description__startswith=string&description__endswith=string&country_code=string&external_id=string&external_id__icontains=string&external_id__startswith=string&external_id__endswith=string&external_id__in=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(Origin)required
results[].​idinteger(ID)read-only
results[].​namestring(Name)[ 1 .. 255 ] charactersrequired
results[].​descriptionstring or null(Description)
results[].​country_codestring(Country code)[ 1 .. 2 ] charactersrequired
results[].​locationobject(Location)
results[].​external_idstring or null(External id)<= 255 characters
results[].​open_atlas_external_idstring or null(Open atlas external id)non-emptyread-only
results[].​open_atlas_informationobject(Open atlas information)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
results[].​assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Origins Create

Request

Security
Bearer
Bodyapplication/json
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
locationobject(Location)
external_idstring or null(External id)<= 255 characters
curl -i -X POST \
  https://api.coolset.com/_mock/supply-chain-api/origins \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "country_code": "st",
    "location": {},
    "external_id": "string"
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
locationobject(Location)
external_idstring or null(External id)<= 255 characters
open_atlas_external_idstring or null(Open atlas external id)non-emptyread-only
open_atlas_informationobject(Open atlas information)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
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "country_code": "st",
  "location": {},
  "external_id": "string",
  "open_atlas_external_id": "string",
  "open_atlas_information": {},
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Origins Read

Request

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

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
locationobject(Location)
external_idstring or null(External id)<= 255 characters
open_atlas_external_idstring or null(Open atlas external id)non-emptyread-only
open_atlas_informationobject(Open atlas information)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
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "country_code": "st",
  "location": {},
  "external_id": "string",
  "open_atlas_external_id": "string",
  "open_atlas_information": {},
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Origins Partial Update

Request

Security
Bearer
Path
idstringrequired
Bodyapplication/json
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
locationobject(Location)
external_idstring or null(External id)<= 255 characters
curl -i -X PATCH \
  'https://api.coolset.com/_mock/supply-chain-api/origins/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "country_code": "st",
    "location": {},
    "external_id": "string"
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
country_codestring(Country code)[ 1 .. 2 ] charactersrequired
locationobject(Location)
external_idstring or null(External id)<= 255 characters
open_atlas_external_idstring or null(Open atlas external id)non-emptyread-only
open_atlas_informationobject(Open atlas information)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
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
Response
application/json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "country_code": "st",
  "location": {},
  "external_id": "string",
  "open_atlas_external_id": "string",
  "open_atlas_information": {},
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Origins Delete

Request

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

Responses

products

Operations

value-chains

Operations