Coolset Supply Chain API (1.0)

Download OpenAPI specification:Download

E-mail: [email protected] URL: https://coolset.com

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

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 <date-time>
created_at__gte	string <date-time>
created_at__lte	string <date-time>
dds_identifier	string
dds_identifier__icontains	string
dds_identifier__in	Array of strings Multiple values may be separated by commas.
id	integer
id__exclude_in	Array of integers Exclude DDSs with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
limit	integer Number of results to return per page.
name	string
name__icontains	string
name__in	Array of strings Multiple values may be separated by commas.
object_pulse_identifier	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
orders__in	Array of integers Only DDSs with an attachment to any of these order ids (CSV).
products__in	Array of integers Only DDSs with an attachment to any of these product ids (CSV).
search	string A search term.
status	string Enum: "complete" "draft" "failed" "in_progress" Lifecycle status. EUTR is always COMPLETE. PPWR starts DRAFT and transitions to COMPLETE when the FE PATCHes after the data-room survey submits. An EUDR statement retrieved from an existing EU TRACES filing starts IN_PROGRESS while the background round-trip runs, then goes COMPLETE, or FAILED with the reason in dds_data; one we submit ourselves also runs IN_PROGRESS until EU TRACES accepts the filing. `draft` - draft `in_progress` - in_progress `complete` - complete `failed` - failed
status__in	Array of strings Multiple values may be separated by commas.
type	string Enum: "EUDR" "EUTR" "PPWR" Type of Due Diligence Statement (EUDR, EUTR, PPWR) `EUDR` - EUDR `EUTR` - EUTR `PPWR` - PPWR
type__in	Array of strings Multiple values may be separated by commas.
updated_at	string <date-time>
updated_at__gte	string <date-time>
updated_at__lte	string <date-time>

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": 0,
"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"dds_data": null,
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": {"eu_traces_status": "AVAILABLE",
"eu_traces_status_observed_at": "2026-08-25T12:00:01Z",
"submitted_at": "2026-08-25T12:00:00Z",
"was_filed": true
},
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a due diligence statement

Create a Due Diligence Statement. orders and products are optional; only orders the company buys and products it owns may be attached. assessment_run_ids is a point-in-time pin and cannot be changed afterwards. name is an optional free-text label.

type=EUDR with a dds_identifier retrieves a statement already filed with EU TRACES. That retrieval runs in the background, so the response returns immediately as in_progress with an empty dds_data, and the statement later moves to complete with the retrieved data — or failed, with the reason in dds_data. Without an identifier we file it ourselves: assessment_run_ids is required and it likewise comes back in_progress, gaining the TRACES-assigned dds_identifier once filed and moving to complete once EU TRACES returns the statement.

type=PPWR requires assessment_run_ids and dds_identifier, and is created draft. type=EUTR mints its identifier and is created complete.

Authorizations:

Bearer

Request Body schema:
application/json
required

type required	string Enum: "EUDR" "EUTR" "PPWR" The regulation the statement is filed under. `EUDR` - EUDR `EUTR` - EUTR `PPWR` - PPWR
name	string or null <= 255 characters Optional user-chosen name for the statement. Searchable and orderable.
status	string Enum: "draft" "in_progress" "complete" "failed" Lifecycle status. EUTR is always COMPLETE. PPWR starts DRAFT and transitions to COMPLETE when the FE PATCHes after the data-room survey submits. An EUDR statement retrieved from an existing EU TRACES filing starts IN_PROGRESS while the background round-trip runs, then goes COMPLETE, or FAILED with the reason in dds_data; one we submit ourselves also runs IN_PROGRESS until EU TRACES accepts the filing. `draft` - draft `in_progress` - in_progress `complete` - complete `failed` - failed
dds_identifier	string
orders	Array of integers Optional orders to attach; supplying them writes the join rows.
products	Array of integers Optional products to attach; supplying them writes the join rows.
assessment_run_ids	Array of strings <uuid> [ items <uuid > ] assessment_run_id UUIDs that support this statement, pinned at creation time and immutable afterwards. Required and non-empty for type=PPWR, and for type=EUDR when no dds_identifier is supplied. Not required for type=EUDR with a dds_identifier (the statement is retrieved from EU TRACES and may predate any assessment). Ignored for type=EUTR.
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"excluded_propagation_identifiers": null
}

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"dds_data": null,
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": {"eu_traces_status": "AVAILABLE",
"eu_traces_status_observed_at": "2026-08-25T12:00:01Z",
"submitted_at": "2026-08-25T12:00:00Z",
"was_filed": true
},
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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 detail, including nested detail for its actively attached orders (orders_detail) and products (products_detail).

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Due Diligence Statement.

Responses

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"dds_data": null,
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": {"eu_traces_status": "AVAILABLE",
"eu_traces_status_observed_at": "2026-08-25T12:00:01Z",
"submitted_at": "2026-08-25T12:00:00Z",
"was_filed": true
},
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"orders_detail": [{"id": 0,
"type": "order",
"buyer_external_id": "string",
"seller_external_id": "string",
"border_cross_country_code": "string",
"buyer_company_id": 0,
"seller_company_id": 0,
"order_created_at": "2019-08-24",
"order_arrival_at": "2019-08-24",
"buyer_company_status": "draft",
"seller_company_status": "draft",
"assessment_status": "pending"
}
],
"products_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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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 status and name can be changed — any other field is rejected, including the assessment_run_ids pin.

