List Order Items

Returns order items, which are the individual redemption lines of orders. A producer for the application sees every item in the application, which makes this the operations view, for example to find every item awaiting provider confirmation. A member sees only the items of their own orders. Newest first by default, and paginated.

Each item carries its own status: in_progress, awaiting_provider_confirmation, redeemed, fulfilled, rejected or refunded. The redeem_url, fulfill_url, reject_url and refund_url fields point to the actions available on the item, and are null for built-in products (badge, multiplier, flair and coupon-code lines) that settle at order time.

Query parameters, all optional:

  • order_id, profile_id, product_id, variant_id: UUIDs that narrow the list to one order, member, product or variant.
  • status: one of the item statuses above.
  • redemption_method: reward_item or cash.
  • redemption_provider: for example konekt.
  • amount__gte, amount__lte: inclusive bounds on the item amount.
  • is_refunded: true for refunded items, false for the rest.
  • since, until: ISO 8601 times. since is inclusive and until is exclusive, both on the creation time.
  • ordering: created_at, updated_at, status, amount or quantity. Prefix with a minus for descending order.
  • page and page_size: pagination. The default page size is 20.
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.

Query Params
string
enum

Only items with this status.

Allowed:
uuid

Only items of this order.

integer

Page number.

Response

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