VTEX · Schema

OriginV2

Object containing information about the order origin.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
account string Name of the account where the order was made.
orderId string Order ID is a unique code that identifies an order.
component string Component information.
View JSON Schema on GitHub

JSON Schema

vtex-originv2-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OriginV2",
  "title": "OriginV2",
  "required": [
    "account",
    "orderId",
    "component"
  ],
  "type": "object",
  "properties": {
    "account": {
      "type": "string",
      "description": "Name of the account where the order was made.",
      "example": "qastore"
    },
    "orderId": {
      "type": "string",
      "description": "Order ID is a unique code that identifies an order.",
      "example": "v12772213qst-02"
    },
    "component": {
      "type": "string",
      "description": "Component information.",
      "example": "MarketplaceComponent"
    }
  },
  "description": "Object containing information about the order origin.",
  "example": {
    "account": "qastore",
    "orderId": "v12772213qst-02",
    "component": "MarketplaceComponent"
  }
}