17TRACK · Schema

BatchResponse

Standard batch response listing accepted and rejected items.

ShippingPackage TrackingLogisticsCarriersDeliveryWebhooks

Properties

Name Type Description
code integer Response status code (0 for success)
data object
View JSON Schema on GitHub

JSON Schema

BatchResponse.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.17track.net/track/v1/schemas/BatchResponse",
  "title": "BatchResponse",
  "description": "Standard batch response listing accepted and rejected items.",
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "Response status code (0 for success)",
      "example": 0
    },
    "data": {
      "type": "object",
      "properties": {
        "accepted": {
          "type": "array",
          "description": "Successfully processed items",
          "items": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string",
                "description": "Tracking number"
              }
            }
          }
        },
        "rejected": {
          "type": "array",
          "description": "Items that could not be processed with error details",
          "items": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string",
                "description": "Tracking number"
              },
              "error": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "integer",
                    "description": "Error code"
                  },
                  "message": {
                    "type": "string",
                    "description": "Error description"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}