/bff/shipping/method/{externalId}/update

Update shipping method

ShippingpostBffShippingMethodByExternalIdUpdate

Parameters

1 path · 17 body

18 total

Path · 1

externalIdstringRequired

Body · 17

codestringRequired

Length: 1–100

namestringRequired

Length: 1–150

descriptionstring | null

audiencestring | string | string | stringRequired

isVisibleboolean

isDefaultboolean

isActiveboolean

sortOrderstring | integer

Range: 0–∞

freeShippingEligibleboolean

legacyPricenumber

Range: 0–∞

carrierIdnull

carrierServiceIdnull

logoBlobIdnull

translationsobject[]3 fields

paymentMethodIdsstring | integer[]

contactGroupIdsstring | integer[]

shippingClassIdsstring | integer[]

Request

POST /bff/shipping/method/{externalId}/update

post

curl -X POST "https://api.bizkithub.com/bff/shipping/method/example_externalId/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "example_code",
  "name": "example_name",
  "isVisible": false,
  "isDefault": false,
  "isActive": false,
  "freeShippingEligible": false,
  "legacyPrice": 0,
  "translations": [
    {
      "name": "example_name"
    }
  ],
  "paymentMethodIds": [],
  "contactGroupIds": [],
  "shippingClassIds": []
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key