Create A Shipment Tracker

Create a tracking.

CURL POST request:

curl --location --request POST 'https://my.trackship.co/api/create-tracker/ts4wc/' \
--header 'trackship-api-key: a1421e5e041bb0288c4b24602c63c54e' \
--header 'store: https://examplestore.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tracking_number": "1Z4937W56728755212",
    "tracking_provider": "ups",
    "order_id": "10",
    "postal_code": "98012",
    "destination_country": "US"
}'

Header Parameter:

trackship-api-key: KP1n2Fr2FVKRE3rSUqE6FTeeAvCyZBWd
Store: https://examplestore.com

Request Body:

{
    "tracking_number": "1Z4937W56728755212",
    "tracking_provider": "ups",
    "order_id": "10",
    "postal_code": "98012",
    "destination_country": "US"
}

Response Body:

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

Request Parameters:

ParmeterTypeDescription
tracking_number(required)StringTracking number for the package
tracking_provider(required)StringUnique code of tracking provider for that tracking
order_id(required)StringRespective order ID
postal_codeStringThe postal code of the receiver’s address. It is required for some couriers, like postnl-3s
destination_countryStringDestination country for receiver’s address. It is required for some couriers, like postnl-3s(ex: NL)

Response Parameters:

ParmeterTypeDescription
statusStringresponse status(ex: ok/error)
status_msgStringstatus msg which explains the status of shipment(pending_trackship/ssl_error/Order id not found)
trackers_balanceStringThe available balance of the TrackShip account
user_planStringActive Subscription plan of TrackShip Account(ex: Free 50/Mini/Small)