List Procurement Items

GET 
/openapi/2022-01/procurements/:id/items

Retrieves the items associated with a given procurement ID.

Request

Path Parameters

id stringrequired

Procurement' ID

Query Parameters

page int32required

Page number for pagination. Must be greater than 0. Default: 1.

limit int32

Number of records per page. Must be greater than 0 and less than 100. Default: 10.

Responses

200

200

application/json

Schema

Schema

countinteger
Default value: 0
Example: 1
items object[]
Array [
idstring
Example: 382706477153919276
procurement_idstring
Example: 382706443201028396
pending_quantityinteger
Default value: 0
Example: 100
received_quantityinteger
Default value: 0
Example: 0
rejected_quantityinteger
Default value: 0
Example: 0
transfer_quantityinteger
Default value: 0
Example: 100
variant_idstring
Example: 4f442546-3a60-43b2-baa5-5e1f07c85464
product_idstring
Example: cbf9e2d2-7f2c-4881-ab7c-abf8e6590592
product_titlestring
Example: test
variant_titlestring
Example:
variant_skustring
Example:
created_atstring
Example: 2024-05-22T01:38:54Z
updated_atstring
Example: 2024-05-22T01:38:54Z
product_image object
srcstring
Example: //img.staticdj.com/c8bf5695d347092d7a010f00182581f7.jpeg
widthinteger
Default value: 0
Example: 710
heightinteger
Default value: 0
Example: 799
altstring
Example:
]

Example

{
  "count": 1,
  "items": [
    {
      "id": "382706477153919276",
      "procurement_id": "382706443201028396",
      "pending_quantity": 100,
      "received_quantity": 0,
      "rejected_quantity": 0,
      "transfer_quantity": 100,
      "variant_id": "4f442546-3a60-43b2-baa5-5e1f07c85464",
      "product_id": "cbf9e2d2-7f2c-4881-ab7c-abf8e6590592",
      "product_title": "test",
      "variant_title": "",
      "variant_sku": "",
      "created_at": "2024-05-22T01:38:54Z",
      "updated_at": "2024-05-22T01:38:54Z",
      "product_image": {
        "src": "//img.staticdj.com/c8bf5695d347092d7a010f00182581f7.jpeg",
        "width": 710,
        "height": 799,
        "alt": ""
      }
    }
  ]
}

Result

{
    "count": 1,
    "items": [
        {
            "id": "382706477153919276",
            "procurement_id": "382706443201028396",
            "pending_quantity": 100,
            "received_quantity": 0,
            "rejected_quantity": 0,
            "transfer_quantity": 100,
            "variant_id": "4f442546-3a60-43b2-baa5-5e1f07c85464",
            "product_id": "cbf9e2d2-7f2c-4881-ab7c-abf8e6590592",
            "product_title": "test",
            "variant_title": "",
            "variant_sku": "",
            "created_at": "2024-05-22T01:38:54Z",
            "updated_at": "2024-05-22T01:38:54Z",
            "product_image": {
                "src": "//img.staticdj.com/c8bf5695d347092d7a010f00182581f7.jpeg",
                "width": 710,
                "height": 799,
                "alt": ""
            }
        }
    ]
}

400

400

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "invalid procurement_id"
  ]
}

Result

{
  "errors": [
    "invalid procurement_id"
  ]
}