Status transitions are allowed for PPWR and EUDR only; EUTR is locked. draft is never re-entered, and complete and failed are terminal. PPWR goes draft → complete; EUDR goes draft → in_progress → complete or failed. Completing an EUDR statement requests its risk assessment; completing a PPWR DoC refreshes the aggregate assessment and cascades it to the linked products.

Every update pushes a due_diligence_statement_updated websocket event on the company's general channel.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Due Diligence Statement.

Request Body schema:
application/json

type	string Enum: "EUDR" "EUTR" "PPWR" The regulation the statement is filed under. `EUDR` - EUDR `EUTR` - EUTR `PPWR` - PPWR
name	string or null <= 255 characters Optional user-chosen name for the statement. Searchable and orderable.
status	string Enum: "draft" "in_progress" "complete" "failed" Lifecycle status. EUTR is always COMPLETE. PPWR starts DRAFT and transitions to COMPLETE when the FE PATCHes after the data-room survey submits. An EUDR statement retrieved from an existing EU TRACES filing starts IN_PROGRESS while the background round-trip runs, then goes COMPLETE, or FAILED with the reason in dds_data; one we submit ourselves also runs IN_PROGRESS until EU TRACES accepts the filing. `draft` - draft `in_progress` - in_progress `complete` - complete `failed` - failed
dds_identifier	string
orders	Array of integers Optional orders to attach; supplying them writes the join rows.
products	Array of integers Optional products to attach; supplying them writes the join rows.
assessment_run_ids	Array of strings <uuid> [ items <uuid > ] assessment_run_id UUIDs that support this statement, pinned at creation time and immutable afterwards. Required and non-empty for type=PPWR, and for type=EUDR when no dds_identifier is supplied. Not required for type=EUDR with a dds_identifier (the statement is retrieved from EU TRACES and may predate any assessment). Ignored for type=EUTR.
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"excluded_propagation_identifiers": null
}

Response samples

Content type

application/json

{"id": 0,
"type": "EUDR",
"name": "string",
"status": "draft",
"dds_identifier": "string",
"dds_data": null,
"orders": [0
],
"products": [0
],
"assessment_run_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metadata": {"eu_traces_status": "AVAILABLE",
"eu_traces_status_observed_at": "2026-08-25T12:00:01Z",
"submitted_at": "2026-08-25T12:00:00Z",
"was_filed": true
},
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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. Pushes a due_diligence_statement_deleted websocket event on the company's general channel.

?has_withdraw_request=true also withdraws the statement from EU TRACES in the background. Only an EUDR statement Coolset filed itself can be withdrawn; otherwise 400 and nothing is deleted. The outcome lands in the deleted statement's metadata.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Due Diligence Statement.

query Parameters

has_withdraw_request

boolean

Default: false

Also withdraw the statement from EU TRACES. Only an EUDR statement Coolset filed itself can be withdrawn; anything else is rejected with 400 and nothing is deleted. The withdrawal runs in the background and its outcome is recorded in the deleted statement's metadata.

Responses

List available orders for tracing

List orders available for tracing to Due Diligence Statements

Authorizations:

Bearer

query Parameters

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

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"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

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
}
}

information-requests

information_requests_create

Create an information request for a specific order

Authorizations:

Bearer

Request Body schema:
application/json

order_id	integer
value_chain_id	integer

Responses

Request samples

Payload

Content type

application/json

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

Bulk create information requests (record list, deprecated) Deprecated

Deprecated record-oriented bulk create: takes an explicit list of at most 100 requests, each naming its own order_id or value_chain_id. Migrate to POST /information-requests/bulk-create/, which selects the targets server-side by filter and so has no list ceiling.

Authorizations:

Bearer

Request Body schema:
application/json
required

required

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

List of information requests to create

Array ([ 1 .. 100 ] items)

order_id	integer
value_chain_id	integer

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 — must be either 'buying' (orders where the authenticated company is the buyer) or 'selling' (orders where it is the seller). Requests without it are rejected with 400 {"order_action": ["This field is required."]}. 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, item traced origins, or passing/failing percentage. Use search to match buyer_external_id, seller_external_id, or tag names.

Authorizations:

Bearer

query Parameters

assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
border_cross_country_code	string
border_cross_country_code__in	Array of strings Multiple values may be separated by commas.
buyer_company_status	string Enum: "closed" "completed" "draft" "ready_for_review" "statement_ready" "waiting_for_supplier" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
buyer_company_status__in	Array of strings Multiple values may be separated by commas.
due_diligence_statements__isnull	boolean true: orders with no active attached DDS; false: orders with at least one. Soft-deleted statements do not count.
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
id	integer
id__exclude_in	Array of integers Exclude orders with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
items__buyer_product	integer
items__buyer_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
items__buyer_product__commodity__in	Array of strings Multiple values may be separated by commas.
items__buyer_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
items__buyer_product__composition__in	Array of strings Multiple values may be separated by commas.
items__buyer_product__in	Array of integers Multiple values may be separated by commas.
items__buyer_product__isnull	boolean
items__buyer_product__name	string
items__buyer_product__name__endswith	string
items__buyer_product__name__icontains	string
items__buyer_product__name__startswith	string
items__buyer_product__sku	string
items__buyer_product__sku__endswith	string
items__buyer_product__sku__icontains	string
items__buyer_product__sku__startswith	string
items__external_id	string
items__external_id__endswith	string
items__external_id__icontains	string
items__external_id__in	Array of strings Multiple values may be separated by commas.
items__external_id__startswith	string
items__seller_product	integer
items__seller_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
items__seller_product__commodity__in	Array of strings Multiple values may be separated by commas.
items__seller_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
items__seller_product__composition__in	Array of strings Multiple values may be separated by commas.
items__seller_product__in	Array of integers Multiple values may be separated by commas.
items__seller_product__isnull	boolean
items__seller_product__name	string
items__seller_product__name__endswith	string
items__seller_product__name__icontains	string
items__seller_product__name__startswith	string
items__seller_product__sku	string
items__seller_product__sku__endswith	string
items__seller_product__sku__icontains	string
items__seller_product__sku__startswith	string
items__traced_origins	integer Orders with at least one item traced to the given origin
items__traced_origins__in	Array of integers Orders with at least one item traced to any of the given origins (CSV)
items__unit	string
items__volume	number <float>
items__volume__gte	number <float>
items__volume__lte	number <float>
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
order_action required	string Enum: "buying" "selling" Required. The perspective to read orders from: 'buying' returns orders where the authenticated company is the buyer, 'selling' where it is the seller. Requests that omit it are rejected with 400. `buying` - buying `selling` - selling
order_arrival_at	string <date>
order_arrival_at__gte	string <date>
order_arrival_at__lte	string <date>
order_created_at	string <date>
order_created_at__gte	string <date>
order_created_at__lte	string <date>
ordering	string Which field to use when ordering the results.
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
search	string Free-text search across buyer_external_id, seller_external_id
seller_company_status	string Enum: "closed" "completed" "draft" "failing" "passing" "pending" "untraced" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
seller_company_status__in	Array of strings Multiple values may be separated by commas.
tags__name	string
tags__name__icontains	string
tags__name__in	Array of strings Multiple values may be separated by commas.
tags__slug	string
tags__slug__in	Array of strings Multiple values may be separated by commas.
type	string Enum: "manufactured_batch" "order" "produced_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
type__in	Array of strings Multiple values may be separated by commas.
value_chain	integer

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [{"id": 0,
"company_id": 0,
"type": "EUDR",
"name": "string",
"dds_identifier": "string",
"dds_data": null,
"status": "draft",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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"
}
]
}

orders_create

Supply chain orders (purchase and sale) with their line items and value chain associations.

Authorizations:

Bearer

Request Body schema:
application/json
required

