Order Lookup

Use the Order Lookup API to review your order.

Methods


					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
			
					orderId=your_order_ID&password=orderPassword
			
					HTTP/1.1 200 OK
			
					{"orders": {
   "order": [   {
      "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/9999999999",
      "id": 9999999999,
      "submissionDate": "2016-11-02T14:25:06.000Z",
      "locale": "en_US",
      "testOrder": "false",
      "pricing":       {
         "total":          {
            "currency": "USD",
            "value": 13.88
         },
         "formattedTotal": "$13.88"
      },
      "payment":       {
         "paymentMethodName": "discover",
         "displayableNumber": "************9876"
      },
      "orderState": "Complete",
      "billingAddress":       {
         "id": "billingAddress",
         "firstName": "John",
         "lastName": "Doe",
         "line1": "PO BOX 3940",
         "city": "Waconia",
         "countrySubdivision": "MN",
         "postalCode": "55387",
         "phoneNumber": "555-555-555",
         "emailAddress": "jdoe@gmail.com"
      },
      "shippingAddress":       {
         "id": "billingAddress",
         "firstName": "John",
         "lastName": "Doe",
         "line1": "PO BOX 3940",
         "city": "Waconia",
         "countrySubdivision": "MN",
         "postalCode": "55387",
         "phoneNumber": "555-555-555",
         "emailAddress": "jdoe@gmail.com"
      }
   }],
   "totalResults": 1,
   "totalResultPages": 1
}}
			

Request Body Parameters

Fields
Data Type
Visibility
Description
creditCardLastDigits
string
default
The last four digits of the shopper's credit card.
emailAddress
string
default
The shopper's email address. The emailAddress requires the creditCardLastDigits.
orderId
string
default
The shopper's order ID. The orderId requires the password.
password
string
default
The shopper's password.

Response Body Parameters

Fields
Data Type
Visibility
Description
billingAddress
link
default
The billing address for the order. See the Addresses API and Fields Used as Keys for more information.
locale
string
default
The locale associated with this order.
id
string
default
The order ID. The ID is assigned automatically when the order is created.
order
string
default
The order ID. The ID is assigned automatically when the order is created.
orders
link
default
The order information for the submitted cart. For more information, see the Orders API.
orderState
string
default
The state of the order. order state, payment settlement state, refund state.
Payment settlement state:
  • Settled
  • Not Settled
  • Partially Settled
Refund state:
  • Refund – Completed
  • Refund – Failed
  • Refund – Pending
  • Partial Refund – Completed
  • Partial Refund – Failed
  • Partial Refund – Pending
payment
structured
default
The payment information for an order.
payment.displayableNumber
string
default
The credit card number of the payment that is safe to display to the shopper.
payment.paymentMethodName
string
default
The payment method name for the order. Possible values include the following: Visa, Mastercard, Americanexpress, JCB, Invoice, Lite, or Purchaseorder.
pricing
structured
default
The pricing information for the order. See the Pricing API for more information.
shippingAddress
link
default
The shipping address for the order. See the Addresses API  and Fields Used as Keys for more information.
submissionDate
date
default
The date the order was created. For delayed payments, this date is the date when the payment was received.
testOrder
Boolean
hidden
When true, the order is a test order. Visibility must be set to true for non-test orders.