Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
1.
  • API Location:
 
  • /consignment/
track
  • tracking
2.

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

  • 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
  • INFO]];
 
  • message(string): error info.

  • For Example:

We tracktrack_reference=1 

{

  • languagejs
    themeConfluence
    linenumberstrue
    {
        "success": true,
 
  • 
        "data":
{

    "16465436":[

      {
  •  {
            "BSLZZ0926000004YQ": {
                "destination_country": "GB",
                "check_points": [
                    {
                        "create_time": "2015-01-
01 08
  • 01T08:10:19+00:00",
                        "current_status": "PREPARING",
                        "note": "Create consignment, preparing."
},      {
  • 
                    },
                    {
                        "create_time": "2015-01-
01 08
  • 01T08:10:19+00:00",
                        "current_status": "PENDING",
                        "note": "Consignment
from [PREPARING] to [PENDING]"},      {
  •  is now at [PENDING] status."
                    },
                    {
                        "create_time": "2015-01-
02 15:48:40",
  • 02T15:30:39+00:00",
                        "current_status": "WAIT_PICKING",
                        "note": "Consignment
from [PENDING] to [WAIT_PICKING]"}

    ]

  },

  "message":[]

}

or

{

  •  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:

    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.