List Pricelist Items
List of items in a price list.
get
/v1/catalog/price-lists/{priceListId}/items
Path parameters
priceListIdstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
--url '/v1/catalog/price-lists/{priceListId}/items'200
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"unitLP": 1,
"unitPP": 1,
"markup": 1,
"margin": 1,
"unitSP": 1,
"PPx1": 1,
"PPxM": 1,
"PPxY": 1,
"SPx1": 1,
"SPxM": 1,
"SPxY": 1,
"LPx1": 1,
"LPxM": 1,
"LPxY": 1,
"priceList": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"currency": "text",
"precision": 1,
"defaultMarkup": 1,
"notes": "text",
"externalIds": {
"vendor": "text"
},
"statistics": {
"sellers": 1,
"listings": 1,
"priceListItems": 1,
"purchasePriceItems": 1,
"purchasePriceCompleteness": 1,
"salesPriceItems": 1,
"salesPriceCompleteness": 1,
"averageMarkup": 1,
"averageMargin": 1
},
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
}
},
"item": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
},
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"multiple": true,
"required": true,
"itemCount": 1,
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"unit": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-23T06:15:46.402Z",
"by": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"name": "text",
"statistics": {
"itemCount": 1
}
},
"terms": {
"period": "1m",
"commitment": "1m"
},
"quantityNotApplicable": true,
"status": "text",
"product": {
"id": "text",
"audit": {
"created": "[Circular Reference]",
"updated": "[Circular Reference]",
"published": "[Circular Reference]",
"pending": "[Circular Reference]",
"unpublished": "[Circular Reference]"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": "[Circular Reference]"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"parameters": [
{
"value": null,
"id": "text",
"externalId": "text",
"type": "text",
"name": "text",
"displayValue": "text"
}
]
},
"status": "Draft"
}
]
}OK
Last updated
Was this helpful?