BizKitHub
DocsAPI ReferenceShipping/bff/shipping/preview
postShippingAdmin BFF

/bff/shipping/preview

Runs the full shipping calculator against a simulated cart. Useful in the admin configurator to sanity-check the price rules before publishing. Body accepts the raw cart lines (product / variant / qty / unit gross price) and resolves weights + shipping classes from the catalog server-side.

ShippingpostBffShippingPreview

Parameters

JSON body

Request body

application/json
countryCodestringRequired
customerIdstring | integerOptional
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
salesChannelCodestringOptional
Length: 032
itemsobject[]Required
Each array item:
productIdstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
variantIdstring | integer | nullRequired
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Variant 2
null
quantitystring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 1
unitPriceGrossnumberRequired
Range: 0

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/shipping/preview

post
curl -X POST "https://api.bizkithub.com/bff/shipping/preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "countryCode": "example_countryCode",
  "salesChannelCode": "example_salesChannelCode",
  "items": [
    {
      "unitPriceGross": 0
    }
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key