Weight bracket

Rates with a weight bracket do not have a fixed price between weight_min and weight_max because their price depends on the actual weight of the parcel. Their price is set to null and should be calculated using the bracket attributes (in the same currency as the contract). If you provide filter[weight] in the GET /service-rates request, you can find the calculated bracket price in the meta of each rate.

Attributes

Attribute	Type	Required	Description
start	integer	✓	The starting weight in grams of this bracket, for which the start_amount will be charged. Once a shipment exceeds this weight, the bracket size and size_amount determine the price of this rate.
start_amount	integer	✓	The starting amount of the bracket price in cents/pence.
size	integer	✓	The incremental weight in grams of this bracket, for which the size_amount will be charged each time it needs to be applied, until the entire shipment weight is covered.
size_amount	integer	✓	The bracket price will be increased with this amount for as many times as you need to add the bracket size to the start weight, to cover the weight of the shipment.

Example

{
    "start": 6000,
    "start_amount": 500,
    "size": 2000,
    "size_amount": 50
}

Note

For the above example, a shipment of 9 kg would cost 500 + 50 + 50 = 600 cents. Because to cover the entire 9000 gram of the shipment, we would need to add two increments of 2000 gram to the starting 6000 gram.

Calculation

This property basically defines a table of brackets up to the weight_max defined on the rate. For our above example this would be:

Cost	Bracket
500	Shipment <= 6kg
550	Shipment > 6 kg =< 8 kg
600	Shipment > 8 kg =< 10 kg
650	Shipment > 10 kg =< 12 kg
700	Shipment > 12 kg =< 14 kg
750	Shipment > 14 kg =< 16 kg
etc…

Note

If you provide filter[weight] when requesting service-rates, our API will calculate the bracket_price and return this in the meta information of each rate.