For all operations listed below you will need to provide HTTP Request Header Authorization param. For more details see Login/Auth page.

Get the list of commodity data

Route: /commodity

Method: GET

Example result

{
    "entities": [
        {
            "name": "Commodity Name",
            "is_active": "1",
            "height": "number",
            "width": "number",
            "length": "number",
            "max_length": number,
            "max_weight": "number",
            "id": "1",
            "is_metric": "0"
        },
        {
            ...
        }
        ...
    "result": true

In the commodity object:

  • name: Name of the commodity
  • is_active: If entry is active
  • height: Height of commodity
  • width: Width of commodity
  • length: Length of commodity
  • max_length: Max length of commodity
  • max_weight: Max weight of commodity
  • id: internal identifier of the commodity object
  • is_metric: Unit system, metric if true, imperial otherwise

Get commodity by internal ID

Route: /commodity/{internal_id}

Method: GET

Example result

{
    "entity": {
        "name": "Commodity Name",
        "is_active": "1",
        "height": "number",
        "width": "number",
        "length": "number",
        "max_length": number,
        "max_weight": "number",
        "id": "1",
        "is_metric": "0"
    },
    "result": true
}