Getting orders
Learn how to retrieve orders.
Getting all orders
You can get all orders for a shopper.
curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/orders?expand=all&pageSize=1' \
--header 'authorization: Basic ***\
...You will receive a 200 OK response.
{
    "order": {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197",
        "id": 278666810197,
        "submissionDate": "2023-10-31T15:59:19.000Z",
        "displayName": "New Order",
        "locale": "en_US",
        "optIn": "false",
        "testOrder": "false",
        "taxExempt": "false",
        "businessEntityCode": "DR_INC-ENTITY",
        "taxInclusive": "false",
        "landedCostState": "NOT_ELIGIBLE",
        "pricing": {
            "subtotal": {
                "currency": "USD",
                "value": 36
            },
            "subtotalWithDiscount": {
                "currency": "USD",
                "value": 36
            },
            "incentive": {
                "currency": "USD",
                "value": 0
            },
            "shipping": {
                "currency": "USD",
                "value": 50
            },
            "tax": {
                "currency": "USD",
                "value": 5.71
            },
            "importTaxAndDuty": {
                "currency": "USD",
                "value": 0
            },
            "total": {
                "currency": "USD",
                "value": 91.71
            },
            "formattedSubtotal": "$36.00",
            "formattedSubtotalWithDiscount": "$36.00",
            "formattedIncentive": "$0.00",
            "formattedShipping": "$50.00",
            "formattedTax": "$5.71",
            "formattedImportTaxAndDuty": "$0.00",
            "formattedTotal": "$91.71"
        },
        "paymentMethod": {
            "type": "creditCard",
            "sourceId": "5658bf4c-0c1b-433d-9953-6091e485efb0",
            "sourceClientSecret": "5658bf4c-0c1b-433d-9953-6091e485efb0_f45435b8-0348-40b2-9da6-6b8b777cfa0d",
            "creditCard": {
                "expirationYear": "2026",
                "lastFourDigits": "1111",
                "clientSecret": "5658bf4c-0c1b-433d-9953-6091e485efb0_f45435b8-0348-40b2-9da6-6b8b777cfa0d",
                "expirationMonth": "3",
                "brand": "Visa",
                "flow": "standard",
                "reusable": "true"
            },
            "amountContributed": {
                "currency": "USD",
                "value": 91.71
            }
        },
        "shippingMethod": {
            "code": 8046100,
            "description": "2 business days"
        },
        "orderState": "In Process",
        "orderStateDetails": {
            "description": "Not Settled",
            "settled": {
                "currency": "USD",
                "value": 0
            },
            "refunded": {
                "currency": "USD",
                "value": 0
            }
        },
        "billingAddress": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/billing-address",
            "id": "billingAddress",
            "firstName": "Subscription",
            "lastName": "Automation",
            "companyName": null,
            "line1": "10380 Bren Rd W",
            "line2": null,
            "line3": null,
            "city": "Minnetonka",
            "countrySubdivision": "MN",
            "postalCode": "55343",
            "country": "GB",
            "countryName": "Great Britain",
            "phoneNumber": null,
            "countyName": null,
            "emailAddress": "[email protected]",
            "phoneticFirstName": null,
            "phoneticLastName": null,
            "division": null,
            "title": null
        },
        "shippingAddress": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/shipping-address",
            "id": "shippingAddress",
            "firstName": "Subscription",
            "lastName": "Automation",
            "companyName": null,
            "line1": "10380 Bren Rd W",
            "line2": null,
            "line3": null,
            "city": "Minnetonka",
            "countrySubdivision": "MN",
            "postalCode": "55347",
            "country": "US",
            "countryName": "United States",
            "phoneNumber": "952-235-1234",
            "countyName": null,
            "emailAddress": "[email protected]",
            "phoneticFirstName": null,
            "phoneticLastName": null,
            "division": null
        },
        "lineItems": {
            "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/line-items",
            "lineItem": [
                {
                    "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/line-items/14052737700",
                    "id": 14052737700,
                    "quantity": 1,
                    "product": {
                        "uri": "https://api.digitalriver.com/v1/shoppers/me/products/8027217700",
                        "id": 8027217700,
                        "name": "Combination Product",
                        "displayName": "Combination Product",
                        "shortDescription": null,
                        "longDescription": null,
                        "productType": "OTHER",
                        "sku": "Combination Product",
                        "externalReferenceId": null,
                        "companyId": "paytest",
                        "displayableProduct": "true",
                        "purchasable": "true",
                        "manufacturerName": null,
                        "manufacturerPartNumber": "1234567890",
                        "thumbnailImage": null,
                        "productImage": null,
                        "keywords": null,
                        "customAttributes": {
                            "attribute": [
                                {
                                    "name": "nonSolr",
                                    "type": "Boolean",
                                    "value": "false"
                                },
                                {
                                    "name": "originalIsOrderable",
                                    "type": "Boolean",
                                    "value": "true"
                                },
                                {
                                    "name": "originalIsViewable",
                                    "type": "Boolean",
                                    "value": "true"
                                }
                            ]
                        }
                    },
                    "pricing": {
                        "listPrice": {
                            "currency": "USD",
                            "value": 36
                        },
                        "listPriceWithQuantity": {
                            "currency": "USD",
                            "value": 36
                        },
                        "salePrice": {
                            "currency": "USD",
                            "value": 36
                        },
                        "salePriceWithQuantity": {
                            "currency": "USD",
                            "value": 36
                        },
                        "formattedListPrice": "$36.00",
                        "formattedListPriceWithQuantity": "$36.00",
                        "formattedSalePrice": "$36.00",
                        "formattedSalePriceWithQuantity": "$36.00",
                        "totalDiscountWithQuantity": {
                            "currency": "USD",
                            "value": 0
                        },
                        "formattedTotalDiscountWithQuantity": "$0.00",
                        "productTax": {
                            "currency": "USD",
                            "value": 0
                        },
                        "shippingTax": {
                            "currency": "USD",
                            "value": 0
                        },
                        "feeTax": {
                            "currency": "USD",
                            "value": 0
                        },
                        "taxRate": 0.08525,
                        "discountDescription": "empty",
                        "importTax": {
                            "currency": "USD",
                            "value": 0
                        },
                        "formattedImportTax": "$0.00",
                        "importDuty": {
                            "currency": "USD",
                            "value": 0
                        },
                        "formattedImportDuty": "$0.00"
                    },
                    "customAttributes": {
                        "attribute": [
                            {
                                "name": "perpetualUnitPrice",
                                "type": "string",
                                "value": "9.00 USD"
                            },
                            {
                                "name": "componentQty",
                                "type": "string",
                                "value": "1"
                            },
                            {
                                "name": "isTaxExempt",
                                "type": "string",
                                "value": "false"
                            },
                            {
                                "name": "productCombinationMaxOrderQuantity",
                                "type": "string",
                                "value": "0"
                            },
                            {
                                "name": "productCombinationMinOrderQuantity",
                                "type": "string",
                                "value": "0"
                            }
                        ]
                    },
                    "components": {
                        "lineItem": [
                            {
                                "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/line-items/14052737700",
                                "id": 14052737700,
                                "quantity": 1,
                                "product": {
                                    "uri": "http://localhost:7163/integration/api/v1/shoppers/me/products/257734900",
                                    "id": 257734900,
                                    "name": "Free trial product",
                                    "displayName": "Free trial product",
                                    "shortDescription": null,
                                    "longDescription": null,
                                    "productType": "DOWNLOAD",
                                    "sku": "asdf",
                                    "externalReferenceId": null,
                                    "companyId": "paytest",
                                    "displayableProduct": "true",
                                    "purchasable": "true",
                                    "manufacturerName": null,
                                    "manufacturerPartNumber": "asdf",
                                    "thumbnailImage": null,
                                    "productImage": null,
                                    "keywords": null,
                                    "customAttributes": {
                                        "attribute": [
                                            {
                                                "name": "freeExtension",
                                                "type": "String",
                                                "value": "NONE"
                                            },
                                            {
                                                "name": "gracePeriod",
                                                "type": "String",
                                                "value": "NONE"
                                            },
                                            {
                                                "name": "timeIntervalForReminderNotifications",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPostCreation",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "suppressOFIInQuantityIncrease",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "numberOfDownloads",
                                                "type": "Integer",
                                                "value": "5"
                                            },
                                            {
                                                "name": "suppressDRMInUpgradeDowngrade",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "suppressOFIInUpgradeDowngrade",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "suppressDRMInQuantityIncrease",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "timeIntervalForReminderNotificationsPostExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "downloadDisplayed",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "downloadDisplayName",
                                                "type": "String",
                                                "value": "workforfree.jpg"
                                            },
                                            {
                                                "name": "autoRenewalDateBasis",
                                                "type": "String",
                                                "value": "PurchaseDate"
                                            },
                                            {
                                                "name": "isFreeTrial",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPreExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "applicationFile",
                                                "type": "String",
                                                "value": "workforfree.jpg"
                                            },
                                            {
                                                "name": "combinedRenewalPeriod",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "duration",
                                                "type": "String",
                                                "value": "WEEKLY"
                                            },
                                            {
                                                "name": "timeIntervalForCCExpirationReminderNotifications",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "purchasedUnits",
                                                "type": "String",
                                                "value": "0"
                                            },
                                            {
                                                "name": "isCombinedRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "suppressDRMInRenewal",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForChangeProductAsRenewal",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "originalIsViewable",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "downloadAdapter",
                                                "type": "String",
                                                "value": "com.digitalriver.downloads.adapters.DRHDownloadAdapter"
                                            },
                                            {
                                                "name": "isAutomatic",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "subscriptionSource",
                                                "type": "String",
                                                "value": "GC"
                                            },
                                            {
                                                "name": "isChangeProductAsRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "originalIsOrderable",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "freeTrialPeriod",
                                                "type": "Integer",
                                                "value": "15"
                                            },
                                            {
                                                "name": "downloadDisplayNames",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "includeRenewalProductInUpgradeList",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForRenewal",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "numberOfIPAddresses",
                                                "type": "Integer",
                                                "value": "10"
                                            },
                                            {
                                                "name": "timeFrame",
                                                "type": "Integer",
                                                "value": "30"
                                            },
                                            {
                                                "name": "unitAutoRenewalTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "suppressOFIInTrialConversion",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "lowUnitUpgradeNotificationTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "fileSize",
                                                "type": "Integer",
                                                "value": "343"
                                            },
                                            {
                                                "name": "subscriptionType",
                                                "type": "String",
                                                "value": "TIME"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPostExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "suppressOFIInRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "suppressDRMInTrialConversion",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "downloadType",
                                                "type": "String",
                                                "value": "HTTP"
                                            },
                                            {
                                                "name": "unitAutoRenewalNotificationTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "maxRolloverUnits",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "trialUnits",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "fileOnBackupMedia",
                                                "type": "Boolean",
                                                "value": "true"
                                            }
                                        ]
                                    },
                                    "recurringSubscriptionInfo": {
                                        "autoRenewal": "true",
                                        "termUnit": "WEEK",
                                        "termLength": "1"
                                    }
                                },
                                "lineItemState": "Complete",
                                "lineItemStateDetails": {
                                    "description": "Downloadable - 1",
                                    "backOrdered": 0,
                                    "shipped": 0,
                                    "returned": 0,
                                    "pendingReturn": 0
                                },
                                "pricing": {
                                    "listPrice": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "listPriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "salePrice": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "salePriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedListPrice": "$0.00",
                                    "formattedListPriceWithQuantity": "$0.00",
                                    "formattedSalePrice": "$0.00",
                                    "formattedSalePriceWithQuantity": "$0.00",
                                    "totalDiscountWithQuantity": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedTotalDiscountWithQuantity": "$0.00",
                                    "productTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "shippingTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "feeTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "taxRate": 0.08525,
                                    "discountDescription": "empty",
                                    "importTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportTax": "$0.00",
                                    "importDuty": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportDuty": "$0.00"
                                },
                                "downloads": {
                                    "downloadUri": [
                                        "https://wgt.digitalriver.com/wgt/9B5A4FCEF11DA80C/B02E8C2AFD4459E0A6761CA182812C35A042CA06F24A67DCEE50EFC144895DA008124CFEFAFF8CF27AF478A90158BD8CCEBEB90BBE21CC64BF8F5A2558CD53AB099767E904E89D92/paytest/workforfree.jpg"
                                    ]
                                },
                                "digitalRights": {},
                                "billingAgreementId": "e8f3ad3a-3890-469b-a858-e67309591380",
                                "customAttributes": {
                                    "attribute": [
                                        {
                                            "name": "perpetualUnitPrice",
                                            "type": "string",
                                            "value": "9.00 USD"
                                        },
                                        {
                                            "name": "componentQty",
                                            "type": "string",
                                            "value": "1"
                                        },
                                        {
                                            "name": "isTaxExempt",
                                            "type": "string",
                                            "value": "false"
                                        },
                                        {
                                            "name": "productCombinationMaxOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        },
                                        {
                                            "name": "productCombinationMinOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        }
                                    ]
                                },
                                "subscriptionIds": [
                                    "35877050197"
                                ]
                            },
                            {
                                "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/line-items/14052747700",
                                "id": 14052747700,
                                "quantity": 1,
                                "product": {
                                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/5505627700",
                                    "id": 5505627700,
                                    "name": "AK123_Physical",
                                    "displayName": "AK123_Physical",
                                    "shortDescription": null,
                                    "longDescription": null,
                                    "productType": "PHYSICAL",
                                    "sku": "AK123_Physical",
                                    "externalReferenceId": null,
                                    "companyId": "paytest",
                                    "displayableProduct": "true",
                                    "purchasable": "true",
                                    "manufacturerName": null,
                                    "manufacturerPartNumber": "MSTS321",
                                    "thumbnailImage": null,
                                    "productImage": null,
                                    "keywords": null,
                                    "customAttributes": {
                                        "attribute": [
                                            {
                                                "name": "clonedFromStaging",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "landedCost",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "nonSolr",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "giftingEnabled",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "needsRestrictedShippingOption",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "originalIsOrderable",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "weight",
                                                "type": "Quantity",
                                                "value": "0.100 lb"
                                            },
                                            {
                                                "name": "originalIsViewable",
                                                "type": "Boolean",
                                                "value": "true"
                                            }
                                        ]
                                    }
                                },
                                "lineItemState": "Pending Fulfillment",
                                "lineItemStateDetails": {
                                    "description": null,
                                    "backOrdered": 0,
                                    "shipped": 0,
                                    "returned": 0,
                                    "pendingReturn": 0
                                },
                                "pricing": {
                                    "listPrice": {
                                        "currency": "USD",
                                        "value": 17
                                    },
                                    "listPriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 17
                                    },
                                    "salePrice": {
                                        "currency": "USD",
                                        "value": 17
                                    },
                                    "salePriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 17
                                    },
                                    "formattedListPrice": "$17.00",
                                    "formattedListPriceWithQuantity": "$17.00",
                                    "formattedSalePrice": "$17.00",
                                    "formattedSalePriceWithQuantity": "$17.00",
                                    "totalDiscountWithQuantity": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedTotalDiscountWithQuantity": "$0.00",
                                    "productTax": {
                                        "currency": "USD",
                                        "value": 1.45
                                    },
                                    "shippingTax": {
                                        "currency": "USD",
                                        "value": 4.26
                                    },
                                    "feeTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "taxRate": 0.08525,
                                    "discountDescription": "empty",
                                    "importTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportTax": "$0.00",
                                    "importDuty": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportDuty": "$0.00"
                                },
                                "downloads": {},
                                "digitalRights": {},
                                "customAttributes": {
                                    "attribute": [
                                        {
                                            "name": "productCombinationMaxOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        },
                                        {
                                            "name": "productCombinationMinOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        },
                                        {
                                            "name": "componentQty",
                                            "type": "string",
                                            "value": "1"
                                        },
                                        {
                                            "name": "isTaxExempt",
                                            "type": "string",
                                            "value": "false"
                                        }
                                    ]
                                }
                            },
                            {
                                "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/278666810197/line-items/14052757700",
                                "id": 14052757700,
                                "quantity": 1,
                                "product": {
                                    "uri": "https://api.digitalriver.com/v1/shoppers/me/products/6686217700",
                                    "id": 6686217700,
                                    "name": "Auto_Monthly_Sub",
                                    "displayName": "Auto_Monthly_Sub",
                                    "shortDescription": null,
                                    "longDescription": null,
                                    "productType": "DOWNLOAD",
                                    "sku": "Auto_Monthly_Sub",
                                    "externalReferenceId": null,
                                    "companyId": "paytest",
                                    "displayableProduct": "true",
                                    "purchasable": "true",
                                    "manufacturerName": null,
                                    "manufacturerPartNumber": "12345678",
                                    "thumbnailImage": null,
                                    "productImage": null,
                                    "keywords": null,
                                    "customAttributes": {
                                        "attribute": [
                                            {
                                                "name": "timeIntervalForTrialReminderNotifications",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "numberOfDownloads",
                                                "type": "Integer",
                                                "value": "5"
                                            },
                                            {
                                                "name": "suppressDRMInUpgradeDowngrade",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "suppressDRMInQuantityIncrease",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "autoRenewalDateBasis",
                                                "type": "String",
                                                "value": "PurchaseDate"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPreExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "purchasedUnits",
                                                "type": "String",
                                                "value": "0"
                                            },
                                            {
                                                "name": "isCombinedRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "originalIsViewable",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "timeIntervalForTrialReminderNotificationsEnabled",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "downloadDisplayNames",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "includeRenewalProductInUpgradeList",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForRenewal",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "suppressOFIInTrialConversion",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "lowUnitUpgradeNotificationTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "subscriptionType",
                                                "type": "String",
                                                "value": "TIME"
                                            },
                                            {
                                                "name": "suppressOFIInRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "trialPostExpirationBillingAttemptIntervalInDays",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "trialGracePeriod",
                                                "type": "String",
                                                "value": "NONE"
                                            },
                                            {
                                                "name": "freeExtension",
                                                "type": "String",
                                                "value": "NONE"
                                            },
                                            {
                                                "name": "gracePeriod",
                                                "type": "String",
                                                "value": "1_WEEK"
                                            },
                                            {
                                                "name": "timeIntervalForReminderNotifications",
                                                "type": "List",
                                                "value": "[30, 15, 7]"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPostCreation",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "nonSolr",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "suppressOFIInQuantityIncrease",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "suppressOFIInUpgradeDowngrade",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "timeIntervalForReminderNotificationsPostExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "isFreeTrial",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "combinedRenewalPeriod",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "duration",
                                                "type": "String",
                                                "value": "MONTHLY"
                                            },
                                            {
                                                "name": "timeIntervalForCCExpirationReminderNotifications",
                                                "type": "List",
                                                "value": "[30, 15, 7]"
                                            },
                                            {
                                                "name": "isDistinctScheduleTurnedOn",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "timeIntervalForManualReminderNotifications",
                                                "type": "List",
                                                "value": "[30, 15, 7]"
                                            },
                                            {
                                                "name": "suppressDRMInRenewal",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForChangeProductAsRenewal",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "downloadAdapter",
                                                "type": "String",
                                                "value": "com.digitalriver.downloads.adapters.NoOpDownloadAdapter"
                                            },
                                            {
                                                "name": "isAutomatic",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForRenewalPreFirst",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "subscriptionSource",
                                                "type": "String",
                                                "value": "GC"
                                            },
                                            {
                                                "name": "isChangeProductAsRenewal",
                                                "type": "Boolean",
                                                "value": "false"
                                            },
                                            {
                                                "name": "originalIsOrderable",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "freeTrialPeriod",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "numberOfIPAddresses",
                                                "type": "Integer",
                                                "value": "10"
                                            },
                                            {
                                                "name": "timeFrame",
                                                "type": "Integer",
                                                "value": "30"
                                            },
                                            {
                                                "name": "unitAutoRenewalTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "numOfDaysPriorExpirationForRenewalFirst",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "timeIntervalForUpgradeReminderNotificationsPostExpiration",
                                                "type": "List",
                                                "value": "[]"
                                            },
                                            {
                                                "name": "postExpirationBillingAttemptIntervalInDays",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "suppressDRMInTrialConversion",
                                                "type": "Boolean",
                                                "value": "true"
                                            },
                                            {
                                                "name": "downloadType",
                                                "type": "String",
                                                "value": "HTTP"
                                            },
                                            {
                                                "name": "unitAutoRenewalNotificationTrigger",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "maxRolloverUnits",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "trialUnits",
                                                "type": "Integer",
                                                "value": "0"
                                            },
                                            {
                                                "name": "timeIntervalForTrialManualReminderNotifications",
                                                "type": "List",
                                                "value": "[]"
                                            }
                                        ]
                                    },
                                    "recurringSubscriptionInfo": {
                                        "autoRenewal": "true",
                                        "termUnit": "MONTH",
                                        "termLength": "1"
                                    }
                                },
                                "lineItemState": "Complete",
                                "lineItemStateDetails": {
                                    "description": "Downloadable - 1",
                                    "backOrdered": 0,
                                    "shipped": 0,
                                    "returned": 0,
                                    "pendingReturn": 0
                                },
                                "pricing": {
                                    "listPrice": {
                                        "currency": "USD",
                                        "value": 19
                                    },
                                    "listPriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 19
                                    },
                                    "salePrice": {
                                        "currency": "USD",
                                        "value": 19
                                    },
                                    "salePriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 19
                                    },
                                    "formattedListPrice": "$19.00",
                                    "formattedListPriceWithQuantity": "$19.00",
                                    "formattedSalePrice": "$19.00",
                                    "formattedSalePriceWithQuantity": "$19.00",
                                    "totalDiscountWithQuantity": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedTotalDiscountWithQuantity": "$0.00",
                                    "productTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "shippingTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "feeTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "taxRate": 0,
                                    "discountDescription": "empty",
                                    "importTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportTax": "$0.00",
                                    "importDuty": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportDuty": "$0.00"
                                },
                                "downloads": {},
                                "digitalRights": {},
                                "billingAgreementId": "c4243051-d794-4a05-b926-5501ae6f1ed6",
                                "customAttributes": {
                                    "attribute": [
                                        {
                                            "name": "perpetualUnitPrice",
                                            "type": "string",
                                            "value": "19.00 USD"
                                        },
                                        {
                                            "name": "componentQty",
                                            "type": "string",
                                            "value": "1"
                                        },
                                        {
                                            "name": "isTaxExempt",
                                            "type": "string",
                                            "value": "false"
                                        },
                                        {
                                            "name": "productCombinationMaxOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        },
                                        {
                                            "name": "productCombinationMinOrderQuantity",
                                            "type": "string",
                                            "value": "0"
                                        }
                                    ]
                                },
                                "subscriptionIds": [
                                    "35877060197"
                                ]
                            }
                        ]
                    }
                }
            ]
        },
        "customAttributes": {
            "attribute": [
                {
                    "name": "orderSubmittedByShopperApiFlag",
                    "type": "string",
                    "value": "shopperApiV1Submitted"
                },
                {
                    "name": "DPL_SERVICE_PROVIDER",
                    "type": "string",
                    "value": "ComplianceService"
                },
                {
                    "name": "SHIPPING_ADDRESS_ID",
                    "type": "string",
                    "value": "35897000197"
                },
                {
                    "name": "isLandedCostPrettyPrice",
                    "type": "string",
                    "value": "false"
                },
                {
                    "name": "DPL_SCREENING_URL",
                    "type": "string",
                    "value": "http://compliance-sys.digitalriverws.net/compliance/resource/screening/VDC3-61182779"
                },
                {
                    "name": "orderGeneratedByFlag",
                    "type": "string",
                    "value": "systemGenerated"
                },
                {
                    "name": "DPLResult",
                    "type": "string",
                    "value": "Accept"
                },
                {
                    "name": "PAYMENT_OPTION_ID_PARAM",
                    "type": "string",
                    "value": "35923000197"
                },
                {
                    "name": "PURCHASEPLAN_INCENTIVE_TOTAL",
                    "type": "string",
                    "value": "0"
                },
                {
                    "name": "orderGeneratedByShopperApiFlag",
                    "type": "string",
                    "value": "shopperApiV1Generated"
                },
                {
                    "name": "BILLING_ADDRESS_ID",
                    "type": "string",
                    "value": "35897000197"
                },
                {
                    "name": "INVENTORY_RESERVED",
                    "type": "string",
                    "value": "true"
                }
            ]
        },
        "paymentSession": {
            "id": "f3e53825-3d20-4c40-afb8-1cde7bdb3a3b",
            "clientSecret": "f3e53825-3d20-4c40-afb8-1cde7bdb3a3b_ef9cb4c1-f56c-4535-bd57-1a313c2f006d",
            "status": "complete"
        }
    }
}See the query parameters for more information.
Getting an order by ID
To retrieve an order, you must specify the order identifier (orderId). You can optionally include the state of the order. Possible order states are Open, Submitted, Cancelled, Complete, Pending Payment, In Review, and In Process. This request requires an authorized or anonymous shopper token. See Getting the order details for more information on getting order details for an anonymous or authenticated shopper without a shopper token.
curl --location --request POST 'https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082' \
--header 'authorization: Basic ***\
...You will receive a 200 OK response.
{
    "order": {
        "links": [
            {
                "rel": "self",
                "href": "https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082"
            },
            {
                "rel": "orders",
                "href": "https://api.digitalriver.com/v1/shoppers/me/orders"
            }
        ],
        "data": {
            "id": 1108696260082,
            "submissionDate": "2023-11-08T18:43:21.000Z",
            "displayName": "New Order",
            "businessEntityCode": "DR_INC-ENTITY",
            "taxInclusive": "false",
            "landedCostState": "NOT_ELIGIBLE",
            "pricing": {
                "subtotal": {
                    "currency": "USD",
                    "value": 100
                },
                "subtotalWithDiscount": {
                    "currency": "USD",
                    "value": 100
                },
                "incentive": {
                    "currency": "USD",
                    "value": 0
                },
                "shipping": {
                    "currency": "USD",
                    "value": 0.1
                },
                "tax": {
                    "currency": "USD",
                    "value": 8.54
                },
                "importTaxAndDuty": {
                    "currency": "USD",
                    "value": 0
                },
                "total": {
                    "currency": "USD",
                    "value": 108.64
                },
                "formattedSubtotal": "$100.00",
                "formattedSubtotalWithDiscount": "$100.00",
                "formattedIncentive": "$0.00",
                "formattedShipping": "$0.10",
                "formattedTax": "$8.54",
                "formattedImportTaxAndDuty": "$0.00",
                "formattedTotal": "$108.64"
            },
            "paymentMethod": {
                "type": "creditCard",
                "sourceId": "3349128c-98c6-4b4a-ab48-60a16f7c7c3b",
                "sourceClientSecret": "3349128c-98c6-4b4a-ab48-60a16f7c7c3b_41654359-6fc3-4b58-8bfc-bbefc5776e6b",
                "creditCard": {
                    "expirationYear": "2030",
                    "lastFourDigits": "1111",
                    "clientSecret": "3349128c-98c6-4b4a-ab48-60a16f7c7c3b_41654359-6fc3-4b58-8bfc-bbefc5776e6b",
                    "expirationMonth": "3",
                    "brand": "Visa",
                    "flow": "standard",
                    "reusable": "true"
                }
            },
            "shippingMethod": {
                "code": 154500,
                "description": "Payments Testing Shipping Method"
            },
            "orderState": "In Process",
            "paymentSession": {
                "id": "99488771-c5cf-4785-b025-0a895e7f8cda",
                "clientSecret": "99488771-c5cf-4785-b025-0a895e7f8cda_4cb90648-9a63-4376-8447-d850e12a239e",
                "status": "complete"
            }
        },
        "entities": [
            {
                "name": "billingAddress",
                "links": [
                    {
                        "rel": "billingaddress",
                        "href": "https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082/billing-address"
                    }
                ]
            },
            {
                "name": "shippingAddress",
                "links": {
                    "self": {
                        "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082/shipping-address"
                    }
                }
            },
            {
                "name": "lineItems",
                "links": [
                    {
                        "rel": "lineitems",
                        "href": "https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082/line-items"
                    }
                ],
                "entities": [
                    {
                        "name": "lineItem",
                        "links": [
                            {
                                "rel": "lineitem",
                                "href": "https://api.digitalriver.com/v1/shoppers/me/orders/1108696260082/line-items/53820030082"
                            }
                        ],
                        "data": {
                            "id": 53820030082,
                            "quantity": 1,
                            "lineItemState": "Pending Fulfillment",
                            "downloads": {},
                            "digitalRights": {},
                            "billingAgreementId": "39b40910-3267-4b38-a07d-a6b05807f227",
                            "subscriptionIds": [
                                "290473170289"
                            ]
                        },
                        "entities": [
                            {
                                "name": "product",
                                "links": [
                                    {
                                        "rel": "product",
                                        "href": "https://api.digitalriver.com/v1/shoppers/me/products/287271100",
                                        "title": "Subscription Physical"
                                    }
                                ],
                                "data": {
                                    "displayName": "Subscription Physical",
                                    "thumbnailImage": null
                                }
                            },
                            {
                                "name": "lineItemStateDetails",
                                "description": null,
                                "backOrdered": 0,
                                "shipped": 0,
                                "returned": 0,
                                "pendingReturn": 0
                            },
                            {
                                "name": "pricing",
                                "data": {
                                    "listPrice": {
                                        "currency": "USD",
                                        "value": 100
                                    },
                                    "listPriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 100
                                    },
                                    "salePriceWithQuantity": {
                                        "currency": "USD",
                                        "value": 100
                                    },
                                    "formattedListPrice": "$100.00",
                                    "formattedListPriceWithQuantity": "$100.00",
                                    "formattedSalePriceWithQuantity": "$100.00",
                                    "productTax": {
                                        "currency": "USD",
                                        "value": 8.53
                                    },
                                    "shippingTax": {
                                        "currency": "USD",
                                        "value": 0.01
                                    },
                                    "feeTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "taxRate": 0.08525,
                                    "importTax": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportTax": "$0.00",
                                    "importDuty": {
                                        "currency": "USD",
                                        "value": 0
                                    },
                                    "formattedImportDuty": "$0.00"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}See query parameters for more information.
Last updated
Was this helpful?