API connection
When to use the API
Shipup provides an API to access tracking information. This information can be used for the following purposes:
Customize your tracking page hosted on your site
Display tracking in a mobile application
Use Shipup information in your back-office: CRM, support, logistics tool, etc.
Be used with a mobile application: Your customers can call in, enter their order number, and retrieve the status of their order
Display tracking in a bot: to respond to your customers asking "where's my package?"
How to use the API
Required conditions
a) You are integrated with orders (technical documentation)
You must specify at least one of the following in your request:
order number
customer email
If you need to paginate the results, you can specify this in the order request by:
order date
date of creation in Shipup
b) You are integrated with trackers (technical documentation)
👉 You will need to specify the tracking number in your request.
Available information
Depending on the request made, Shipup will respond with the appropriate information. The main information is:
email
order date
delivery address
order content
delivery status
estimated delivery date
events
Technical documentation
For more information, review our technical documentation!
A) You are integrated by Commandes/Orders
You must specify at least one of the following in your request:
order number
customer email
If you need to paginate the results, you can specify in the query to order by :
order date
Shipup creation date
B) You are integrated by tracker number
Tracking number.
Available information
Depending on the request, Shipup will respond with the appropriate information. The main information is :
email
order date
shipping address
order content
order status
estimated delivery date
events
For more info :
Check our Technical documentation!
Our Support and Technical teams are available to answer your questions: