--- title: "Get your orders" method: POST path: "/v1/shoppers/order-lookup" tags: ["Order Lookup"] --- # Get your orders `POST /v1/shoppers/order-lookup` Get your order(s). Several ways to get your orders: * an authenticated shopper token, creditCardLastDigits, emailAddress * an anonymous shopper token, creditCardLastDigits, emailAddress * an anonymous shopper token, orderId, password ## Query parameters - `token` string - `expand` string - `fields` string ## Response `200` Successful response. - union - DefaultOrderLookup - `orders` object - `order` object[] - `uri` string - `id` integer - `submissionDate` string - `pricing` object - `total` DefaultCurrency - `currency` string - `value` string - `formattedTotal` string - `paymentMethod` PaymentMethodObjectPaymentSource — Payment information, displayed when using a Payment Source created payment. - `type` string — The type of the payment. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of creditCard indicates that there is an object in the response named creditCard that will contain card-specific data. - `sourceId` string — A unique identifier for the payment source. - `sourceClientSecret` string — The unique client secret for the payment source. - `creditCard` object — Credit card information. This field is displayed when type is creditCard. - `expirationYear` string — Four digits representing the expiration year. - `lastFourDigits` string — The last four digits of the card number. (e.g. 1111) - `clientSecret` string — The unique client secret for the payment source. - `expirationMonth` string — One to two digits representing the expiration month. - `fundingSource` string — The card type returned from Payments Processor. (e.g. Credit, Debit, PrePaid, Charge, Deferred_debit) - `brand` string — The card brand (e.g. Visa, MasterCard, American Express, etc.). - `reusable` string — Whether the payment is reusable. - `amountContributed` object — The amount which is contributed by this payment source. - `currency` string — Three-letter ISO currency code associated with the object. - `value` number — Value associated with the object. - `charges` PaymentMethodObjectPaymentSourceCharge[] — Payment charge information, displayed when the payment source has payment charge records. - `chargeId` string — The unique identifier of the charge. - `amount` object — The amount which is charged for this payment source. - … - `status` 'pending' | 'capturable' | 'processing' | 'complete' | 'cancelled' | 'failed' — The current status of this charge. Possible values are: "pending" "capturable" "processing" "complete" "cancelled" "failed" - `createdTime` string — The time when the charge was created. - `updatedTime` string — The time when the charge was last updated. - `supplementaryPaymentMethods` PaymentMethodObjectSupplementaryPaymentSource[] — Supplementary payment information, displayed when cart using Payment Source created supplementary payments. - `type` string — The type of the payment. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of customerCredit indicates that there is an object in the response named customerCredit that will contain customer-credit-specific data. - `sourceId` string — A unique identifier for the payment source. - `sourceClientSecret` string — The unique client secret for the payment source. - `customerCredit` object — Customer credit information. This field is displayed when type is customerCredit. - … - `charges` PaymentMethodObjectSupplementaryPaymentSourceCharge[] — Payment charge information, displayed when the payment source has payment charge records. - … - `amountContributed` object — The amount which is contributed by this payment source. - … - `payment` OrderResponsePayment — 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 - `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. - `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.) - `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 - ExpandedOrderLookup - `orders` object - `order` object[] - `uri` string - `id` integer - `submissionDate` string - `locale` string - `testOrder` string - `pricing` object - `total` DefaultCurrency - `currency` string - `value` string - `formattedTotal` string - `paymentMethod` PaymentMethodObjectPaymentSource — Payment information, displayed when using a Payment Source created payment. - `type` string — The type of the payment. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of creditCard indicates that there is an object in the response named creditCard that will contain card-specific data. - `sourceId` string — A unique identifier for the payment source. - `sourceClientSecret` string — The unique client secret for the payment source. - `creditCard` object — Credit card information. This field is displayed when type is creditCard. - `expirationYear` string — Four digits representing the expiration year. - `lastFourDigits` string — The last four digits of the card number. (e.g. 1111) - `clientSecret` string — The unique client secret for the payment source. - `expirationMonth` string — One to two digits representing the expiration month. - `fundingSource` string — The card type returned from Payments Processor. (e.g. Credit, Debit, PrePaid, Charge, Deferred_debit) - `brand` string — The card brand (e.g. Visa, MasterCard, American Express, etc.). - `reusable` string — Whether the payment is reusable. - `amountContributed` object — The amount which is contributed by this payment source. - `currency` string — Three-letter ISO currency code associated with the object. - `value` number — Value associated with the object. - `charges` PaymentMethodObjectPaymentSourceCharge[] — Payment charge information, displayed when the payment source has payment charge records. - `chargeId` string — The unique identifier of the charge. - `amount` object — The amount which is charged for this payment source. - … - `status` 'pending' | 'capturable' | 'processing' | 'complete' | 'cancelled' | 'failed' — The current status of this charge. Possible values are: "pending" "capturable" "processing" "complete" "cancelled" "failed" - `createdTime` string — The time when the charge was created. - `updatedTime` string — The time when the charge was last updated. - `supplementaryPaymentMethods` PaymentMethodObjectSupplementaryPaymentSource[] — Supplementary payment information, displayed when cart using Payment Source created supplementary payments. - `type` string — The type of the payment. The payment type will correspond to another element in the source response that contains detailed information specific to the type. For example, a type of customerCredit indicates that there is an object in the response named customerCredit that will contain customer-credit-specific data. - `sourceId` string — A unique identifier for the payment source. - `sourceClientSecret` string — The unique client secret for the payment source. - `customerCredit` object — Customer credit information. This field is displayed when type is customerCredit. - … - `charges` PaymentMethodObjectSupplementaryPaymentSourceCharge[] — Payment charge information, displayed when the payment source has payment charge records. - … - `amountContributed` object — The amount which is contributed by this payment source. - … - `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 - `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. - `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.) - `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)