Billing
6 months ago

Billing API Update (03.04.2024)

New Features
  • Add fixed pricing for a specific SKU in picking rates. This feature allows you to choose an additional fee for a SKU or a set fee i.e. if you have the SKU LEAFLET1 you can choose to add 10p or you can choose to SET 10p. This function also allows a negative value so you can ask the system to deduct from the picking rates also.
  • Allow the ability to charge by cubic as well as storage locations. This feature allows you to bill storage as cubic units or by the current way of telling us what location types and quantities you want bill for. The cubic storage is decided by setting cubic bands i.e. up to 5, up to 10, up to 20 and then deciding a price per cube if the total cube falls in that band. Although the system GUI shows CBM for cubic metres the calculations are unitless and you should submit in the units you want to work in. It would be typical for you to send the call with the dimensions in metres.
These new API calls have not been added to the WMS yet but are scheduled to be soon.

The call for cubic storage is a POST request to https://production.billingapi.co.uk/api/submit-cubic-storage-charges with the headers of Bearer Token in the format of Bearer <<insert billing api token from billing api home page>>.

{
    "customer_dc_id": "Insert customer id",
    "items": [
        {
            "sku":"SKU1",
            "height":"1",
            "width":"1",
            "length":"5",
            "quantity":"3"
        },
        {
            "sku":"SKU2",
            "height":"1",
            "width":"1",
            "length":"1",
            "quantity":"11"
        }
    ]
}

The call for recurring storage charges is to https://billing.courierapi.co.uk/api/update-recurring-storage-charge-quantities and looks like the below where type_id is the locations storage type as defined in the billing api GUI.

[
    {
        "type_id": 2,
        "dc_customer_id": "SAND-01",
        "quantity": 3
    },
    {
        "type_id": 3,
        "dc_customer_id": "SAND-01",
        "quantity": 44
    },
    {
        "type_id": 4,
        "dc_customer_id": "SAND-01",
        "quantity": 33
    },
    {
        "type_id": 5,
        "dc_customer_id": "SAND-01",
        "quantity": 12
    }
]