Skip to content
Supply Chain API/
/
Orders Items Create

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

Orders Items ListDeprecated

Request

List order items (deprecated)

Security
Bearer
Query
buyer_productstring

buyer_product

buyer_product__instring

buyer_product__in

buyer_product__isnullstring

buyer_product__isnull

seller_productstring

seller_product

seller_product__instring

seller_product__in

seller_product__isnullstring

seller_product__isnull

volumestring

volume

volume__gtestring

volume__gte

volume__ltestring

volume__lte

unitstring

unit

assessment_statusstring

assessment_status

Enum"pending""passing""failing"
assessment_status__instring

assessment_status__in

order__typestring

order__type

Enum"order""produced_batch""manufactured_batch"
order__type__instring

order__type__in

order__order_created_atstring

order__order_created_at

order__order_created_at__gtestring

order__order_created_at__gte

order__order_created_at__ltestring

order__order_created_at__lte

order__order_statusstring

order__order_status

Enum"draft""open""complete""cancelled"
order__order_status__instring

order__order_status__in

buyer_product__skustring

buyer_product__sku

buyer_product__sku__icontainsstring

buyer_product__sku__icontains

buyer_product__sku__startswithstring

buyer_product__sku__startswith

buyer_product__sku__endswithstring

buyer_product__sku__endswith

buyer_product__namestring

buyer_product__name

buyer_product__name__icontainsstring

buyer_product__name__icontains

buyer_product__name__startswithstring

buyer_product__name__startswith

buyer_product__name__endswithstring

buyer_product__name__endswith

buyer_product__commoditystring

buyer_product__commodity

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

buyer_product__composition

Enum"simple""composite"
seller_product__skustring

seller_product__sku

seller_product__sku__icontainsstring

seller_product__sku__icontains

seller_product__sku__startswithstring

seller_product__sku__startswith

seller_product__sku__endswithstring

seller_product__sku__endswith

seller_product__namestring

seller_product__name

seller_product__name__icontainsstring

seller_product__name__icontains

seller_product__name__startswithstring

seller_product__name__startswith

seller_product__name__endswithstring

seller_product__name__endswith

seller_product__commoditystring

seller_product__commodity

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

seller_product__composition

Enum"simple""composite"
passing_percentage_gtestring

passing_percentage_gte

failing_percentage_gtestring

failing_percentage_gte

traced_orders_existsstring

traced_orders_exists

traced_origins_existsstring

traced_origins_exists

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-items?buyer_product=string&buyer_product__in=string&buyer_product__isnull=string&seller_product=string&seller_product__in=string&seller_product__isnull=string&volume=string&volume__gte=string&volume__lte=string&unit=string&assessment_status=pending&assessment_status__in=string&order__type=order&order__type__in=string&order__order_created_at=string&order__order_created_at__gte=string&order__order_created_at__lte=string&order__order_status=draft&order__order_status__in=string&buyer_product__sku=string&buyer_product__sku__icontains=string&buyer_product__sku__startswith=string&buyer_product__sku__endswith=string&buyer_product__name=string&buyer_product__name__icontains=string&buyer_product__name__startswith=string&buyer_product__name__endswith=string&buyer_product__commodity=cattle&buyer_product__composition=simple&seller_product__sku=string&seller_product__sku__icontains=string&seller_product__sku__startswith=string&seller_product__sku__endswith=string&seller_product__name=string&seller_product__name__icontains=string&seller_product__name__startswith=string&seller_product__name__endswith=string&seller_product__commodity=cattle&seller_product__composition=simple&passing_percentage_gte=string&failing_percentage_gte=string&traced_orders_exists=string&traced_origins_exists=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(OrderItem)required
results[].​idinteger(ID)read-only
results[].​orderinteger(Order)required
results[].​order_detailobject(OrderList)
results[].​buyer_productinteger or null(Buyer product)
results[].​buyer_product_detailobject(ProductList)
results[].​seller_productinteger or null(Seller product)
results[].​seller_product_detailobject(ProductList)
results[].​volumenumber(Volume)required
results[].​unitstring(Unit)[ 1 .. 3 ] charactersrequired
results[].​line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
results[].​external_idstring or null(External id)<= 255 characters
results[].​traced_ordersArray of integersunique
results[].​traced_orders_detailArray of objects(OrderList)read-only
results[].​is_complete_matchstring(Is complete match)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": [
    { … }
  ]
}

Orders Items CreateDeprecated

Request

Create order item (deprecated)