company_id required	integer [ 0 .. 2147483647 ]
type required	string (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id required	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at required	string <date>
order_arrival_at	string or null <date>
buyer_company_status	string (BuyerCompanyStatusEnum) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
seller_company_status	string (SellerCompanyStatusEnum) Enum: "draft" "untraced" "pending" "passing" "failing" "completed" "closed" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
value_chain	integer or null
buyer_company_id	integer or null [ 0 .. 2147483647 ]
seller_company_id	integer or null [ 0 .. 2147483647 ]
signed_off_at	string or null <date-time>
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
tags required	Array of strings[ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"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",
"value_chain": 0,
"buyer_company_id": 2147483647,
"seller_company_id": 2147483647,
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"tags": ["string"
]
}

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [{"id": 0,
"company_id": 0,
"type": "EUDR",
"name": "string",
"dds_identifier": "string",
"dds_data": null,
"status": "draft",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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. Requires the same order_action (buying|selling) query parameter as the list endpoint, since the filterset is applied to detail lookups too.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Order.

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [{"id": 0,
"company_id": 0,
"type": "EUDR",
"name": "string",
"dds_identifier": "string",
"dds_data": null,
"status": "draft",
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Order.

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 (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id required	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at required	string <date>
order_arrival_at	string or null <date>
buyer_company_status	string (BuyerCompanyStatusEnum) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
seller_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
signed_off_at	string or null <date-time>
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any

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,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null
}

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"assessment_summary": null,
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Order.

Request Body schema:
application/json

type	string (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at	string <date>
order_arrival_at	string or null <date>
buyer_company_status	string (BuyerCompanyStatusEnum) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
seller_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
signed_off_at	string or null <date-time>
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any

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,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null
}

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"assessment_summary": null,
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null,
"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 (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id required	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at required	string <date>
order_arrival_at	string or null <date>
buyer_company_status	string (BuyerCompanyStatusEnum) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
value_chain	integer or null
seller_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
send_information_request	boolean Default: false
signed_off_at	string or null <date-time>
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any
dds_identifiers	Array of strings[ items non-empty ]

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,
"seller_company_id": 2147483647,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null,
"dds_identifiers": ["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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"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"
},
"excluded_propagation_identifiers": null,
"assessment_summary": null,
"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

integer

A unique integer value identifying this Order.

Request Body schema:
application/json

type	string (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at	string <date>
order_arrival_at	string or null <date>
buyer_company_status	string (BuyerCompanyStatusEnum) Enum: "draft" "waiting_for_supplier" "ready_for_review" "statement_ready" "completed" "closed" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
value_chain	integer or null
seller_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
send_information_request	boolean Default: false
signed_off_at	string or null <date-time>
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any
dds_identifiers	Array of strings[ items non-empty ]

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,
"seller_company_id": 2147483647,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null,
"dds_identifiers": ["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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"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"
},
"excluded_propagation_identifiers": null,
"assessment_summary": null,
"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 (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id required	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at required	string <date>
order_arrival_at	string or null <date>
seller_company_status	string (SellerCompanyStatusEnum) Enum: "draft" "untraced" "pending" "passing" "failing" "completed" "closed" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
assessment_status	string (AssessmentStatusEnum) Enum: "pending" "in_progress" "passing" "failing" "mitigated" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
value_chain	integer or null
buyer_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
send_information_request	boolean Default: false
signed_off_at	string or null <date-time>
dds_identifiers	Array of strings[ items non-empty ]
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any

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,
"buyer_company_id": 2147483647,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null
}

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"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"
},
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Order.

Request Body schema:
application/json

type	string (Type6f8Enum) Enum: "order" "produced_batch" "manufactured_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
external_id	string [ 1 .. 255 ] characters
buyer_external_id	string or null [ 1 .. 255 ] characters
seller_external_id	string or null [ 1 .. 255 ] characters
order_created_at	string <date>
order_arrival_at	string or null <date>
seller_company_status	string (SellerCompanyStatusEnum) Enum: "draft" "untraced" "pending" "passing" "failing" "completed" "closed" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
assessment_status	string (AssessmentStatusEnum) Enum: "pending" "in_progress" "passing" "failing" "mitigated" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
value_chain	integer or null
buyer_company_id	integer or null [ 0 .. 2147483647 ]
	Array of objects (NestedOrderItemRequest)
send_information_request	boolean Default: false
signed_off_at	string or null <date-time>
dds_identifiers	Array of strings[ items non-empty ]
border_cross_country_code	string or null <= 2 characters Country code of the border crossing country
excluded_propagation_identifiers	any

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,
"buyer_company_id": 2147483647,
"items": [{"id": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"trace": {"traced_orders": [0
],
"traced_origins": [0
]
},
"excluded_propagation_identifiers": null
}
],
"send_information_request": false,
"signed_off_at": "2019-08-24T14:15:22Z",
"dds_identifiers": ["string"
],
"border_cross_country_code": "st",
"excluded_propagation_identifiers": null
}

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"metadata": {"percentage_estimation_or_deviation": "2.5",
"supplementary_unit": "12.5",
"supplementary_unit_qualifier": "MTQ"
},
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"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": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"signed_off_at": "2019-08-24T14:15:22Z",
"due_diligence_statements": [[null
]
],
"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"
},
"excluded_propagation_identifiers": null,
"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

assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
border_cross_country_code	string
border_cross_country_code__in	Array of strings Multiple values may be separated by commas.
buyer_company_status	string Enum: "closed" "completed" "draft" "ready_for_review" "statement_ready" "waiting_for_supplier" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
buyer_company_status__in	Array of strings Multiple values may be separated by commas.
delimit_by	string Enum: "daily" "monthly" "yearly" `yearly` - yearly `monthly` - monthly `daily` - daily
due_diligence_statements__isnull	boolean true: orders with no active attached DDS; false: orders with at least one. Soft-deleted statements do not count.
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
group_by	Array of strings Items Enum: "assessment_status" "buyer_company_status" "seller_company_status" "type" "value_chain_id" `type` - type `buyer_company_status` - buyer_company_status `seller_company_status` - seller_company_status `assessment_status` - assessment_status `value_chain_id` - value_chain_id
id	integer
id__exclude_in	Array of integers Exclude orders with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
items__buyer_product	integer
items__buyer_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
items__buyer_product__commodity__in	Array of strings Multiple values may be separated by commas.
items__buyer_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
items__buyer_product__composition__in	Array of strings Multiple values may be separated by commas.
items__buyer_product__in	Array of integers Multiple values may be separated by commas.
items__buyer_product__isnull	boolean
items__buyer_product__name	string
items__buyer_product__name__endswith	string
items__buyer_product__name__icontains	string
items__buyer_product__name__startswith	string
items__buyer_product__sku	string
items__buyer_product__sku__endswith	string
items__buyer_product__sku__icontains	string
items__buyer_product__sku__startswith	string
items__external_id	string
items__external_id__endswith	string
items__external_id__icontains	string
items__external_id__in	Array of strings Multiple values may be separated by commas.
items__external_id__startswith	string
items__seller_product	integer
items__seller_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
items__seller_product__commodity__in	Array of strings Multiple values may be separated by commas.
items__seller_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
items__seller_product__composition__in	Array of strings Multiple values may be separated by commas.
items__seller_product__in	Array of integers Multiple values may be separated by commas.
items__seller_product__isnull	boolean
items__seller_product__name	string
items__seller_product__name__endswith	string
items__seller_product__name__icontains	string
items__seller_product__name__startswith	string
items__seller_product__sku	string
items__seller_product__sku__endswith	string
items__seller_product__sku__icontains	string
items__seller_product__sku__startswith	string
items__traced_origins	integer Orders with at least one item traced to the given origin
items__traced_origins__in	Array of integers Orders with at least one item traced to any of the given origins (CSV)
items__unit	string
items__volume	number <float>
items__volume__gte	number <float>
items__volume__lte	number <float>
order_action required	string Enum: "buying" "selling" Required. The perspective to read orders from: 'buying' returns orders where the authenticated company is the buyer, 'selling' where it is the seller. Requests that omit it are rejected with 400. `buying` - buying `selling` - selling
order_arrival_at	string <date>
order_arrival_at__gte	string <date>
order_arrival_at__lte	string <date>
order_created_at	string <date>
order_created_at__gte	string <date>
order_created_at__lte	string <date>
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
search	string Free-text search across buyer_external_id, seller_external_id
seller_company_status	string Enum: "closed" "completed" "draft" "failing" "passing" "pending" "untraced" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
seller_company_status__in	Array of strings Multiple values may be separated by commas.
tags__name	string
tags__name__icontains	string
tags__name__in	Array of strings Multiple values may be separated by commas.
tags__slug	string
tags__slug__in	Array of strings Multiple values may be separated by commas.
type	string Enum: "manufactured_batch" "order" "produced_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
type__in	Array of strings Multiple values may be separated by commas.
value_chain	integer

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",
"value_chain_id": 0
}
]

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 id, name, country code, country name, assessment status, or created/updated time.

