Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Current »

  • API Location:
    /consignment/tracking

  • Params:(POST or GET)
    tracking_reference(mandatory field): track references imploded by ',';
    newest(true/false default to be false): true with results not loading from cache.

  • Response Data:
    success(true/false): true with data returns and false with message returns;
    data(array): track info in associate array like ['TRACK_REFERENCE' => [TIME_LINE]];
    message(string): error info.

  • For Example:
    You send a request like: 
    http://api.birdsystem.com/consignment/tracking?tracking_references=BSLZZ1020007635YQ
    or  
    http://api.birdsystem.com/consignment/tracking?tracking_references=BSLZZ1020007635YQ&newest=true


    It will returns json data like:

    {
        "success": true,
        "data": {
            "BSLZZ0926000004YQ": {
                "destination_country": "GB",
                "check_points": [
                    {
                        "create_time": "2015-01-01T08:10:19+00:00",
                        "current_status": "PREPARING",
                        "note": "Create consignment, preparing."
                    },
                    {
                        "create_time": "2015-01-01T08:10:19+00:00",
                        "current_status": "PENDING",
                        "note": "Consignment is now at [PENDING] status."
                    },
                    {
                        "create_time": "2015-01-02T15:30:39+00:00",
                        "current_status": "WAIT_PICKING",
                        "note": "Consignment is now at [WAIT_PICKING] status."
                    },
                    {
                        "create_time": "2015-01-02T15:43:40+00:00",
                        "current_status": "PICKING",
                        "note": "Consignment is now at [PICKING] status."
                    },
                    {
                        "create_time": "2015-01-02T19:50:39+00:00",
                        "current_status": "FINISHED",
                        "note": "Consignment is now at [FINISHED] status."
                    },
                    {
                        "create_time": "2015-01-02T19:50:39+00:00",
                        "current_status": "FINISHED",
                        "note": "This is a non-tracked service, no more delivery service is shown."
                    }
                ]
            }
        },
        "message": []
    }

    or error response like:

    {
      "success": false,
      "data": [],
      "message": "Invalid track reference."
    }

Related pages

Filter by label

There are no items with the selected labels at this time.

Useful hint

Confluence Administrators can also make templates that are available across your whole Confluence instance.

  • No labels