Report

Label Exceptions and Holds

This service retrieves the info of the label exceptions and holds.

URL

PROD https://api.skypostal.com/

TEST https://api-test.skypostal.com/

Endpoint

POST /wcf-services/service-report.svc/report/get-label-exceptions-holds

Request Credentials

Parameters
`user_info`	Object - Required User Info Definition.
`start_date`	String Datetime Definition.
`end_date`	String Datetime Definition.
`copa_list`	List of Integer List of client identificator provided by Skypostal.
`country_list`	List of String List of 2 characters iso code. (e.g. BR, MX, US, etc.)
`include_not_processed`	Integer Set 1 when include not processed items, default 0.

User Info Definition

Parameters
`user_code`	Integer - Required This is the user code provided by Skypostal.
`user_key`	String - Required This is the app key provided by Skypostal.
`app_key`	String - Required This is the app key provided by Skypostal.

Parameters

user_code

Integer - Required

This is the user code provided by Skypostal.

user_key

String - Required

This is the app key provided by Skypostal.

app_key

String - Required

This is the app key provided by Skypostal.

Remember

user_code, user_key, app_key and copa_id are generic credentials, make sure to request your own for TEST and PROD environemnts

The command should be run as in the following example:

{
  "user_info": {
    "user_code": 123213,
    "user_key": "ok",
    "app_key": "ok"
  },
  "start_date": "/Date(1576058400000-0400)/",
  "end_date": "/Date(1576058400000-0400)/",
  "copa_list": 
    [
        753      
    ],
    "country_list":
    [
        "US",
    ],
  "include_not_processed": 0
}

The command will return the following format:

[
   {
      "_verify":true,
      "additional_info":{
         "internal":[
            
         ],
         "server":{
            "server_id":null,
            "server_time":0
         }
      },
      "error":{
         "error_description":"",
         "error_location":"",
         "system_error":false
      },
      "rpt_transit_times":[
         {
            "_verify":true,
            "additional_info":{
               "internal":[
                  
               ],
               "server":{
                  "server_id":null,
                  "server_time":0
               }
            },
            "awb":16290356,
            "client_id_verification":"Invalid CPF",
            "consignee_id":"",
            "copa_id":753,
            "copa_name":"Globegistics",
            "country_iso_code":"BR",
            "data_received":"\/Date(1597734317000-0500)\/",
            "date_diff_received_processed":13,
            "default_label_reason":"",
            "error":null,
            "external_tracking":"200818060457760",
            "holds":"MCD,",
            "holds_detail":"MISSING CUSTOMS DOCUMENTATION,",
            "inactive_days":11,
            "internal_number":"420945409405509206094568296801",
            "last_status":"MCD",
            "last_status_date":"\/Date(1599167755000-0500)\/",
            "order_label":"SP00004995963BR",
            "order_number":"200818060457760",
            "provider":"SKYPOSTAL",
            "received":"\/Date(1599167751000-0500)\/"
         },
         {
            "_verify":true,
            "additional_info":{
               "internal":[
                  
               ],
               "server":{
                  "server_id":null,
                  "server_time":0
               }
            },
            "awb":16291042,
            "client_id_verification":"Invalid CPF",
            "consignee_id":"",
            "copa_id":753,
            "copa_name":"Globegistics",
            "country_iso_code":"BR",
            "data_received":"\/Date(1597747098000-0500)\/",
            "date_diff_received_processed":1,
            "default_label_reason":"",
            "error":null,
            "external_tracking":"200818093726463",
            "holds":"MCD,",
            "holds_detail":"MISSING CUSTOMS DOCUMENTATION,",
            "inactive_days":23,
            "internal_number":"JOLWINFL1000061038",
            "last_status":"MCD",
            "last_status_date":"\/Date(1597777490000-0500)\/",
            "order_label":"SP00004774985BR",
            "order_number":"200818093726463",
            "provider":"SKYPOSTAL",
            "received":"\/Date(1597777486000-0500)\/"
         }
      ]
   }
]