Create a tracking

Create a shipment tracker for Custom App

URL

https://my.trackship.com/api/create-tracker/customapp/

Header Parameter:

trackship-api-key : <your api key here>
app-name          : <your app name here>

CURL POST request:

curl --location --request POST 'https://my.trackship.com/api/create-tracker/customapp/' \
--header 'Content-Type: application/json' \
--header 'trackship-api-key: <your api key here>' \
--header 'app-name: <your app name here>' \
--data-raw '{
    "tracking_number": "1Z4937W56728755212",
    "tracking_provider": "ups",
    "order_id": "13",
    "postal_code": "98012",
    "destination_country": "US"
}'

Request Parameters:

Parameter	Type	Description
tracking_number(required)	String	Tracking number for the package
tracking_provider(required)	String	Unique code of tracking provider for that tracking
order_id(required)	String	Respective order ID
postal_code	String	The postal code of the receiver’s address. It is required for some couriers, like postnl-3s
destination_country	String	Destination country for receiver’s address. It is required for some couriers, like postnl-3s(ex: NL)

Response Body:

{
    "status": "ok",
    "status_msg": "pending_trackship",
    "trackers_balance": "98",
    "user_plan": "Mini"
}

Response Parameters:

Parameter	Type	Description
status	String	response status(ex: ok/error)
status_msg	String	status msg which explains the status of shipment(pending_trackship/ssl_error/Order id not found)
trackers_balance	String	The available balance of the TrackShip account
user_plan	String	Active Subscription plan of TrackShip Account(ex: Free 50/Mini/Small)