courier_connection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-courier-connection-schema.json",
  "title": "courier_connection",
  "description": "This model represents user-created courier connection details. AfterShip will use this information to retrieve tracking updates from carriers based on the provided tracking numbers.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aftership-courier-connection-api-openapi.yml#/components/schemas/Courier_connection",
  "x-stoplight": {
    "id": "h993xw7eds2r0"
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "x-stoplight": {
        "id": "201rqv73grnrb"
      },
      "description": "The courier connection ID is a special set of numbers generated by AfterShip to define each user-created connection."
    },
    "courier_slug": {
      "type": "string",
      "x-stoplight": {
        "id": "ee7qhv7as4q73"
      },
      "description": "Unique courier code. Get courier codes [here](https://www.aftership.com/docs/tracking/others/supported-couriers)."
    },
    "credentials": {
      "type": "object",
      "x-stoplight": {
        "id": "xi69b9bloyj4v"
      },
      "description": "It refers to the authentication details required for each specific carrier details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to establish a carrier connection. The content varies by carrier.",
      "additionalProperties": {
        "x-stoplight": {
          "id": "ocqnsnsekerdh"
        },
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "x-stoplight": {
        "id": "zop3vvrqzfmmx"
      },
      "description": "The date and time the courier connection was created. It uses the format YYYY-MM-DDTHH:mm:ssZ for the timezone GMT +0."
    },
    "updated_at": {
      "type": "string",
      "x-stoplight": {
        "id": "jr9fxq11w9ghx"
      },
      "description": "The date and time the courier connection was updated. It uses the format YYYY-MM-DDTHH:mm:ssZ for the timezone GMT +0."
    }
  }
}