Karrio Trackers API

openapi: 3.2.0
info:
  description: 'Karrio is a multi-carrier shipping API that simplifies the integration of logistics carrier services.


    The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded

    request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.


    The Karrio API differs for every account as we release new versions.

    These docs are customized to your version of the API.


    ## Versioning


    When backwards-incompatible changes are made to the API, a new, dated version is released.

    The current version is `2024.12.6`.


    Read our API changelog to learn more about backwards compatibility.


    As a precaution, use API versioning to check a new API version before committing to an upgrade.


    ## Environments


    The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`.

    In development, it is therefore possible to add carrier connections, get live rates,

    buy labels, create trackers and schedule pickups in `test_mode`.


    ## Pagination


    All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list addresses,

    list shipments, and list trackers. These list API methods share a common structure, taking at least these

    two parameters: limit, and offset.


    Karrio utilizes offset-based pagination via the offset and limit parameters.

    Both parameters take a number as value (see below) and return objects in reverse chronological order.

    The offset parameter returns objects listed after an index.

    The limit parameter take a limit on the number of objects to be returned from 1 to 100.


    ```json

    {

    "count": 100,

    "next": "/v1/shipments?limit=25&offset=50",

    "previous": "/v1/shipments?limit=25&offset=25",

    "results": [

    { ... },

    ]

    }

    ```


    ## Metadata


    Updateable Karrio objects—including Shipment and Order have a metadata parameter.

    You can use this parameter to attach key-value data to these Karrio objects.


    Metadata is useful for storing additional, structured information on an object.

    As an example, you could store your user''s full name and corresponding unique identifier

    from your system on a Karrio Order object.


    Do not store any sensitive information as metadata.


    ## Authentication


    API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard.


    Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret

    API keys in publicly accessible areas such as GitHub, client-side code, and so forth.


    Authentication to the API is performed via HTTP Basic Auth. Provide your API token as

    the basic auth username value. You do not need to provide a password.


    ```shell

    $ curl https://instance.api.com/v1/shipments \

    -u key_xxxxxx:

    # The colon prevents curl from asking for a password.

    ```


    If you need to authenticate via bearer auth (e.g., for a cross-origin request),

    use `-H "Authorization: Token key_xxxxxx"` instead of `-u key_xxxxxx`.


    All API requests must be made over HTTPS.

    API requests without authentication will also fail.'
  title: Karrio Trackers API
  version: 2024.12.6
tags:
- name: Trackers
  description: 'This is an object representing your Karrio shipment tracker.

    A shipment tracker is an object attached to a shipment by it''s tracking number.

    The tracker provide the latest tracking status and events associated with a shipment'
paths:
  /v1/trackers:
    get:
      operationId: listTrackers
      description: Retrieve all shipment trackers.
      summary: List all package trackers
      parameters:
      - in: query
        name: carrier_name
        schema:
          type: string
        description: 'The unique carrier slug. <br/>Values: `allied_express`, `allied_express_local`, `amazon_shipping`, `aramex`, `asendia_us`, `australiapost`, `boxknight`, `bpost`, `canadapost`, `canpar`, `chronopost`, `colissimo`, `dhl_express`, `dhl_parcel_de`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `easyship`, `eshipper`, `fedex`, `fedex_ws`, `freightcom`, `generic`, `geodis`, `hay_post`, `laposte`, `locate2u`, `nationex`, `purolator`, `roadie`, `royalmail`, `sapient`, `seko`, `sendle`, `tge`, `tnt`, `ups`, `usps`, `usps_international`, `usps_wt`, `usps_wt_international`, `zoom2u`'
      - in: query
        name: created_after
        schema:
          type: string
          format: date-time
      - in: query
        name: created_before
        schema:
          type: string
          format: date-time
      - in: query
        name: status
        schema:
          type: string
        description: 'Valid tracker status. <br/>Values: `pending`, `unknown`, `on_hold`, `delivered`, `in_transit`, `delivery_delayed`, `out_for_delivery`, `ready_for_pickup`, `delivery_failed`'
      - in: query
        name: tracking_number
        schema:
          type: string
      tags:
      - Trackers
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackerList'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: listTrackers
    post:
      operationId: addTracker
      description: 'This API creates or retrieves (if existent) a tracking status object containing the

        details and events of a shipping in progress.'
      summary: Add a package tracker
      parameters:
      - in: query
        name: hub
        schema:
          type: string
      - in: query
        name: pending_pickup
        schema:
          type: boolean
        description: Add this flag to add the tracker whether the tracking info exist or not.When the package is eventually picked up, the tracker with capture real time updates.
      tags:
      - Trackers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackingData'
        required: true
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingStatus'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '424':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessages'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: addTracker
  /v1/trackers/{carrier_name}/{tracking_number}:
    get:
      operationId: createTracker
      description: 'This API creates or retrieves (if existent) a tracking status object containing the

        details and events of a shipping in progress.'
      summary: Create a package tracker
      parameters:
      - in: path
        name: carrier_name
        schema:
          type: string
        required: true
      - in: query
        name: carrier_name
        schema:
          type: string
          enum:
          - allied_express
          - allied_express_local
          - amazon_shipping
          - aramex
          - asendia_us
          - australiapost
          - boxknight
          - bpost
          - canadapost
          - canpar
          - chronopost
          - colissimo
          - dhl_express
          - dhl_parcel_de
          - dhl_poland
          - dhl_universal
          - dicom
          - dpd
          - dpdhl
          - fedex
          - fedex_ws
          - generic
          - geodis
          - hay_post
          - laposte
          - locate2u
          - nationex
          - purolator
          - roadie
          - royalmail
          - seko
          - sendle
          - tge
          - tnt
          - ups
          - usps
          - usps_international
          - usps_wt
          - usps_wt_international
          - zoom2u
        required: true
      - in: query
        name: hub
        schema:
          type: string
      - in: path
        name: tracking_number
        schema:
          type: string
        required: true
      tags:
      - Trackers
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      deprecated: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingStatus'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '424':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessages'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: createTracker
  /v1/trackers/{id_or_tracking_number}:
    get:
      operationId: retrieveTracker
      description: Retrieve a package tracker
      summary: Retrieves a package tracker
      parameters:
      - in: path
        name: id_or_tracking_number
        schema:
          type: string
        required: true
      tags:
      - Trackers
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingStatus'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessages'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: retrieveTracker
    put:
      operationId: updateTracker
      description: Mixin to log requests
      summary: Update tracker data
      parameters:
      - in: path
        name: id_or_tracking_number
        schema:
          type: string
        required: true
      tags:
      - Trackers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackerUpdateData'
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingStatus'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: updateTracker
    delete:
      operationId: removeTracker
      description: Discard a package tracker.
      summary: Discard a package tracker
      parameters:
      - in: path
        name: id_or_tracking_number
        schema:
          type: string
        required: true
      tags:
      - Trackers
      security:
      - TokenBasic: []
      - Token: []
      - OAuth2: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingStatus'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
      x-operationId: removeTracker
components:
  schemas:
    ErrorMessages:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          description: The list of error messages
    Message:
      type: object
      properties:
        message:
          type: string
          description: The error or warning message
        code:
          type: string
          description: The message code
        details:
          type: object
          additionalProperties: {}
          description: any additional details
        carrier_name:
          type: string
          description: The targeted carrier
        carrier_id:
          type: string
          description: The targeted carrier name (unique identifier)
    TrackerUpdateData:
      type: object
      properties:
        info:
          allOf:
          - $ref: '#/components/schemas/TrackingInfo'
          description: The package and shipment tracking details
        metadata:
          type: object
          additionalProperties: {}
          description: User metadata for the tracker
    TrackingStatus:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier
        carrier_name:
          type: string
          description: The tracking carrier
        carrier_id:
          type: string
          description: The tracking carrier configured identifier
        tracking_number:
          type: string
          description: The shipment tracking number
        info:
          allOf:
          - $ref: '#/components/schemas/TrackingInfo'
          default:
            carrier_tracking_link: null
            customer_name: null
            expected_delivery: null
            note: null
            order_date: null
            order_id: null
            package_weight: null
            package_weight_unit: null
            shipment_package_count: null
            shipment_pickup_date: null
            shipment_delivery_date: null
            shipment_service: null
            shipment_origin_country: null
            shipment_origin_postal_code: null
            shipment_destination_country: null
            shipment_destination_postal_code: null
            shipping_date: null
            signed_by: null
            source: null
          description: The package and shipment tracking details
        events:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TrackingEvent'
          description: The tracking details events
        delivered:
          type: boolean
          description: Specified whether the related shipment was delivered
        test_mode:
          type: boolean
          description: Specified whether the object was created with a carrier in test mode
        status:
          enum:
          - pending
          - unknown
          - on_hold
          - delivered
          - in_transit
          - delivery_delayed
          - out_for_delivery
          - ready_for_pickup
          - delivery_failed
          type: string
          x-spec-enum-id: 979a07e5fd2a5042
          default: pending
          description: The current tracking status
        estimated_delivery:
          type: string
          description: The delivery estimated date
        meta:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: provider specific metadata
        object_type:
          type: string
          default: tracker
          description: Specifies the object type
        metadata:
          type: object
          additionalProperties: {}
          default: {}
          description: User metadata for the tracker
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          default: []
          description: The list of note or warning messages
        delivery_image_url:
          type:
          - string
          - 'null'
          format: uri
          description: The shipment invoice URL
        signature_image_url:
          type:
          - string
          - 'null'
          format: uri
          description: The shipment invoice URL
      required:
      - carrier_id
      - carrier_name
      - test_mode
      - tracking_number
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
          description: The list of API errors
    APIError:
      type: object
      properties:
        message:
          type: string
          description: The error or warning message
        code:
          type: string
          description: The message code
        details:
          type: object
          additionalProperties: {}
          description: any additional details
    TrackingData:
      type: object
      properties:
        tracking_number:
          type: string
          description: The package tracking number
        carrier_name:
          enum:
          - allied_express
          - allied_express_local
          - amazon_shipping
          - aramex
          - asendia_us
          - australiapost
          - boxknight
          - bpost
          - canadapost
          - canpar
          - chronopost
          - colissimo
          - dhl_express
          - dhl_parcel_de
          - dhl_poland
          - dhl_universal
          - dicom
          - dpd
          - dpdhl
          - fedex
          - fedex_ws
          - generic
          - geodis
          - hay_post
          - laposte
          - locate2u
          - nationex
          - purolator
          - roadie
          - royalmail
          - seko
          - sendle
          - tge
          - tnt
          - ups
          - usps
          - usps_international
          - usps_wt
          - usps_wt_international
          - zoom2u
          type: string
          x-spec-enum-id: 0253dcf2d811f867
          description: The tracking carrier
        account_number:
          type:
          - string
          - 'null'
          description: The shipper account number
        reference:
          type:
          - string
          - 'null'
          description: The shipment reference
        info:
          allOf:
          - $ref: '#/components/schemas/TrackingInfo'
          description: The package and shipment tracking details
        metadata:
          type: object
          additionalProperties: {}
          default: {}
          description: The carrier user metadata.
      required:
      - carrier_name
      - tracking_number
    TrackerList:
      type: object
      properties:
        count:
          type:
          - integer
          - 'null'
        next:
          type:
          - string
          - 'null'
          format: uri
        previous:
          type:
          - string
          - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/TrackingStatus'
      required:
      - results
    TrackingEvent:
      type: object
      properties:
        date:
          type: string
          description: 'The tracking event''s date. Format: `YYYY-MM-DD`'
        description:
          type: string
          description: The tracking event's description
        location:
          type: string
          description: The tracking event's location
        code:
          type:
          - string
          - 'null'
          description: The tracking event's code
        time:
          type:
          - string
          - 'null'
          description: 'The tracking event''s time. Format: `HH:MM AM/PM`'
        latitude:
          type:
          - number
          - 'null'
          format: double
          description: The tracking event's latitude.
        longitude:
          type:
          - number
          - 'null'
          format: double
          description: The tracking event's longitude.
    TrackingInfo:
      type: object
      properties:
        carrier_tracking_link:
          type:
          - string
          - 'null'
          description: The carrier tracking link
        customer_name:
          type:
          - string
          - 'null'
          description: The customer name
        expected_delivery:
          type:
          - string
          - 'null'
          description: The expected delivery date
        note:
          type:
          - string
          - 'null'
          description: A tracking note
        order_date:
          type:
          - string
          - 'null'
          description: The package order date
        order_id:
          type:
          - string
          - 'null'
          description: The package order id or number
        package_weight:
          type:
          - string
          - 'null'
          description: The package weight
        package_weight_unit:
          type:
          - string
          - 'null'
          description: The package weight unit
        shipment_package_count:
          type:
          - string
          - 'null'
          description: The package count
        shipment_pickup_date:
          type:
          - string
          - 'null'
          description: The shipment pickup date
        shipment_delivery_date:
          type:
          - string
          - 'null'
          description: The shipment delivery date
        shipment_service:
          type:
          - string
          - 'null'
          description: The shipment service
        shipment_origin_country:
          type:
          - string
          - 'null'
          description: The shipment origin country
        shipment_origin_postal_code:
          type:
          - string
          - 'null'
          description: The shipment origin postal code
        shipment_destination_country:
          type:
          - string
          - 'null'
          description: The shipment destination country
        shipment_destination_postal_code:
          type:
          - string
          - 'null'
          description: The shipment destination postal code
        shipping_date:
          type:
          - string
          - 'null'
          description: The shipping date
        signed_by:
          type:
          - string
          - 'null'
          description: The person who signed for the package
        source:
          type:
          - string
          - 'null'
          description: The tracker source
  securitySchemes:
    JWT:
      in: header
      type: apiKey
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      description: 'Authorization: Bearer xxx.xxx.xxx'
    OAuth2:
      type: oauth2
      in: header
      name: Authorization
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize/
          tokenUrl: /oauth/token/
          scopes:
            read: Reading scope
            write: Writing scope
            openid: OpenID connect
      description: 'Authorization: Bearer xxxxxxxx'
    Token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization: Token key_xxxxxxxx'
    TokenBasic:
      type: http
      scheme: basic
      name: Authorization
      description: '-u key_xxxxxxxx:'
x-provenance:
  method: harvested
  publisher: Karrio
  source: https://www.karrio.io/openapi.yml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)