settings.channel.update

Update one marketplace channel's policy: push/pull switches, price rule, buffer, resend window, disconnect and buyer-mail policy.

Payload

fieldtyperequirednotes
channelstring (/^[a-z0-9_]{2,24}$/)yes
patchobjectyes
pushStockboolean | nullno
pushPriceboolean | nullno
pullOrdersboolean | nullno
pullStockboolean | nullno
bufferinteger (0..10000) | nullno
minResendMinutesinteger (0..60) | nullno
disconnect"zero" | "freeze" | nullno
buyerMail"suppress" | "send" | nullno
autoApproveboolean | nullno
pullIntervalSecinteger (60..3600) | nullno
priceRuleobjectno
base"price" | "compareAt" | nullno
markupBpinteger (-5000..50000) | nullno
addKurusinteger (-10000000..10000000) | nullno
rounding"90" | "99" | "none" | "integer" | nullno
floorKurusinteger (0..9007199254740991) | nullno
ceilingKurusinteger (0..9007199254740991) | nullno
maxChangeBpinteger (0..100000) | nullno
listPrice"sale" | "compareAt" | "markup" | nullno
listMarkupBpinteger (0..50000) | nullno

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "pattern": "^[a-z0-9_]{2,24}$"
    },
    "patch": {
      "type": "object",
      "properties": {
        "pushStock": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "pushPrice": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "pullOrders": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "pullStock": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "buffer": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            },
            {
              "type": "null"
            }
          ]
        },
        "minResendMinutes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 60
            },
            {
              "type": "null"
            }
          ]
        },
        "disconnect": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "zero",
                "freeze"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "buyerMail": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "suppress",
                "send"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "autoApprove": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "pullIntervalSec": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 60,
              "maximum": 3600
            },
            {
              "type": "null"
            }
          ]
        },
        "priceRule": {
          "type": "object",
          "properties": {
            "base": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "price",
                    "compareAt"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "markupBp": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": -5000,
                  "maximum": 50000
                },
                {
                  "type": "null"
                }
              ]
            },
            "addKurus": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": -10000000,
                  "maximum": 10000000
                },
                {
                  "type": "null"
                }
              ]
            },
            "rounding": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "90",
                    "99",
                    "none",
                    "integer"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "floorKurus": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            },
            "ceilingKurus": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            },
            "maxChangeBp": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 100000
                },
                {
                  "type": "null"
                }
              ]
            },
            "listPrice": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "sale",
                    "compareAt",
                    "markup"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "listMarkupBp": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 50000
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "channel",
    "patch"
  ],
  "additionalProperties": false
}
Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/commands/settings.channel.update.md