Tracktry API

Trackings 

Manage your trackings

URI Method Description
POST /trackings/post POST Create a tracking item
GET /trackings/{carrier_code}/{tracking_number} GET Get tracking results of a single tracking.
PUT /trackings/{carrier_code}/{tracking_number} PUT Update Tracking item
DELETE /trackings/{carrier_code}/{tracking_number} DELETE Delete a tracking item
POST /trackings/batch POST Create multiple trackings.
GET /trackings/get GET List all trackings
POST /trackings/realtime POST Get realtime tracking results of a single tracking

Create multiple trackings.

https://api.tracktry.com/v1/trackings/batch

Headers

  • Content-Type: application/json
    Tracktry-Api-Key: YOUR_API_KEY
  • Tips

    POST /trackings/batch API interface for up to 40 waybill numbers per operation.

Parameters

ParamDescription
tracking_numberTracking number
carrier_code Carrier code. Check courier code
destination_code (optional)Destination Carrier code.
title (optional)Title of the tracking
logistics_channel (optional)Logistics channel of the tracking
customer_name (optional)Customer name of the tracking.
customer_email (optional)Email address to receive email notifications of the customer.
customer_phone (optional)Phone number to receive SMS notifications.
order_id (optional)Text field for order ID.
order_create_time (optional)Order Create Time(eg:2017/8/27 16:51).
tracking_ship_date(optional)Shipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post
tracking_postal_code(optional)The postal code of receiver's address. Required by some couriers, such as postnl-3s
tracking_account_number(optional)Account Number
specialNumberDestination(optional)Destination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s
lang (optional)Return to language type (only when courier official website supports).
auto_correct (optional)Auto detect carriers when it's blank. You can set 1 if need to specify the carrier_code.
comment (optional)Text field for comment

Request Body

  • [
      {
          "tracking_number": "RP893531375SG",
          "carrier_code": "singapore-post",
          "logistics_channel": "4PX挂号小包",
          "customer_phone": "+110110",
          "destination_code": "cn",
          "title": "title 1",
          "customer_email": "[email protected]",
          "order_id": "213456",
          "comment": "备注",
          "order_create_time": "2017/8/27 16:51",
          "lang": "en"
      },
      {
          "tracking_number": "LK894734223CN",
          "carrier_code": "china-ems",
          "logistics_channel": "4PX挂号小包",
          "customer_phone": "+22222222",
          "destination_code": "cn",
          "title": "title 1",
          "customer_email": "[email protected]",
          "order_id": "213456",
          "comment": "备注",
          "order_create_time": "2017/8/27 16:51",
          "lang": "en"
      }
    ]
                    
  • Response Body 201

    {
        "meta": {
            "code": 201,
            "type": "Created",
            "message": "The request was successful and a resource was created."
        },
        "data": {
            "submitted": 2,
            "added": 0,
            "trackings": [],
            "errors": [{
                "tracking_number": "RP893531375SG",
                "carrier_code": "singapore-post",
                "code": 4016,
                "message": "Tracking already exists."
            }, {
                "tracking_number": "LK894734223CN",
                "carrier_code": "china-ems",
                "code": 4016,
                "message": "Tracking already exists."
            }]
        }
    }
    
  • Response Body 200

    {
        "meta": {
            "code": 200,
            "type": "Success",
            "message": "Success"
        },
        "data": {
            "submitted": 2,
            "added": 2,
            "trackings": [{
                "id": "ec6150c0b7557eb3131578640e04f798",
                "tracking_number": "RP893531375SG",
                "carrier_code": "singapore-post",
                "order_create_time": "2017\/8\/27 16:51",
                "status": "pending",
                "created_at": "2018-04-18T07:26:14+00:00",
                "customer_email": "[email protected]",
                "customer_name": null,
                "customer_phone": "+110110",
                "order_id": "213456",
                "comment": "备注",
                "title": "title 1"
                "logistics_channel": "4PX挂号小包"
            }, {
                "id": "bca8dab58bac35e0658f93c09e8092ac",
                "tracking_number": "LK894734223CN",
                "carrier_code": "china-ems",
                "order_create_time": "2017\/8\/27 16:51",
                "status": "pending",
                "created_at": "2018-04-18T07:26:14+00:00",
                "customer_email": "[email protected]",
                "customer_name": null,
                "customer_phone": "+22222222",
                "order_id": "213456",
                "comment": "备注",
                "title": "title 1"
                "logistics_channel": "4PX挂号小包"
            }]
        }
    }