VTEX · Schema

PurchaseSettingsRequest

Object containing purchase settings information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentMethod object
salesChannel string Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) applied to the subscription being created. You can associate only one sales channel
View JSON Schema on GitHub

JSON Schema

vtex-purchasesettingsthinrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PurchaseSettingsThinRequest",
  "title": "PurchaseSettingsRequest",
  "description": "Object containing purchase settings information.",
  "required": [
    "paymentMethod",
    "salesChannel"
  ],
  "type": "object",
  "properties": {
    "paymentMethod": {
      "$ref": "#/components/schemas/PaymentMethodThinRequest"
    },
    "salesChannel": {
      "type": "string",
      "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) applied to the subscription being created. You can associate only one sales channel to each subscription. The default value is the main sales channel, which corresponds to `1`.",
      "default": "1"
    }
  },
  "additionalProperties": false
}