List Procurement Items

🔒

Requires read_product access scope. More access scope

The List Procurement Items API retrieves the items associated with a given procurement ID.

Use Cases

  1. Fetching all items under a specific procurement.
  2. Checking the quantity and details of items in procurement.
  3. Managing and tracking procurement inventory.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredExampleDescription
idstringYes"38270644320102839"The unique identifier of the procurement.

Body Parameters

ParameterTypeRequiredExampleDescription
pageintegerNo1The page number for pagination. Default: 1.
limitintegerNo10The number of records per page (Min: 1, Max: 100).

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

FieldTypeExampleDescription
idstring"38276477 153919276"Unique identifier for the procurement item.
procurement_idstring"382706443 20102839"ID of the procurement to which this item belongs.
pending_quantityinteger100Number of units pending in the procurement.
received_quantityinteger0Number of units received in the procurement.
rejected_quantityinteger0Number of units rejected in the procurement.
transfer_quantityinteger100Number of units transferred.
variant_idstring"4f442546-3a6 0-43b2-ba..."Unique identifier of the product variant.
product_idstring"cbf9e2d2-7f2 c-4881-ab..."Unique identifier of the product.
product_titlestring"Test"The title of the product.
variant_skustring""The SKU of the variant (if available).
created_atstring"2024-05-22T 01:38:54Z"Timestamp when the item was created.
updated_atstring"2024-05-22T01 :38:54Z"Timestamp when the item was last updated.
product_image.srcstring"//img.staticdj .com/c8bf56..."URL of the product image.
product_image.widthinteger710Width of the product image.
product_image.heightinteger799Height of the product image.

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.

FieldTypeExampleDescription
errorArray "store is not active"Indicates an error encountered during the process.

Error Details

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).{ "errors": [ "invalid procurement_id"]}
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!