--- updatedAt: 2026-05-05T20:25:41.000Z agentTools: siteIndex: https://docs.recurly.com/llms.txt projectIndex: https://docs.recurly.com/recurly-commerce/llms.txt --- # List Orders Get all orders # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/api/v1/orders": { "get": { "operationId": "listOrders", "summary": "List Orders", "description": "Get all orders", "parameters": [ { "name": "page", "required": true, "in": "query", "description": "Page number", "schema": { "default": 1, "type": "number" } }, { "name": "limit", "required": true, "in": "query", "description": "Items per page. Limit must be between 1 and 250.", "schema": { "default": 10, "type": "number" } }, { "name": "sort", "required": false, "in": "query", "description": "Sort order. If not set, default is createdAt.", "schema": { "type": "string" } }, { "name": "desc", "required": false, "in": "query", "description": "Sort direction. If not set, default is ASC.", "schema": { "type": "boolean" } }, { "name": "minCreatedAt", "required": false, "in": "query", "description": "The min date of createdAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "maxCreatedAt", "required": false, "in": "query", "description": "The max date of createdAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "minUpdatedAt", "required": false, "in": "query", "description": "The min date of updatedAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "maxUpdatedAt", "required": false, "in": "query", "description": "The min date of updatedAt", "schema": { "format": "date-time", "default": "2023-01-01T00:00:00.000Z", "type": "string" } }, { "name": "includeDeleted", "required": false, "in": "query", "description": "If true, include deleted lines", "schema": { "default": false, "type": "boolean" } }, { "name": "subscriptionId", "required": false, "in": "query", "description": "The subscription ID", "schema": { "type": "string" } }, { "name": "subscriptionExternalId", "required": false, "in": "query", "description": "The shopify ID of the subscription", "schema": { "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "The order status", "schema": { "enum": [ "PROCESSED", "REFUNDED", "PARTIALLY_REFUNDED" ], "type": "string" } }, { "name": "subscriberId", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "subscriberEmail", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "subscriberExternalId", "required": false, "in": "query", "description": "The shopify ID of the subscriber", "schema": { "type": "string" } }, { "name": "orderExternalId", "required": false, "in": "query", "description": "The shopify ID of the order", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved orders", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResultDto" } } } } }, "security": [ { "bearer": [] } ], "tags": [ "Orders API" ] } } }, "info": { "title": "Recurly Commerce API Documentation", "description": "Recurly Commerce API Documentation", "version": "1.3", "contact": {} }, "servers": [ { "url": "https://subs.api.recurlycommerce.com" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http" } }, "schemas": { "SubscriberDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string", "description": "The date the shopper record was created in the Commerce system. This is merchant-agnostic and may predate when the shopper first subscribed to your store." }, "relationshipStartedAt": { "format": "date-time", "type": "string", "nullable": true, "description": "The date the relationship between this shopper and your store began (e.g. their first subscription). Null if unknown, e.g. gift recipients without a direct relationship." }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify id of the subscriber" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string" }, "phoneCountryCode": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "required": [ "id", "createdAt", "relationshipStartedAt", "updatedAt", "externalId", "firstName", "lastName", "email", "phoneCountryCode", "phone" ] }, "ProductForVariantDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify product ID" }, "imageUrl": { "type": "string", "nullable": true }, "productTitle": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "externalId", "imageUrl", "productTitle", "description" ] }, "SubscriptionOfferOptionDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify selling plan ID" }, "type": { "type": "string", "enum": [ "ONETIME_AND_SUBSCRIPTION", "ONE_TIME_AND_PREPAID_SUBSCRIPTION", "SUBSCRIPTION_ONLY", "PREPAID_SUBSCRIPTION_ONLY", "ONETIME_AND_SUBSCRIPTION_AND_PREPAID", "SUBSCRIPTION_AND_PREPAID", "MEMBERSHIP" ], "nullable": true }, "name": { "type": "string" }, "deliveryCadenceCount": { "type": "number" }, "deliveryCadenceUnit": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "WEEK", "YEAR" ] }, "billingCadenceCount": { "type": "number" }, "billingCadenceUnit": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "WEEK", "YEAR" ] }, "discount": { "type": "number" }, "discountModifier": { "type": "string", "enum": [ "PERCENTAGE", "AMOUNT", "FIXED_AMOUNT" ] }, "archived": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "externalId", "type", "name", "deliveryCadenceCount", "deliveryCadenceUnit", "billingCadenceCount", "billingCadenceUnit", "discount", "discountModifier", "archived" ] }, "SubscriptionOfferDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify selling plan group ID" }, "type": { "type": "string", "enum": [ "ONETIME_AND_SUBSCRIPTION", "ONE_TIME_AND_PREPAID_SUBSCRIPTION", "SUBSCRIPTION_ONLY", "PREPAID_SUBSCRIPTION_ONLY", "ONETIME_AND_SUBSCRIPTION_AND_PREPAID", "SUBSCRIPTION_AND_PREPAID", "MEMBERSHIP" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "DRAFT" ] }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "subscriptionOfferOptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionOfferOptionDto" } }, "cancellationFlowId": { "type": "string", "nullable": true, "description": "The ID of the associated cancellation flow, if any" }, "trialDurationValue": { "type": "number", "nullable": true }, "trialDurationUnit": { "type": "string", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "externalId", "type", "status", "name", "description", "subscriptionOfferOptions", "trialDurationValue", "trialDurationUnit" ] }, "VariantDto": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": "string", "description": "The shopify variant ID" }, "status": { "type": "string", "enum": [ "ACTIVE", "DELETED" ] }, "currentPrice": { "type": "number" }, "variantTitle": { "type": "string" }, "sku": { "type": "string", "nullable": true }, "requiresShipping": { "type": "boolean" }, "product": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/ProductForVariantDto" } ] }, "subscriptionOffer": { "$ref": "#/components/schemas/SubscriptionOfferDto" } }, "required": [ "id", "externalId", "status", "currentPrice", "variantTitle", "sku", "requiresShipping" ] }, "OrderLineItemDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify order line item ID" }, "orderId": { "type": "string" }, "subscriptionId": { "type": "string" }, "quantity": { "type": "number" }, "priceTotal": { "type": "number" }, "priceTotalDiscounted": { "type": "number" }, "priceTotalTaxWithDiscounts": { "type": "number" }, "discountAllocationTotalAmount": { "type": "number" }, "variant": { "$ref": "#/components/schemas/VariantDto" }, "productTitle": { "type": "string", "nullable": true }, "variantTitle": { "type": "string", "nullable": true }, "variantSku": { "type": "string", "nullable": true }, "isAddOnOneTime": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "externalId", "orderId", "subscriptionId", "quantity", "priceTotal", "priceTotalDiscounted", "priceTotalTaxWithDiscounts", "discountAllocationTotalAmount", "variant", "productTitle", "variantTitle", "variantSku", "isAddOnOneTime" ] }, "OrderDto": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "externalId": { "type": "string", "description": "The shopify id of the order" }, "baseOrderId": { "type": "string", "nullable": true, "description": "The id of the base order" }, "status": { "type": "string", "enum": [ "PROCESSED", "REFUNDED", "PARTIALLY_REFUNDED" ] }, "type": { "type": "string", "enum": [ "CHARGED", "PREPAID_FULFILLMENT" ] }, "scheduledDate": { "format": "date-time", "type": "string", "nullable": true }, "purchaseDate": { "format": "date-time", "type": "string", "nullable": true }, "currencyCode": { "type": "string" }, "chargedAmount": { "type": "number", "description": "The total charged amount" }, "subscriptionChargedAmount": { "type": "number", "description": "The subscription charged amount" }, "tax": { "type": "number" }, "deliveryAmount": { "type": "number" }, "presentmentCurrencyCode": { "type": "string", "nullable": true, "description": "The currency the shopper was actually charged in" }, "presentmentChargedAmount": { "type": "number", "nullable": true, "description": "The total charged amount in the presentment currency" }, "presentmentTax": { "type": "number", "nullable": true, "description": "The tax amount in the presentment currency" }, "presentmentDeliveryAmount": { "type": "number", "nullable": true, "description": "The delivery amount in the presentment currency" }, "orderLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDto" } }, "subscriber": { "$ref": "#/components/schemas/SubscriberDto" }, "isSkipped": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "externalId", "baseOrderId", "status", "type", "scheduledDate", "purchaseDate", "currencyCode", "chargedAmount", "subscriptionChargedAmount", "tax", "deliveryAmount", "presentmentCurrencyCode", "presentmentChargedAmount", "presentmentTax", "presentmentDeliveryAmount", "orderLineItems", "subscriber", "isSkipped" ] }, "OrderResultDto": { "type": "object", "properties": { "page": { "type": "number", "description": "Current page number" }, "limit": { "type": "number", "description": "Number of items per page" }, "totalItems": { "type": "number", "description": "Total number of items" }, "totalPages": { "type": "number", "description": "Total number of pages" }, "orders": { "description": "Array of orders for the current page", "type": "array", "items": { "$ref": "#/components/schemas/OrderDto" } } }, "required": [ "page", "limit", "totalItems", "totalPages", "orders" ] } } }, "x-readme": { "explorer-enabled": false } } ``` # Sibling pages * [Get Orders Count](https://docs.recurly.com/recurly-commerce/reference/getorderscount.md)