List Pricelist Items
Retrieve a list of items in a pricelist.
get
Path parameters
priceListIdstringRequired
Responses
200
OK
application/json
get
GET /public/v1/catalog/price-lists/{priceListId}/items HTTP/1.1
Host: api.s1.today
Accept: */*
200
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"status": "Draft",
"description": "text",
"reasonForChange": "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-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"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": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"pending": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"status": "text",
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2025-09-12T20:19:27.234Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
}
}
},
"item": {
"id": "text",
"name": "text",
"revision": 1,
"externalIds": {
"vendor": "text",
"operations": "text"
}
}
}
]
}Last updated
Was this helpful?