home.picAlt
Products
Tracking API
Shopify app
iframe tracking widget
API
Carriers
Carriers
Resources
Pricing
Products
Carriers
Resources
App
English
XYY tracking API

XYY tracking API

{carrierName} tracking API

Empower your dev team with seamless XYY tracking using Track123’s API.

Effortlessly set up real-time XYY tracking through a robust RESTful API and webhooks, automating delivery updates as they happen. With a Track123 account, enjoy rapid tracking updates and an industry-leading 99.9% API uptime. Take your logistics to the next level with the XYY Tracking API from Track123.

XYY Tracking API

Register trackings

Parameters

  • RAW_BODY
    array of objects
    An array of objects where each object contains the following details:
    • trackNo
      string
      Track number
    • courierCode
      string
      The unique carrier code, if it is null, the system will auto-detect carrier base tracking number format
    • orderNo
      string
      Order number
    • country
      string
      Country code of destination: CN,US,GB
    • shipTime
      string
      Ship time
    • customerEmail
      string
      The customer email address associated with the order
    • postalCode
      string
      The postcode of the destination (15 letters or numbers, can contain +, -, and spaces)
    • extendFieldMap
      object
      Be used to add additional information, such as phone number
    • remark
      string
      Remark
    • custom1
      string
      Custom field 1
    • custom2
      string
      Custom field 2

Returns

  • code
    string
    Service status code
  • data
    object
    • accepted
      array of objects
      Successful registration of tracking number
    • rejected
      array of objects
      Rejected registration of tracking number
  • msg
    string
    The description information corresponding to the service status code or other auxiliary description information.
  • traceId
    string
shell
curl --request POST \
   --url https://api.track123.com/gateway/open-api/tk/v2/track/import \
   --header 'Track123-Api-Secret: Test' \
   --header 'accept: application/json' \
   --header 'content-type: application/json' \
   --data '[
            {
              "trackNo": "LV209031969CN",
              "courierCode": "xyy",
              "orderNo": "x1234567890",
              "country": "CN",
              "shipTime": "2024-01-01 12:00:00",
              "customerEmail": "customer@track123.com",
              "postalCode": "000000",
              "extendFieldMap": {
                "phoneSuffix": "2390"
              },
              "remark": "remark",
              "custom1": "customField1",
              "custom2": "customField2"
            }
    ]'
response.json
  {
    "code": "00000",
    "data": {
      "accepted": [
        {
          "trackNo": "LV209031969CN",
          "courierCode": "xyy",
          "postalCode": "000000",
          "orderNo": "x1234567890",
          "country": "CN",
          "shipTime": "2024-01-01 12:00:00",
          "customerEmail": "customer@track123.com",
          "remark": "remark",
          "extendFieldMap": {
            "phoneSuffix": "2390"
          }
        }
      ],
      "rejected": [
        {
          "index": 2,
          "trackNo": "LV209031969CN",
          "orderNo": "x1234567890",
          "courierCode": "xyy",
          "error": {
            "code": "A0400",
            "msg": "The order number has been imported"
          }
        }
      ]
    },
    "msg": "Success",
    "traceId": "79160aef7dde4df3ab53d77a5e783fad.161.17086538800398087"
  }

Get trackings

You can track up to 100 tracking numbers at a time.

Parameters

  • trackNoInfos
    array of objects
    Tracking numbers list
  • orderNos
    array of strings
    Order number list
  • createTimeStart
    string
    The start point of time range of tracking created, used to screen tracking results
  • createTimeEnd
    string
    The end point of time range of tracking created, used to screen tracking results
  • cursor
    string
    Pagination query request, cursor, obtained from the query result of the previous page, leave blank to track the result of the first page
  • queryPageSize
    integer
    Pagination query request, number of queries per page, default 100, maximum 100 queries at a time

Returns

  • code
    string
    Service status code
  • data
    object
    • accepted
      array of objects
      Successful registration of tracking number
    • rejected
      array of objects
      Rejected registration of tracking number
  • msg
    string
    Rejected registration of tracking number
  • traceId
    string
shell
curl --request POST \
   --url https://api.track123.com/gateway/open-api/tk/v2/track/query \
   --header 'Track123-Api-Secret: Test' \
   --header 'accept: application/json' \
   --header 'content-type: application/json' \
   --data '{
            "trackNos": [
              "304071414818",
              "620372231752"
            ],
            "orderNos": [
              ""
            ],
            "createTimeStart": "2021-08-01 00:00:00",
            "createTimeEnd": "2021-09-28 00:00:00",
            "cursor": "",
            "queryPageSize": 100
      }'
