Versions Compared

Key

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

  • Params:(POST or GET)
 
  • track_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]];
 
  • message(string): error info.

  • For Example:
    We send a request like:

  • /consignment/track?track_reference=1
    It will returns json data like:

    Wiki Markup
    ` ``
    {
      "success":true,
      "data":{
        "16465436":[
          {"create_time":"2015-01-01 08:10:19","current_status":"PREPARING","note":"Create consignment, preparing."},
          {"create_time":"2015-01-01 08:10:19","current_status":"PENDING","note":"Consignment from [PREPARING] to [PENDING]"},
          {"create_time":"2015-01-02 15:48:40","current_status":"WAIT_PICKING","note":"Consignment from [PENDING] to [WAIT_PICKING]"}
        ]
      },
      "message":[]
    }
    ` ``

{

  "success":true,

  "data":{

    "16465436":[

      {"create_time":"2015-01-01 08:10:19","current_status":"PREPARING","note":"Create consignment, preparing."},

      {"create_time":"2015-01-01 08:10:19","current_status":"PENDING","note":"Consignment from [PREPARING] to [PENDING]"},

      {"create_time":"2015-01-02 15:48:40","current_status":"WAIT_PICKING","note":"Consignment from [PENDING] to [WAIT_PICKING]"}

    ]

  },

  "message":[]

}

or error response like:

{

  "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.