Skip to main content
GET
List Orders
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Retrieve a paginated list of orders scoped to the authenticated vendor. Only orders containing line items belonging to the vendor are returned. Results include order totals, customer info, and fulfillment status for each order.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

Use Cases

  • Vendor order dashboards — Display a vendor’s recent order activity
  • Order sync — Pull vendor orders into an external OMS or ERP system
  • Reporting — Build custom reports on vendor sales and fulfillment

Query Parameters

integer
Filter by Shopify location ID.
string
Filter by financial status. One of: pending, authorized, paid, partially_paid, refunded, voided, partially_refunded.
string
Filter by order creation date (minimum, ISO 8601). Example: 2024-01-01T00:00:00Z.
string
Filter by order creation date (maximum, ISO 8601).
Search in order name/number (max 200 characters).
integer
Number of items to return, forward pagination (1-100).
string
Cursor for forward pagination.
integer
Number of items to return, backward pagination (1-100).
string
Cursor for backward pagination.

Response

200

Example

More Examples

Filter by date range and status
Search orders with payout filter