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.
get/{client_id}/order-items/

Request

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

Path parameters

client_idstring required

The client ID of the application.

Query parameters

status'in_progress' | 'awaiting_provider_confirmation' | 'redeemed' | 'fulfilled' | 'rejected' | 'refunded'

Only items with this status.

order_idstring uuid

Only items of this order.

pageinteger

Page number.

Response

OK

countinteger
nextstring nullable

Changes

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