LogoLogo
System Status
  • Commerce API
    • Test and use cases
    • Roles and permissions
    • Sending API calls
  • Shopper APIs
    • Shopper basics
      • Common use cases
        • Creating a customer
        • Applying store credit
        • Private store workflow
        • Guest checkout
    • OAuth
      • Authentication
      • OAuth 2.0 APIs
      • Token
      • Access tokens
      • Session-aware access tokens
      • Authorizing a shopper
    • Shoppers
      • Managing shoppers
        • User management
        • Single sign-on (SSO)
        • Data validation
        • Bulk user management
        • Bulk user account export
      • Managing a shopper's account
      • Managing a shopper's address
      • Managing payment options
    • Product discovery
      • Categories
      • Products
      • Product variations
      • Pricing
      • Inventory status
      • Financing
      • Offers
        • Understanding offers
        • How to use point of promotions (POPs)
          • Retrieving all point of promotion offers for a specific product
          • Retrieving all offers for a specific point of promotion
        • How to use offers
      • Private stores
        • Managing private stores
        • Submitting an order for a private store
        • Useful APIs
      • Fulfillment
        • Electronic Fulfillment Service (OFI)
        • Digital rights
        • Digital rights revocation
        • Physical fulfillment
          • EDI X12 832 definition data elements
          • EDI X12 846 definition data elements
          • EDI X12 850 definition data elements
          • EDI X12 855 definition data elements
          • EDI X12 856 definition data elements
          • EDI X12 180-1 definition data elements
          • EDI X12 180-2 definition of data elements
          • EDI X12 180-3 definition of data elements
    • Cart
      • Applying a shopper to a cart
      • Getting the current cart
      • Creating or updating a cart
        • Adding a product to a cart
          • Gifting
        • Capturing the customer's IP address
        • Providing address information
        • Managing the shipping or billing address
        • Providing subscription information
        • Managing payment methods
        • Capturing the Terms of Sale (TOS) acceptance
      • Managing offers in a cart
        • Applying an offer
        • Applying a coupon or promo code
        • Getting all applied offers
        • Removing an applied offer
        • Removing eligible offers
        • Reconciling conflicting offers
        • Dynamic offers/personalization
          • Skipping Global Commerce merchandising offer arbitration
          • Triggering a promotional URL offer
          • Overriding a promotional URL offer discount
      • Pricing
        • Landed cost
          • Mixed cart support
          • Tax-included pretty price
      • Redirecting to a Digital River-hosted cart
      • Configuring taxes
        • Managing tax identifiers
      • Managing shipping options
        • Getting shipping options
        • Providing a shipping discount
      • Managing line items
      • Applying a price override
      • Managing payment sessions
      • Managing web checkout
      • Submitting a cart
        • Initiating a charge
        • Authorization declines
      • Resuming cart submission
      • HGOP2
    • Orders
      • Getting orders
      • Selling entities
      • Retrieving addresses from an order
      • Retrieving line items from an order
      • Order lookup
      • Returns
        • Initiate an authenticated session
        • Setting up returns in Global Commerce
        • Managing returns
    • Subscriptions
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Updating the subscription's shipping address
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
      • Immediately apply a midterm subscription change
        • Reducing the subscription renewal quantity
  • Admin APIs
    • Admin basics
      • Available Admin API calls
    • Order management
      • Getting the order's details
      • Downloading the invoice
    • Offer management
    • Refund management
      • Authorization
      • Refund reason codes
      • Creating a satisfaction refund
      • Getting the available refunds for a specific order
      • Getting refunds for a specific order
      • Getting refunds available for a shopper's order
      • Getting the JSON schema for an order refund
      • Managing a refund for a delayed payment method
      • Refund error scenarios
    • Subscription management
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update the subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal product
        • Changing the subscription renewal price
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Activating a subscription
        • Changing the subscription's external reference identifier
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
        • Updating the subscription's expiration date
      • Immediately apply a midterm subscription change
        • Applying a midterm change with price override
        • Reducing the subscription renewal quantity
      • Subscription notifications
        • Updating the subscriber's email address
        • Card Account Updater
        • Sending a payment information change notification
        • Sending an expired credit card notification
        • Sending an invalid payment account notification
        • Sending a payment failure notification
        • Sending a subscription renewal reminder notification
        • Setting up subscription renewal reminders
        • Setting up trial subscription renewal reminders
        • Setting up marketing reminders
      • Using the Expired Card Optimizer
    • Customer management
      • Retrieving customer details
      • Requesting PII removal for a customer
    • Site management
      • Configuring authorized shipping and billing countries
      • Getting a site's authorized billing countries
      • Getting a site's authorized shipping countries
    • Product management
      • Getting started
      • Manage products (asynchronous API)
        • Creating or updating a product
        • Adding or updating a product variation
        • Deploying a product
        • Applying live changes
        • Retiring a product
        • Deleting a product variation
        • Deleting a base or individual product's locale
      • Retrieve products (synchronous API)
        • Getting a product by locale
        • Getting a product variation
        • Getting a product variation by locale
      • Get the task status for a product (synchronous API)
        • Getting the latest information on a product task
        • Retrieving the tasks for a specific product
        • Retrieving the tasks for products
      • Bulk operation
        • Asynchronous bulk operations
          • Creating products in bulk
          • Updating products in bulk
          • Deploying products in bulk
          • Deleting product variations in bulk
        • Bulk product upload (BPU)
        • Bulk Product Export (BPE)
          • Line-item level satisfaction refund
          • Order-level satisfaction refund
          • Auto-created line-item level return product
          • Line-item level return product
    • File management
      • Downloading a file
  • Payments
    • Payments solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BLIK
          • Configuring Boleto
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BLIK
      • Boleto
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Building payment workflows
      • Flows by payment type
      • Handling redirect payment methods
    • PSD2 and SCA
    • Payment testing scenarios
      • Testing standard payment methods
      • Testing redirect payment methods
      • Testing receiver payment methods
      • Testing the CCAvenue payment method
  • Events
    • Events overview
    • Responding to events
    • Event types
      • Delayed payment event types
        • Delayed payment expired event
          • Boleto
          • Konbini
          • Wire Transfer
        • Delayed payment reminder event
          • Boleto
          • Konbini
          • Wire Transfer
      • Subscription event types
        • Subscription created event
        • Subscription updated event
        • Subscription action processed event
        • Subscription cancelled event
        • Subscription credit card expired event
        • Subscription payment information changed event
        • Subscription renewal reminder event
        • Subscription renewed event
        • Subscription trial converted event
        • Subscription trial renewal reminder event
        • Subscription payment failed event
      • Post-order event types
        • Invoice created event
        • Refund credit memo event
      • Inventory event types
        • Inventory out of stock event
        • Inventory source and management
        • Inventory self-managed updated event
        • Inventory fulfiller-managed updated event
      • Post-order Notification Integration Guide
    • Webhooks
      • Commerce API safelist
      • Searching for a webhook
      • Creating a webhook
      • Using webhooks
      • Editing a webhook
      • Turning webhooks on or off
      • Revealing a webhook's secret
      • Rotating a webhook's secret
      • Viewing the webhook details
      • Deleting a webhook
  • Developer Resources
    • Postman collection
    • Commerce API references
    • Shopper APIs reference
    • Admin APIs reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline refund element
        • Online Banking elements
        • Tax Identifier element
        • Delayed payment instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
  • General resources
    • Global Commerce
    • Global Commerce
      • Company hierarchy
      • Categories
        • Getting a list of categories
      • Products
        • Product scenarios
        • Individual products
          • Creating an individual product
        • Base product with variants
          • Creating a base product with variants
        • Bundle offers
          • Creating a prorated bundle offer with a subscription
        • Product combination
          • Creating a product combination
        • Gifting
        • Inventory status
      • Customer service
        • Log a shopper's request to remove PII
      • Customers
        • Creating a customer
        • Digital River-maintained customer login
        • Client-maintained customer login
      • Transparent Commerce purchase flow
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2024 latest
      • 2023
      • 2022
      • 2021
      • 2020
