Skip to content
/products

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

Products List

Request

Security
Bearer
Query
skustring

sku

sku__icontainsstring

sku__icontains

sku__startswithstring

sku__startswith

sku__endswithstring

sku__endswith

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

description__isnullstring

description__isnull

scientific_namestring

scientific_name

scientific_name__icontainsstring

scientific_name__icontains

scientific_name__startswithstring

scientific_name__startswith

scientific_name__endswithstring

scientific_name__endswith

scientific_name__isnullstring

scientific_name__isnull

common_namestring

common_name

common_name__icontainsstring

common_name__icontains

common_name__startswithstring

common_name__startswith

common_name__endswithstring

common_name__endswith

common_name__isnullstring

common_name__isnull

typestring

type

Enum"manufactured""produced""purchased"
type__instring

type__in

hs_codestring

hs_code

hs_code__icontainsstring

hs_code__icontains

hs_code__startswithstring

hs_code__startswith

hs_code__endswithstring

hs_code__endswith

hs_code__instring

hs_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

commoditystring

commodity

Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
commodity__instring

commodity__in

compositionstring

composition

Enum"simple""composite"
composition__instring

composition__in

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/products?sku=string&sku__icontains=string&sku__startswith=string&sku__endswith=string&name=string&name__icontains=string&name__startswith=string&name__endswith=string&description=string&description__icontains=string&description__startswith=string&description__endswith=string&description__isnull=string&scientific_name=string&scientific_name__icontains=string&scientific_name__startswith=string&scientific_name__endswith=string&scientific_name__isnull=string&common_name=string&common_name__icontains=string&common_name__startswith=string&common_name__endswith=string&common_name__isnull=string&type=manufactured&type__in=string&hs_code=string&hs_code__icontains=string&hs_code__startswith=string&hs_code__endswith=string&hs_code__in=string&external_id=string&external_id__icontains=string&external_id__startswith=string&external_id__endswith=string&external_id__in=string&commodity=cattle&commodity__in=string&composition=simple&composition__in=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(ProductList)required
results[].​idinteger(ID)read-only
results[].​company_idinteger(Company id)read-only
results[].​skustring(Sku)non-emptyread-only
results[].​namestring(Name)non-emptyread-only
results[].​descriptionstring or null(Description)non-emptyread-only
results[].​scientific_namestring or null(Scientific name)non-emptyread-only
results[].​common_namestring or null(Common name)non-emptyread-only
results[].​typestring(Type)read-only
Enum"manufactured""produced""purchased"
results[].​hs_codestring(Hs code)non-emptyread-only
results[].​commoditystring(Commodity)read-only
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
results[].​compositionstring(Composition)read-only
Enum"simple""composite"
results[].​external_idstring or null(External id)non-emptyread-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Products Create

Request

Security
Bearer
Bodyapplication/json
skustring(Sku)[ 1 .. 100 ] charactersrequired
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
scientific_namestring or null(Scientific name)<= 255 characters
common_namestring or null(Common name)<= 255 characters
typestring(Type)required
Enum"manufactured""produced""purchased"
hs_codestring(Hs code)[ 1 .. 255 ] charactersrequired
commoditystring(Commodity)required
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
compositionstring(Composition)required
Enum"simple""composite"
external_idstring or null(External id)<= 255 characters
product_componentsArray of integersunique

A list of product IDs to set as components.

curl -i -X POST \
  https://api.coolset.com/_mock/supply-chain-api/products \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "string",
    "name": "string",
    "description": "string",
    "scientific_name": "string",
    "common_name": "string",
    "type": "manufactured",
    "hs_code": "string",
    "commodity": "cattle",
    "composition": "simple",
    "external_id": "string",
    "product_components": [
      0
    ]
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
skustring(Sku)[ 1 .. 100 ] charactersrequired
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
scientific_namestring or null(Scientific name)<= 255 characters
common_namestring or null(Common name)<= 255 characters
typestring(Type)required
Enum"manufactured""produced""purchased"
hs_codestring(Hs code)[ 1 .. 255 ] charactersrequired
commoditystring(Commodity)required
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
compositionstring(Composition)required
Enum"simple""composite"
external_idstring or null(External id)<= 255 characters
product_componentsArray of integersunique

