--- title: "List orders" method: GET path: "/1.0/commerce/orders" tags: ["Orders"] --- # List orders `GET /1.0/commerce/orders` ## Request - Base URL: `https://api.squarespace.com` - URL: `https://api.squarespace.com/1.0/commerce/orders` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves information about all orders. Orders can be filtered by Customer ID and date ranges. The response contains order information in an Order, up to 50 Orders ordered by their modification date (modifiedOn), and supports dynamic cursors for pagination. ## Query parameters - `customerId` string - `modifiedAfter` string - `modifiedBefore` string - `cursor` string - `fulfillmentStatus` string - `paymentStates` string ## Headers - `Authorization` string, required - `User-Agent` string, required ## Response `200` A paginated list of orders. - OrderListResponse - `pagination` object - `hasNextPage` boolean - `nextPageCursor` string - `nextPageUrl` string - `result` Order[] - `billingAddress` Address: Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address. - `address1` string: Primary street address - `address2` string: Secondary address line - `city` string: City - `countryCode` string: ISO 3166-1 alpha-2 country code - `firstName` string: First name - `lastName` string: Last name - `phone` string: Phone number - `postalCode` string: Postal or ZIP code - `state` string: State or province - `channel` string: Where the order originated; possible values are: web and pos. - `channelName` string: Name of the third-party sales channel. - `createdOn` string, date-time: ISO 8601 UTC date and time string; represents the moment when the order was placed. - `customerEmail` string: Email address entered at checkout or, for recurring subscription orders, the customer's current email address. - `customerId` string: Unique customer id. - `discountLines` DiscountLine[]: Array of discount line items; describes the promotions redeemed during checkout. - `amount` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `description` string: A plain-English description of the promotion - `name` string: Name of the promotion - `promoCode` string: The user-entered promo code that triggered the discount - `discountTotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `externalOrderReference` string: Order reference identifier used by the third-party sales channel. - `formSubmission` FormItem[]: Array of form data submitted via the checkout page. - `label` string: The name of the form field - `value` string: The value of the field, as entered by the shopper - `fulfilledOn` string, date-time: ISO 8601 UTC date and time string; represents the moment the order was fulfilled. - `fulfillmentStatus` 'PENDING' | 'FULFILLED' | 'CANCELED': Current fulfillment status of the order. Value may be: PENDING, FULFILLED, or CANCELED. - `fulfillments` Fulfillment[]: Array of shipping fulfillments; describes shipment information for the order. - `carrierName` string: Name of the carrier handling the shipment. - `service` string: Carrier's level of service for shipping. - `shipDate` string, date-time: ISO 8601 UTC date and time string; represents the moment the fulfillment was shipped. - `trackingNumber` string: Carrier's parcel tracking number. - `trackingUrl` string: URL provided by the carrier to track the shipment. - `grandTotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `id` string: Unique Order id. - `internalNotes` OrderNote[]: Array of internal notes added to the order by the merchant. - `content` string: Content for the note - `lineItems` LineItem[]: Array of purchased line items; line items describe what product or product variant was purchased, how many of that item were purchased, and additional details. - `customizations` FormItem[]: Array of form data submitted via a product's custom form prior to being added to the cart. - `label` string: The name of the form field - `value` string: The value of the field, as entered by the shopper - `height` number, float: Shipping height of the physical product variant. 0.0 when not specified or when the variant is not a physical product. - `id` string: Unique line item id. - `imageUrl` string: URL of the primary image for the item. - `length` number, float: Shipping length of the physical product variant. 0.0 when not specified or when the variant is not a physical product. - `lineItemType` string: Product type of the item. - `productId` string: Unique product id; unless null, every line item with a variantId is a variant of a product with productId. - `productName` string: Name of the purchased product. - `quantity` integer: Amount of the item purchased. - `sku` string: Stock keeping unit (SKU) code assigned by the Squarespace merchant for a variant. Null for digital products. - `unitPricePaid` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `variantId` string: Unique id of the ProductVariant sold. Populated for physical, service, or gift card line items created on or after May 28, 2019. - `variantOptions` VariantOption[]: Array of variant options; represents variant choices made by the customer. Null for download and gift card products. - `optionName` string: The name of the option (e.g. color, size, material) - `value` string: The shopper-selected value for the option (e.g. red, small, cotton) - `weight` number, float: Shipping weight of the physical product variant. 0.0 when not specified or when the variant is not a physical product. - `width` number, float: Shipping width of the physical product variant. 0.0 when not specified or when the variant is not a physical product. - `modifiedOn` string, date-time: ISO 8601 UTC date and time string; represents when the order was last modified. - `orderNumber` string: Unique, sequential number for the Order. - `paymentState` 'NOT_CHARGED' | 'AUTHORIZED' | 'PAID' | 'REFUNDED' | 'PENDING' | 'FAILED' | 'REFUND_PENDING' | 'REFUND_FAILED' | 'PARTIALLY_PAID': Current state of payment for the order. - `priceTaxInterpretation` string: Indicates whether lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE. - `refundedTotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `shippingAddress` Address: Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address. - `address1` string: Primary street address - `address2` string: Secondary address line - `city` string: City - `countryCode` string: ISO 3166-1 alpha-2 country code - `firstName` string: First name - `lastName` string: Last name - `phone` string: Phone number - `postalCode` string: Postal or ZIP code - `state` string: State or province - `shippingLines` ShippingLine[]: Array of shipping line items; describes the shipping options chosen at checkout. - `amount` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `method` string: Description of the shipping option - `shippingOptionName` string: the specific shipping service name selected at checkout (e.g. "USPS Ground Advantage", "Royal Mail Tracked 48"). - `shippingOptionServiceType` 'FEDEX_GROUND' | 'FEDEX_GROUND_HOME_DELIVERY' | 'FEDEX_PRIORITY_OVERNIGHT' | 'FEDEX_STANDARD_OVERNIGHT' | 'FEDEX_2_DAY' | 'FEDEX_2_DAY_AM' | 'FEDEX_EXPRESS_SAVER' | 'FEDEX_FIRST_FREIGHT' | 'FEDEX_FREIGHT_PRIORITY' | 'FEDEX_FREIGHT_ECONOMY' | 'FEDEX_FIRST_OVERNIGHT' | 'FEDEX_SAME_DAY' | 'FEDEX_SAME_DAY_CITY' | 'FEDEX_EUROPE_FIRST_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_ECONOMY' | 'FEDEX_INTERNATIONAL_FIRST' | 'FEDEX_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_ECONOMY_FREIGHT' | 'FEDEX_INTERNATIONAL_PRIORITY_FREIGHT' | 'UPS_GROUND' | 'UPS_NEXT_DAY_AIR' | 'UPS_NEXT_DAY_AIR_SAVER' | 'UPS_NEXT_DAY_AIR_EARLY_AM' | 'UPS_TWO_DAY_AIR' | 'UPS_THREE_DAY_SELECT' | 'UPS_TWO_DAY_AIR_AM' | 'USPS_UNKNOWN' | 'USPS_FIRST_CLASS' | 'USPS_PRIORITY' | 'USPS_EXPRESS' | 'USPS_STANDARD' | 'USPS_ALL' | 'USPS_ONLINE' | 'OTHER': The carrier service type identifier. - `shippingTotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `subtotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `taxTotal` MonetaryAmount: A monetary amount with currency code and decimal value. - `currency` object: ISO 4217 currency code. - `currencyCode` string - `defaultFractionDigits` integer - `displayName` string - `numericCode` integer - `numericCodeAsString` string - `symbol` string - `value` number: Decimal monetary value. - `testmode` boolean: If true, the order is a test order created using a payment method in test mode. ## Other responses - `400`: Bad request. The cursor parameter contains an invalid value, cursor was specified with other parameters, modifiedAfter or modifiedBefore is not a valid ISO 8601 UTC date and time string, paymentStates is not a valid value, modifiedBefore occurred before or at the same time as modifiedAfter, fulfillmentStatus is not one of the recognized values, or modifiedAfter or modifiedBefore was specified without the other parameter. --- [API](https://skmtc.dev/squarespace/apis/commerce-api.md) - [All operations](https://skmtc.dev/squarespace/apis/commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/squarespace/apis/commerce-api/revisions/5dd4b1b7cd38?raw)