VTEX · Schema

Partial update connector

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
path string What part of the configuration do you want to change.
op string Type of operation to be performed.
value string New value which will appear in the changed field.
View JSON Schema on GitHub

JSON Schema

vtex-partialupdateconnector-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/partialUpdateConnector",
  "title": "Partial update connector",
  "required": [
    "path",
    "op",
    "value"
  ],
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "default": "",
      "description": "What part of the configuration do you want to change."
    },
    "op": {
      "type": "string",
      "default": "",
      "description": "Type of operation to be performed."
    },
    "value": {
      "type": "string",
      "default": "",
      "description": "New value which will appear in the changed field."
    }
  },
  "example": {
    "path": "/segment",
    "op": "replace",
    "value": "DEPARTMENT_STORES"
  }
}