Orders

Learn more about the orders resource

Orders handle customers' purchases. When you create an order, you instruct Digital River, the authorized reseller, to send an authorization request to start the collection process.

The data of an order persist, acting as a permanent record of the sale, which Digital River is required to maintain for auditing purposes.

An order maintains an enduring record of when it was placed, a charge is created and captured, a refund is processed, and other key events in the order lifecycle occur. More specifically, an order persists:

• The total refunded, cancelled, and captured payment amounts

• A charge containing a payment source, an amount charged to that source, and the state of the charge

The following diagram depicts the relationship between an order and other resources in the Digital River APIs.

To ensure that your integration is functioning properly, you can create test orders using the information contained in the Testing Scenarios page.

The orders resource

In the following section, you'll find information on some of an order's attributes and how you might use them in downstream requests. For a complete list, refer to the Orders API reference documentation.

Unique identifier

An order contains a unique id. You can use this identifier when initiating physical fulfillments, cancelling shipments, capturing and cancelling payments, creating physical returns, handling third-party returns, and issuing refunds.

Order

{
    "id": "177452480336",
    ...

Ship to values

An order's shipTo values are displayed on invoices and credit memos.

    ...
    "customerId": "987654321",
    ...
    "shipTo": {
        "address": {
            "line1": "10380 Bren Rd W",
            "line2": "string",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
        },
        "name": "Jane Doe",
        "phone": "952-111-1111",
        "email": "[e-mail]",
        "organization": "Digital River"
    },

Amounts, fees, and taxes

The total amount, fees, taxes, and other costs of the order are the same as those presented to customers when they confirm the purchase. You can retrieve these values and display them on the customer's order confirmation page.

    ...
    "totalAmount": 177.67,
    "subtotal": 172.5,
    "totalFees": 0.0,
    "totalTax": 5.17,
    "totalDuty": 0.0,
    "totalDiscount": 7.5,
    "totalShipping": 5.0,
    ...

Line items

Digital River assigns each of an order's items[] a unique id. You need this identifier when capturing and cancelling payments, handling third-party returns, and issuing refunds.

Depending on how you send product data in checkouts, each of an order's items[] also contains either a skuId or a productDetails object.

In addition, these items[] store detailed price, tax, and quantity information that you can display to customers on order confirmation and order detail pages.

For more information on subscriptionInfo, refer to the Subscription information page.

    ...
    "items": [
        {
            "id": "96415480336",
            "skuId": "08141946",
            "amount": 100.0,
            "quantity": 1,
            "state": "created",
            "stateTransitions": {
                "created": "2020-05-21T17:26:34Z"
            },
            "tax": {
                "rate": 0.0,
                "amount": 0.0
            },
            "subscriptionInfo": {
                "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
                "terms": "Insert terms here",
                "autoRenewal": true,
                "freeTrial": false
            }
        },
        {
            "id": "96415490336",
            "skuId": "05081978",
            "amount": 67.5,
            "quantity": 1,
            "discount": {
                "percentOff": 10.0,
                "quantity": 1
            },
            "state": "created",
            "stateTransitions": {
                "created": "2020-05-21T17:26:34Z"
            },
            "tax": {
                "rate": 0.07125,
                "amount": 4.81
            }
        }
    ],
    ...

Tax invoices and credit memos

In most cases, Digital River populates an order's invoicePDFs and creditMemoPDFs with information that you can use to access and share tax invoices and credit memo files.

    ...
    "invoicePDFs": [
        {
            "url": "https://api.digitalriver.com/files/23c7e1a5-25e4-41a9-b935-eda98dfa238b/content",
            "id": "23c7e1a5-25e4-41a9-b935-eda98dfa238b"
        }
    ],
    "creditMemoPDFs": [
        {
            "url": "https://api.digitalriver.com/files/5cec4a32-853f-485a-90a0-15ea0a614355/content",
            "id": "5cec4a32-853f-485a-90a0-15ea0a614355"
        }
    ],
    ...

State and fraud state

For more information about an order's state and fraudState, refer to the Order lifecycle page.

Tax identifiers

Orders with applied tax identifiers contain an array of tax identifier objects.

JSON

  ...
  "taxIdentifiers": [{
        "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
        "customerId": "5774321009",
        "type": "uk",
        "value": "GB000283536",
        "state": "verified",
        "stateTransitions":
             {"pending": "2020-05-13T11:00:00.000Z", "verified": "2020-05-15T16:00:00.000Z"},
        "verified_name": "Descon Ltd",
        "verified_address": "Design House, 18b Tromode, Isle of Man",
        "createdTime": "2020-08-01T02:25:53Z",
        "updatedTime": "2020-08-01T05:47:21Z"
    }],
   ...

Charges

An order's charges[] contains one or more elements, each representing a charge created from a primary or secondary payment source. Each charge contains a unique identifier, an amount, a state, and the identifier of the payment source used to create the charge.

    ...
    "charges": [
        {
            "id": "d3a02b03-1378-431e-81a5-9cb6dd54d90b",
            "createdTime": "2020-05-21T17:26:37Z",
            "currency": "USD",
            "amount": 177.67,
            "state": "capturable",
            "captured": false,
            "refunded": false,
            "sourceId": "deabb3a4-14e4-4702-a13b-ddaac23277d3"
        }
    ],
    ...

Request to be forgotten

An order's requestToBeForgotten indicates whether an order's data is scheduled for deletion. This is the only attribute (other than metadata) that can be modified in an update order request.

    ...
    "requestToBeForgotten": false,
    ...
}

