Java bridge reference

This older, unversioned documentation link describes the three Java API-key bridge endpoints. It is not the original V1 JWT API or the new V2 resource API. Choose the version used by your integration.

Developer API

Request label cancellation

POST
/v1/shipping/refund

Permissions: labels.buy

Request fields

shippingAccountIdThe shipping account used to purchase the label.
shipmentId, trackingNumberThe shipment identifier and tracking number returned when the label was purchased.

Response

Returns accepted, refundId and message. Review the result before treating a cancellation as successful. Availability and refund timing depend on the carrier and label status.

Responses use { code, message, data }. Check both the HTTP status and response code; provider errors are not successful purchases.