GET /apiv2/addOns

Takes no freight shape. It is called before the customer has entered a consignment, so there is nothing to evaluate applicability against — every add-on comes back with applicability: "unknown". Filtering by the shape of the freight is a later addition, and the field ships now so a client's model does not change when it lands.


companyId is required rather than inferred, because a broker legitimately quotes on behalf of a child company. It is checked against the caller's accessible tree, and a company outside it is reported as not found rather than forbidden, so the response cannot be used to enumerate companies.

Servers

Query parameters

Name Type Required Description
companyId Integer No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.