Developers - JSON response

JSON response

Example of response with a single service

    {
        "result": [
            {
                "ID": 5,
                "ServiceTag": "jour",
                "ServiceNameFr": "Lendemain",
                "ServiceNameEn": "Next day",
                "DeliveryDate": "2020-03-03 17:00",
                "BasePrice": 5,
                "SurchargeCharges": [],
                "SurchargeTotal": 0,
                "TaxCharges": [
                    {
                        "ID": "GST",
                        "Charge": 0.25,
                        "Rate": 0.05,
                        "NameFr": "TPS",
                        "NameEn": "GST"
                    },
                    {
                        "ID": "PST",
                        "Charge": 0.5,
                        "Rate": 0.1,
                        "NameFr": "TVQ",
                        "NameEn": "PST"
                    },
                    {
                        "ID": "HST",
                        "Charge": 0,
                        "Rate": 0,
                        "NameFr": "TVH",
                        "NameEn": "HST"
                    }
                ],
                "SubTotal": 5,
                "Total": 5.75
            }
        ],
        "errors": []
    }           

Operation

• If a service is not available at the time of the request, it will not be displayed.
• if the packages are too big or too heavy no service will be displayed.

Description of the root elements of the response

result: (ARRAY)

errors: (ARRAY)

Description of the elements of the result object

ID: (INT)

ServiceTag: (STRING)

ServiceNameFr: (STRING)

ServiceNameEn: (STRING)

DeliveryDate: (STRING)

BasePrice: (FLOAT)

SurchargeCharges: (ARRAY)

• NameFr: (STRING) The description of the additional charge in French.
• NameEn: (STRING) The description of the additional charge in English.
• Charge: (FLOAT) Amount of additional charge.

SurchargeTotal: (FLOAT)

TaxCharges: (ARRAY)

• ID: (INT) The tax id
• Charge: (FLOAT) The amount of tax.
• Rate: (FLOAT) The tax rate.
• NameFr: (STRING) The description of the tax in French.
• NameEn: (STRING) the description of the tax in English.

SubTotal: (FLOAT)

Total: (FLOAT)