Requires read_product access scope. More access scope
The List Procurements API retrieves a list of procurement records with optional filters such as state, creation date, or update date. This API supports pagination to manage large datasets efficiently.This API is especially useful for:
Fetching procurement records based on specific criteria for management or reporting.
Filtering procurement records by state or date range.
Managing large procurement datasets with pagination.
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:
1: Waiting for stock
2: Partial receipt
3: Complete receipt
4: Cancelled
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).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
Invalid or empty Procurement's ID
missing required id or id with incorrect UUID types
{ "errors": [ "invalid id"]}
404
Procurement not found
can't find the Procurement's ID
{ "errors": [ "Procurement not found"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
