LogoLogo
System status
Admin APIs reference
Admin APIs reference
  • Admin APIs reference
  • Order management
    • Refunds
    • Retrieve an order (synchronous API)
    • Retrieve an invoice (synchronous API)
    • Manage orders (synchronous API)
  • Customer management
    • Retrieve a customer (synchronous API)
    • Manage a customer (synchronous API)
  • Subscription mangement
    • Manage a subscription
    • Renew a subscription
    • Apply an immediate midterm change
    • Manage subscription payments
    • Modify the subscription's external reference ID
    • Manage the subscription's address
    • Get all orders
    • Retrieve subscriptions with pending actions
    • Retrieve subscriptions
    • Manage a perpetual price
    • Update a subscription's email address
  • Site management
    • Get authorized countries
  • Product management
    • Manage products (asynchronous API)
    • Retrieve a product (synchronous API)
    • Retrieve the product task status (synchronous API)
  • Offer Management
    • Manage offers (synchronous API)
    • Retrieve an offer (synchronous API)
  • Webhook management
    • Manage webhook events
  • Payment source
    • Source management
  • File management
    • Retrieve a file
Powered by GitBook
On this page
  • Admin APIs
  • Download the Admin.json file

Admin APIs reference

NextRefunds

Last updated 2 months ago

The Admin APIs provide robust tools designed to empower administrative operations on your eCommerce platform. These APIs enable seamless management of orders, customer information, promotional campaigns, site configurations, and more. By leveraging these API endpoints, authorized users can perform critical backend tasks efficiently and securely, ensuring your platform operates smoothly and effectively.

You will need an API key with specific permissions to access and use the Admin APIs. This ensures that only authorized personnel can perform sensitive administrative operations, maintaining the security and integrity of your eCommerce platform. The Admin APIs are RESTful, meaning that Digital River designed them to allow you to retrieve, create, update, and delete objects using the HTTP verbs GET, POST, and DELETE. The Admin APIs exclusively use JSON. Therefore, you should always set the content-type header to application/json to ensure the API accepts and processes your requests. All Admin API requests are sent to https://api.digitalriver.com.

Admin APIs

are designed to enhance backend administrative operations for eCommerce platforms. They provide functionalities that include:

  • : Retrieve order details and download invoices.

  • Promotional strategies: Create and deploy offers.

  • : Access and manage customer profiles and handle requests to remove personal information (PII).

  • : Handle refunds efficiently, including various refund scenarios.

  • : Facilitate the management of customer subscriptions, including renewals and cancellations.

  • : Enable control over site configurations and settings, ensuring your eCommerce platform runs smoothly.

  • : Manage your product catalog, from adding new products to updating existing listings.

  • File Management: Download files and handle digital assets within the eCommerce framework.

To access and use the Admin APIs, you need an . This ensures that only authorized personnel can perform sensitive administrative operations, maintaining the security and integrity of your eCommerce platform.

Download the Admin.json file

You can download the Admin.json file to access the comprehensive details and specifications for the Admin APIs. This file contains all the necessary information to integrate and manage the APIs effectively in your environment.

  1. Click the Admin.json file link below to initiate the download.

  2. Save the Admin.json file to your preferred directory on your machine.

Order management
Customer information management
Admin APIs
Refund management
Subscription management
Site management
Product management
API key with specific permissions for Admin API access
756KB
Admin.json