VTEX · Schema

requestSendTracking

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
courier string Courier.
trackingNumber string Tracking number.
trackingUrl string Tracking URL.
dispatchedDate string Date of order dispatch.
View JSON Schema on GitHub

JSON Schema

vtex-requestsendtracking-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/requestSendTracking",
  "title": "requestSendTracking",
  "required": [
    "courier",
    "trackingNumber",
    "trackingUrl",
    "dispatchedDate"
  ],
  "properties": {
    "courier": {
      "type": "string",
      "description": "Courier.",
      "example": "courier-example"
    },
    "trackingNumber": {
      "type": "string",
      "description": "Tracking number.",
      "example": "12345678abc"
    },
    "trackingUrl": {
      "type": "string",
      "description": "Tracking URL.",
      "example": "https://courier-example.com/tracking"
    },
    "dispatchedDate": {
      "type": "string",
      "description": "Date of order dispatch.",
      "example": "2021-06-09"
    }
  }
}