response.json
 {
   "code": "00000",
   "data": {
     "accepted": {
       "content": [
         {
           "trackNo": "9261290289104300655419",
           "createTime": "2022-08-02 20:20:36",
           "nextUpdateTime": "2022-08-05 20:20:45",
           "orderNo": "",
           "customerEmail": "",
           "shipFrom": "US",
           "shipTo": "US",
           "trackingStatus": "001",
           "transitStatus": "EXPIRED",
           "transitSubStatus": null,
           "shipTime": "2022-06-14 18:10:10",
           "orderTime": "2022-05-31 14:46:06",
           "receiptTime": "2022-06-01 11:17:36",
           "deliveredTime": null,
           "lastTrackingTime": "2022-06-01 19:50:20",
           "receiptDays": 14,
           "deliveredDays": null,
           "remark": "test-bytedance",
           "custom1": "Custom field 1",
           "custom2": "Custom field 2",
           "localLogisticsInfo": {
             "courierCode": "parcll",
             "courierNameCN": "PARCLL",
             "courierNameEN": "PARCLL",
             "courierHomePage": "https://www.parcll.com/",
             "courierTrackingLink": "https://parclltrack.com/parcelTracking?id=9261290289104300655419",
             "trackingDetails": [
               {
                 "address": "New York",
                 "eventTime": "2022-06-01 19:50:20",
                 "eventTimeZeroUTC": "2022-06-01T11:50:20Z",
                 "timezone": "+08:00",
                 "eventDetail": "Departed Facility In processing center",
                 "transitSubStatus": "IN_TRANSIT_01"
               },
               {
                 "address": "",
                 "eventTime": "2022-06-01 11:47:00",
                 "eventTimeZeroUTC": "2022-06-01T03:47:00Z",
                 "timezone": "+08:00",
                 "eventDetail": "picked up by shipping partner, usps awaiting item",
                 "transitSubStatus": "INFO_RECEIVED_01"
               },
               {
                 "address": "New York",
                 "eventTime": "2022-06-01 11:17:40",
                 "eventTimeZeroUTC": "2022-06-01T03:17:40Z",
                 "timezone": "+08:00",
                 "eventDetail": "Departed Facility in New York ",
                 "transitSubStatus": "IN_TRANSIT_01"
               },
               {
                 "address": "New York",
                 "eventTime": "2022-06-01 11:17:36",
                 "eventTimeZeroUTC": "2022-06-01T03:17:36Z",
                 "timezone": "+08:00",
                 "eventDetail": "Arrived at Sort Facility New York ",
                 "transitSubStatus": "IN_TRANSIT_01"
               },
               {
                 "address": "",
                 "eventTime": "2022-05-31 14:46:06",
                 "eventTimeZeroUTC": "2022-05-31T06:46:06Z",
                 "timezone": "+08:00",
                 "eventDetail": "Shipment information received",
                 "transitSubStatus": "INFO_RECEIVED_01"
               }
             ]
           },
           "expectedDelivery": null,
           "shipmentType": "",
           "lastMileInfo": {
             "lmTrackNo": "9261290289104300655419",
             "openApiWayBillInfo": {
               "courierCode": "usps",
               "courierNameCN": "美国邮政",
               "courierNameEN": "USPS",
               "courierHomePage": "https://www.usps.com/",
               "courierTrackingLink": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9261290289104300655419",
               "trackingDetails": [
                 {
                   "address": "",
                   "eventTime": "2022-06-01 11:47:00",
                   "eventTimeZeroUTC": "2022-06-01T17:47:00Z",
                   "timezone": "-06:00",
                   "eventDetail": "Picked Up by Shipping Partner, USPS Awaiting Item -> Your item was picked up by a shipping partner at 11:47 am on June 1, 2022. This does not indicate receipt by the USPS or the actual mailing date.",
                   "transitSubStatus": "INFO_RECEIVED_01"
                 }
               ]
             }
           }
         }
       ],
       "totalElements": "1",
       "totalPages": "1",
       "currentPage": "1",
       "cursor": "1659442836095,342401319572631552,2"
     },
     "rejected": []
   },
   "msg": "Success"
 }

How can I generate a XYY API key?

To ensure secure access, Track123 requires an API key in the header of each request. Simply sign up for a Track123 account to receive your API key.

Do I need a XYY developer account to use this API?

No, a XYY account is not necessary. Track123 is partnered with XYY, giving you direct access to XYY tracking data via the Track123 API.

Does Track123 support tracking API for other carriers?

Yes, Track123 supports shipment tracking API for over 1,000 carriers. By integrating with Track123, you can track shipments from more than 1,000 carriers worldwide.
All carriers
Your online tracking solution
Track your package anywhere, anytime
Products
API
Shopify app
iframe tracking widget
Resources
Carriers
Shopify app help doc
API doc
Support
Pricing
Contact us
Company
About us
Be our partner
Privacy policy
ISO 27001 certification
Compliant with the world’s most rigorous standards for information security and privacy.
Copyright 2024 @Track123.
粤ICP备 18033028号
取消