Coolset Supply Chain API (1.0)

Download OpenAPI specification:Download

E-mail: support@coolset.com URL: https://coolset.com

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

Order Tracing

List available orders for tracing

List orders available for tracing to Due Diligence Statements

Authorizations:

Bearer

query Parameters

ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
exclude_dds	string Exclude orders already traced to DDS ID(s). Supports single ID or comma-separated list (e.g., '1' or '1,2,3')

Responses

Response samples

Content type

application/json

{"results": [{"id": 0,
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"count": 0,
"next": "http://example.com",
"previous": "http://example.com"
}

Trace orders to DDS

Trace orders to Due Diligence Statement(s) (adds to existing orders)

Authorizations:

Bearer

Request Body schema: application/json
required

dds_id required	Array of integers DDS ID or list of DDS IDs to trace orders to (accepts single integer or array)
order_id required	Array of integers Order ID or list of order IDs to trace to the DDS(s) (accepts single integer or array)

Responses

Request samples

Payload

Content type

application/json

{"dds_id": [0
],
"order_id": [0
]
}

Response samples

Content type

application/json

{"results": [{"dds_id": 0,
"added_orders": [0
],
"total_orders": 0,
"message": "string"
}
],
"summary": {"total_dds_processed": 0,
"total_orders_added": 0
}
}

eudr

List due diligence statements

Returns a paginated list of EUDR Due Diligence Statements for the authenticated company. Each DDS includes its identifier, status, traced orders, and submission details.

Authorizations:

Bearer

query Parameters

created_at	string
created_at__gte	string
created_at__lte	string
dds_identifier	string
type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"type": "EUDR",
"dds_identifier": "string",
"dds_data": { },
"orders": [0
],
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a due diligence statement

Create a new EUDR Due Diligence Statement. Orders can be traced to the DDS afterwards using the trace-orders endpoint.

Authorizations:

Bearer

Request Body schema: application/json
required

type	string (Type) Enum: "EUDR" "EUTR" Type of Due Diligence Statement (EUDR, EUTR)
dds_identifier	string (Dds identifier)

Responses

Request samples

Payload

Content type

application/json

{"type": "EUDR",
"dds_identifier": "string"
}

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"dds_identifier": "string",
"dds_data": { },
"orders": [0
],
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a due diligence statement

Returns a single DDS by ID with full details including traced orders.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"dds_identifier": "string",
"dds_data": { },
"orders": [0
],
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a due diligence statement

Partially update an existing DDS. Only provided fields are changed.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

type	string (Type) Enum: "EUDR" "EUTR" Type of Due Diligence Statement (EUDR, EUTR)
dds_identifier	string (Dds identifier)

Responses

Request samples

Payload

Content type

application/json

{"type": "EUDR",
"dds_identifier": "string"
}

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"dds_identifier": "string",
"dds_data": { },
"orders": [0
],
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete a due diligence statement

Soft-deletes a Due Diligence Statement by ID.

Authorizations:

Bearer

path Parameters

required

string

Responses

information-requests

Send an information request

Create an information request for a specific order

Authorizations:

Bearer

Request Body schema: application/json
required

order_id	integer (Order id)
value_chain_id	integer (Value chain id)

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"value_chain_id": 0
}

Send information requests in bulk

Create multiple information requests in bulk

Authorizations:

Bearer

Request Body schema: application/json
required

required

Array of objects (InformationRequestItem) [ 1 .. 100 ] items

List of information requests to create

Array ([ 1 .. 100 ] items)

order_id	integer (Order id)
value_chain_id	integer (Value chain id)

Responses

Request samples

Payload

Content type

application/json

{"information_requests": [{"order_id": 0,
"value_chain_id": 0
}
]
}

Response samples

Content type

application/json

{"message": "Bulk information requests processed",
"results": {"summary": {"total_information_requests": 3,
"processed": 2,
"failed": 1
},
"processed": [{"index": 0,
"order_id": 123,
"value_chain_id": null,
"invitation_action": "send_invitation"
},
{"index": 2,
"order_id": null,
"value_chain_id": 456,
"invitation_action": "send_invitation"
}
],
"failed": [{"index": 1,
"data": {"order_id": 999
},
"error": "Order not found or not accessible"
}
]
}
}

orders

List orders

Returns a paginated list of supply chain orders for the authenticated company. Each order includes its type (buying/selling), buyer and seller IDs, value chain association, and nested order items with product details. Required filter: order_action (buying|selling) — determines whether to return orders where the authenticated company is the buyer or seller. Optional filters: type, buyer_company_status, seller_company_status, assessment_status, value_chain, date ranges (order_created_at, order_arrival_at), border_cross_country_code, tags, item product details (SKU, name, commodity, composition), item volume/unit, item external ID, or passing/failing percentage. Use search to match buyer_external_id, seller_external_id, or tag names.

Authorizations:

Bearer

query Parameters

type	string
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
buyer_company_status	string
buyer_company_status__in	string
seller_company_status	string
seller_company_status__in	string
assessment_status	string
assessment_status__in	string
value_chain	string
border_cross_country_code	string
border_cross_country_code__in	string
tags__name	string
tags__name__in	string
tags__name__icontains	string
tags__slug	string
tags__slug__in	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	string
items__buyer_product__commodity__in	string
items__buyer_product__composition	string
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	string
items__seller_product__commodity__in	string
items__seller_product__composition	string
items__seller_product__composition__in	string
passing_percentage_gte	string
failing_percentage_gte	string
order_action required	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"company_id": 2147483647,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [{"id": 0,
"company_id": 0,
"type": "EUDR",
"dds_data": { },
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessment_summary": { },
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Retrieve an order

Returns a single order by ID with full details including order items, value chain, and traceability counts.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"company_id": 2147483647,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [{"id": 0,
"company_id": 0,
"type": "EUDR",
"dds_data": { },
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessment_summary": { },
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an order

Soft-deletes a single order by ID.

Authorizations:

Bearer

path Parameters

required

string

Responses

Create batch orders

Create multiple orders in a single request. Each order can include nested order items with buyer/seller product references. Used for bulk data imports and integrations.

Authorizations:

Bearer

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
buyer_company_status	string (Buyer company status) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed"
seller_company_id	integer or null (Seller company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
signed_off_at	string or null <date-time> (Signed off at)
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"assessment_summary": { },
"border_cross_country_code": "st",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a batch order

Update an existing batch order and its line items.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
buyer_company_status	string (Buyer company status) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed"
seller_company_id	integer or null (Seller company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
signed_off_at	string or null <date-time> (Signed off at)
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"assessment_summary": { },
"border_cross_country_code": "st",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Create a purchase order

Create a new purchase order with nested order items. The authenticated company is set as the buyer.

Authorizations:

Bearer

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
buyer_company_status	string (Buyer company status) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed"
value_chain	integer or null (Value chain)
	object (ValueChain)
seller_company_id	integer or null (Seller company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
send_information_request	boolean (Send information request) Default: false
signed_off_at	string or null <date-time> (Signed off at)
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (Country)
dds_identifiers	Array of strings[ items non-empty ]
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"value_chain": 0,
"value_chain_detail": {"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
},
"seller_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"border_cross_country": { },
"dds_identifiers": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"dds_identifiers": ["string"
],
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a purchase order

Partially update an existing purchase order and its items.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
buyer_company_status	string (Buyer company status) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed"
value_chain	integer or null (Value chain)
	object (ValueChain)
seller_company_id	integer or null (Seller company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
send_information_request	boolean (Send information request) Default: false
signed_off_at	string or null <date-time> (Signed off at)
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (Country)
dds_identifiers	Array of strings[ items non-empty ]
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"value_chain": 0,
"value_chain_detail": {"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
},
"seller_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"border_cross_country": { },
"dds_identifiers": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"dds_identifiers": ["string"
],
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Create a sale order

Create a new sale order with nested order items. The authenticated company is set as the seller.

Authorizations:

Bearer

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
seller_company_status	string (Seller company status) Enum: "draft" "untraced" "pending" "passing" "failing" "completed" "closed"
assessment_status	string (Assessment status) Enum: "pending" "passing" "failing" "mitigated"
value_chain	integer or null (Value chain)
	object (ValueChain)
buyer_company_id	integer or null (Buyer company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
send_information_request	boolean (Send information request) Default: false
signed_off_at	string or null <date-time> (Signed off at)
dds_identifiers	Array of strings[ items non-empty ]
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (Country)
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
},
"buyer_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"border_cross_country": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"buyer_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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a sale order

Partially update an existing sale order and its items.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

type required	string (Type) Enum: "order" "produced_batch" "manufactured_batch" "product_chain"
external_id required	string (External id) [ 1 .. 255 ] characters
buyer_external_id	string or null (Buyer external id) [ 1 .. 255 ] characters
seller_external_id	string or null (Seller external id) [ 1 .. 255 ] characters
order_created_at required	string <date> (Order created at)
order_arrival_at	string or null <date> (Order arrival at)
seller_company_status	string (Seller company status) Enum: "draft" "untraced" "pending" "passing" "failing" "completed" "closed"
assessment_status	string (Assessment status) Enum: "pending" "passing" "failing" "mitigated"
value_chain	integer or null (Value chain)
	object (ValueChain)
buyer_company_id	integer or null (Buyer company id) [ 0 .. 2147483647 ]
	object (CoolsetCompany)
	object (CoolsetCompany)
	object (CoolsetCompany)
	Array of objects (NestedOrderItem)
send_information_request	boolean (Send information request) Default: false
signed_off_at	string or null <date-time> (Signed off at)
dds_identifiers	Array of strings[ items non-empty ]
border_cross_country_code	string or null (Border cross country code) <= 2 characters Country code of the border crossing country
	object (Country)
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
},
"buyer_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"items": [{"id": 0,
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
}
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"border_cross_country": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"type": "order",
"external_id": "string",
"buyer_external_id": "string",
"seller_external_id": "string",
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"value_chain_detail": {"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
},
"buyer_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": [{"id": 0,
"order": 0,
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"is_complete_match": "string",
"traced_order_count": "string",
"traced_origin_count": "string",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [0
],
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"border_cross_country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"tags": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List order statistics

Returns aggregated order statistics such as order counts grouped by date. Required filter: order_action (buying|selling). Use filters to narrow by type, buyer_company_status, seller_company_status, assessment_status, value_chain, date ranges (order_created_at, order_arrival_at), border_cross_country_code, tags, or item details. Results are not paginated.

Authorizations:

Bearer

query Parameters

type	string
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
buyer_company_status	string
buyer_company_status__in	string
seller_company_status	string
seller_company_status__in	string
assessment_status	string
assessment_status__in	string
value_chain	string
border_cross_country_code	string
border_cross_country_code__in	string
tags__name	string
tags__name__in	string
tags__name__icontains	string
tags__slug	string
tags__slug__in	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	string
items__buyer_product__commodity__in	string
items__buyer_product__composition	string
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	string
items__seller_product__commodity__in	string
items__seller_product__composition	string
items__seller_product__composition__in	string
passing_percentage_gte	string
failing_percentage_gte	string
order_action required	string
group_by	string
delimit_by	string

Responses

Response samples

Content type

application/json

[{"order_count": 0,
"date": "2019-08-24",
"type": "string",
"buyer_company_status": "string",
"seller_company_status": "string",
"assessment_status": "string"
}
]

origins

List origins

Returns a paginated list of geographic origins for the authenticated company. Each origin includes its name, country code, coordinates, and description. Use search to filter by name or description, or order by name/country_code.

Authorizations:

Bearer

query Parameters

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	string
assessment_status__in	string
passing_percentage_gte	string
failing_percentage_gte	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
]
}

Create an origin

Create a new geographic origin with a name, country code, and optional coordinates and description.

Authorizations:

Bearer

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 255 ] characters
description	string or null (Description)
country_code required	string (Country code) [ 1 .. 2 ] characters
	object (Country)
location	object (Location)
external_id	string or null (External id) <= 255 characters
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"country_code": "st",
"country": { },
"location": { },
"external_id": "string",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}

Retrieve an origin

Returns a single origin by ID with full details.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}

Update an origin

Partially update an existing origin. Only provided fields are changed.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 255 ] characters
description	string or null (Description)
country_code required	string (Country code) [ 1 .. 2 ] characters
	object (Country)
location	object (Location)
external_id	string or null (External id) <= 255 characters
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"country_code": "st",
"country": { },
"location": { },
"external_id": "string",
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}

Delete an origin

Soft-deletes a single origin by ID.

Authorizations:

Bearer

path Parameters

required

string

Responses

products

List products

Returns a paginated list of products for the authenticated company. Each product includes its name, SKU, commodity type, composition, and HS code classification. Search by SKU or name, and order by name, commodity, type, or composition.

Authorizations:

Bearer

query Parameters

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	string
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	string
commodity__in	string
composition	string
composition__in	string
is_packaging	string
volume	string
volume__gte	string
volume__lte	string
volume__isnull	string
unit	string
unit__in	string
assessment_status	string
assessment_status__in	string
assessment_status__isnull	string
tags__name	string
tags__name__in	string
tags__name__icontains	string
tags__slug	string
tags__slug__in	string
passing_percentage_gte	string
failing_percentage_gte	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a product

Create a new product with a name, SKU, commodity type, and optional HS code and composition details.

Authorizations:

Bearer

Request Body schema: application/json
required

sku required	string (Sku) [ 1 .. 100 ] characters
name required	string (Name) [ 1 .. 255 ] characters
description	string or null (Description)
scientific_name	string or null (Scientific name) <= 255 characters
common_name	string or null (Common name) <= 255 characters
type required	string (Type) Enum: "manufactured" "produced" "purchased"
hs_code required	string (Hs code) [ 1 .. 255 ] characters
commodity required	string (Commodity) Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood"
composition required	string (Composition) Enum: "simple" "composite"
external_id	string or null (External id) <= 255 characters
is_packaging	boolean (Is packaging)
volume	number or null (Volume)
unit	string or null (Unit) Enum: "mg" "g" "kg" "tonne" "ml" "cl" "l" "oz" "lb"
product_components	Array of integers unique A list of product IDs to set as components.
tags	Array of strings[ items non-empty ]
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"description": "string",
"scientific_name": "string",
"common_name": "string",
"type": "manufactured",
"hs_code": "string",
"commodity": "cattle",
"composition": "simple",
"external_id": "string",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"product_components": [0
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"product_components": [0
],
"product_components_detail": [{"id": 0,
"product": 0,
"component_product": 0,
"component_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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a product

Returns a single product by ID with full details.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"product_components": [0
],
"product_components_detail": [{"id": 0,
"product": 0,
"component_product": 0,
"component_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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a product

Partially update an existing product. Only provided fields are changed.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

sku required	string (Sku) [ 1 .. 100 ] characters
name required	string (Name) [ 1 .. 255 ] characters
description	string or null (Description)
scientific_name	string or null (Scientific name) <= 255 characters
common_name	string or null (Common name) <= 255 characters
type required	string (Type) Enum: "manufactured" "produced" "purchased"
hs_code required	string (Hs code) [ 1 .. 255 ] characters
commodity required	string (Commodity) Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood"
composition required	string (Composition) Enum: "simple" "composite"
external_id	string or null (External id) <= 255 characters
is_packaging	boolean (Is packaging)
volume	number or null (Volume)
unit	string or null (Unit) Enum: "mg" "g" "kg" "tonne" "ml" "cl" "l" "oz" "lb"
product_components	Array of integers unique A list of product IDs to set as components.
tags	Array of strings[ items non-empty ]
	object (PulseParams)

Responses

Request samples

Payload

Content type

application/json

{"sku": "string",
"name": "string",
"description": "string",
"scientific_name": "string",
"common_name": "string",
"type": "manufactured",
"hs_code": "string",
"commodity": "cattle",
"composition": "simple",
"external_id": "string",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"product_components": [0
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
}

Response samples

Content type

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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"product_components": [0
],
"product_components_detail": [{"id": 0,
"product": 0,
"component_product": 0,
"component_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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": { },
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete a product

Soft-deletes a single product by ID.

Authorizations:

Bearer

path Parameters

required

string

Responses

traces

List traceable order items

Returns order items where your company is the seller, showing their traceability status — which source orders and origins are linked. Use filters to narrow by product, volume, or assessment status.

Authorizations:

Bearer

query Parameters

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	string
assessment_status__in	string
order__type	string
order__type__in	string
order__order_created_at	string
order__order_created_at__gte	string
order__order_created_at__lte	string
order__buyer_company_status	string
order__buyer_company_status__in	string
order__seller_company_status	string
order__seller_company_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	string
buyer_product__composition	string
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	string
seller_product__composition	string
passing_percentage_gte	string
failing_percentage_gte	string
traced_orders_exists	string
traced_origins_exists	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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_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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"traced_origins_detail": [{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"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"
}
]
}

Retrieve a traceable order item

Returns a single traceable order item by ID with its linked orders and origins.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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_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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"traced_origins_detail": [{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"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"
}

Update trace

Partially updates the traceability links for a single order item. To update multiple items at once use the bulk-update endpoint.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

order required	integer (Order)
	object (OrderList)
buyer_product	integer or null (Buyer product)
	object (ProductList)
seller_product	integer or null (Seller product)
	object (ProductList)
volume required	number (Volume)
unit required	string (Unit) [ 1 .. 3 ] characters
line_number	integer or null (Line number) [ 0 .. 2147483647 ]
external_id	string or null (External id) <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"value_chain": 0,
"buyer_company_id": 2147483647,
"seller_company_id": 2147483647,
"company": { },
"buyer_company": { },
"seller_company": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
}
},
"buyer_product": 0,
"buyer_product_detail": { },
"seller_product": 0,
"seller_product_detail": { },
"volume": 0,
"unit": "str",
"line_number": 2147483647,
"external_id": "string"
}

Response samples

Content type

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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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",
"is_packaging": true,
"volume": 0,
"unit": "mg",
"tags": ["string"
],
"assessment_status": "pending",
"assessment_summary": { },
"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_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",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending",
"value_chain": 0,
"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"
},
"signed_off_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"traced_origins_detail": [{"id": 0,
"name": "string",
"description": "string",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"location": { },
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": { },
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending"
}
],
"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"
}

value-chains

List value chain partners

Returns a paginated list of value chain partners (suppliers/customers). Each entry includes the partner company name, country, contact details, status, and assessment status. Search by company_name or contact_name.

Authorizations:

Bearer

query Parameters

company_name	string
company_name__icontains	string
company_name__startswith	string
company_name__endswith	string
type	string
type__in	string
description	string
description__icontains	string
description__startswith	string
description__endswith	string
status	string
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	string
assessment_status__in	string
tags__name	string
tags__name__in	string
tags__name__icontains	string
tags__slug	string
tags__slug__in	string
passing_percentage_gte	string
failing_percentage_gte	string
ordering	string Which field to use when ordering the results.
search	string A search term.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
}
]
}

