VTEX · Schema

MetaData

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
0	object	Item ID in the cart.
shippingEstimatedDate	string	Order's Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
metaData	string	Metadata.
serviceId	string	Service ID.
shippingPrice	number	Order's shipping price in cents.
status	string	Shipping status.
labels	array	Shipping labels, there may be more than one per order due to breakage in packages.
trackingUrl	string	Carrier's tracking URL of the order.
name	string	Carrier name.
id	string	Tracking ID.
type	string	Type of transportation.
url	string	Carrier URL.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetaData",
  "title": "MetaData",
  "type": "object",
  "properties": {
    "0": {
      "$ref": "#/components/schemas/generatedObject",
      "description": "Item ID in the cart."
    },
    "shippingEstimatedDate": {
      "type": "string",
      "nullable": true,
      "description": "Order's Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "metaData": {
      "type": "string",
      "nullable": true,
      "description": "Metadata."
    },
    "serviceId": {
      "type": "string",
      "description": "Service ID."
    },
    "shippingPrice": {
      "type": "number",
      "description": "Order's shipping price in cents."
    },
    "status": {
      "type": "string",
      "description": "Shipping status."
    },
    "labels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Label"
      },
      "description": "Shipping labels, there may be more than one per order due to breakage in packages."
    },
    "trackingUrl": {
      "type": "string",
      "description": "Carrier's tracking URL of the order."
    },
    "name": {
      "type": "string",
      "description": "Carrier name."
    },
    "id": {
      "type": "string",
      "description": "Tracking ID."
    },
    "type": {
      "type": "string",
      "description": "Type of transportation."
    },
    "url": {
      "type": "string",
      "description": "Carrier URL."
    }
  },
  "example": {
    "shippingEstimatedDate": "2024-01-05T11:11:11.000Z",
    "metaData": null,
    "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27",
    "shippingPrice": 284.02,
    "status": "PENDING",
    "labels": [
      {
        "name": "Shipping label",
        "id": "78c83922-d658-48bf-89d5-0658a6a94e27",
        "type": "PDF",
        "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf"
      }
    ]
  }
}