VTEX · Schema

TrackingEventsRequest

Shipping's tracking information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
trackingNumber string Shipping's tracking identification code.
View JSON Schema on GitHub

JSON Schema

vtex-trackingeventsrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrackingEventsRequest",
  "title": "TrackingEventsRequest",
  "description": "Shipping's tracking information.",
  "required": [
    "trackingNumber"
  ],
  "type": "object",
  "properties": {
    "trackingNumber": {
      "type": "string",
      "description": "Shipping's tracking identification code.",
      "example": "BR000000000"
    }
  },
  "example": {
    "trackingNumber": "BR000000000"
  }
}