Create a value chain partner

Create a new value chain partner with company name, country code, and optional contact details.

Authorizations:

Bearer

Request Body schema: application/json
required

company_name required	string (Company name) [ 1 .. 255 ] characters
type required	string (Type) Enum: "supplier" "customer" "investment" "investor" "franchise" "franchisor" "group_member" "group_parent"
description	string or null (Description)
status	string (Status) Enum: "revoked" "not_invited_yet" "invitation_sent" "connected"
country_code required	string (Country code) [ 1 .. 2 ] characters
	object (Country)
external_id	string or null (External id) <= 255 characters
permission_granted	boolean (Permission granted)
is_self_managed	boolean (Is self managed)
contact_name required	string (Contact name) [ 1 .. 255 ] characters
contact_email required	string <email> (Contact email) [ 1 .. 254 ] characters
send_information_request	boolean (Send information request) Default: false
invitation_id	string or null <uuid> (Invitation id)
reciprocal_company_id	integer or null (Reciprocal company id) [ 0 .. 2147483647 ]
	object or null (OwnershipInformation)

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
}

Retrieve a value chain partner

Returns a single value chain partner by ID with full details.

Authorizations:

Bearer

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
}

Update a value chain partner

Partially update an existing value chain partner.

Authorizations:

Bearer

