BizKitHub
DocsAPI ReferenceShipment/bff/shipment/complaint-return
postShipmentAdmin BFF

/bff/shipment/complaint-return

Uses the order delivery address as sender and the carrier account sender address as recipient. Packeta returns are label-less (drop-off code); other carriers return a label. With sendToCustomer the customer gets the complaint-return-label e-mail.

ShipmentpostBffShipmentComplaint-return

Parameters

JSON body

Request body

application/json
complaintExternalIdstringRequired
carrierConfigurationExternalIdstringRequired
serviceCodestringOptional
weightGnumberRequired
Range: 1–100000
sendToCustomerbooleanOptional

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

POST /bff/shipment/complaint-return

post
curl -X POST "https://api.bizkithub.com/bff/shipment/complaint-return" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "complaintExternalId": "example_complaintExternalId",
  "carrierConfigurationExternalId": "example_carrierConfigurationExternalId",
  "serviceCode": "example_serviceCode",
  "weightG": 0,
  "sendToCustomer": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key