BizKitHub
DocsAPI ReferenceShipping/bff/shipping/free-shipping-rule/{ruleId}/update
postShippingAdmin BFF

/bff/shipping/free-shipping-rule/{ruleId}/update

Update free-shipping rule

ShippingpostBffShippingFree-shipping-ruleByRuleIdUpdate

Parameters

1 path · JSON body

Path parameters

· 1
ruleIdstring | integerRequired

Request body

application/json
countryCodestringRequired
audience"all" | "retail" | "wholesale" | "group"Required
minOrderValuenumberRequired
restrictedDeliveryIdsstring | integer[]Required
Each array item:
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/shipping/free-shipping-rule/{ruleId}/update

post
curl -X POST "https://api.bizkithub.com/bff/shipping/free-shipping-rule/{ruleId}/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "countryCode": "example_countryCode",
  "minOrderValue": 0,
  "restrictedDeliveryIds": []
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key