Skip to content

Fill a price list from the Trade price

POST
/rate-sets/{id}/prices/fill
curl --request POST \
--url https://example.com/rate-sets/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices/fill \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "percentOff": 1 }'

The shortcut “Set every price to trade price less 10%”. Every product the business sells, other than deposits, rent and delivery, gets this list’s price set to its Trade price (its Consumer price where it has no Trade price) less percentOff, rounded to the penny, in the VAT basis that price was typed in. What the list had for those is replaced; its deposit and rent amounts stay as they are. Each price shows and can be changed on the product afterwards (PUT /products/{id}/prices).

id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Media typeapplication/json
object
percentOff
required
number
<= 100

Example generated

{
"percentOff": 1
}

The list with its new prices

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
colour
required
string | null
notes
required
string | null
memberCount
required
integer
priceCount
required
integer
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
prices
required
Array<object>
object
productId
required

UUID v7

string format: uuid
unitPrice
required
integer
<= 100000000
priceIncludesVat
required
boolean
notCharged
required
boolean
cylinderCharges
required
Array<object>
object
gasTypeId
required

UUID v7

string | null format: uuid
sizeId
required

UUID v7

string | null format: uuid
name
required
string
depositId
required

UUID v7

string | null format: uuid
rentId
required

UUID v7

string | null format: uuid
choice
required

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.

string
Allowed values: usual deposit rent none
amount
required
object
unitPrice
required
integer
<= 100000000
priceIncludesVat
required
boolean

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

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

No such price list

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

The list is archived

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}