Allows canceling an existing procurement record by its unique identifier (id).
Requireswrite_inventoryaccess scope. More access scope
The Cancel Procurement API marks an existing procurement record as cancelled while preserving its data in the system.
This API is especially useful for:
- Stopping fulfillment of procurement orders that are no longer needed
- Maintaining accurate procurement status tracking
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
procurement_id | string | Yes | Unique identifier of the procurement to cancel | "proc_123456789" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
data.procurements | array[object] | - | List of procurement objects |
data.cursor | string | "def456" | Pagination token |
data.has_more | boolean | true | More results available |
Procurement Object
Parameter | Type | Example | Description |
|---|---|---|---|
| string |
| Unique procurement ID |
| string |
| Procurement serial number |
| string |
| Supplier reference ID |
| string |
| Warehouse location ID |
| string |
| Procurement notes |
| int32 |
| Current state (1-4) |
| int32 |
| Items awaiting receipt |
| int32 |
| Items successfully received |
| int32 |
| Items rejected |
| int32 |
| Items in transit |
| string |
| Creator user ID |
| string |
| Creation timestamp |
| string |
| Last update timestamp |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |