Reject Order Item

Declines an order item and marks it rejected, whether or not it was delivered. Requires a producer access token for the application.

Rejecting moves no money and no stock. To give the member their balance back and restock the item, issue a refund with Create Refund. An optional reason is recorded on the item as failure_reason.

An item that can't be rejected from its current state fails with 422 and an error_code. Built-in products (badge, multiplier, flair and coupon-code lines) settle at order time and have no manual steps, so they fail with 400 PRODUCT_NOT_ACTIONABLE. The response is the updated order item, in the same shape as Retrieve Order Item, plus new_balance, the member's current balance in the order's reward item. It is null for a cash order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

uuid
required

The ID of the order item.

Body Params
string
length ≤ 255

Why the item was rejected. Optional, and stored as failure_reason on the item.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json