--- title: "Get the shopper orders" method: GET path: "/v1/shoppers/me/orders" tags: ["Orders"] --- # Get the shopper orders `GET /v1/shoppers/me/orders` Use this method to retrieve the history of orders for a shopper. ## Query parameters - `token` string - `orderState` string - `pageNumber` string - `pageSize` string - `expand` string - `fields` string ## Response `200` Successful response. - union - DefaultOrders - `orders` object - `uri` string - `order` object[] - `uri` string - `totalResults` string - `totalResultPages` string - ExpandedOrders - `orders` object - `uri` string - `order` ExpandedOrderNoFeePricing[] - `uri` string - `id` integer - `submissionDate` string - `displayName` string - `locale` string - `optIn` string - `testOrder` string - `taxExempt` string - `businessEntityCode` string - `taxInclusive` boolean — The price list setup for the currency. * If true, the price list is set to tax inclusive. * If false, the price list is set to tax exclusive. - `pricing` object - `subtotal` DefaultCurrency - `currency` string - `value` string - `subtotalWithDiscount` DefaultCurrency - `currency` string - `value` string - `incentive` DefaultCurrency - `currency` string - `value` string - `shipping` DefaultCurrency - `currency` string - `value` string - `tax` DefaultCurrency - `currency` string - `value` string - `total` DefaultCurrency - `currency` string - `value` string - `formattedSubtotal` string - `formattedSubtotalWithDiscount` string - `formattedIncentive` string - `formattedShipping` string - `formattedTax` string - `formattedTotal` string - `payment` ExpandedOrderResponsePayment — Payment information, displayed when using a non-Payment Source created payment. - `paymentMethodName` string — The given name of this payment. - `displayableNumber` string — The card number, only display the last four digits. (e.g. ************1111) - `expirationMonth` string — One to two digits representing the expiration month. - `expirationYear` string — Four digits representing the expiration year. - `customerFirstName` string - `customerLastName` string - `customerEmail` string - `paymentAmount` DefaultCurrency - `currency` string - `value` string - `softDescriptor` string - `shippingMethod` object - `code` integer - `description` string - `orderState` string — Current state of the order. The possible values are as follows. Open, Submitted, Cancelled, Complete, Dispute, Pending Payment, In Review, Source Pending Funds, Charge Pending, In Process. - `orderStateDetails` object - `description` string - `settled` DefaultCurrency - `currency` string - `value` string - `refunded` DefaultCurrency - `currency` string - `value` string - `billingAddress` BillingAddress - `uri` string - `relation` string - `id` string — Unique identifier of the address. - `firstName` string — The shopper's first name. - `lastName` string — The shopper's last name. - `companyName` string — Company Name - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `line3` string — The third line of the address. (Optional) - `city` string — City or town. - `countrySubdivision` string — State/County/Province/Region. - `postalCode` string — ZIP or postal code. - `country` string — A two-letter (ISO 3166-2) country code. See https://en.wikipedia.org/wiki/ISO_3166-2 for a complete list of country codes. - `countryName` string — Country. - `phoneNumber` string — The shopper's phone number. - `emailAddress` string — The shopper's email address. - `countyName` string — County. - `phoneticFirstName` string — The shopper's Japanese Katakana first name. (Optional, usually for Japanese locale.) - `phoneticLastName` string — The shopper's Japanese Katakana last name. (Optional, usually for Japanese locale.) - `division` string — The shopper's company departmant name. (Optional, usually for Japanese locale.) - `title` string — The shopper's title. (Optional, usually for France locale.) - `shippingAddress` ShippingAddress - `uri` string - `relation` string - `id` string — Unique identifier of the address. - `firstName` string — The shopper's first name. - `lastName` string — The shopper's last name. - `companyName` string — Company Name - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `line3` string — The third line of the address. (Optional) - `city` string — City or town. - `countrySubdivision` string — State/County/Province/Region. - `postalCode` string — ZIP or postal code. - `country` string — A two-letter (ISO 3166-2) country code. See https://en.wikipedia.org/wiki/ISO_3166-2 for a complete list of country codes. - `countryName` string — Country. - `phoneNumber` string — The shopper's phone number. - `countyName` string — County. - `emailAddress` string — The shopper's email address. - `phoneticFirstName` string — The shopper's Japanese Katakana first name. (Optional, usually for Japanese locale.) - `phoneticLastName` string — The shopper's Japanese Katakana last name. (Optional, usually for Japanese locale.) - `division` string — The shopper's company departmant name. (Optional, usually for Japanese locale.) - `lineItems` ExpandedOrderLineItemsNoFeePricing - `uri` string - `lineItem` ExpandedLineItemNoFeePricing[] - `uri` string - `id` string - `quantity` string - `product` ExpandedProduct - … - `pricing` object - … - `groups` object - … - `downloads` object - … - `digitalRights` object - … - `billingAgreementId` string — Digital River billing agreement ID. It represents the terms the customer agreed to when they stored their card details or chose to apply them to any kind of recurring purchase. The ID of the agreement can then be referenced for subsequent purchases, which gives us the ability to tie them together. - `customAttributes` DefaultCustomAttributes - … - `subscriptionIds` string[] — The unique identifier for the subscription. - `customAttributes` DefaultCustomAttributes - `attribute` object[] - `name` string - `value` string - `type` string - `paymentSession` PaymentSession — The payment session information. - `id` string — A unique identifier for this session. - `status` string — The current state of the session. Possible values are: * requires_source * requires_confirmation * pending * pending_funds * chargeable * complete * processing * failed * pending_redirect - `clientSecret` string — The unique client secret related to this session. - `redirectUrl` string — The redirect URL. This attribute only be displayed when pending_redirect status. - `customerType` string — Shopper Type applied to this cart. B as Business, I as Individual. - `taxRegistrations` object[] - `key` string — Tax Registration Key - `value` string — Tax ID value - `totalResults` integer - `totalResultPages` integer ## Other responses - `401` — * Invalid Token --- [API](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-shopper-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-shopper-apis/revisions/4b69392f93b9/schema)