Procurement Order Product List

🔒

Requires read_inventory access scope.

The Procurement Order Product List API retrieves the list of products associated with a specific procurement order. This API provides details about the items, including their quantities, variants, and other related metadata.

This API is especially useful for:

  1. Viewing the products included in a procurement order.
  2. Tracking the quantities and status of specific items in the procurement process.
  3. Managing product-level details for inventory or logistics purposes.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

FieldTypeDescriptionRequiredExample
procurement_idstringUnique identifier of the procurement order.Yes"385070142252984200"
limitstringLimit per page for the number of items returned.Yes"10"
pagestringPage number for pagination.Yes"1"

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

Field Type Example Description
count int32 1 Total number of items in the procurement order.
items array List of items in the procurement order.
items[].
procurement_item_id
int64 385700142268825400 Unique identifier for the procurement item.
items[].
transfer_quantity
int32 10 Quantity of the item transferred.
items[].
pending_quantity
int32 0 Quantity of the item pending procurement.
items[].
received_quantity
int32 10 Quantity of the item received.
items[].
rejected_quantity
int32 0 Quantity of the item rejected.
items[].
variant_id
string "1c5b9912-42af-41cb-bf7d-df609be87d20" Unique identifier of the product variant.
items[].
product_id
string "ac0b5372-4396-4415-979a-64e835abfd5b" Unique identifier of the product.
items[].
product_image
object Metadata about the product's image.
items[].
product_image.
src
string "//cdn.shoplazza.com/e1d7b475be103047d49d63c521ed0305.jpeg" Source URL of the product image.
items[].
product_image.
alt
string "" Alt text for the product image.
items[].
product_image.
width
int32 780 Width of the product image.
items[].
product_image.
height
int32 780 Height of the product image.
items[].
product_image.
path
string "e1d7b475be103047d49d63c521ed0305.jpeg" Path of the product image in the storage system.
items[].
product_title
string "0415" Title of the product.
items[].
variant_title
string "" Title of the product variant.
items[].
created_at
string "2024-05-30T07:54:40Z" Timestamp indicating when the procurement item was created.
items[].
updated_at
string "2024-05-30T07:55:03Z" Timestamp indicating when the procurement item was last updated.
items[].
variant_delete
int32 0 Indicator if the variant is deleted.
items[].
purchase_price
int32 0 Purchase price of the item.
items[].
variant_sku
string "--A001125" SKU of the product variant.
items[].
lot_number
string "20240530" Lot number of the item.
items[].
expiration_date
string "2026-05-29T17:00:00Z" Expiration date of the item, if applicable.
items[].
shipped_quantity
int32 0 Quantity of the item shipped.
items[].
shipped_received_quantity
int32 0 Quantity of the item shipped and received.

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
errorString "page not found"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
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!