Create a Tracking

post https://public-api.easyship.com/2024-09/trackings

Create a single tracking in your account.

Required authorization scope: public.track_3p:write

This API requires an updated contract with Easyship. Get in touch with your account manager or Easyship Support Team.

Responses

Response body

object

tracking

object

Tracking details

string

tracking_number

string

Reference provided by the courier for this leg

source

string

easyship external

courier_service

object

easyship_shipment_id

string

Readable identifier prefixed with ES (Easyship) and destination country code

platform_order_number

string | null

≤ 200

Order number that was either copied from an order synced from an ecommerce platform or manually edited in Easyship's order from

origin_country_alpha2

string

Country Code in Alpha-2 format (ISO 3166-1)

AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

destination_country_alpha2

string

Country Code in Alpha-2 format (ISO 3166-1)

tracking_state

string

The current state of the tracking

created active pending completed overwritten_by_admin

status

string | null

The latest event status

Created Cancelled by Company Cancelled by Easyship Awaiting Pickup at Seller Assigned Pickup Picked Up at Seller Received at Fulfillment Center Verified Packed Pending Tracking Event Tracking Info Received In Transit to Customer Out for Delivery Failed Delivery Attempt Delivered Exception No Recent Tracking Updates Shipped (No Tracking Provided) In Transit to Consolidation Center Arrived at Consolidation Center Processing at Consolidation Center Delivery Expected (End of Updates) Shipped Incomplete Lost by Courier To be returned Archived Draft Cancelled Label Pending Label Ready Label Printed Pickup Scheduled Pickup Complete Cancelled (No Stock) Handed Over to Courier Label Rejected Drop-off Complete Dispatched from Sorting Hub Received at Local Fulfilment Center Awaiting Pickup Confirmation by Courier Pickup Request Failed Uncancelled Discarded Draft Liquidated Awaiting Confirmation by Warehouse Order Failed to Create at Warehouse Order Received by Warehouse Order Packed Order Collected Backorder (No Stock) Awaiting Dispatch by Warehouse Cancellation Requested Cancellation Request Failed

tracking_page_url

uri | null

Tracking page URL. If certain condition is met, it will be empty.

eta_date

date-time | null

201tracking successfully created

422failed validations