{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-courier-connection-response-get-multiple-schema.json",
  "title": "Courier connection response for get courier connections",
  "description": "Courier connection response for getting courier connections",
  "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_response_get_multiple",
  "x-stoplight": {
    "id": "9o1l7x6pqo6fp"
  },
  "type": "object",
  "required": [
    "meta"
  ],
  "properties": {
    "meta": {
      "$ref": "#/$defs/Meta.v1",
      "x-stoplight": {
        "id": "6c201d370nvrt"
      }
    },
    "data": {
      "type": "object",
      "x-stoplight": {
        "id": "w25ebamui3w29"
      },
      "properties": {
        "pagination": {
          "type": "object",
          "x-stoplight": {
            "id": "vkvzrkb7rdj7y"
          },
          "properties": {
            "total": {
              "type": "integer",
              "x-stoplight": {
                "id": "a4sudr3suz1mx"
              },
              "description": "The total number of courier connections."
            },
            "next_cursor": {
              "type": "string",
              "x-stoplight": {
                "id": "pg0inus4ychbj"
              },
              "description": "A string representing the cursor value for the next page of results."
            },
            "has_next_page": {
              "type": "boolean",
              "x-stoplight": {
                "id": "1nmwapf8zdp7j"
              },
              "description": "To indicate if next page is available."
            }
          }
        },
        "courier_connections": {
          "type": "array",
          "x-stoplight": {
            "id": "36jy9hhq1dksm"
          },
          "items": {
            "$ref": "#/$defs/Courier_connection",
            "x-stoplight": {
              "id": "v74u6j9mo413l"
            }
          }
        }
      }
    }
  },
  "$defs": {
    "Courier_connection": {
      "x-stoplight": {
        "id": "h993xw7eds2r0"
      },
      "title": "courier_connection",
      "type": "object",
      "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.",
      "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."
        }
      }
    },
    "Meta.v1": {
      "title": "meta",
      "type": "object",
      "description": "Meta data",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "description": "meta code"
        },
        "message": {
          "type": "string",
          "description": "error message, only exist if the response status is not 2xx"
        },
        "type": {
          "type": "string",
          "enum": [
            "BadRequest",
            "Unauthorized",
            "Forbidden",
            "NotFound",
            "TooManyRequests",
            "InternalError"
          ],
          "description": "error type, only exist if the response status is not 2xx"
        }
      }
    }
  }
}