Rest API v2

Tracking

This article guides you through how to receive tracking updates for your shipments.

Read

/api/weship.tracking/get_weship_tracking_details

Read tracking information for a specific tracking number.

GET

                                        
                                            curl -v -i -k -H "Content-Type: text/html" https://test.weship.at/api/weship.tracking/get_weship_tracking_details 
                                            -X PUT -H "access_token: XXXXXXXXXXXXXXXXX" -d '{"tracking_number":"WS123456789012345"}'

Response All

                                                
                                                    {
                                                        "code":200,
                                                        "data":{
                                                           "tracking_details":[
                                                              {
                                                                 "tracking_description":"Package was delivered",
                                                                 "tracking_stage":{
                                                                    "description":"The package has been delivered successfully.",
                                                                    "code":"DL",
                                                                    "name":"Delivered",
                                                                    "sequence":10
                                                                 },
                                                                 "location":"AT",
                                                                 "zip":"8700",
                                                                 "date":"2020-04-10 10:27:00",
                                                                 "tracking_event":"Delivery"
                                                              },
                                                              {...}
                                                           ],
                                                           "shipping_address":{
                                                              "city":"Graz",
                                                              "state":"Styria",
                                                              "street":"Musterweg 1",
                                                              "zip":"8010",
                                                              "phone":"0123 456789",
                                                              "mobile":"",
                                                              "country":"Austria",
                                                              "contact_name":"Max Mustermann",
                                                              "street2":"",
                                                              "email":"max.mustermann@gmail.com"
                                                           },
                                                           "customer_name":"Max Mustermann"
                                                        },
                                                        "success":true
                                                     }

Properties

weship.tracking

Properties related to the weship.tracking table.

Field	Data type		Description
customer_name	Char	Read-Only	Name of the customer.
shipping_address	Object	Read-Only	Address of the customer, to which the package was sent to. weship.shipping.address
tracking_details	List	Read-Only	List of all the tracking events that we received from the carrier. weship.tracking.details

weship.tracking.details

Properties related to the weship.tracking.details table.

Field	Data type		Description
date	Datetime	Read-Only	Date and time of when this event took place.
location	Char	Read-Only	Shortcode of the country.
tracking_description	Char	Read-Only	Detailed description of the tracking event.
tracking_event	Char	Read-Only	Title of the tracking event.
zip	Int	Read-Only	ZIP code of the delivery address.

weship.shipping.address

Properties related to the weship.customer table.

Field	Data type		Description
city	Char	Read-Only	Name of the city
contact_name	Char	Read-Only	First and last name
country	Char	Read-Only	Name of the country
email	Char	Read-Only	Email address
phone	Char	Read-Only	Phone or mobile number
mobile	Char	Read-Only	Mobile number
state	Char	Read-Only	Name of the state in the country
street	Char	Read-Only	Name of the street, including house number
street2	Char	Read-Only	Additional address information
zip	Char	Read-Only	ZIP code of the city