Update Merchant Shipping Settings

Updates the merchant's fallback shipping behavior toggles.

Update Merchant Shipping Settings

patch

Partially updates the merchant's shipping toggles using JSON Merge Patch semantics: only the fields present in the request body are modified; omitted fields are left untouched.

Path parameters

merchant_idinteger · int32Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/jsonapplication/merge-patch+json

Toggles that govern fallback shipping behavior. Does not manage fallback shipping methods or shipping exclusion rules.

exclude_external_methodsboolean · nullableOptional

When true, ignore all shipping rates returned by the merchant's e-commerce platform.

Example: true

exclude_external_free_shippingboolean · nullableOptional

When true, hide free shipping options returned by the platform.

Example: false

use_fallback_methods_on_emptyboolean · nullableOptional

When true, use fallback methods only when the platform returns zero rates, rather than always.

Example: true

Responses

200

The updated shipping settings.

application/json

Toggles that govern fallback shipping behavior. Does not manage fallback shipping methods or shipping exclusion rules.

exclude_external_methodsboolean · nullableOptional

When true, ignore all shipping rates returned by the merchant's e-commerce platform.

Example: true

exclude_external_free_shippingboolean · nullableOptional

When true, hide free shipping options returned by the platform.

Example: false

use_fallback_methods_on_emptyboolean · nullableOptional

When true, use fallback methods only when the platform returns zero rates, rather than always.

Example: true

patch/merchants/{merchant_id}/shipping-settings

HTTPcURLJavaScriptPython

PATCH /v1/merchants/{merchant_id}/shipping-settings HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "exclude_external_methods": true
}

application/jsonapplication/merge-patch+json

200

The updated shipping settings.

{
  "exclude_external_methods": true,
  "exclude_external_free_shipping": false,
  "use_fallback_methods_on_empty": true
}