A list of product IDs to set as components.

product_components_detailArray of objects(ProductComponent)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "id": 0,
  "sku": "string",
  "name": "string",
  "description": "string",
  "scientific_name": "string",
  "common_name": "string",
  "type": "manufactured",
  "hs_code": "string",
  "commodity": "cattle",
  "composition": "simple",
  "external_id": "string",
  "product_components": [
    0
  ],
  "product_components_detail": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Products Read

Request

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

Responses

Bodyapplication/json
idinteger(ID)read-only
skustring(Sku)[ 1 .. 100 ] charactersrequired
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
scientific_namestring or null(Scientific name)<= 255 characters
common_namestring or null(Common name)<= 255 characters
typestring(Type)required
Enum"manufactured""produced""purchased"
hs_codestring(Hs code)[ 1 .. 255 ] charactersrequired
commoditystring(Commodity)required
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
compositionstring(Composition)required
Enum"simple""composite"
external_idstring or null(External id)<= 255 characters
product_componentsArray of integersunique

A list of product IDs to set as components.

product_components_detailArray of objects(ProductComponent)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "id": 0,
  "sku": "string",
  "name": "string",
  "description": "string",
  "scientific_name": "string",
  "common_name": "string",
  "type": "manufactured",
  "hs_code": "string",
  "commodity": "cattle",
  "composition": "simple",
  "external_id": "string",
  "product_components": [
    0
  ],
  "product_components_detail": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Products Partial Update

Request

Security
Bearer
Path
idstringrequired
Bodyapplication/json
skustring(Sku)[ 1 .. 100 ] charactersrequired
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
scientific_namestring or null(Scientific name)<= 255 characters
common_namestring or null(Common name)<= 255 characters
typestring(Type)required
Enum"manufactured""produced""purchased"
hs_codestring(Hs code)[ 1 .. 255 ] charactersrequired
commoditystring(Commodity)required
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
compositionstring(Composition)required
Enum"simple""composite"
external_idstring or null(External id)<= 255 characters
product_componentsArray of integersunique

A list of product IDs to set as components.

curl -i -X PATCH \
  'https://api.coolset.com/_mock/supply-chain-api/products/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "string",
    "name": "string",
    "description": "string",
    "scientific_name": "string",
    "common_name": "string",
    "type": "manufactured",
    "hs_code": "string",
    "commodity": "cattle",
    "composition": "simple",
    "external_id": "string",
    "product_components": [
      0
    ]
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
skustring(Sku)[ 1 .. 100 ] charactersrequired
namestring(Name)[ 1 .. 255 ] charactersrequired
descriptionstring or null(Description)
scientific_namestring or null(Scientific name)<= 255 characters
common_namestring or null(Common name)<= 255 characters
typestring(Type)required
Enum"manufactured""produced""purchased"
hs_codestring(Hs code)[ 1 .. 255 ] charactersrequired
commoditystring(Commodity)required
Enum"cattle""cocoa""coffee""palm_oil""rubber""soya""wood"
compositionstring(Composition)required
Enum"simple""composite"
external_idstring or null(External id)<= 255 characters
product_componentsArray of integersunique

A list of product IDs to set as components.

product_components_detailArray of objects(ProductComponent)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "id": 0,
  "sku": "string",
  "name": "string",
  "description": "string",
  "scientific_name": "string",
  "common_name": "string",
  "type": "manufactured",
  "hs_code": "string",
  "commodity": "cattle",
  "composition": "simple",
  "external_id": "string",
  "product_components": [
    0
  ],
  "product_components_detail": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Products Delete

Request

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

Responses

value-chains

Operations