BizKitHub
DocsAPI ReferenceShipment/bff/shipment/api-log
getShipmentAdmin BFF

/bff/shipment/api-log

Every HTTP exchange with the carrier API (redacted request + response, status, duration), newest first, for one shipment or one carrier account.

ShipmentgetBffShipmentApi-log

Parameters

5 query

Query parameters

· 5
shipmentExternalIdstringOptional
Exampleexample_shipmentExternalId
carrierConfigurationExternalIdstringOptional
Exampleexample_carrierConfigurationExternalId
onlyErrorsstringOptional
Exampleexample_onlyErrors
pagestringOptional
Exampleexample_page
limitstringOptional
Exampleexample_limit

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/shipment/api-log

get
curl -X GET "https://api.bizkithub.com/bff/shipment/api-log?shipmentExternalId=example_shipmentExternalId&carrierConfigurationExternalId=example_carrierConfigurationExternalId&onlyErrors=example_onlyErrors&page=example_page&limit=example_limit" \
  -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