WHwhatnot
Orders

Get an order item

Retrieve an item on an order sold by the authenticated seller. Requires read:orders.

get/orders/{order_id}/items/{item_id}

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/orders/{order_id}/items/{item_id}
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Path parameters

order_idstring required

The order's ID.

item_idstring required

The order item's ID.

Response

Successful Response

idstring required

The order item's ID.

order_idstring required

The ID of the order containing this item.

product_idstring nullable required

The purchased product's ID, if known.

variant_idstring nullable required

The purchased variant's ID, if the product has variants.

product_external_idstring nullable required

The seller-provided external ID of the purchased product, if set.

variant_external_idstring nullable required

The seller-provided external ID of the purchased variant, if set.

quantityinteger required

The number of units purchased.

price_includes_taxboolean nullable required

Whether unit_price includes tax, if recorded.

shipment_idstring nullable required

The ID of the shipment currently containing this item, if any.

Example response

{
  "id": "987654",
  "order_id": "123456",
  "price_includes_tax": false,
  "product_external_id": "shopify-product-1",
  "product_id": "4321",
  "purchased_item": {
    "description": "Near mint, graded PSA 9.",
    "sku": "CHAR-BS-PSA9",
    "title": "Charizard Holo - Base Set"
  },
  "quantity": 1,
  "shipment_id": "55555",
  "unit_price": {
    "amount": "42",
    "currency": "USD"
  },
  "variant_external_id": "shopify-variant-1",
  "variant_id": "0f5e1c9a-2b7d-4e3f-8a6b-1c2d3e4f5a6b"
}

Changes

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