Transload API Manual

Root API Path

Path
https://api.blipai.com/transload/v2

Endpoints

1. Only the containers are found in the most recent optimization run are returned

2. Note the GET requests do not need to specify 'content-type'

3. One ore more optimal doors may be returned based on the number of defined zones at the facility
   
   

A. Most optimal door for a container

GET

/container/<container number>/best

Headers

Authorization: Bearer <your secret key>

x-blip-location: <facility id>

Request Body: N/A

Example Request

/container/TCKU4624541/best

Example Response

{

  "ctr_id": "MSNU5516068",

  "best": [

    {

      "zone": "A",

      "door": "D033",

      "distance": 6486

    },

    {

      "zone": "B",

      "door": "D087",

      "distance": 6656

    }

  ]

}

B. Most optimal doors for a list of containers

POST

/container/bulk_best

Headers

Authorization: Bearer <your secret key>

x-blip-location: <facility id>

content-type: application/json

Example Request

/container/bulk_best

Example Request Body

{

  "ctr_nums": [

       "EGSU9274457",

       "EMCU1824727",

       "TCKU4624541"

  ]

}

Example Response : Container IDs not in the system are are ignored and are not returned in the response

[

  {

    "ctr_id": "MSNU5516068",

    "best": [

      {

        "zone": "A",

        "door": "D033",

        "distance": 6486

      },

      {

        "zone": "B",

        "door": "D087",

        "distance": 6656

      }

    ]

  },

  {

    "ctr_id": "OOCU7928960",

    "best": [

      {

        "zone": "C",

        "door": "D159",

        "distance": 1137

      }

    ]

  },

  {

    "ctr_id": "ONEU0412257",

    "best": [

      {

        "zone": "A",

        "door": "D031",

        "distance": 6648

      },

      {

        "zone": "B",

        "door": "D087",

        "distance": 6900

      }

    ]

  }

]

C. Travel distance for a container assigned to a specific door

GET

/container/<container number>/distance/<assigned door>

Headers

Authorization: Bearer <your secret key>

x-blip-location: <facility id>

Request Body: N/A

Example Request

/container/MSNU5516068/distance/D029

Example Response

{

  "ctr_id": "MSNU5516068",

  "zone": "A",

  "door": "D029",

  "distance": 6534

}

D. Top 10 optimal containers for a specified open door

GET

/containers/<open door>

Example

TBD

Header:

Authorization: Bearer <your secret key>

x-blip-location: <facility id>

Request Body: N/A

Example Response: TBD