List All Order Items

GET

/v1/order-items

Returns a paginated list of order items.


Filter parameters

order_id

Return only order items belonging to the order with this ID.

product_id

Return only order items belonging to the product with this ID.

variant_id

Return only order items belonging to the variant with this ID.


curl "https://api.lemonsqueezy.com/v1/order-items" \
  -H 'Accept: application/vnd.api+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}'
curl "https://api.lemonsqueezy.com/v1/order-items?filter[order_id]=1" \
  -H 'Accept: application/vnd.api+json'  \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {api_key}'

Returns

Returns a paginated list of Order Items.

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 10,
      "to": 10,
      "total": 10
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://api.lemonsqueezy.com/v1/order-items?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id",
    "last": "https://api.lemonsqueezy.com/v1/order-items?page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=id"
  },
  "data": [
    {
      "type": "order-items",
      "id": "1",
      "attributes": {
        "order_id": 1,
        "product_id": 1,
        "variant_id": 1,
        "product_name": "Lemonade",
        "variant_name": "Citrus Blast",
        "price": 999,
        "quantity": 1,
        "created_at": "2021-05-24T14:15:06.000000Z",
        "updated_at": "2021-05-24T14:15:06.000000Z"
      },
      "relationships": {
        "order": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/order",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/order"
          }
        },
        "product": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/product",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/product"
          }
        },
        "variant": {
          "links": {
            "related": "https://api.lemonsqueezy.com/v1/order-items/1/variant",
            "self": "https://api.lemonsqueezy.com/v1/order-items/1/relationships/variant"
          }
        }
      },
      "links": {
        "self": "https://api.lemonsqueezy.com/v1/order-items/1"
      }
    },
    {...},
    {...},
  ]
}

Was this page helpful?