WHwhatnot
Orders

List order items

List an order's items newest first by default; set reverse=false for oldest first. Requires read:orders.

get/orders/{order_id}/items

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/orders/{order_id}/items
  • 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.

Query parameters

limitinteger

Maximum results per page.

cursorstring nullable

Cursor from the previous page.

reverseboolean

Return descending order when true; ascending when false.

Response

Successful Response

next_cursorstring nullable required

Continuation cursor; null when there are no more results.

Example response

{
  "data": [
    {
      "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 2 revisions of this API.