Skip to content
Supply Chain API/
/
Orders List

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 List

Request

Security
Bearer
Query
typestring

type

Enum"order""produced_batch""manufactured_batch"
type__instring

type__in

order_created_atstring

order_created_at

order_created_at__gtestring

order_created_at__gte

order_created_at__ltestring

order_created_at__lte

order_arrival_atstring

order_arrival_at

order_arrival_at__gtestring

order_arrival_at__gte

order_arrival_at__ltestring

order_arrival_at__lte

order_statusstring

order_status

Enum"draft""open""complete""cancelled"
order_status__instring

order_status__in

assessment_statusstring

assessment_status

Enum"pending""passing""failing"
assessment_status__instring

assessment_status__in

value_chainstring

value_chain

items__buyer_productstring

items__buyer_product

items__buyer_product__instring

items__buyer_product__in

items__buyer_product__isnullstring

items__buyer_product__isnull

items__seller_productstring

items__seller_product

items__seller_product__instring

items__seller_product__in

items__seller_product__isnullstring

items__seller_product__isnull

items__volumestring

items__volume

items__volume__gtestring

items__volume__gte

items__volume__ltestring

items__volume__lte

items__unitstring

items__unit

items__external_idstring

items__external_id

items__external_id__icontainsstring

items__external_id__icontains

items__external_id__startswithstring

items__external_id__startswith

items__external_id__endswithstring

items__external_id__endswith

items__external_id__instring

items__external_id__in

items__buyer_product__skustring

items__buyer_product__sku

items__buyer_product__sku__icontainsstring

items__buyer_product__sku__icontains

items__buyer_product__sku__startswithstring

items__buyer_product__sku__startswith

items__buyer_product__sku__endswithstring

items__buyer_product__sku__endswith

items__buyer_product__namestring

items__buyer_product__name

items__buyer_product__name__icontainsstring

items__buyer_product__name__icontains

items__buyer_product__name__startswithstring

items__buyer_product__name__startswith

items__buyer_product__name__endswithstring

items__buyer_product__name__endswith

items__buyer_product__commoditystring

items__buyer_product__commodity

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

items__buyer_product__commodity__in

items__buyer_product__compositionstring

items__buyer_product__composition

Enum"simple""composite"
items__buyer_product__composition__instring

items__buyer_product__composition__in

items__seller_product__skustring

items__seller_product__sku

items__seller_product__sku__icontainsstring

items__seller_product__sku__icontains

items__seller_product__sku__startswithstring

items__seller_product__sku__startswith

items__seller_product__sku__endswithstring

items__seller_product__sku__endswith

items__seller_product__namestring

items__seller_product__name

items__seller_product__name__icontainsstring

items__seller_product__name__icontains

items__seller_product__name__startswithstring

items__seller_product__name__startswith

items__seller_product__name__endswithstring

items__seller_product__name__endswith

items__seller_product__commoditystring

items__seller_product__commodity

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

items__seller_product__commodity__in

items__seller_product__compositionstring

items__seller_product__composition

Enum"simple""composite"
items__seller_product__composition__instring

items__seller_product__composition__in

passing_percentage_gtestring

passing_percentage_gte

failing_percentage_gtestring

failing_percentage_gte

order_actionstringrequired

order_action

