PayPal · Schema

Tracking Identifier

The tracking identifiers for a shipment.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
transaction_id string The PayPal transaction ID.
tracking_number string The tracking number for the shipment.
links array An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
View JSON Schema on GitHub

JSON Schema

paypal-tracker-identifier-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tracker_identifier",
  "title": "Tracking Identifier",
  "type": "object",
  "description": "The tracking identifiers for a shipment.",
  "properties": {
    "transaction_id": {
      "type": "string",
      "description": "The PayPal transaction ID.",
      "minLength": 1,
      "maxLength": 50,
      "pattern": "^[a-zA-Z0-9]*$"
    },
    "tracking_number": {
      "type": "string",
      "description": "The tracking number for the shipment.",
      "minLength": 1,
      "maxLength": 64
    },
    "links": {
      "type": "array",
      "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/link_description",
        "readOnly": true
      }
    }
  },
  "required": [
    "transaction_id"
  ]
}