Set a price list’s prices
const url = 'https://example.com/rate-sets/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices';const options = { method: 'PUT', headers: { cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>', 'Content-Type': 'application/json' }, body: '{"prices":[{"productId":"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f","unitPrice":1,"priceIncludesVat":true,"notCharged":false}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/rate-sets/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices \ --header 'Content-Type: application/json' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \ --data '{ "prices": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "unitPrice": 1, "priceIncludesVat": true, "notCharged": false } ] }'The whole list, replaced: a product left out is no longer priced by the list, and its members pay the Trade price for it (or, for a deposit or rent, the Trade or Consumer amount where its chargeAudience includes them). Each product must be this business’s and not archived: something it sells, or a deposit or rent, never a delivery charge (422 otherwise). On a deposit or rent, notCharged true means members do not pay it at all; on anything else it is a 422. A customer’s own agreed amount still comes first. To change one product’s price on every list, use PUT /products/{id}/prices. Where a gas type (or a size) has both a deposit and rent, a list charges one of them or neither, never both: an amount on one needs the other notCharged (422 charges_both otherwise). The one chosen with no row of its own is charged at the usual amount, whoever usually pays it. A customer’s own deposit-or-rent choice, set on their record, still beats the list’s. PUT /rate-sets/{id}/cylinder-charges says the same per gas type.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
Request Bodyrequired
Section titled “Request Bodyrequired”object
object
UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fDeposits and rent only: members do not pay this charge. Sent on anything else, 422.
Responses
Section titled “Responses”The set with its prices
object
UUID v7
object
UUID v7
object
UUID v7
UUID v7
UUID v7
UUID v7
What a price list charges its members on one gas type (or size). usual: each member pays the deposit or rent they are set to, at the usual amount. deposit: the deposit and never rent. rent: the rent and never a deposit. none: neither.
object
Example
{ "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "prices": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } ], "cylinderCharges": [ { "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "sizeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "depositId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "rentId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "choice": "usual" } ]}Not signed in
object
Example
{ "error": "not_found", "message": "Customer not found"}Not a member, or without the permission this needs
object
Example
{ "error": "not_found", "message": "Customer not found"}No such price list
object
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
object
object
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}