path Parameters

required

string

Request Body schema: application/json
required

company_name required	string (Company name) [ 1 .. 255 ] characters
type required	string (Type) Enum: "supplier" "customer" "investment" "investor" "franchise" "franchisor" "group_member" "group_parent"
description	string or null (Description)
status	string (Status) Enum: "revoked" "not_invited_yet" "invitation_sent" "connected"
country_code required	string (Country code) [ 1 .. 2 ] characters
	object (Country)
external_id	string or null (External id) <= 255 characters
permission_granted	boolean (Permission granted)
is_self_managed	boolean (Is self managed)
contact_name required	string (Contact name) [ 1 .. 255 ] characters
contact_email required	string <email> (Contact email) [ 1 .. 254 ] characters
send_information_request	boolean (Send information request) Default: false
invitation_id	string or null <uuid> (Invitation id)
reciprocal_company_id	integer or null (Reciprocal company id) [ 0 .. 2147483647 ]
	object or null (OwnershipInformation)

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": { },
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
}
}

Response samples

Content type

application/json

{"id": 0,
"company_name": "string",
"type": "supplier",
"description": "string",
"status": "revoked",
"country_code": "st",
"country": {"name": "string",
"alpha_2": "string",
"alpha_3": "string",
"numeric": "string",
"official_name": "string",
"flag": "string",
"eu_status": "string"
},
"external_id": "string",
"permission_granted": true,
"is_self_managed": true,
"contact_name": "string",
"contact_email": "user@example.com",
"send_information_request": false,
"invitation_id": "a6e6785a-3ea9-406c-b873-17eaf2ed5fc9",
"reciprocal_company_id": 2147483647,
"has_account": "string",
"is_invited": "string",
"pulse_params": "string",
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": { },
"assessment_status": "pending",
"tags": ["string"
]
}

Delete a value chain partner

Soft-deletes a single value chain partner by ID.

Authorizations:

Bearer

path Parameters

required

string

Coolset Supply Chain API (1.0)

Order Tracing

List available orders for tracing

Authorizations:

query Parameters

Responses

Response samples

Trace orders to DDS

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

eudr

List due diligence statements

Authorizations:

query Parameters

Responses

Response samples

Create a due diligence statement

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve a due diligence statement

Authorizations:

path Parameters

Responses

Response samples

Update a due diligence statement

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a due diligence statement

Authorizations:

path Parameters

Responses

information-requests

Send an information request

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Send information requests in bulk

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

orders

List orders

Authorizations:

query Parameters

Responses

Response samples

Retrieve an order

Authorizations:

path Parameters

Responses

Response samples

Delete an order

Authorizations:

path Parameters

Responses

Create batch orders

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a batch order

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required