BizKitHub
DocsAPI ReferenceShipment/bff/shipment/defaults
getShipmentAdmin BFF

/bff/shipment/defaults

Suggested carrier account, service, pickup point and weight for a new shipment, derived from the order's shipping method and items. Values are suggestions; the operator may change them.

ShipmentgetBffShipmentDefaults

Parameters

1 query

Query parameters

· 1
orderExternalIdstringRequired
Exampleexample_orderExternalId

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/shipment/defaults

get
curl -X GET "https://api.bizkithub.com/bff/shipment/defaults?orderExternalId=example_orderExternalId" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key