Retrieve an Order Item

GET

/v1/order-items/:id

Retrieves the order item with the given ID.


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

Returns

Returns an Order Item object.

{
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://api.lemonsqueezy.com/v1/order-items/1"
  },
  "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?