Security
Bearer
Bodyapplication/json
orderinteger(Order)required
order_detailobject(OrderList)
buyer_productinteger or null(Buyer product)
buyer_product_detailobject(ProductList)
seller_productinteger or null(Seller product)
seller_product_detailobject(ProductList)
volumenumber(Volume)required
unitstring(Unit)[ 1 .. 3 ] charactersrequired
line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
external_idstring or null(External id)<= 255 characters
traced_ordersArray of integersunique
curl -i -X POST \
  https://api.coolset.com/_mock/supply-chain-api/orders-items \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": 0,
    "order_detail": {
      "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",
      "value_chain": 0,
      "buyer_company_id": 2147483647,
      "seller_company_id": 2147483647,
      "company": {},
      "buyer_company": {},
      "seller_company": {}
    },
    "buyer_product": 0,
    "buyer_product_detail": {},
    "seller_product": 0,
    "seller_product_detail": {},
    "volume": 0,
    "unit": "str",
    "line_number": 2147483647,
    "external_id": "string",
    "traced_orders": [
      0
    ]
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
orderinteger(Order)required
order_detailobject(OrderList)
buyer_productinteger or null(Buyer product)
buyer_product_detailobject(ProductList)
seller_productinteger or null(Seller product)
seller_product_detailobject(ProductList)
volumenumber(Volume)required
unitstring(Unit)[ 1 .. 3 ] charactersrequired
line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
external_idstring or null(External id)<= 255 characters
traced_ordersArray of integersunique
traced_orders_detailArray of objects(OrderList)read-only
is_complete_matchstring(Is complete match)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,
  "order": 0,
  "order_detail": {
    "id": 0,
    "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,
    "buyer_company_id": 2147483647,
    "seller_company_id": 2147483647,
    "company": { … },
    "buyer_company": { … },
    "seller_company": { … },
    "assessment_summary": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "buyer_product": 0,
  "buyer_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "seller_product": 0,
  "seller_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "volume": 0,
  "unit": "str",
  "line_number": 2147483647,
  "external_id": "string",
  "traced_orders": [
    0
  ],
  "traced_orders_detail": [
    { … }
  ],
  "is_complete_match": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Orders Items ReadDeprecated

Request

Get order item (deprecated)

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

Responses

Bodyapplication/json
idinteger(ID)read-only
orderinteger(Order)required
order_detailobject(OrderList)
buyer_productinteger or null(Buyer product)
buyer_product_detailobject(ProductList)
seller_productinteger or null(Seller product)
seller_product_detailobject(ProductList)
volumenumber(Volume)required
unitstring(Unit)[ 1 .. 3 ] charactersrequired
line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
external_idstring or null(External id)<= 255 characters
traced_ordersArray of integersunique
traced_orders_detailArray of objects(OrderList)read-only
is_complete_matchstring(Is complete match)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,
  "order": 0,
  "order_detail": {
    "id": 0,
    "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,
    "buyer_company_id": 2147483647,
    "seller_company_id": 2147483647,
    "company": { … },
    "buyer_company": { … },
    "seller_company": { … },
    "assessment_summary": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "buyer_product": 0,
  "buyer_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "seller_product": 0,
  "seller_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "volume": 0,
  "unit": "str",
  "line_number": 2147483647,
  "external_id": "string",
  "traced_orders": [
    0
  ],
  "traced_orders_detail": [
    { … }
  ],
  "is_complete_match": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Orders Items Partial UpdateDeprecated

Request

Partial update order item (deprecated)

Security
Bearer
Path
idstringrequired
Bodyapplication/json
orderinteger(Order)required
order_detailobject(OrderList)
buyer_productinteger or null(Buyer product)
buyer_product_detailobject(ProductList)
seller_productinteger or null(Seller product)
seller_product_detailobject(ProductList)
volumenumber(Volume)required
unitstring(Unit)[ 1 .. 3 ] charactersrequired
line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
external_idstring or null(External id)<= 255 characters
traced_ordersArray of integersunique
curl -i -X PATCH \
  'https://api.coolset.com/_mock/supply-chain-api/orders-items/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": 0,
    "order_detail": {
      "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",
      "value_chain": 0,
      "buyer_company_id": 2147483647,
      "seller_company_id": 2147483647,
      "company": {},
      "buyer_company": {},
      "seller_company": {}
    },
    "buyer_product": 0,
    "buyer_product_detail": {},
    "seller_product": 0,
    "seller_product_detail": {},
    "volume": 0,
    "unit": "str",
    "line_number": 2147483647,
    "external_id": "string",
    "traced_orders": [
      0
    ]
  }'

Responses

Bodyapplication/json
idinteger(ID)read-only
orderinteger(Order)required
order_detailobject(OrderList)
buyer_productinteger or null(Buyer product)
buyer_product_detailobject(ProductList)
seller_productinteger or null(Seller product)
seller_product_detailobject(ProductList)
volumenumber(Volume)required
unitstring(Unit)[ 1 .. 3 ] charactersrequired
line_numberinteger or null(Line number)[ 0 .. 2147483647 ]
external_idstring or null(External id)<= 255 characters
traced_ordersArray of integersunique
traced_orders_detailArray of objects(OrderList)read-only
is_complete_matchstring(Is complete match)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,
  "order": 0,
  "order_detail": {
    "id": 0,
    "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,
    "buyer_company_id": 2147483647,
    "seller_company_id": 2147483647,
    "company": { … },
    "buyer_company": { … },
    "seller_company": { … },
    "assessment_summary": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "buyer_product": 0,
  "buyer_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "seller_product": 0,
  "seller_product_detail": {
    "id": 0,
    "company_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",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "volume": 0,
  "unit": "str",
  "line_number": 2147483647,
  "external_id": "string",
  "traced_orders": [
    0
  ],
  "traced_orders_detail": [
    { … }
  ],
  "is_complete_match": "string",
  "pulse_params": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "assessment_summary": {},
  "assessment_status": "pending"
}

Orders Items DeleteDeprecated

Request

Delete order item (deprecated)

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

Responses

origins

Operations

products

Operations

value-chains

Operations