🔒

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:

1. Fetching procurement records based on specific criteria for management or reporting.
2. Filtering procurement records by state or date range.
3. Managing large procurement datasets with pagination.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all queries are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Query Parameters

Response Explanation

Successful Response

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.

Request Examples

curl --request GET \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/procurements \
     --header 'accept: application/json' \
     --header 'access-token: <YOUR_ACCESS_TOKEN>' \
     --data-urlencode 'page=1' \
     --data-urlencode 'limit=10' \
     --data-urlencode 'state=1' \
     --data-urlencode 'created_at_min=2023-01-01T00:00:00Z' \
     --data-urlencode 'created_at_max=2023-01-31T23:59:59Z'

Success Response Example

{
  "procurements": [
    {
      "id": "454492069793111015",
      "procurement_sn": "00000002",
      "supplier_id": "454466651757222887",
      "location_id": "447078705085299687",
      "note": "1123131231321231231231231231232123123123123131231231231322123",
      "state": 4,
      "pending_quantity": 0,
      "received_quantity": 0,
      "rejected_quantity": 0,
      "transfer_quantity": 0,
      "created_by": "",
      "created_at": "2024-12-06T03:49:13Z",
      "updated_at": "2024-12-06T16:14:07Z"
    },
    {
      "id": "454492025190882279",
      "procurement_sn": "00000001",
      "supplier_id": "454466651757222887",
      "location_id": "447078705085299687",
      "note": "1",
      "state": 1,
      "pending_quantity": 0,
      "received_quantity": 0,
      "rejected_quantity": 0,
      "transfer_quantity": 0,
      "created_by": "",
      "created_at": "2024-12-06T03:49:03Z",
      "updated_at": "2024-12-06T17:54:05Z"
    }
  ],
  "count": 2
}

Error Response Example

{
  "error": "Supplier not found"}
}

Error Details