Enum"buying""selling"
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/orders?type=order&type__in=string&order_created_at=string&order_created_at__gte=string&order_created_at__lte=string&order_arrival_at=string&order_arrival_at__gte=string&order_arrival_at__lte=string&order_status=draft&order_status__in=string&assessment_status=pending&assessment_status__in=string&value_chain=string&items__buyer_product=string&items__buyer_product__in=string&items__buyer_product__isnull=string&items__seller_product=string&items__seller_product__in=string&items__seller_product__isnull=string&items__volume=string&items__volume__gte=string&items__volume__lte=string&items__unit=string&items__external_id=string&items__external_id__icontains=string&items__external_id__startswith=string&items__external_id__endswith=string&items__external_id__in=string&items__buyer_product__sku=string&items__buyer_product__sku__icontains=string&items__buyer_product__sku__startswith=string&items__buyer_product__sku__endswith=string&items__buyer_product__name=string&items__buyer_product__name__icontains=string&items__buyer_product__name__startswith=string&items__buyer_product__name__endswith=string&items__buyer_product__commodity=cattle&items__buyer_product__commodity__in=string&items__buyer_product__composition=simple&items__buyer_product__composition__in=string&items__seller_product__sku=string&items__seller_product__sku__icontains=string&items__seller_product__sku__startswith=string&items__seller_product__sku__endswith=string&items__seller_product__name=string&items__seller_product__name__icontains=string&items__seller_product__name__startswith=string&items__seller_product__name__endswith=string&items__seller_product__commodity=cattle&items__seller_product__commodity__in=string&items__seller_product__composition=simple&items__seller_product__composition__in=string&passing_percentage_gte=string&failing_percentage_gte=string&order_action=buying&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(Order)required
results[].​idinteger(ID)read-only
results[].​company_idinteger(Company id)[ 0 .. 2147483647 ]required
results[].​typestring(Type)required
Enum"order""produced_batch""manufactured_batch"
results[].​buyer_external_idstring or null(Buyer external id)[ 1 .. 255 ] characters
results[].​seller_external_idstring or null(Seller external id)[ 1 .. 255 ] characters
results[].​order_created_atstring(date)(Order created at)required
results[].​order_arrival_atstring or null(date)(Order arrival at)
results[].​order_statusstring(Order status)
Enum"draft""open""complete""cancelled"
results[].​assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
results[].​value_chaininteger or null(Value chain)
results[].​value_chain_detailobject(ValueChain)
results[].​buyer_company_idinteger or null(Buyer company id)[ 0 .. 2147483647 ]
results[].​seller_company_idinteger or null(Seller company id)[ 0 .. 2147483647 ]
results[].​companyobject(CoolsetCompany)
results[].​buyer_companyobject(CoolsetCompany)
results[].​seller_companyobject(CoolsetCompany)
results[].​itemsArray of objects(NestedOrderItem)read-only
results[].​due_diligence_statementsArray of objects(DueDiligenceStatementNested)read-only
results[].​assessment_summaryobject(Assessment summary)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
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Orders Read

Request

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

Responses

Bodyapplication/json
idinteger(ID)read-only
company_idinteger(Company id)[ 0 .. 2147483647 ]required
typestring(Type)required
Enum"order""produced_batch""manufactured_batch"
buyer_external_idstring or null(Buyer external id)[ 1 .. 255 ] characters
seller_external_idstring or null(Seller external id)[ 1 .. 255 ] characters
order_created_atstring(date)(Order created at)required
order_arrival_atstring or null(date)(Order arrival at)
order_statusstring(Order status)
Enum"draft""open""complete""cancelled"
assessment_statusstring(Assessment status)read-only
Enum"pending""passing""failing"
value_chaininteger or null(Value chain)
value_chain_detailobject(ValueChain)
buyer_company_idinteger or null(Buyer company id)[ 0 .. 2147483647 ]
seller_company_idinteger or null(Seller company id)[ 0 .. 2147483647 ]
companyobject(CoolsetCompany)
buyer_companyobject(CoolsetCompany)
seller_companyobject(CoolsetCompany)
itemsArray of objects(NestedOrderItem)read-only
due_diligence_statementsArray of objects(DueDiligenceStatementNested)read-only
assessment_summaryobject(Assessment summary)read-only
pulse_paramsstring(Pulse params)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "id": 0,
  "company_id": 2147483647,
  "type": "order",
  "buyer_external_id": "string",
  "seller_external_id": "string",
  "order_created_at": "2019-08-24",
  "order_arrival_at": "2019-08-24",
  "order_status": "draft",
  "assessment_status": "pending",
  "value_chain": 0,
  "value_chain_detail": {
    "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": {}
  },
  "buyer_company_id": 2147483647,
  "seller_company_id": 2147483647,
  "company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "buyer_company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "seller_company": {
    "id": 0,
    "name": "string",
    "slug": "string",
    "type": "string",
    "city": "string",
    "country": "string",
    "nr_of_employees": 0,
    "nr_of_locations": 0,
    "default_currency": "string",
    "default_locale": "string",
    "data_room_consumer_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "items": [
    { … }
  ],
  "due_diligence_statements": [
    { … }
  ],
  "assessment_summary": {},
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Orders Delete

Request

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

Responses

orders-items

Operations

origins

Operations

products

Operations

value-chains

Operations