🔒
Requires write_product access scope. More access scope

The Cancel Procurement API allows canceling an existing procurement record by its unique identifier (id). This enables users to stop the processing of procurement records that are no longer needed.This API is especially useful for:

Canceling procurements that are no longer required.
Managing procurement workflows by marking records as canceled.
Ensuring accurate inventory and procurement records.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
id	`string`	Yes	`"382451985837728044"`	The unique identifier of the procurement record to cancel.

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

Parameter	Type	Example	Description
procurement.id	`string`	`"382451985837728044"`	The unique identifier of the procurement record.
procurement. procurement_sn	`string`	`"00000002"`	The procurement serial number.
procurement.state	`integer`	`4`	The state of the procurement after cancellation. `4` represents `cancelled`.

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Field	Type	Example	Description
`errors`	Array	`["Supplier not found"]`	A list of errors encountered during the request processing.

Field	Type	Example	Description
`error`	Array	`"error": "store is not active"`	Indicates an error encountered during the process.

Error Details

Status Code	Message	Possible Reason	Example Response
400	Bad Request	Invalid input format or request structure (e.g., missing required fields or incorrect data types).	`{ "errors": [ "invalid procurement_id"]}`
	Unauthorized	The request is missing valid authentication credentials or the credentials provided are invalid.	`Unauthorized`
	Invalid or empty `procurement_id`	missing required `procurement_id` or `procurement_id` with incorrect `UUID` types	`{ "errors": [ "invalid procurement_id"]}`
404	`procurement_id` is not found	Provided`procurement_id` is not found	`{ "errors": [ "Procurement not found"]}`

API Structure Overview