Get Merchant Shipping Settings

Returns the merchant's fallback shipping behavior toggles. Fallback shipping methods and shipping exclusion rules are managed through their own resources and are not included here.

Get Merchant Shipping Settings

get

Returns the merchant's fallback shipping behavior toggles. Fallback shipping methods and shipping exclusion rules are managed through their own resources and are not included here.

Path parameters

merchant_idinteger · int32Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

The merchant's 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

get/merchants/{merchant_id}/shipping-settings

HTTPcURLJavaScriptPython

GET /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
Accept: */*

200

The merchant's shipping settings.

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