Get Procurement List

🔒
Requires read_inventory access scope. More access scope

The Get Procurement List API allows users to retrieves a paginated list of procurement records with filtering capabilities.

This API is especially useful for:

Request Parameters

📘
Public Request Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Pagination cursor	`"abc123"`
`page_size`	int32	No	Results per page (1-100)	`50`
`ids`	array[string]	No	Filter by procurement IDs	`["proc_123","proc_456"]`
`state`	int32	No	Procurement state filter. Accepted values: 1 (waiting for stock), 2 (partial receipt), 3 (complete receipt), 4 (cancelled).	`2`
`created_at_min`	string	No	Filter records created after (ISO-8601)	`"2023-01-01T00:00:00Z"`
`created_at_max`	string	No	Filter records created before (ISO-8601)	`"2023-12-31T23:59:59Z"`
`updated_at_min`	string	No	Filter records updated after (ISO-8601)	`"2023-06-01T00:00:00Z"`
`updated_at_max`	string	No	Filter records updated before (ISO-8601)	`"2023-06-30T23:59:59Z"`

📘
Public Response Parameters

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

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

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message