BizKitHub
DocsAPI ReferenceBff/bff/carrier-invoice/preview
postBffAdmin BFF

/bff/carrier-invoice/preview

No description provided.

bffpostBffCarrier-invoicePreview

Parameters

JSON body

Request body

application/json
fileBase64stringRequired
Length: 1–∞
mappingobjectOptional
trackingstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
amountstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
weightstring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null
currencystring | integer | nullOptional
One of 2:
Variant 1
string | integer
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Range: 0–∞
Variant 2
null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/carrier-invoice/preview

post
curl -X POST "https://api.bizkithub.com/bff/carrier-invoice/preview" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "fileBase64": "example_fileBase64",
  "mapping": {}
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key