Requireswrite_productaccess scope. More [access
The Update Procurement API allows updating the details of an existing procurement record, such as its supplier, note, or other properties. This enables users to modify procurement data efficiently.This API is especially useful for:
- Updating supplier or notes information for procurement records.
- Managing and tracking procurement details over time.
- Reviewing procurement notes and updates for auditing.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| id | string | Yes | 382454149549138220 | The unique identifier of the procurement record to update. |
Body Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| procurement | object | No | ||
| procurement.supplier_id | string | No | "382453603865993516" | The unique identifier of the supplier. |
| procurement.note | string | No | "test note" | Notes or additional details about the procurement. |
Response Explanation
Public Response Parameters
Success Response
Parameter | Type | Example | Description |
|---|---|---|---|
procurement.id | string | "382451985837728044" | The unique identifier of the procurement. |
procurement.procurement_sn | string | "00000002" | The procurement serial number. |
procurement.supplier_id | string | "382453603865993516" | The unique identifier of the supplier associated with the procurement. |
procurement.location_id | string | "190035786870033452" | The unique identifier of the location associated with the procurement. |
procurement.note | string | "teest note" | Notes or additional details about the procurement. |
procurement.state | integer | 4 | The state of the procurement:
|
procurement.pending_quantity | integer | 0 | The quantity of items still pending delivery. |
procurement.received_quantity | integer | 0 | The quantity of items received. |
procurement.rejected_quantity | integer | 0 | The quantity of items rejected. |
procurement.transfer_quantity | integer | 0 | The quantity of items transferred. |
procurement.created_by | string | "" | The user who created the procurement record. |
procurement.created_at | string | "2024-05-21T08:47:39Z" | The date and time when the procurement was created. |
procurement.updated_at | string | "2024-05-21T09:59:29Z" | The date and time when the procurement was last updated. |
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 | |
| 422 | Invalid or empty supplier_id | missing required supplier_id or supplier_id with incorrect UUID types | { "errors": [ "Supplier not found"]} |
supplier_id is not found | Providedsupplier_id is not found | { "errors": [ "Supplier not found"]} | |
| 404 | procurement_id is not found | Providedprocurement_id is not found | { "errors": [ "Procurement not found"]} |