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
  • Unsuccessful response or communication issues
  • Retry policy
  • Exception handling
  • Charging policy
  • Integration exception
  • Handling failed digital rights
  • Response details for an unsuccessful scenario
  • Response details for a successful scenario
  • Response details for a successful scenario
  • Response details for an unsuccessful scenario
  • Key request
  • Schemas

Was this helpful?

  1. Shopper APIs
  2. Product discovery
  3. Fulfillment

Digital rights

Understand how Digital Rights work.

Digital Rights refer to entitlements provided to consumers, such as serial numbers, unlock codes, or download URLs, necessary to access or activate digital products or services. Consumers receive these rights by email after the purchased order is fulfilled.

Unsuccessful response or communication issues

When you receive an unsuccessful response or experience communication issues (such as failed transports), the shopping process behaves as follows:

Retry policy

The retry policy is a critical component of our system's reliability strategy, ensuring that temporary issues do not prevent the successful completion of transactions. This policy defines how the system handles unsuccessful responses, outlines the intervals and duration for automatic retries, and stipulates conditions under which the system ceases retry attempts and handles the order accordingly. This mechanism helps to maintain user satisfaction by not imposing charges until the transaction is successful and digital rights are delivered.

The retry policy ensures that if an unsuccessful response or communication issue occurs, the system attempts to resend the request periodically. Here’s a breakdown of how the retry policy works:

  • Auto retries: If the <isAutoRetriable> element is true, the system retries the request every hour.

  • Retry duration: The system continues to retry for up to 21 days.

  • Order handling: If no successful response is received after 21 days, the order is removed from the system.

  • Consumer charges: The consumer is not charged until they successfully receive their digital rights, such as serial numbers or unlock codes.

Exception handling

Exception handling is the process of responding to the occurrence of exceptional conditions (e.g., an error during execution) that disrupt the normal flow of a program. This involves detecting errors, reporting them, and taking corrective actions to ensure the system functions correctly. Types of exceptions include:

  • Timeout Exceptions: Occur when a request times out.

  • Network Errors: Issues related to loss of connectivity.

  • Invalid Data: This happens when the data received is not as expected.

Charging policy

The consumer is not charged during this period until you fulfill their order and they obtain the necessary digital rights (such as serial numbers or unlock codes). If the process is not completed within 21 days, the order is cancelled, and the consumer will not incur any charges.

Integration exception

An integration exception refers to an error during the system integration process where different software components or systems fail to communicate or transfer data correctly. This can involve issues such as unsuccessful digital rights responses and missing or invalid elements in the data exchange. The integration exceptions are recorded and displayed on the globalCommerce Integration Exception screen, which provides detailed information, including error messages and corrective actions.

Handling failed digital rights

When a digital rights request fails, the corresponding line item enters a "failed digital rights" state and appearson the globalCommerce Integration Exception screen. Here are the steps to handle this scenario:

  1. Review the error details: Examine the details provided in the <returnMessage> element on the Integration Exception screen.

  2. Assess the <isAutoRetriable> flag:

    • If <isAutoRetriable> is false, ensure the <returnCode> is non-zero and use the <returnMessage> to understand and rectify the issue.

    • If the <key> element is missing or empty, Digital River will attempt to resolve the issue using the information in <returnCode>, <isAutoRetriable>, and <returnMessage>, then retry the request.

  3. Resubmit the line item: After fixing the identified issue, resubmit the line item through the Integration Exception screen for a new attempt at obtaining the digital rights.

Response details for an unsuccessful scenario

In a successful scenario such as this, the system ignores <returnCode>, <isAutoRetryiable>, and <returnMessage> elements. These elements come into play in an unsuccessful scenario.

Note that the <item> element is unbounded. That means you can send multiple keys in response (in response to the <quantity> element in this <getKeyRequest>).

A successful Digital Rights request results in a response that contains a non-null, non-empty <key> element.

Response details for a successful scenario

When a shopper buys a product that has Digital rights, they get a key (serial number or unlock code) that they can use to access the product.

You can create and associate keys with products to deliver and manage Digital Rights. You can create as many keys as needed to satisfy your Digital Rights requirements.

Digital Rights is an outbound event.

  • Key Request

  • Key Revocation

The types of custom integrations for Digital Rights are as follows:

Digital Rights refer to the rights or permissions granted to a shopper by the publisher or manufacturer to use or access a software application, game, system, etc. Digital Rights protect the sale and distribution of copyrighted works. Use Digital Rights to enable and manage the serial numbers and unlock codes that control access to software and other digital products.

Digital Rights refer to the rights or permissions granted to a shopper by the publisher or manufacturer to use or access a software application, game, system, etc. Digital Rights protect the sale and distribution of copyrighted works. Use Digital Rights to enable and manage the serial numbers and unlock codes that control access to software and other digital products.

The types of custom integrations for Digital Rights are as follows:

  • Key Request

  • Key Revocation

Digital Rights is an outbound event.

You can create and associate keys with products to deliver and manage Digital Rights. You can create as many keys as needed to satisfy your Digital Rights requirements.

When a shopper buys a product that has Digital rights, they get a key (serial number or unlock code) that they can use to access the product.