Gets an order by ID.

Retrieves the details of an order. Supply the unique identifier of the order you would like to retrieve.

get

/orders/{id}

Authorizations

Path parameters

idstringrequired

Order ID

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/orders/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

405

406

408

429

500

502

503

504

200

{
  "id": "ord_5823594809",
  "checkoutId": "5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "customerId": "cus_5774321009",
  "currency": "usd",
  "email": "[e-mail]",
  "locale": "en_US",
  "browserIp": "111.111.111.111",
  "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
  "invoiceAttributes": {
    "id": "1234",
    "customerId": "5678",
    "createdTime": "2018-04-25T20:36:00Z",
    "updatedTime": "2018-04-25T20:36:00Z",
    "liveMode": false,
    "type": "cn_business_general",
    "atttributes": [
      {
        "invoiceTitle": "Invoice title",
        "regAccount": "87654",
        "regAddress": "123 Example st.",
        "regBank": "Bank",
        "regPhone": "8005551234"
      }
    ]
  },
  "shipFrom": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "shipTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[e-mail]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ"
    }
  },
  "billTo": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[e-mail]",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "営業部",
      "phoneticName": "ヤマダ タロ",
      "title": "M"
    }
  },
  "organization": {
    "id": "123456789"
  },
  "subtotal": 1094.5,
  "totalTax": 82.76,
  "totalImporterTax": 82.76,
  "importerOfRecordTax": true,
  "totalFees": 0,
  "totalDuty": 0,
  "totalDiscount": 0,
  "totalShipping": 5.76,
  "totalAmount": 1180.26,
  "discount": {
    "amountOff": 5.95,
    "percentOff": 100
  },
  "availableToRefundAmount": 18.58,
  "refundedAmount": 1,
  "cancelledAmount": 1,
  "capturedAmount": 1,
  "requestToBeForgotten": true,
  "shippingChoice": {
    "amount": 5.95,
    "taxAmount": 0.1,
    "description": "USPS: Priority (1 day delivery)",
    "serviceLevel": "Standard Ground",
    "shippingTerms": "DDP"
  },
  "stateTransitions": {
    "accepted": "2025-02-21T18:03:36.884Z",
    "pending_payment": "2025-02-21T18:03:36.884Z",
    "in_review": "2025-02-21T18:03:36.884Z",
    "complete": "2025-02-21T18:03:36.884Z",
    "dispute": "2025-02-21T18:03:36.884Z",
    "cancelled": "2025-02-21T18:03:36.884Z",
    "fulfilled": "2025-02-21T18:03:36.884Z",
    "blocked": "2025-02-21T18:03:36.884Z",
    "returned": "2025-02-21T18:03:36.884Z"
  },
  "fraudStateTransitions": {
    "blocked": "2025-02-21T18:03:36.884Z",
    "review_opened": "2025-02-21T18:03:36.884Z",
    "passed": "2025-02-21T18:03:36.884Z"
  },
  "cancelReason": "fraud",
  "payment": {
    "session": {
      "id": "5823594809",
      "amountContributed": 10.5,
      "amountRemainingToBeContributed": 5.5,
      "clientSecret": "f93b4a5a-6971-4a50-b752-58636f9cfa07_35436acd-7d47-41df-8e5",
      "state": "requires_confirmation"
    },
    "sources": [
      {
        "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
        "clientSecret": "52199c06-b261-4786-8609-d0a84185a0d2_2b72614b-77f6-4801-bd48-8982e314fdd5",
        "createdTime": "2018-04-25T20:36:00Z",
        "currency": "USD",
        "amount": 1180.26,
        "reusable": true,
        "owner": {
          "firstName": "John",
          "lastName": "Smith",
          "email": "[e-mail]",
          "organization": "Digital River",
          "upstreamId": "55129-54673",
          "address": {
            "line1": "10380 Bren Rd W",
            "line2": "text",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
          },
          "additionalAddressInfo": {
            "neighborhood": "Centro",
            "division": "営業部",
            "phoneticName": "ヤマダ タロ"
          }
        },
        "creditCard": {
          "lastFourDigits": "3119",
          "expirationMonth": 3,
          "expirationYear": 2023,
          "brand": "Visa"
        },
        "googlePay": {
          "lastFourDigits": "3119",
          "expirationMonth": 2,
          "expirationYear": 2022,
          "brand": "Visa"
        },
        "payPal": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "payPalBilling": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "payPalCredit": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/e626ec65-24d6-46fb-b632-10b90f4c4912?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success",
            "cancelUrl": "https://mypage.com/cancel"
          },
          "directDebit": {
            "token": "EC-53H39048EL439164J"
          }
        },
        "directDebit": {
          "redirect": {
            "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
            "returnUrl": "https://mypage.com/success"
          }
        },
        "wireTransfer": {
          "accountHolder": "Netgiro Payments AB",
          "bankName": "ABN AMRO Bank N.V.",
          "city": "Prague",
          "country": "ES",
          "referenceId": "DR1651067521",
          "accountNumber": "0100037259",
          "additionalBankInformation": "Codigo de oficina: 0001 Codigo de entidad: 0156 Digitos de control: 09",
          "iban": "ES35 0156 0001 0901 0003 7259"
        },
        "payCo": {
          "redirectUrl": "https://api.digitalriver.com:443/payments/redirects/75743f60-1023-470e-be48-b761260317af?apiKey=pk_test_6cb0fe9ce3124093a9ad906f6c589e2d",
          "returnUrl": "https://mypage.com/success",
          "payCo": {}
        },
        "alipay": {},
        "applePay": {},
        "bPay": {
          "accountHolder": "Global Collect BV",
          "bankName": "Commonwealth Bank",
          "city": "Sydney",
          "country": "Australia",
          "referenceId": "12345678",
          "accountNumber": "87654321",
          "billId": "112233",
          "customerPaymentReference": "443322",
          "swiftCode": "CTBAAU2S"
        },
        "onlineBanking": {
          "bankCode": "86"
        },
        "codJapan": {},
        "klarnaCredit": {
          "shipping": {
            "recipient": "John Doe",
            "phoneNumber": "5559895326",
            "address": {
              "line1": "10380 Bren Road West",
              "city": "Minnetonka",
              "state": "MN",
              "country": "US",
              "postalCode": "55343"
            },
            "email": "[e-mail]"
          },
          "token": "1111222233334444"
        },
        "klarnaCreditRecurring": {
          "returnUrl": "https://example.org/return",
          "cancelUrl": "https://example.org/cancel"
        },
        "konbini": {
          "storeId": "33334444",
          "receiptNumber": "8675309",
          "printableInvoiceUrl": "https://printableinvoice.com",
          "storeName": "Seven Eleven",
          "localizedStoreName": "セブン‐イレブン",
          "storeLogoUrl": "https://storelogo.com"
        },
        "bankTransfer": {},
        "msts": {},
        "bancontact": {},
        "ideal": {},
        "giftCard": {
          "cardCurrency": "USD",
          "conversionRate": 1,
          "lastFourDigits": 8139
        },
        "metadata": {
          "coupon": "iOS"
        },
        "customerId": "5823594809",
        "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
        "liveMode": false,
        "type": "creditCard",
        "flow": "standard",
        "state": "chargeable"
      }
    ],
    "charges": [
      {
        "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
        "createdTime": "2018-04-25T20:36:00Z",
        "currency": "USD",
        "amount": 1180.26,
        "orderId": "9986340012",
        "sourceId": "9986340012",
        "failureCode": "a failure code",
        "failureMessage": "a failure message",
        "paymentSessionId": "8cecaa32-f692-44cc-b103-4cf24dc93913",
        "captured": false,
        "refunded": false,
        "liveMode": true,
        "state": "pending",
        "type": "customer_initiated",
        "cancels": [
          {
            "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
            "createdTime": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "failureCode": "text",
            "failureMessage": "text",
            "state": "pending"
          }
        ],
        "captures": [
          {
            "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
            "createdTime": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "failureCode": "text",
            "failureMessage": "text",
            "state": "pending"
          }
        ],
        "refunds": [
          {
            "id": "a6809a63-e6a9-4016-abbc-f33d19fccb5b",
            "createdTime": "2018-04-25T20:36:00Z",
            "updatedTime": "2018-04-25T20:36:00Z",
            "amount": 1180.26,
            "failureCode": "text",
            "failureMessage": "text",
            "state": "pending"
          }
        ]
      }
    ]
  },
  "disclosures": {
    "disclosures": [
      {
        "entityName": "Digital River Inc.",
        "entityId": "DR_INC-ENTITY",
        "localizedText": "Terms of Sale",
        "url": "https://store.digitalriver.com/store/defaults/en_US/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Inc.",
        "type": "termsOfSale"
      }
    ]
  },
  "liveMode": true,
  "metadata": {
    "coupon": "iOS"
  },
  "sellingEntity": {
    "id": "C5_INC-ENTITY",
    "name": "DR globalTech Inc."
  },
  "purchaseLocation": {
    "country": "US",
    "state": "MN",
    "postalCode": "55364"
  },
  "customerType": "individual",
  "upstreamId": "0916805858",
  "updatedTime": "2018-04-25T20:37:00Z",
  "state": "created",
  "fraudState": "passed",
  "taxIdentifiers": [
    {
      "id": "5774321009",
      "createdTime": "2018-04-25T20:36:00Z",
      "customerId": "5774321009",
      "type": "de",
      "value": "DE123456789",
      "stateTransitions": {
        "pending": "2018-04-25T20:36:00Z",
        "verified": "2018-04-25T20:36:00Z",
        "not_valid": "2018-04-25T20:36:00Z"
      },
      "verifiedName": ".",
      "verifiedAddress": ".",
      "updatedTime": "2018-04-25T20:36:00Z",
      "state": "pending"
    }
  ],
  "items": [
    {
      "id": "100067660336",
      "skuId": "sku_5823594809",
      "productDetails": {
        "id": "100067660336",
        "skuGroupId": "wireless-keyboards",
        "name": "Keyboard",
        "description": "Top rated keyboard",
        "url": "https://producturl.com",
        "countryOfOrigin": "US",
        "image": "https://imageurl.com",
        "weight": 20.5,
        "partNumber": "SWG1224J10L",
        "weightUnit": "oz"
      },
      "subscriptionInfo": {
        "freeTrial": true,
        "autoRenewal": true,
        "terms": "Please accept these terms.",
        "planId": "654321",
        "subscriptionId": "665430999",
        "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
        "startTime": "2020-05-21T00:00:00Z",
        "endTime": "2021-05-20T11:59:59Z"
      },
      "fees": {
        "amount": 4.5,
        "taxAmount": 1.2,
        "details": [
          {
            "amount": 3,
            "perUnitAmount": 1.5,
            "id": "asdkj1h239lkj123j9123",
            "type": "battery"
          }
        ]
      },
      "quantity": 2,
      "stateTransitions": {
        "created": "2025-02-21T18:03:36.884Z",
        "fulfilled": "2025-02-21T18:03:36.884Z",
        "paid": "2025-02-21T18:03:36.884Z",
        "cancelled": "2025-02-21T18:03:36.884Z",
        "blocked": "2025-02-21T18:03:36.884Z",
        "returned": "2025-02-21T18:03:36.884Z"
      },
      "amount": 18.58,
      "availableToRefundAmount": 18.58,
      "sellerTaxIdentifier": "IE6426071C",
      "tax": {
        "rate": 0.0675,
        "amount": 89
      },
      "importerTax": {
        "amount": 12.34
      },
      "duties": {
        "amount": 12.34
      },
      "discount": {
        "amountOff": 5.95,
        "percentOff": 100,
        "quantity": 1
      },
      "shipFrom": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "営業部",
          "phoneticName": "ヤマダ タロ"
        }
      },
      "shipping": {
        "amount": 5.99,
        "taxAmount": 1.99
      },
      "metadata": {
        "coupon": "iOS"
      },
      "state": "created"
    }
  ],
  "invoicePDFs": [
    {
      "id": "text",
      "url": "text"
    }
  ],
  "creditMemoPDFs": [
    {
      "id": "text",
      "url": "text"
    }
  ]
}

OK.