VTEX · Schema

Updatepartialinvoice.SendTrackingNumber.Request

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
trackingNumber string The number code that identifies the order tracking.
trackingUrl string Package tracking URL.
dispatchedDate string Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00.
courier string The name of the carrier responsible for delivering the order.
View JSON Schema on GitHub

JSON Schema

vtex-updatepartialinvoicesendtrackingnumberrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Updatepartialinvoice.SendTrackingNumber.Request",
  "title": "Updatepartialinvoice.SendTrackingNumber.Request",
  "required": [
    "trackingNumber",
    "trackingUrl",
    "courier",
    "dispatchedDate"
  ],
  "type": "object",
  "properties": {
    "trackingNumber": {
      "type": "string",
      "description": "The number code that identifies the order tracking."
    },
    "trackingUrl": {
      "type": "string",
      "nullable": true,
      "description": "Package tracking URL."
    },
    "dispatchedDate": {
      "type": "string",
      "nullable": true,
      "description": "Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00."
    },
    "courier": {
      "type": "string",
      "nullable": true,
      "description": "The name of the carrier responsible for delivering the order."
    }
  },
  "example": {
    "trackingNumber": "87658",
    "trackingUrl": "https://www.tracking.com/url",
    "courier": "carrierOne",
    "dispatchedDate": "2022-02-08T13:16:13.4617653+00:00"
  }
}