VTEX · Schema

Marketplace

Details about the marketplace related to the order.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
baseURL string Marketplace base URL.
isCertified string If is a certified marketplace.
name string Name of the marketplace.
View JSON Schema on GitHub

JSON Schema

vtex-marketplace-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Marketplace",
  "title": "Marketplace",
  "description": "Details about the marketplace related to the order.",
  "required": [
    "baseURL",
    "isCertified",
    "name"
  ],
  "type": "object",
  "properties": {
    "baseURL": {
      "type": "string",
      "description": "Marketplace base URL."
    },
    "isCertified": {
      "type": "string",
      "nullable": true,
      "description": "If is a certified marketplace."
    },
    "name": {
      "type": "string",
      "description": "Name of the marketplace."
    }
  },
  "example": {
    "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
    "isCertified": null,
    "name": "luxstore"
  }
}