Response details for a successful scenario

A successful Digital Rights request results in a response that contains a non-null, non-empty <key> element.

Note that the <item> element is unbounded. That means you can send multiple keys in response (in response to the <quantity> element in this <getKeyRequest>).

In a successful scenario such as this, the system ignores <returnCode>, <isAutoRetryiable>, and <returnMessage> elements. These elements come into play in an unsuccessful scenario.

Response details for an unsuccessful scenario

An unsuccessful response occurs when the <key> element is missing or empty. In this situation, Digital River will try to fix the issue causing the non-successful response by using the <returnCode>, <isAutoRetriable>, and <returnMessage> elements and try again.

If the <isAutoRetriable> flag is false, the <returnCode> element must contain a non-0 response. Also, the <returnMessage> element should explain what the value in <returnCode> means, what is wrong with the request, and, if possible, how to fix it.

When an unsuccessful Digital Rights response occurs:

  • The consumer is not charged for the line item until receiving a serial number, unlock code, or download URL.

  • The line item goes into a "failed digital rights" state, and when this happens, it appears on the globalCommerce Integration Exception screen.

  • Using the details provided in the <returnMessage> element, you can use the globalCommerce Integration Exception screen to fix the issue and resubmit the line item.

If the <isAutoRetriable> element is true, Digital River automatically retries the request every hour for 21 days. If there is no action after 21 days, the system "forgets" the order.

When you receive an unsuccessful response or experience communication issues (such as failed transports), the shopping process behaves as follows:

  • The consumer does not receive the Digital Right (serial number, unlock code, or download URL). Instead, the consumer gets instructions to wait for an email containing the Digital Right.

  • The consumer will receive Digital Right by email when the order is fulfilled.

  • The consumer is charged until the Digital Right is fulfilled.

{
	"GetKeyRequest": {
		"orderID": {
			"_xmlns:xsi": "https://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
			"_xsi:type": "xsd:string",
			"__text": "123456789"
		},
		"submissionDate": {
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
			"_xsi:type": "xsd:dateTime",
			"__text": "2014-09-24T15:50:12.252Z"
		},
		"orderExternalReferenceID": {
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
			"_xsi:type": "xsd:string",
			"_xsi:nil": "true"
		},
		"orderLineItemID": {
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
			"_xsi:type": "xsd:string",
			"__text": "213456789"
		},
		"quantity": {
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
			"_xsi:type": "xsd:int",
			"__text": "1"
		},
		"preOrder": {
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:soapenc": "http://schemas.xmlsoap.org/soap/encoding/",
			"_xsi:type": "soapenc:boolean",
			"__text": "false"
		},
		"productKey": {
			"productID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "312456789"
			},
			"externalReferenceID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "4123456789"
			},
			"companyID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "companyID"
			},
			"locale": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "en_US"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns2": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns2:ProductKey"
		},
		"userKey": {
			"userID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "512346789"
			},
			"externalReferenceID": "2269079261",
			"companyID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "companyID"
			},
			"loginID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "test@example.com"
			},
			"siteID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "siteID"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns3": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns3:UserKey"
		},
		"billingAddress": {
			"addressID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "612345789"
			},
			"city": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "City"
			},
			"countryA2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"country": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "US"
			},
			"countryName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "United States"
			},
			"line1": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "123 Example Street"
			},
			"line2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"line3": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"locationCode": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"name1": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "FirstName"
			},
			"name2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "LastName"
			},
			"phoneNumber": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "(123) 456-7890"
			},
			"postalCode": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "12345"
			},
			"state": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "MN"
			},
			"email": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "test2@email.com"
			},
			"faxPhone": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"companyName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "Company Name"
			},
			"phoneNumber2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"countyName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"extendedAttributes": {
				"item": {
					"name": {
						"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
						"_xsi:type": "xsd:string",
						"__text": "ExtendedAttributeName"
					},
					"value": {
						"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
						"_xsi:type": "xsd:string",
						"__text": "value"
					},
					"valueDataType": {
						"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
						"_xsi:type": "xsd:string",
						"__text": "string"
					},
					"_xsi:type": "ns4:ExtendedAttributesInfo"
				},
				"_xsi:type": "ns4:ExtendedAttributesInfoArray"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns4": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns4:AddressInfo"
		},
		"shippingAddress": {
			"addressID": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "612345789"
			},
			"city": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "City"
			},
			"countryA2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"country": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "US"
			},
			"countryName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "United States"
			},
			"line1": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "123 Example Street"
			},
			"line2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"line3": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"locationCode": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"name1": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "FirstName"
			},
			"name2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "LastName"
			},
			"phoneNumber": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "(123) 456-7890"
			},
			"postalCode": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "12345"
			},
			"state": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "MN"
			},
			"email": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "test2@email.com"
			},
			"faxPhone": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"companyName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"__text": "Company Name"
			},
			"phoneNumber2": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"countyName": {
				"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
				"_xsi:type": "xsd:string",
				"_xsi:nil": "true"
			},
			"extendedAttributes": {
				"_xsi:type": "ns5:ExtendedAttributesInfoArray"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns5": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns5:AddressInfo"
		},
		"extendedAttributes": {
			"item": {
				"name": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "ExtendedAttributeName"
				},
				"value": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "value"
				},
				"valueDataType": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "string"
				},
				"_xsi:type": "ns6:ExtendedAttributesInfo"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns6": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns6:ExtendedAttributesInfoArray"
		},
		"orderPricing": {
			"total": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "11.11"
				},
				"_xmlns:ns8": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns8:MoneyInfo"
			},
			"subtotal": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "11.11"
				},
				"_xmlns:ns9": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns9:MoneyInfo"
			},
			"tax": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns10": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns10:MoneyInfo"
			},
			"shipping": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns13": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns13:MoneyInfo"
			},
			"incentive": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns14": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns14:MoneyInfo"
			},
			"shippingIncentive": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns15": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns15:MoneyInfo"
			},
			"nonTaxableFees": {
				"_xmlns:ns16": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns16:MoneyInfo",
				"_xsi:nil": "true"
			},
			"taxableFees": {
				"_xmlns:ns17": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns17:MoneyInfo",
				"_xsi:nil": "true"
			},
			"taxOnTaxableFees": {
				"_xmlns:ns18": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns18:MoneyInfo",
				"_xsi:nil": "true"
			},
			"exchangeRate": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "1"
				},
				"_xmlns:ns19": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns19:MoneyInfo"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns7": "http://integration.digitalriver.com/commonRequisition/1.0",
			"_xsi:type": "ns7:OrderPriceInfo"
		},
		"lineItemPricing": {
			"unitPrice": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "11.11"
				},
				"_xmlns:ns21": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns21:MoneyInfo"
			},
			"listPrice": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "11.11"
				},
				"_xmlns:ns22": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns22:MoneyInfo"
			},
			"pricePerQty": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "11.11"
				},
				"_xmlns:ns24": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns24:MoneyInfo"
			},
			"tax": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns25": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns25:MoneyInfo"
			},
			"shipping": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns28": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns28:MoneyInfo"
			},
			"handling": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns29": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns29:MoneyInfo"
			},
			"incentive": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns30": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns30:MoneyInfo"
			},
			"reqLevelIncentivePerQuantity": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns31": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns31:MoneyInfo"
			},
			"lineItemLevelIncentivePerQuantity": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns32": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns32:MoneyInfo"
			},
			"taxableFees": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns33": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns33:MoneyInfo"
			},
			"taxOnTaxableFees": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns34": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns34:MoneyInfo"
			},
			"nonTaxableFees": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns35": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns35:MoneyInfo"
			},
			"recurringFee": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns36": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns36:MoneyInfo"
			},
			"shippingBeforeDiscount": {
				"currencyCode": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "USD"
				},
				"amount": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:decimal",
					"__text": "0.00"
				},
				"_xmlns:ns37": "http://integration.digitalriver.com/Common/1.0",
				"_xsi:type": "ns37:MoneyInfo"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns20": "http://integration.digitalriver.com/commonRequisition/1.0",
			"_xsi:type": "ns20:LineItemPriceInfo"
		},
		"productAttributes": {
			"item": {
				"name": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "ExtendedAttributeName"
				},
				"value": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "value"
				},
				"valueDataType": {
					"_xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
					"_xsi:type": "xsd:string",
					"__text": "string"
				},
				"_xsi:type": "ns38:ExtendedAttributesInfo"
			},
			"_xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
			"_xmlns:ns38": "http://integration.digitalriver.com/Common/1.0",
			"_xsi:type": "ns38:ExtendedAttributesInfoArray"
		},
		"_xmlns:ns1": "http://integration.digitalriver.com/DigitalRight/1.0",
		"__prefix": "ns1"
	}
}
{
	"getKeyResponse": {
		"key": {
			"item": {
				"key": "ABC123",
				"keyType": "SERIAL_NUMBER"
			}
		}
	}
}
{
	"getKeyResponse": {
		"returnCode": "1",
		"isAutoRetriable": "false",
		"returnMessage": "Unrecognized orderExternalReferenceID - \nplease supply correct value"
	}
}

Key request

The Digital Rights process is a request/response-based process for retrieving external digital rights. When a purchase occurs, the process requests a serial number or an unlock code. A key request integration sends a request for a key (serial number or unlock code) when a shopper purchases a product set up to use the integration.

  • Notification—Global Commerce generates a Get Key Request and sends the request to your endpoint.

  • Required Response to Notification—Your endpoint must synchronously respond with a Get Key Response.

Schemas

Schemas define the structure and format of the data exchanged between systems. They ensure that data is consistently formatted and interpreted correctly by both the requestor and the responder. In the Digital Rights process, schemas provide the specific structure for the key request and response messages, including required and optional fields to ensure smooth integration and communication between systems.

Version
Schema Component Table
Raw Schema
Sample XML

10 (Current)

9

8

PreviousElectronic Fulfillment Service (OFI)NextDigital rights revocation

Last updated 1 year ago

Was this helpful?

Get key request

View
View
View
View
View
View
View
View
View