VTEX · Schema

OrderInfo

Order information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
orderId string Order ID.
sequence integer Sequence number.
cart object
clientProfile object
shipping object
View JSON Schema on GitHub

JSON Schema

vtex-orderinfo-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrderInfo",
  "title": "OrderInfo",
  "type": "object",
  "description": "Order information.",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Order ID.",
      "example": "v5006128str"
    },
    "sequence": {
      "type": "integer",
      "description": "Sequence number.",
      "example": 5006128
    },
    "cart": {
      "$ref": "#/components/schemas/Cart1"
    },
    "clientProfile": {
      "$ref": "#/components/schemas/ClientProfile"
    },
    "shipping": {
      "$ref": "#/components/schemas/Shipping"
    }
  }
}