An electronic letter of destruction (ELOD) is the agreement a shopper accepts when they return a digital product. When acceptELOD is true, the customer must complete the ELOD and destroy all copies of the product before they can return the product.
Action
The action parameter modifies the POST behavior for a line item in a cart. The action parameter determines the method behavior for handling the quantity associated with a posted line item. Valid values are: add, update, and subtract. The default action for the resource method is update. The default action for the resource method is add. To override the default method behavior for handling quantity, explicitly specify the value of the action query parameter. This query parameter is available when you .
Activation date
The activationDate is the subscription's activation date when the shopper activates or begins using the subscription and marks the start of the subscription period. This is the date when the subscription term begins. Digital River uses this date to renew the subscription if it is set to auto-renew. The activation date is essential because the other dates in the lifecycle (like billing) either begin with the activation date or depend on the activation date.
Activation key
The activationKey activates the subscription.
Add-ons
The addOns is an array of objects. The objects are sub-components, features, or products that a shopper can add to their subscription product for an additional fee per renewal cycle. An add-on is incremental to the main subscription product and follows the subscription renewal cycle. During the lifecycle of a subscription, the shopper can add or remove the add-on products. When a shopper adds an add-on product to a subscription, Digital River renews the add-on product at the same time as the main subscription product until the shopper deactivates the add-on.
Product
The product object contains the product's identifier information.
id: The product identifier.
externalReferenceId: The product's external reference identifier.
Quantity
The quantity is a numeric number that indicates the number of add-ons.
The apiKey is your account's API key used to authenticate your API requests. You must specify either an apiKey or token.
Applied product offers
The appliedProductOffer object contains an offer, and/or shipping offer applies to the product.
Offer: This object contains either the offer identifier (offerId) or the external reference identifier (externalReferenceId) and a custom description (customDescription) of the offer. Use externalReferenceId only if your site enforces a unique offer ERID.
Shipping offer: This object contains either the offer identifier (offerId) or the external reference identifier (externalReferenceId) and a custom description (customDescription) of the shipping offer. Use externalReferenceId only if your site enforces a unique offer ERID.
Applied order offers
The appliedOrderOffers object contains an offer and/or shipping offer as applicable for the order.
Offer
This object contains either the offer identifier (offerId) or the external reference identifier (externalReferenceId) and a custom description (customDescription) of the offer. Use externalReferenceId only if your site enforces a unique offer ERID.
Shipping offer
This object contains either the offer identifier (offerId) or the external reference identifier (externalReferenceId) and a custom description (customDescription) of the shipping offer. Use externalReferenceId only if your site enforces a unique offer ERID.
Apply email to subscriptions
Begin received time
The beginReceivedTime query parameter filters a list based on the receivedTime field. A filter on a list based on the receivedTime field. The value can be a string with an ISO-8601 UTC format optional (for example, yyyy-mm-ddT00:00:00.000Z). The response displays results for 30 days starting from the specified date. The response displays results for 30 days starting from the specified date.
GET 'https://api.digitalriver.com/v1/products/tasks?beginReceivedTime=2022-10-01T00:00:00.000Z'
Use the beginReceivedTime parameter to filter dates based on the date when the task was received. The following example shows how to display the next page.
The billingAddress object contains the shopper's billing information.
Cart
The cart object contains the cart information by line items and applied order offers.
catalogs
The catalogs is a collection of products for sale on your site. A catalog contains categories to organize your products.
Calalog identifier
A calalogId is the catalog identifier.
Categories
The categories is an array of products organized within a catalog and often appears in the store to help shoppers locate products and navigate the store/site.
categoryId: The category identifier.
Prices
The pricesis an array of prices for a product by currency and locale.
type: The type of the price list. Used to classify the prices in a price list. A price list type may also indicate how the price list or pricing will be used. For example, you can create an MSRP list, a subscription renewal price list, etc.
prices: The prices is an array of prices for a product by currency and locale.
locale: Optional. If your store supports multiple locales, your price list will contain space for you to enter pricing in currencies used by the locales supported by your store. The price you enter for a product in a currency will be used by any locale that uses the currency in which you entered the price.
configuredPrice: The configured price for the product.
Catalogs
A catalog is a collection of products for sale on your site. A catalog contains categories to organize your products.
cattlogId: The catalog identifier. The variation catalog and category are inherited from the base product. The information will be provided in the product variation but ignored if you insert that information in a product variation request.
categories: Use categories to organize products within a catalog, often appearing in the store to help shoppers navigate the store or site to locate products
categoryId: The category identifier.
pricing: The price of a product by currency and locale.
type: The price list type. Used to classify the prices in a price list. A price list type may also indicate how the price list or pricing will be used. For example, you can create an MSRP list, a subscription renewal price list, etc.
locale: Optional. If your store supports multiple locales, your price list will contain the currency for each of the supported locales. When you enter a price for a product by currency, any locale that uses that currency will use the price you provided.
configuredPrice: The configured price for the product.
Charge type
The chargeType specifies the charge type for the subscriptionInfo . The valid values are:
customer_initiated: The shopper initiates the transaction, such as the first purchase of a subscription order.
merchant_initiated: The merchant initiates the transaction, such as automatically renewing a subscription.
moto: Customer service initiates the transaction, such as a mail order or telephone order (moto).
Comments
The comments provides any additional information regarding the return.
Company Identifier
Country
The country is a two-digit ISO 3166-2 country code.
Currency
Use the currency query parameter when you want to see the currency associated with the category. The currency query parameter takes precedence over the locale.
Custom attributes
The customAttributes is an object that lists the default custom attributes.
Customer external Reference identifier (ERID)
The Remote User Management (also known as SSO) service requires an externalReferenceID as a customer identifier.
You must specify a unique externalReferenceID for each user because several objects use it. Failure to do so may violate your contract with Digital River and will cause users to get cross-linked.
You must specify a unique inbound userKey (in response to LoginRequest, GetUserRequest) for each user in the clients' database.
Deployment required changes
Any changed attributes in the deploymentRequiredChanges object will not go live until you deploy the product. This object includes the following attributes:
Fulfillment types
A fulfillmentType defines how products are delivered to shoppers. The options are empty (""), physical or download. When the value is empty, the fulfillment type is neither a physical nor a download product. The empty value reflects the Other setting in Global Commerce for service, warranty, entitlement, etc. Digital River supports two types of digital products: subscription and download.
Other fulfillment integration
The otherFulfillmentIntegration setting allows you to provide a unique fulfillment for your products. Contact your Store Operations team if you have special fulfillment needs that could benefit from Other Fulfillment Requirements and integrations.
fulfillerIds: The fulfiller's identifier.
Transfer product
The transferProduct is the upgraded product identifier. This is a subscription product term. You can use the product identifier (productID) or the external reference identifier (ERID) The base product cannot be a transfer product.
Upgrade products
The upgradeProducts is the upgraded product identifier for a subscription product. You can use the product identifier (productID) or the external reference identifier (ERID). You cannot upgrade a base product.
Downgrade products
The downgradeProducts is the downgrade product identifier for a subscription product. You can use the product identifier (productID) or the external reference identifier (ERID). You cannot downgrade a base product.
Discount
The value for the discount field is the order level discount. It includes:
If you set the price list to tax-inclusive, this price will include tax
It does not include the following:
The line item level discount
If you set the price list to tax exclusive, this price will NOT include tax
If you need an overall discount for this order, you would need to sum the sum of the discount for all items.
Email address
Email domain
emailInvitationAddress
emailInvitationPin
A PIN is associated with an email invitation. If a private store shopper invites a friend to view a private store, the PIN is provided with the invitation.
End received time
This optional endReceivedTime query parameter filters a list on the finishedTime field. The value can be a string with an ISO-8601 UTC format datetime (for example, yyyy-mm-ddT00:00:00.000Z). The response displays results for 30 days before and including the specified date.
GET 'https://api.digitalriver.com/v1/products/tasks?endReceivedTime=2022-10-31T00:00:00.000Z'
Use the endReceivedTime parameter to filter dates based on the date when the task was received. The following example shows how to display the next page.
This optional endingBefore query parameter filters a list based on taskId. Use the endingBefore value in the previousPage object from the previous request when requesting the next page of tasks.
GET 'https://api.digitalriver.com/v1/products/tasks?endingefore={taskId}'
Expand
Use the expand query parameter when you want related information to appear in the response. The expand query parameter provides additional fields in the response. Expanding resources reduces the number of API calls required to accomplish a task. See the Expand query parameter for more information.
genericIdentifier
genericIdentifierPin
ipAddress
referralUrl
Expiration date
The expirationDate is the date when the subscription expires.
External reference identifier (ERID)
Fee tax
The value of the feeTax field is the fee tax amount of the line item with quantity. If there is more than one fee for this product, this amount is the sum of all fee taxes regardless of whether the fees are "Included in Price" (an invisible fee) or fee "Excluded from price" (a visible fee).
Fields
Use the fields query parameter to specify the fields that appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time. See Fields query parameter for more information.
Format
The format overrides the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.
Import duty
The value of the importDuty field is the import duty amount. When a customer purchases products online, one or more of the products may not originate in the country the customer resides in and, therefore, are subject to customs duty when importing products across international borders.
When goods are not shipped domestically (within the customer’s country) or within a single customs union, such as the European Union, the customer is liable to pay any inbound duties that the customer’s local customs authority deems appropriate.
Import tax
The value for the importTax field is the VAT or other sales tax assessed on the transaction.
Import tax and duty
The value for the importTaxAndDuty field is the sum of import taxes and duties for all line items.
IP address
The ipAddress is the shopper's IP address for the current session.
Key
The key is a unique identifier used to reference specific resources or entities within the system, such as the tax registration resource. It is essential to track various elements and ensure their proper management and retrieval.
Landed cost state
The value for the landedCostState field is the state of landed cost calculation whose enumerated values are as follows:
ERROR: Failed to calculate landed cost. This occurs when the integration service is unavailable.
PREPAID: The current cart is eligible for landed cost calculation. The shopper prepays the landed cost.
VIEWED_NOT_ELIGIBLE or NOT_ELIGIBLE: The current cart is not eligible for landed cost calculation.
Line item
A single line in a cart consists of a line item (lineItem), which includes at least one product identifier and the corresponding quantity.
Identifier: The id is the line item identifier.
Quantity: The quantity is the number of products added to the cart. The value must be a valid integer. If the quantity is not explicitly specified, the default is 1.
Automatic renewal: When set to true, the autoRenewal indicates the subscription will renew automatically (as opposed to manually).
Terms: The terms describe the recurring purchase terms for the customer.
Free trial: When set to true, the freeTrial indicates the subscription is a free trial.
Start time: The subscription's start date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
End time: The subscription's end date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
Billing agreement identifier: The billingAgreementId is the Digital River billing agreement ID. It represents the terms the customer agreed to when they stored their card details or applied them to any recurring purchase. The agreement ID can then be referenced for subsequent purchases, which allows us to tie them together
Subscription identifier: The subscriptionId is the subscription's identifier.
Segment identifier: The segmentId is the unique segment identifier for each renewal term. For example, you can set the initial acquisition to 1. After that, you can increment the renewal term identifier value by 1 for each additional renewal term.
Renewal attempt number: The renewalAttemptNumber is the billing attempt number for the current renewal. The value should reset to 1 after every successful renewal.
Custom attributes: An customAttributes object contains the default custom attributes.
attribute: An attribute is an array of objects that define the specific qualities of the line item.
name: The attribute's name.
value: The value associated with the attribute.
type: The type of attribute.
currency: A three-letter ISO 4217 currency code. Only available for unit price override.
value: The value of the price override or sale price. Only available for unit price override.
itemPrice: This object allows you to set the overall total item price with quantity (salePriceWithQuantity). Only available for line item price override.
value: The value of the overall total item price with quantity.
The lineItems is an object containing the line items associated with the cart.
Line items identifier
The lineItemsId is a comma-separated list of one or more line item identifiers.
Line item quantity identifiers
The lineItemQuantityIdentifiers is an array of integers.
Limit
This optional limit query parameter filters a list on the finishedTime field. The value can be a string with an ISO-8601 UTC format datetime (for example, yyyy-mm-ddT00:00:00.000Z). The response displays results for 30 days before and including the specified date.
GET 'https://api.digitalriver.com/v1/products/tasks?endReceivedTime=2022-10-31T00:00:00.000Z?limit=10'
Live changes
The changed attributes under the liveChanges object will go live immediately. You do not need to deploy these changes. You can use the following attributes to insert live changes when creating a product. After creating the product, the fields are read-only. You can apply live changes by using the POST /v1/products/{productId}/live-changes API. This object is available when you update a product. This object includes the following attributes:
External reference ID
The externalReferenceId is the product's external reference identifier. It's your company's unique identifier for the product.
Locale
Use the locale query parameter when you want to see the locale associated with a category, billing country, or shipping country.
Localizations
This localizations object defines the locales supported by the product.
locale
The product's supported locale.
Is default
When isDefault is set to true, the locale is the default locale.
groups
The groups is an array of grouped attributes associated with the locale.
groupId: The group identifier for the attributes (for example, 1100). This field is read-only. You do not need to provide this attribute in the request. The request will ignore this attribute when creating or updating the product.
groupName: The group name for the attributes. This field is read-only. You do not need to provide this attribute in the request. The request will ignore this attribute when creating or updating the product.
attributes: An array of properties associated with the group.
The possible attributes are as follows:
Name: The name of a product as it appears in reports, offers, and other places within Global Commerce. Shoppers will not see this name in your store. For example: Maverick Sneakers
displayName: The public-facing product name as it appears in your store. Shoppers can see this name when they browse your store or use it when searching for it. For example: F-18 Hornet Fighter Jet
sku: The stock keeping unit (SKU) or product name. For example: f18
shortDescription: A brief description of the product. For example: The Boeing F/A-18E and F/A-18F Super Hornet are twin-engine, carrier-capable, multirole fighter aircraft...
A product contains any other license requirements/restrictions
A product has an end-use that is prohibited by applicable export control laws
Digital River's legal documentation lists ECCNs pre-approved for use in the Admin APIs. In the table's description field, you may find additional requirements and restrictions that further limit the use of the ECCN.
Digital River can only resell products with these listed ECCNs. If you have a product with an ECCN that you'd like to be considered for addition to the list, e contact Legal-compliance@digitalriver.com.
downloadFulfillment: The download fulfillment type. This attribute is required when you are creating a digital product. The valid values are digitalRiver or thirdParty. If you don't provide this attribute when you create or update a product, the default value is digitalRiver.
List price
The value of the listPrice field is the per-unit price setup in the price list for the product associated with this line item. It includes:
The "Included in Price" fee (an invisible fee) if it's configured for the line item
If the price list is set to tax-inclusive, this price will include tax
It does not include the following:
The discount
The "Excluded from price" fee (a visible fee)
If you set the price list to tax-exclusive, this price will NOT include tax
List price with quantity
The value of the listPriceWithQuantity field is the total calculated list price for the line item with quantity. It includes:
The "Included in Price" fee (an invisible fee) if it's configured for the line item
If you set the price list to tax-inclusive, this price will include tax
It does not include the following:
The discount.
The "Excluded from price" fee (a visible fee).
If you set the price list to tax exclusive, this price will NOT include tax.
The value for this field uses the following formula: listPrice × qty.
Offer
Offer identifier
The offerId is the offer's identifier.
Order identifier
The orderId is the order's identifier.
Order state
The orderState specifies the state of the order. The possible values are as follows: Open, In Process, Cancelled, Submitted, Complete, Dispute, In Review, Source Pending Funds, Source Pending Redirect, and Charge Pending.
Order total
The value for the orderTotal field is the final price of the order.
Page number
Page size
Parent line item identifier
The parentLineItemId is the line item identifier of the parent product. While adding a child product to the cart, provide the line item identifier of the parent product along with the offer identifier to specify the child product should be associated with which parent product line item.
Payment option identifier
The paymentOptionId is the payment option identifier for a specific payment method. Digital River uses this value when a shopper selects a payment method and applies it to their cart. If the shopper does not select a payment method, Digital River uses the shopper's default payment option.
Perpetual unit price
The perpetualUnitPrice refers to the cost of a subscription product that remains consistent for each billing cycle. It is a fixed price that customers pay on an ongoing basis for the duration of their subscription.
POP name
Postal code
The postalCode is the postal code. For United States addresses, Digital River supports ZIP+4 codes. They consist of the last four digits of a full nine-digit ZIP code. A nine-digit ZIP Code has two parts: the initial five digits of the zip code indicating the destination post office or delivery area, and the last four digits representing a specific delivery route within that overall delivery area.
Product external reference identifier (ERID)
Some companies have internal identifiers for their products. We call them external reference identifiers to distinguish them from our product identifiers. These external reference identifiers may or may not match the product identifier in Global Commerce.
GET 'https://api.digitalriver.com/v1/products/tasks?productId={productId or productERID}'
Note: If you specify a productERID, you must include x-erid-as-pid=true in the request header.
Product identifier
A productId is your unique product identifier or unique stock keeping unit (SKU) for a product. A product's unique identifier is represented by an id.
Product page size
Product tax
The value of the productTax field is the tax amount for the product at the line-item level with quantity. When you set up a fee for the product and choose "Included in Price" (an invisible fee), the response includes the fee in the price and excludes the invisible fee tax in the productTax. When you set up the fee and choose "Excluded from Price” (a visible fee), the response excludes the visible fee tax from productTax.
Products
The products object provides the product identifier (productId) and/or External Reference Identifier (externalReferenceId), and product type (productType). The valid product types are INDIVIDUAL, BASE, VARIATION.
Promotional code
The promoCode is the promotional code the shopper wants to apply to the cart.
Quantity
The quantity is the number of products added to the cart. The value must be a valid integer. If the quantity is not explicitly specified, the default is 1.
Reason
The reason provides the reason for the return.
Received time and finished time
A task always contains receivedTime and finishedTime fields. The receiveTime field indicates the date and time when the task began and the finishedTime field indicates when the task is completed. You can use the beginReceivedTime or endReceivedTime query parameters in the URI to search for all tasks associated with a specific receivedTime or finishedTime.
Redirect URI
The redirect_URI is the page you want to redirect the shopper to after saving their information.
Request type
The requestType attribute identifies the type of request associated with the task. The valid request types are CREATE_PRODUCT, CREATE_VARIATION, UPDATE_PRODUCT, UPDATE_VARIATION, DELETE_VARIATION, DELETE_LOCALE, DEPLOY_PRODUCT, RETIRE_PRODUCT, UPDATE_PRODUCT_LIVE_CHANGE, and UPDATE_VARIATION_LIVE_CHANGE.
Return
The return object contains the return information.
Return line items
The returnLineItems is an array of objects containing the returned line items.
Sale price
The value of the salePrice field is the per-unit price for the product associated with this line item. It includes:
The line item level discount per unit
The "Included in Price" fee (an invisible fee) if it's configured for the line item
If you set the price list to tax-inclusive, this price will include tax
It does not include the following:
The order level discount
The "Excluded from price" fee (a visible fee)
If you set the price list to tax exclusive, this price will NOT include tax
The value of the salePriceWithQuantity field is the total calculated price for the line item with quantity. It includes:
The line item level discount
The "Included in Price" fee (an invisible fee) if it's configured for the line item
If you set the price list to tax-inclusive, this price will include tax
It does not include the following:
The order level discount
The "Excluded from price" fee (a visible fee)
If you set the price list to tax exclusive, this price will NOT include tax
Shipping address
The shippingAddress object contains the shopper's shipping information.
Shipping address identifier
The shippingAddressId is the identifier of a shopper address resource to use as the shipping address. If neither shipping nor a billing address is provided, the default address for the shopper is used. Otherwise, the billing address ID (if provided) is applied as the default shipping address.
Shipping and handling
The value for the shippingAndHandling field is the shipping and handling fee.
If you set the price list to tax-inclusive, this price will include tax.
If you set the price list to tax exclusive, this price will NOT include tax.
Shipping options identifier
The shippingOptionsId is the shipping option identifier for the cart.
Shipping tax
The value of the shippingTax field is the shipping tax amount of the line item with quantity. If you ship more than one line item together, the items might share the shipping tax amount in the response for the order.
Skip offer arbitration
Starting after
This optional startingAfter query parameter filters a list based on taskId.
Use the startingAfter value in the nextPage object from the previous request when requesting the next page of tasks.
GET 'https://api.digitalriver.com/v1/products/tasks?startingAfter={taskId}'
Subtotal
The value of the subTotal field is the order total before applying the order level discount. This is calculated based on the sum of the line-item level salePriceWithQuantity. It includes:
The line item level discount
The "Included in Price" fee (an invisible fee) if it's configured for the line item
The "Excluded from price" fee (a visible fee)
If you set the price list to tax-inclusive, this price will include tax
It does not include the following:
The order level discount
If you set the price list to tax exclusive, this price will NOT include tax
The value for this field is the sum of all line-item level salePriceWithQuantity values. If there is an "Excluded from price" (a visible fee), it will be treated as a line item and included in this value.
Subtotal with discount
The value of the subtotalWithDiscount field is the subtotal applied order level discount.
If you set the price list to tax-inclusive, this price will include tax
If you set the price list to tax exclusive, this price will NOT include tax
The value for this field uses the following formula: subtotal – discount
Suggestion identifier
The suggestionId is the identifier of the Billing Address Suggestion resource to apply to the cart's billing address.
Suppress order confirmation email
A real order uses suppressorderconfirmationemail to suppress the order confirmation email. If you want to use this feature, contact your Customer Success Manager.
Task identifier
A taskId is a unique identifier. You can use this identifier to retrieve a task.
Task status
This query taskStatus parameter filters a list based on the taskStatus. You can add multiple values separated by a comma. The valid task values are PUBLISHED, COMPLETED, FAILED, PROCESSING, PUBLISHED. The request returns tasks with the specified values.
GET 'https://api.digitalriver.com/v1/products/tasks?staskStatus=COMPLETED,FAILED'
Tax
The tax field's value is the sum of all taxes for this order.
Tax rate
The taxRate field's value is the rate available for calculating the tax for this line item.
Tax-inclusive
The taxIncludedPrice field's value is either true (tax inclusive) or false (tax exclusive).
Task status
The taskStatus attribute identifies the type of status associated with the task. The valid task values are PUBLISHED, COMPLETED, FAILED, PROCESSING, PUBLISHED.
Term identifier
The termId is the finance term identifier associated with the cart. You must pass the termId with the productId or externalReferenceId.
Terms of sales (TOS) acceptance
Theme identifier
The themeId is the identifier of the theme associated with a site. The theme controls the styles of a Digital River-hosted web page.
Token
The token is the authorized or anonymous token for the shopper.
URI
A uri is the web address for a specific task.
Value
Variations
This variations object defines the variation of a base product. This attribute is available when you create a base product. It's only required when you want to create variations of a base product.
Varying attributes
The following attributes for the varyingAttributes object distinguish the product variation from the base product.
attributeName: The name of the attribute, such as size.
attributeValue: The attribute's value, such as small, medium, or large.
Version
The version string gets the specific version of the product by state. The enums are DEPLOYED and RETIRED. If you do not specify the version query parameter, the response will contain the latest version. For example, if the product history is as follows:
Version 1 is retired: This product version is retired. Shoppers can no longer see or purchase this product in the store.
Version 2 is deployed: This product version is available in the store. Shoppers can see and purchase this product from your store.
Version 3 is in design. This new product version is not yet available in the store, but you plan to deploy it eventually. Shoppers cannot see or purchase this product from your store.
Use the following calls can get the different versions:
If you want to get the retired version (version 1), use the following call:
GET /v1/products/{productId}?version=retired
If you want to get the deployed version (version 2), use the following call:
GET /v1/products/{productId}?version=deployed
If you want to get the latest unreleased version, use the following call:
GET /v1/products/{productId}
When the value for the applyEmailToSubscriptions query parameter is true, and you provide the emailAddress in the request body, all active and inactive subscription shipping and billing email addresses will be updated when you update the shopper's subscription billing and shipping email addresses. This query parameter is only available when .
The following request filters tasks by the receivedTime (for example, 2022-0901dT00:00:00.000Z). The begin received time includes everything starting on the specified received time date and going forward.
The request list the tasks by beginReceivedTime in the response
This request displays the next page by beginReceivedTime in the response.
Available for .
The companyId is the company's identifier. This query parameter is available when you .
You can use an external reference ID (externalReferenceID ) to refer to either a or a .
Use the emailAddress to supply the shopper's email address you want to use for the search. This query parameter only applies to .
Use the emailDomain to supply the domain name you want to use for the search. This query parameter only applies to .
An email address associated with an invitation to a private store. When a private store shopper invites a friend to view a private store, the invitation email address belongs to the private store shopper who sent the invite. This query parameter only applies to .
This parameter is Required only if emailInvitationAddress was provided. This query parameter only applies to .
The following request filters tasks by the finishedTime (for example, 2022-10-30T23:00:00.000Z). The end received time includes everything ending on the specified finished time date and going backward.
The generic identifier to use for the search. This query parameter only applies to .
The PIN that accompanies the generic identifier for the search. This query parameter is required if provide the genericIdentifier. This query parameter only applies to .
The IP address to use for the search. This query parameter only applies to .
The referral URL to use for the search. This query parameter only applies to .
The is a company's internal identifier for a product.
Subscription information: The subscriptionInfo object contains the base information-related data for an external subscription engine. Available for .
Billing optimization: The billingOptimization object is the ECO (Expired Card Optimizer) billing optimization tool for a 3rd party subscription. Available for .
Pricing: The pricing object allows you to set the sale price for a line item in a cart. Only available for and .
This object contains either the offer identifier (offerId) or the (externalReferenceId) and a custom description (customDescription) of the offer. Use externalReferenceId only if your site enforces a unique offer ERID.
The pageNumber specifies the page to display from the results page. The default is 10. Only available for .
The pageSize specifies the maximum number of items to include on each page. Only available for .
The popName is the name of the point of promotion (POP) the resources.
You can use an external reference ID (ERID) to refer to either a or a .
The productsPageSize query parameter specifies the maximum number of products to include for each category returned in a paginated response. The value must be a positive number greater than zero and less than 100000. The default is 10. This query parameter is only available when and .
Use to enable or disable the Global Commerce Merchandising Offer arbitration logic. When enabled (set to true), Digital River disables the skip offer arbitration to find the best price for a product and displays the base price. When disabled (set to false), Digital River enables the skip offer arbitration to find the best price, and the best offer wins.
The termsOfSalesAcceptance indicates whether or not the shopper accepted the .
The value is the tax identifier for the tax registration resource. For , you must specify either an apiKey or token.
