Trackings

Create a Tracking

Changed on

Create a single tracking in your account.

Required authorization scope: public.track_3p:write

Note: This endpoint requires an advanced scope. You can enable advanced scopes when creating or editing your API connection.

Note: Calls to this endpoint count towards your API usage allowance. You can monitor your current usage in the Subscription section of your account.

post/2024-09/trackings

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/trackings
  • Auth
    HTTP bearer

Request body

tracking_numberstring required
courier_service_idstring uuid

unique identifier for a courier service

courier_service_namestring

Name of the courier service. Required if courier_service_id is not provided. For courier services that Easyship doesn't support label generation, please retrieve the name using GET /trackings/external_courier_services

platform_order_numberPlatformOrderNumber (unresolved $ref)
origin_address_idstring uuid

ID of origin address. Required if the origin_address object is not provided. If provided, the origin address attributes will be ignored.

Response

tracking successfully created

Changes

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • warning

      added the new Pickup/Drop-off enum value to the / response property for the response status

    • info

      added the new optional request property /////

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property / became nullable

    • info

      the request property / became nullable