Update Procurement

Allows updating the details of an existing procurement record, such as its supplier, note, or other properties.

🔒

Requires write_inventory access scope. More access scope

The Update Procurement API allows users to modifies an existing procurement record with updated supplier information or additional notes.

This API is especially useful for:

  1. Changing supplier associations for procurement orders.
  2. Adding contextual notes to procurement records.
  3. Maintaining accurate procurement documentation.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredDescriptionExample
procurement_idstringYesUnique identifier of the procurement record"proc_123456789"

Body Parameters

ParameterTypeRequiredDescriptionExample
procurementobjectYesContainer for procurement updates-
procurement.supplier_idstringNoNew supplier identifier"supp_987654321"
procurement.notestringNoAdditional procurement comments"Urgent order - prioritize shipping"

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"success"Status code of the API response
messagestring"Order retrieved successfully"Descriptive message about the response
data.procurementsarray[object]-List of procurement objects
data.cursorstring"def456"Pagination token
data.has_morebooleantrueMore results available

Procurement Object

Parameter

Type

Example

Description

id

string

"proc_123"

Unique procurement ID

procurement_sn

string

"PO-2023-001"

Procurement serial number

supplier_id

string

"sup_456"

Supplier reference ID

location_id

string

"wh_789"

Warehouse location ID

note

string

"Urgent order"

Procurement notes

state

int32

2

Current state (1-4)
1 : pending
2 : partial
3 : completed
4 : cancelled

pending_quantity

int32

50

Items awaiting receipt

received_quantity

int32

100

Items successfully received

rejected_quantity

int32

2

Items rejected

transfer_quantity

int32

0

Items in transit

created_by

string

"user_123"

Creator user ID

created_at

string

"2023-06-15T10:30:00Z"

Creation timestamp

updated_at

string

"2023-06-16T09:15:00Z"

Last update timestamp

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!