Skip to main content
POST
Estimate refund for a shipment or order

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Body

application/json
order_number
string
required
shipment_number
string | null
required

Shipment number to estimate refund for. If not provided, refund will be estimated for the order as a whole.

Response

OK

message
string
required
success
boolean
required
content
object
required