Create Refund

Refunds one order item. The item's amount is credited back to the member, the item is restocked, and the item is marked refunded. Refunds are per item, and the item is identified by the URL. Requires a producer access token for the application.

A reason is required. The response is the refund, in the same shape as Retrieve Refund, plus new_balance, the member's current balance in the order's reward item. It is null for a cash order. A refund that can't be issued fails with 422 and an error_code. Built-in products (badge, multiplier, flair and coupon-code lines) settle at order time and can't be refunded, so they fail with 400 PRODUCT_NOT_ACTIONABLE.

post/{client_id}/order-items/{order_item_id}/refunds/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/order-items/{order_item_id}/refunds/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application.

order_item_idstring uuid required

The ID of the order item to refund.

Request body

reasonstring required

Why the item is being refunded. Can't be blank.

Response

Created. The refund was issued.

idstring uuid
statusstring
total_amountstring
new_balancestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.