Powered by GitBook
On this page
  • Bulk Product Export (BPE)
  • Schemas
  • Catalog feed
  • Details
  • Terminology
  • Schemas
  • Invoice report
  • Details
  • Schemas
  • Sales reporting
  • Details
  • Schemas
  • Reporting
  • Checking the availability of a report
  • Downloading the report

Was this helpful?

  1. Admin APIs
  2. Product management
  3. Bulk operation

Bulk Product Export (BPE)

Understand how to use BPE.

Bulk Product Export (BPE)

Use the Bulk Product Export (BPE) process to export a catalog for a specific site or company to a file in an XML format. The file is compatible with the BPU process.

BPE is non-interactive. When the BPE process finishes, there is no required notification response. When the BPE process ends, an export file indicates the bulk file upload has been completed.

The BPE process is an inbound event.

Schemas

Version
Schema Components Table
Raw Schema
Sample XML

11 (Current)

10

9

Catalog feed

The Catalog Feed API provides a complete record of the products available to a retailer. A batched business process provides the data in XML format over FTP.

Details

The following steps outline how to implement the business process for the product catalog:

  1. Your company completes the product profile form (which is included in the Business Users Guide).

  2. Digital River sets up the business process according to this form.

  3. Your company implements and tests the business process on their side to ensure it works.

