LogoLogo
Shopper APIs reference
Shopper APIs reference
  • Shopper APIs reference
  • OAuth
    • Tokens
    • Access tokens
  • Shoppers
    • Shoppers
    • Addresses
    • Payment options
  • Browse (product discovery)
    • Categories
    • Products
    • Product variations
    • Pricing
    • Inventory status
    • Financing
    • Offers
    • Purchase plan
    • Find a purchase plan
    • Authorize a purchase plan
  • Cart
    • Apply a shopper to a cart
    • Line items
    • Billing address
    • Shipping address
    • Payment methods
    • Shipping options
    • Web checkout
    • Submit a cart
    • Apply or detach payment methods
    • Apply a shipping option
    • Carts
    • Cart offers
    • API trigger offer
    • Resume cart
    • Third-party subscription engine
    • Tax registration
    • Price override
  • Orders
    • Orders
    • Order lookup
    • Order address
    • Returns
  • Subscriptions
    • Manage a subscription
    • Manage the subscription's renewal plan
    • Immediate midterm change
    • Payment
    • Address
    • Orders
    • Pending actions
    • Retrieve subscriptions
    • Subscription billing and shipping addresses
Powered by GitBook
On this page
  1. Orders

Order lookup

PreviousOrdersNextOrder address

Last updated 11 months ago

Get your orders

post

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
tokenstringOptional

Provide the authorized or anonymous token for a shopper.

expandstringOptional

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstringOptional

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Body
creditCardLastDigitsstringOptional

The last four digits of the shopper's credit card.

emailAddressstringOptional

The shopper's email address. The emailAddress requires the creditCardLastDigits.

orderIdstringOptional

Provide the shopper's order identifier. The orderId requires a password.

passwordstringOptional

The shopper's password.

Responses
200
Successful response.
application/json
Responseone of
or
401
* Invalid Token
application/json
post
POST /v1/shoppers/order-lookup HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 88

"creditCardLastDigits='text'&emailAddress='text'&orderId='text'&password='text'"
{
  "orders": {
    "order": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/100009222210019",
        "id": 100009222210019,
        "submissionDate": "2018-05-04T17:12:17.000Z",
        "pricing": {
          "total": {
            "currency": "USD",
            "value": "19.99"
          },
          "formattedTotal": "$13.95"
        },
        "paymentMethod": {
          "type": "creditCard",
          "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
          "sourceClientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
          "creditCard": {
            "expirationYear": "2030",
            "lastFourDigits": "0000",
            "clientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
            "expirationMonth": "08",
            "fundingSource": "debit",
            "brand": "Visa",
            "reusable": "true"
          },
          "amountContributed": {
            "currency": "USD",
            "value": 1059.5
          },
          "charges": [
            {
              "chargeId": "1cac37c0-98a7-46b2-b9ed-fbc615c9f18a",
              "amount": {
                "currency": "USD",
                "value": 1059.5
              },
              "status": "failed",
              "createdTime": "2021-12-06T09:03:46.877Z",
              "updatedTime": "2021-12-06T09:03:46.877Z"
            }
          ],
          "supplementaryPaymentMethods": [
            {
              "type": "customerCredit",
              "sourceId": "a231f38d-3a07-4a13-96ed-89693ba7d56c",
              "sourceClientSecret": "a231f38d-3a07-4a13-96ed-89693ba7d56c_f6d8c951-59c9-4ef3-ac45-9f33c77d2f46",
              "customerCredit": {
                "flow": "standard",
                "reusable": "true"
              },
              "charges": [
                {
                  "chargeId": "cf57f9c9-8b0d-4e64-998a-816499fefa01",
                  "amount": {
                    "currency": "USD",
                    "value": 1059.5
                  },
                  "status": "failed",
                  "createdTime": "2021-12-06T09:03:46.877Z",
                  "updatedTime": "2021-12-06T09:03:46.877Z"
                }
              ],
              "amountContributed": {
                "currency": "USD",
                "value": 1059.5
              }
            }
          ]
        },
        "payment": {
          "paymentMethodName": "discover",
          "displayableNumber": "************4321",
          "expirationMonth": "08",
          "expirationYear": "2030",
          "customerFirstName": "AUTOMATION",
          "customerLastName": "TESTER",
          "customerEmail": "automatedtester68091904@digitalriver.com",
          "paymentAmount": {
            "currency": "USD",
            "value": "19.99"
          },
          "softDescriptor": "DRI*demosft1"
        },
        "orderState": "Complete",
        "billingAddress": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/address/47278020023",
          "relation": "https://developers.digitalriver.com/v1/shoppers/AddressesResource",
          "id": "billingAddress",
          "firstName": "Automation",
          "lastName": "Tester",
          "companyName": "Digital River",
          "line1": "PO BOX 6930",
          "line2": "123",
          "line3": "Suite Line 3",
          "city": "Waconia",
          "countrySubdivision": "MN",
          "postalCode": "5387.0",
          "country": "US",
          "countryName": "United States",
          "phoneNumber": "099-222-44454",
          "emailAddress": "automatedTester@digitalriver.com",
          "countyName": "Hennepin",
          "phoneticFirstName": "クリス",
          "phoneticLastName": "ミラー",
          "division": "製品開発",
          "title": "M"
        },
        "shippingAddress": {
          "uri": "https://api.digitalriver.com/v1/shoppers/me/address/47278020023",
          "relation": "https://developers.digitalriver.com/v1/shoppers/AddressesResource",
          "id": "shippingAddress",
          "firstName": "Automation",
          "lastName": "Tester",
          "companyName": "Digital River",
          "line1": "PO BOX 6930",
          "line2": "123",
          "line3": "Suite Line 3",
          "city": "Waconia",
          "countrySubdivision": "MN",
          "postalCode": "5387.0",
          "country": "US",
          "countryName": "United States",
          "phoneNumber": "099-222-44454",
          "countyName": "Hennepin",
          "emailAddress": "automatedTester@digitalriver.com",
          "phoneticFirstName": "クリス",
          "phoneticLastName": "ミラー",
          "division": "製品開発"
        },
        "paymentSession": {
          "id": "text",
          "status": "text",
          "clientSecret": "text",
          "redirectUrl": "https://api.digitalriver.com:80/payments/redirects/12759bb0-xxxx-4bdb-bfeb-9095ba8059fc?apiKey=a88fxxxx1eef47eb95bc609c22e593c8"
        },
        "customerType": "B",
        "taxRegistrations": [
          {
            "key": "UK_VAT",
            "value": "GB698588737"
          }
        ]
      }
    ],
    "totalResults": 1,
    "totalResultPages": 1
  }
}