Authorizations:

Bearer

query Parameters

assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
country_code	string
country_code__in	Array of strings Multiple values may be separated by commas.
created_at	string <date-time>
created_at__date	string <date>
created_at__date__gte	string <date>
created_at__date__lte	string <date>
created_at__gte	string <date-time>
created_at__lte	string <date-time>
description	string
description__endswith	string
description__icontains	string
description__iendswith	string
description__istartswith	string
description__startswith	string
external_id	string
external_id__endswith	string
external_id__icontains	string
external_id__iendswith	string
external_id__in	Array of strings Multiple values may be separated by commas.
external_id__istartswith	string
external_id__startswith	string
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
id__exclude_in	Array of integers Exclude origins with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
limit	integer Number of results to return per page.
name	string
name__endswith	string
name__icontains	string
name__iendswith	string
name__istartswith	string
name__startswith	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
search	string Free-text search across name, description
updated_at	string <date-time>
updated_at__date	string <date>
updated_at__date__gte	string <date>
updated_at__date__lte	string <date>
updated_at__gte	string <date-time>
updated_at__lte	string <date-time>

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
]
}

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 [ 1 .. 255 ] characters
description	string or null
country_code required	string [ 1 .. 2 ] characters
location	any
external_id	string or null <= 255 characters
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"country_code": "st",
"location": null,
"external_id": "string",
"excluded_propagation_identifiers": null
}

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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}

Retrieve an origin

Returns a single origin by ID with full details.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Origin.

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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}

Update an origin

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

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Origin.

Request Body schema:
application/json

name	string [ 1 .. 255 ] characters
description	string or null
country_code	string [ 1 .. 2 ] characters
location	any
external_id	string or null <= 255 characters
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"country_code": "st",
"location": null,
"external_id": "string",
"excluded_propagation_identifiers": null
}

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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}

Delete an origin

Soft-deletes a single origin by ID.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Origin.

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, SKU, commodity, type, or composition.

Authorizations:

Bearer

query Parameters

