SHshopback
Orders

Order refund

post/order/{orderUuid}/refund

Request

Path parameters

orderUuidstring required

order uuid

Headers

Authorizationstring required

Authorization

X-ShopBack-Idempotent-Idstring
Example:faa5e09a-8cf3-43f7-8309-d94deb426e66

Idempotent Id for the request. If this is absent, every request will be treated as unique and will be processed as such. (This is optional for now, but will be made required in the future)

Request body */*

descriptionstring required

Operation description

refundedByEmailstring

Refunded by email - coming from business.shopback.* portal

webhookUrlstring

Webhook address - when operation will be done specified endpoint will be invoked

amountnumber required

Amount to refund

Example request

{
  "description": "Out of stock/Color is not fit to my bedroom",
  "refundedByEmail": "user@email.com",
  "webhookUrl": "https://mystore.com/shopback/hooks",
  "items": [
    {
      "sku": "93847598347"
    }
  ]
}

Response

successful operation

status'ACCEPTED' | 'REJECTED' | 'DONE' | 'FAILED' required

Request processing status

requestIdstring

Request identifier. Present only if request has been accepted.

createdAtstring date-time

Request creation date-time in ISO-8601 date-time format. Present only if request has been accepted.

type'FULL' | 'PARTIAL' required

Type of refund.

codestring required

Response code. Useful to extract error details.

messagestring required

Response message

Example response

{
  "status": "ACCEPTED, REJECTED, DONE, FAILED",
  "requestId": "d04f56e9-412c-4e7a-8cb7-3f405ff96a13",
  "createdAt": "2022-04-01T04:01:41.041Z",
  "type": "FULL",
  "code": "accepted, in_process, duplicated_request, invalid_order_status, no_active_merchant_fee_schema_found,  refund_amount_too_large, refund_limit_exceeded",
  "message": "Request accepted"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.