BizKitHub
DocsAPI ReferenceShipping/bff/shipping/method/{externalId}/update
postShippingAdmin BFF

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

Update shipping method

ShippingpostBffShippingMethodByExternalIdUpdate

Parameters

1 path · JSON body

Path parameters

· 1
externalIdstringRequired
Exampleexample_externalId

Request body

application/json
codestringRequired
Length: 1100
namestringRequired
Length: 1150
descriptionstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
audience"all" | "retail" | "wholesale" | "group"Required
isVisiblebooleanOptional
isDefaultbooleanOptional
isActivebooleanOptional
sortOrderstring | integerOptional
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0
freeShippingEligiblebooleanOptional
legacyPricenumberOptional
Range: 0
carrierIdstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Variant 2
null
carrierServiceIdstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Variant 2
null
logoBlobIdstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Variant 2
null
translationsobject[]Optional
Each array item:
localeIdstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
namestringRequired
Length: 1
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
paymentMethodIdsstring | integer[]Optional
Each array item:
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
contactGroupIdsstring | integer[]Optional
Each array item:
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
shippingClassIdsstring | integer[]Optional
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/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": []
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key