assessment_identifier__in	Array of strings Products whose assessment_summary.assessment_runs references any of the given identifiers, e.g. scranton$Product$123 (CSV)
assessment_run_id__contains	Array of strings Products whose assessment_summary.assessment_runs contains all of the given assessment run ids (CSV, AND)
assessment_run_id__in	Array of strings Products whose assessment_summary.assessment_runs contains any of the given assessment run ids (CSV, OR)
assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
assessment_status__isnull	boolean
commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
commodity__in	Array of strings Multiple values may be separated by commas.
common_name	string
common_name__endswith	string
common_name__icontains	string
common_name__isnull	boolean
common_name__startswith	string
composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
composition__in	Array of strings Multiple values may be separated by commas.
description	string
description__endswith	string
description__icontains	string
description__isnull	boolean
description__startswith	string
due_diligence_statements__isnull	boolean true: products with no active attached DDS; false: products with at least one. Soft-deleted statements do not count.
external_id	string
external_id__endswith	string
external_id__icontains	string
external_id__in	Array of strings Multiple values may be separated by commas.
external_id__startswith	string
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
hs_code	string
hs_code__endswith	string
hs_code__icontains	string
hs_code__in	Array of strings Multiple values may be separated by commas.
hs_code__startswith	string
id	integer
id__exclude_in	Array of integers Exclude products with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
is_included_in_order	boolean true: products referenced by at least one active order item (buyer or seller side); false: products referenced by none
limit	integer Number of results to return per page.
metadata__species__common_name	string Items whose metadata.species has an entry with this exact common_name.
metadata__species__scientific_name	string Items whose metadata.species has an entry with this exact scientific_name.
name	string
name__endswith	string
name__icontains	string
name__iendswith	string
name__istartswith	string
name__startswith	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
scientific_name	string
scientific_name__endswith	string
scientific_name__icontains	string
scientific_name__isnull	boolean
scientific_name__startswith	string
search	string Free-text search across sku, name
sku	string
sku__endswith	string
sku__icontains	string
sku__iendswith	string
sku__istartswith	string
sku__startswith	string
tags__name	string
tags__name__exclude_in	Array of strings Exclude products tagged with any of the given tag names (CSV, exact match)
tags__name__icontains	string
tags__name__in	Array of strings Multiple values may be separated by commas.
tags__slug	string
tags__slug__in	Array of strings Multiple values may be separated by commas.
type	string Enum: "manufactured" "produced" "purchased" `manufactured` - Manufactured `produced` - Produced `purchased` - Purchased
type__in	Array of strings Multiple values may be separated by commas.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
}
]
}

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 [ 1 .. 100 ] characters
name required	string [ 1 .. 255 ] characters
description	string or null
scientific_name	string or null <= 255 characters
common_name	string or null <= 255 characters
type required	string (TypeFdfEnum) Enum: "manufactured" "produced" "purchased" `manufactured` - Manufactured `produced` - Produced `purchased` - Purchased
hs_code	string or null <= 255 characters
	(CommodityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
composition required	string (CompositionEnum) Enum: "simple" "composite" `simple` - Simple `composite` - Composite
external_id	string or null <= 255 characters
	object Allowed keys: species (list of {scientific_name, common_name} entries). Unknown keys are rejected.
product_components	Array of integers A list of product IDs to set as components.
tags	Array of strings[ items non-empty ]
excluded_propagation_identifiers	any

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"product_components": [0
],
"tags": ["string"
],
"excluded_propagation_identifiers": null
}

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"due_diligence_statements": [[null
]
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Product.

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"due_diligence_statements": [[null
]
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Product.

Request Body schema:
application/json

sku	string [ 1 .. 100 ] characters
name	string [ 1 .. 255 ] characters
description	string or null
scientific_name	string or null <= 255 characters
common_name	string or null <= 255 characters
type	string (TypeFdfEnum) Enum: "manufactured" "produced" "purchased" `manufactured` - Manufactured `produced` - Produced `purchased` - Purchased
hs_code	string or null <= 255 characters
	(CommodityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
composition	string (CompositionEnum) Enum: "simple" "composite" `simple` - Simple `composite` - Composite
external_id	string or null <= 255 characters
	object Allowed keys: species (list of {scientific_name, common_name} entries). Unknown keys are rejected.
product_components	Array of integers A list of product IDs to set as components.
tags	Array of strings[ items non-empty ]
excluded_propagation_identifiers	any

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"product_components": [0
],
"tags": ["string"
],
"excluded_propagation_identifiers": null
}

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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"quantity": 2147483647,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
],
"due_diligence_statements": [[null
]
],
"tags": ["string"
],
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"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

integer

A unique integer value identifying this Product.

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

assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
buyer_product	integer
buyer_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
buyer_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
buyer_product__in	Array of integers Multiple values may be separated by commas.
buyer_product__isnull	boolean
buyer_product__name	string
buyer_product__name__endswith	string
buyer_product__name__icontains	string
buyer_product__name__startswith	string
buyer_product__sku	string
buyer_product__sku__endswith	string
buyer_product__sku__icontains	string
buyer_product__sku__startswith	string
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
id	integer
id__exclude_in	Array of integers Exclude order items with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
limit	integer Number of results to return per page.
metadata__percentage_estimation_or_deviation	number Exact match on metadata.percentage_estimation_or_deviation.
metadata__supplementary_unit	number Exact match on metadata.supplementary_unit.
metadata__supplementary_unit_qualifier	string Enum: "KGM" "LTR" "MTK" "MTQ" "MTR" "NAR" "NPR" "TNE" Exact match on metadata.supplementary_unit_qualifier. `KGM` - Kilograms `LTR` - Litres `MTK` - Square metres `MTQ` - Cubic metres `MTR` - Metres `NAR` - Number of articles `NPR` - Number of pairs `TNE` - Tonnes
offset	integer The initial index from which to return the results.
order	integer
order__buyer_company_status	string Enum: "closed" "completed" "draft" "ready_for_review" "statement_ready" "waiting_for_supplier" `draft` - Draft `waiting_for_supplier` - Waiting for Supplier `ready_for_review` - Ready for Review `statement_ready` - Statement Ready `completed` - Completed `closed` - Closed
order__buyer_company_status__in	Array of strings Multiple values may be separated by commas.
order__in	Array of integers Multiple values may be separated by commas.
order__order_created_at	string <date>
order__order_created_at__gte	string <date>
order__order_created_at__lte	string <date>
order__seller_company_status	string Enum: "closed" "completed" "draft" "failing" "passing" "pending" "untraced" `draft` - Draft `untraced` - Untraced `pending` - Pending `passing` - Passing `failing` - Failing `completed` - Completed `closed` - Closed
order__seller_company_status__in	Array of strings Multiple values may be separated by commas.
order__type	string Enum: "manufactured_batch" "order" "produced_batch" "product_chain" `order` - Order `produced_batch` - Produced Batch `manufactured_batch` - Manufactured Batch `product_chain` - Product Chain
order__type__in	Array of strings Multiple values may be separated by commas.
ordering	string Which field to use when ordering the results.
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
search	string Free-text search across external_id, order__seller_external_id, buyer_product__name, seller_product__name
seller_product	integer
seller_product__commodity	string or null Enum: "cattle" "cocoa" "coffee" "palm_oil" "rubber" "soya" "wood" `cattle` - Cattle `cocoa` - Cocoa `coffee` - Coffee `palm_oil` - Palm Oil `rubber` - Rubber `soya` - Soya `wood` - Wood
seller_product__composition	string Enum: "composite" "simple" `simple` - Simple `composite` - Composite
seller_product__in	Array of integers Multiple values may be separated by commas.
seller_product__isnull	boolean
seller_product__name	string
seller_product__name__endswith	string
seller_product__name__icontains	string
seller_product__name__startswith	string
seller_product__sku	string
seller_product__sku__endswith	string
seller_product__sku__icontains	string
seller_product__sku__startswith	string
trace_suggestions_exists	boolean Filter to items that have an acceptable exact-SKU trace suggestion (true), or those still needing manual mapping (false).
traced_orders_exists	boolean Filter by whether order item has any traced orders (true/false)
traced_origins_exists	boolean Filter by whether order item has any traced origins (true/false)
unit	string
volume	number <float>
volume__gte	number <float>
volume__lte	number <float>

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": 0,
"order": 0,
"order_detail": {"id": 0,
"type": "order",
"buyer_external_id": "string",
"seller_external_id": "string",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"traced_orders_detail": [{"id": 0,
"type": "order",
"buyer_external_id": "string",
"seller_external_id": "string",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
}
],
"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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"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

integer

A unique integer value identifying this Order Item.

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",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"traced_orders_detail": [{"id": 0,
"type": "order",
"buyer_external_id": "string",
"seller_external_id": "string",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
}
],
"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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"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

