Shop

List order items

get/order-items

Request

  • Base URL
    https://gorest.co.in/public/v3
  • URL
    https://gorest.co.in/public/v3/order-items
  • Auth
    • none
    • or HTTP bearer

Query parameters

page[size]integer

Items on one page.

page[after]string

The cursor of the next page, from meta.next_cursor or the Link header. Treat it as opaque; it works only with the same query.

page[number]integer

Offset paging, 1 based, at most 10,000. Cannot be sent with page[after]. Pages can shift while you write.

page[count]boolean

true adds meta.total to a cursor page (it costs a count).

searchstring

Case-insensitive text search over the resource's text fields.

order_idstring uuid
product_idstring uuid

filter[order_id]= (one order), filter[product_id]= (one product). An id you cannot see gives an empty list. search matches the name and sku.

sort'created_at' | '-created_at'

One field; a leading - sorts descending. Default -created_at.

order-itemsstring

fields[order-items]=name,quantity returns only those fields; included items are added whole.

Headers

If-None-Matchstring

An ETag from an earlier answer; an unchanged item answers 304 with no body.

Response

One page of order items.

Changes

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