settings.checkout.update
Update checkout legal settings: delivery estimate, return-cargo carrier/cost disclosure.
- scope:
store:admin - storefront-visible (bumps the catalog generation): no
- destructive: no
Payload
| field | type | required | notes |
|---|---|---|---|
deliveryEstimateDays | array<object> | null | no | |
returnCarrierName | string (≤60 chars) | null | no | |
returnCostBearer | "merchant" | "consumer" | null | no | |
returnCostKurus | integer (0..10000000000000) | null | no | |
returnAddress | string (≤300 chars) | null | no | |
returnInstructionsNote | string (≤500 chars) | null | no |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"deliveryEstimateDays": {
"anyOf": [
{
"type": "array",
"prefixItems": [
{
"type": "integer",
"minimum": 1,
"maximum": 30
},
{
"type": "integer",
"minimum": 1,
"maximum": 30
}
]
},
{
"type": "null"
}
]
},
"returnCarrierName": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 60
},
{
"type": "null"
}
]
},
"returnCostBearer": {
"anyOf": [
{
"type": "string",
"enum": [
"merchant",
"consumer"
]
},
{
"type": "null"
}
]
},
"returnCostKurus": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 10000000000000
},
{
"type": "null"
}
]
},
"returnAddress": {
"anyOf": [
{
"type": "string",
"minLength": 10,
"maxLength": 300
},
{
"type": "null"
}
]
},
"returnInstructionsNote": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/commands/settings.checkout.update.md