Skip to main content

Refund Label

POST 

/api/shippo/instances/:integration_instance/labels/:label/refund

Requests a void/refund of a purchased label at Shippo. Refunds are asynchronous: the label is returned in its refund-pending state (status REFUNDPENDING, refund_status QUEUED or PENDING) and resolves to REFUNDED or REFUNDREJECTED later via webhook or the tracking reconcile — live refunds can take up to 14 days. Test-mode refunds usually resolve immediately.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

No body. Refunds are refused (422, code api_error) when the label was never purchased, a refund was already requested, or the carrier has already scanned the parcel. Shippo failures return 422 with a stable code: invalid_token (Shippo rejected the API token), rate_limited (Shippo is throttling — retry in a minute), api_error (Shippo refused the request; message carries its reason) or unreachable (Shippo could not be reached). Returns 404 when the label does not exist or belongs to a different instance.

Authentication: Requires a Bearer token.

Required permission: fulfillment_orders.ship (Fulfillment Orders → Ship) and fulfillment_orders.index (Fulfillment Orders → View). A token also needs its orders scope; the owner needs these role permissions.

Request​

Responses​

OK

Response Headers
    Content-Type