integer

A unique integer value identifying this Order Item.

Request Body schema:
application/json

order	integer
buyer_product	integer or null
seller_product	integer or null
volume	number <double>
unit	string [ 1 .. 3 ] characters
line_number	integer or null [ 0 .. 2147483647 ]
external_id	string or null <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"order": 0,
"buyer_product": 0,
"seller_product": 0,
"volume": 0.1,
"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",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"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",
"metadata": {"species": [{"common_name": "Oak",
"scientific_name": "Quercus robur"
}
]
},
"assessment_status": "pending",
"assessment_summary": null,
"excluded_propagation_identifiers": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"tags": ["string"
],
"due_diligence_statements": [[null
]
]
},
"volume": 0.1,
"unit": "str",
"line_number": 2147483647,
"external_id": "string",
"traced_orders_detail": [{"id": 0,
"type": "order",
"buyer_external_id": "string",
"seller_external_id": "string",
"tags": ["string"
],
"border_cross_country_code": "st",
"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": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"excluded_propagation_identifiers": null
}
],
"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": null,
"external_id": "string",
"open_atlas_external_id": "string",
"open_atlas_information": null,
"pulse_params": {"identifier": "string",
"model_identifier": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null
}
],
"is_complete_match": true,
"seller_traced_suggestions": {"property1": null,
"property2": null
},
"pulse_params": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"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