This business process is available in batch mode only because of the substantial amount of data that is being shared.

The following table shows the business process specifics.

Characteristic
Specification

Business Process Type

Batch Only

Communication Protocols

FTP Only

Data Formats Available

XML

The business process architecture diagram for the product catalog business process (see image below) shows a combination of several views. It combines a data flow view, an implementation view, and a process flow view into a common, condensed view. This view provides developers with fewer architectural views, making it simpler to understand and implement the Integrated Channel Partner Program (ICPP).

You create one file each time you run the product catalog extract. Files are in your home directory under the /PRODUCTCATALOG directory on the Digital River FTP server or your FTP servers. Digital River archives files for 30 days.

Best Practices: You should also maintain an archive.

The export file contains all the products currently available for purchase by a customer. When you import the file, you should scan for products in your database but no longer in your feed. These products are retired and should not be available for sale on your site. After you flag the retired products in their database, they can reimport the entire catalog feed so all updates and changed data elements are available in addition to new products.

Digital River exports the full catalog once per day.

Best Practices: You should import this full catalog daily to keep in sync with changes, receive new products, and retire unavailable products.

Terminology

Term
Definition

Client

The Digital River business partner who participates in the Integrated Channel Partner Program (ICPP).

Digital River Product ID

The product's ID used internally by the Digital River system.

Integrated Channel Partner Program (ICPP)

The specific product offering provided by Digital River that enables clients the ability to offer the Digital River product catalog to their customers.

Application Programming Interface (API)

A set of routines that an application uses to request and carry out lower-level services.

Uniform Resource Locator (URL)

An Internet standard that allows for the precise discovery of websites and other web resources.

Business process

A data trading agreement between two companies. The business process is all-encompassing and includes both the business rules and the technical rules of the data exchange.

Extensible Markup Language (XML)

The data feed Digital River sends to the client, and the order fulfillment requests the client sends to Digital River are in XML format.

Schemas

Version
Schema Components Table
Raw Schema
XML Schema

1 (Current)

Invoice report

The Invoice Report represents the financial-related information used to reconcile orders and returns for billing and credit. A batched business process provides the data in XML format over FTP.

Details

The Invoice response document represents the financial-related information used to reconcile orders and returns for billing and credit. Digital River can support other formats, such as proprietary CSV, but we highly encourage using our XML format. This report is provided weekly to your company and is available via FTP. A separate monthly billing statement will be sent to your company upon Digital River's expectation of payment. Your company’s bill will be generated monthly in Excel and sent along with the combined CSV files for the month to your company.

The following table shows the business process specifics.

Characteristic
Specification

Business Process Type

Batch only

Communication Protocols

FTP only

Data Formats Available

XML

Digital River creates one file for the client each time the invoice report extract runs. Files are placed in the client’s home directory under the /REPORTING/INVOICEREPORT/ directory on the Digital River FTP server or the client’s FTP servers. Digital River archives files for 30 days. We recommend that the client also maintains an archive.

The export file contains all placed orders on the client’s site.

Digital River runs the invoice report once per week on Monday mornings at 7 am.

Best Practices: The client should import this invoice feed for their accounting records.

The following image shows an example of a monthly billing statement.

Schemas

Version
Schema Components Table
Raw Schema
Sample XML

