Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • 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:

    Code Block
    languagejs
    themeConfluence
    linenumberstrue
    {
        "success": true,
        "data": {"BSLZZ1020007635YQ":
            "BSLZZ0926000004YQ": {
                "destination_country": "GB",
                "check_points": [
                    {
                        "create_time": "20162015-1001-20T0201T08:1610:4819+0100:00",
                        "current_status": "PREPARING",
                        "note": "Create consignment, preparing."
                    },
                    {
                        "create_time": "20162015-1001-20T0201T08:1610:4919+0100:00",
                        "current_status": "PENDING",
                        "note": "Consignment fromis [PREPARING]now toat [PENDING] status."
                    },
                    {
                        "create_time": "20162015-1001-20T0602T15:5730:0439+0100:00",
                        "current_status": "WAIT_PICKING",
                        "note": "Consignment fromis [PENDING]now toat [WAIT_PICKING] status."
                    },
                    {
                        "create_time": "20162015-1001-20T0602T15:5843:4940+0100:00",
                        "current_status": "PICKING",
                        "note": "Consignment from [WAIT_PICKING] tois now at [PICKING] status."
                    },
                    {
                        "create_time": "20162015-1001-20T1002T19:1850:5439+0100:00",
                        "current_status": "FINISHED",
                        "note": "Consignment is now fromat [PROCESSING] to [FINISHED]"}]},
      "message":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:

    Code Block
    languagejs
    themeConfluence
    linenumberstrue
    {
      "success": false,
      "data": [],
      "message": "Invalid track reference."
    }

Related pages

Filter by label (Content by label)
showLabelsfalse
spacesBIRDAPI
showSpacefalse
sorttitle
typepage
cqllabel = "documentation-space-sample" and type = "page" and space = "BIRDAPI"
labelsdocumentation-space-sample

Info
titleUseful hint

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