assessment_status	string Enum: "failing" "in_progress" "mitigated" "passing" "pending" `pending` - Pending `in_progress` - In progress `passing` - Passing `failing` - Failing `mitigated` - Mitigated
assessment_status__in	Array of strings Multiple values may be separated by commas.
company_name	string
company_name__endswith	string
company_name__icontains	string
company_name__startswith	string
contact_email	string
contact_email__endswith	string
contact_email__icontains	string
contact_email__startswith	string
contact_name	string
contact_name__endswith	string
contact_name__icontains	string
contact_name__startswith	string
country_code	string
country_code__in	Array of strings Multiple values may be separated by commas.
description	string
description__endswith	string
description__icontains	string
description__startswith	string
external_id	string
external_id__endswith	string
external_id__icontains	string
external_id__in	Array of strings Multiple values may be separated by commas.
external_id__startswith	string
failing_percentage_gte	number <double> Filter by minimum failing percentage (0-100)
id	integer
id__exclude_in	Array of integers Exclude value chains with any of the given IDs (CSV)
id__in	Array of integers Multiple values may be separated by commas.
is_self_managed	boolean
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
passing_percentage_gte	number <double> Filter by minimum passing percentage (0-100)
permission_granted	boolean
search	string Free-text search across company_name, contact_name
status	string Enum: "connected" "in_review" "invitation_sent" "not_invited_yet" "revoked" `revoked` - Revoked `not_invited_yet` - Not invited yet `in_review` - In review `invitation_sent` - Invitation sent `connected` - Connected
status__in	Array of strings Multiple values may be separated by commas.
tags__name	string
tags__name__icontains	string
tags__name__in	Array of strings Multiple values may be separated by commas.
tags__slug	string
tags__slug__in	Array of strings Multiple values may be separated by commas.
type	string Enum: "customer" "franchise" "franchisor" "group_member" "group_parent" "investment" "investor" "supplier" `supplier` - Supplier `customer` - Customer `investment` - Investment `investor` - Investor `franchise` - Franchise `franchisor` - Franchisor `group_member` - Group Member `group_parent` - Group Parent
type__in	Array of strings Multiple values may be separated by commas.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"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 [ 1 .. 255 ] characters
type required	string (Type526Enum) Enum: "supplier" "customer" "investment" "investor" "franchise" "franchisor" "group_member" "group_parent" `supplier` - Supplier `customer` - Customer `investment` - Investment `investor` - Investor `franchise` - Franchise `franchisor` - Franchisor `group_member` - Group Member `group_parent` - Group Parent
description	string or null
country_code required	string [ 1 .. 2 ] characters
external_id	string or null <= 255 characters
is_self_managed	boolean
contact_name required	string [ 1 .. 255 ] characters
contact_email required	string <email> non-empty
send_information_request	boolean Default: false
	object or null
	object Allowed keys: requested_by_user_id (int), contacts (dict), invitation_ids (list). Unknown keys are rejected.
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"type": "supplier",
"description": "string",
"country_code": "st",
"external_id": "string",
"is_self_managed": true,
"contact_name": "string",
"contact_email": "[email protected]",
"send_information_request": false,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"excluded_propagation_identifiers": null
}

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"tags": ["string"
]
}

Retrieve a value chain partner

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

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Value Chain.

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"tags": ["string"
]
}

Update a value chain partner

Partially update an existing value chain partner.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Value Chain.

Request Body schema:
application/json

company_name	string [ 1 .. 255 ] characters
type	string (Type526Enum) Enum: "supplier" "customer" "investment" "investor" "franchise" "franchisor" "group_member" "group_parent" `supplier` - Supplier `customer` - Customer `investment` - Investment `investor` - Investor `franchise` - Franchise `franchisor` - Franchisor `group_member` - Group Member `group_parent` - Group Parent
description	string or null
country_code	string [ 1 .. 2 ] characters
external_id	string or null <= 255 characters
is_self_managed	boolean
contact_name	string [ 1 .. 255 ] characters
contact_email	string <email> non-empty
send_information_request	boolean Default: false
	object or null
	object Allowed keys: requested_by_user_id (int), contacts (dict), invitation_ids (list). Unknown keys are rejected.
excluded_propagation_identifiers	any

Responses

Request samples

Payload

Content type

application/json

{"company_name": "string",
"type": "supplier",
"description": "string",
"country_code": "st",
"external_id": "string",
"is_self_managed": true,
"contact_name": "string",
"contact_email": "[email protected]",
"send_information_request": false,
"ownership_information": {"ownership_periods": [{"valid_from_month": "string",
"valid_to_month": "string",
"consolidation_approach": "equity_share",
"ownership_percentage": "100"
}
],
"sector_code": "string",
"notes": "string"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"excluded_propagation_identifiers": null
}

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": "[email protected]",
"reciprocal_company_id": 0,
"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"
},
"metadata": {"contacts": {"[email protected]": {"invitation_id": "3f1c...",
"name": "Jane Doe"
}
},
"invitation_ids": ["3f1c..."
],
"requested_by_user_id": 42
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"assessment_summary": null,
"assessment_status": "pending",
"excluded_propagation_identifiers": null,
"tags": ["string"
]
}

Delete a value chain partner

Soft-deletes a single value chain partner by ID.

Authorizations:

Bearer

path Parameters

required

integer

A unique integer value identifying this Value Chain.

Coolset Supply Chain API (1.0)

eudr

List due diligence statements

Authorizations:

query Parameters

Responses

Response samples

Create a due diligence statement

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/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/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Delete a due diligence statement

Authorizations:

path Parameters

query Parameters

Responses

List available orders for tracing

Authorizations:

query Parameters

Responses

Response samples

Trace orders to DDS

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

information-requests

information_requests_create

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Bulk create information requests (record list, deprecated) Deprecated

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

orders

List orders

Authorizations:

query Parameters

Responses

Response samples

orders_create

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

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/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json