1 (Current)

Sales reporting

The Sales Reporting runs once a day and always on a 2-3-day lag. It includes all the sales data for a specific site or company over a particular period. When a sale occurs, the system generates a Sales Order Activity and sends it to your endpoint. The Sales Order Activity Info contains the shipping or returns information for all line items in a single order.

The following table describes the contents of a sales notification.

Description
Physical
Digital

Always runs on a 2-3-day lag to account for timings related to fraud and orders transferred from remote databases.

Includes "fulfilled" orders, not necessarily money collected.

Includes delayed payment orders that cleared for that day.

Excludes any suppression (frauded out order) if the suppression occurred within the lag period. Otherwise, the order will be included in the feed.

Best Practices: Use a 3-day lag.

Does not reflect chargebacks or reversals.

Cancelled Orders

Digital River cancelled an order because of suppression after running the report, the suppression will not be visible in that report.

Orders or line items of orders cancelled because of a shopper's request or a fulfiller's notification will not be included in the feed.

Orders or line items of orders cancelled because of a fraud suppression may be included in the feed. The orders or orders' line items will be included, and have no indication of the cancellation if the fraud suppression occurred after the fulfiller shipped the items, and after the Sales Notification service generated the fee. The order or orders' line items will not be in the feed at all if the fraud suppression occurred after the fulfiller shipped the items before the Sales Notification service generated the feed.

Date Order Appears in the Sales Feed

The date the fulfiller told us the order shipped (usually equivalent to the date when the item shipped).

The digital fulfillment date, which is usually within seconds of order submission if the download is hosted by Digital River. If the download is not hosted by Digital River, the date of digital fulfillment (when URL was delivered).

Returns

The date the product returned to the warehouse.

If LOD is required, this is the date when the system received the LO. If nothing is required, this is the date when the system created the return.

If the return completed on the same day, both a (+) and a (-) entry will appear within the same file.

If the returned product has digital rights (serial numbers or unlock codes), then the serial number or unlock code associated with the return is also provided.

Fees charged to your company are not part of this feed (for example download fees).

Includes returns as negative values.

Shows satisfaction refunds (CSR returns money to the customer to make them happy, but and the customer keeps the product). The following Satisfaction Return types are available:

  • Line Item Level Satisfaction Refund

  • Order Level Satisfaction Refund

  • Satisfaction Refund (DEPRECATED)

Other supported return types include:

  • Line Item Level Return Product

  • Order Level Return Product

  • TaxExemptRefund

  • AutoCreateLineItemLevelReturnProduct

  • CancelRequestReturnProduct

  • ReturnProduct (DEPRECATED)

Details

The Sales Notification Feed contains many amount elements.

Schemas

Version
Schema Components Table
Raw Schema
Sample XML

18 (Current)

17

16

Reporting

You can use Reporting to see if a report is available for downloading and download the report.

Checking the availability of a report

The following example shows the Reporting call you must send to get a list of all available reports. The response contains the list of available reports.

GET https://api.digitalriver.com/reporting/files/all
[
  {"filename": "TransactionCustomerDetail.zip","size": "249.333 KB","link": "/lenovo/files/TransactionCustomerDetail.zip","modification_ts": 1540996235000,"modification_date": "2018-10-31"
  }
]

Downloading the report

The following example shows the Reporting call you need to send to download a specific report, where <File Name> is the name of the zip file containing the report.

GET https://api.digitalriver.com/reporting/files/<File Name>.zip
PreviousBulk product upload (BPU)NextLine-item level satisfaction refund

Last updated 1 year ago

Was this helpful?

ICCP System Architecture

Monthly billing statement

A Line Item Satisfaction Refund allows you to refund money to the shopper because the shopper is upset or has experienced undue hardship in getting the product. The shopper is not required to return any product. See for an example.

An Order Level Satisfaction Refund allows you to return money to the shopper when a shopper is upset or goes through undue hardship to get the product. The shopper is not required to return any product. See for an example.

Return receipt arrived with no prior return established. See for an example.

Returned a quantity on a line item or the entire quantity on the order. See for an example.

Line-item level satisfaction refund
Order-level satisfaction refund
Auto-created line-item level return product
Line-item level return product
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
✅
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View
View