LogoLogo
System Status
  • Digital River API
  • Getting started
  • Using our services
    • Local pricing
    • Item classification
    • Subscriptions
    • e-Invoicing
  • Integration options
    • Low-code checkouts
      • Implementing a Prebuilt Checkout
      • Implementing a Components checkout
      • Offering local pricing
      • Using a shipping endpoint
      • Processing subscription acquisitions
      • Adding custom fields
      • Offering store credit
      • Displaying policies and getting consent
      • Collecting e-invoice information
      • Handling completed checkout-sessions
    • Direct integrations
      • Standard flow
      • Building checkouts
        • Checking out guest and registered customers
        • Describing line items
          • Setting the price of an item
          • Managing items with shared SKU identifiers
        • Providing address information
        • Handling shipping choice
        • Tax identifiers
        • Applying a discount
        • Setting the customer type
        • Providing the IP address
        • Selecting a currency
        • Initiating a charge
        • Setting the purchase location
        • Configuring taxes
        • Accessing regulatory fee information
        • Localizing invoices and credit memos
        • Providing an upstream identifier
        • Applying store credit
        • Handling e-invoicing requirements
        • Landed cost
        • Tax calculation inputs
        • Selling entities
        • Payment sessions
        • Applying store credit (legacy)
        • Country specs
      • Building payment workflows
        • Handling redirect payment methods
        • Handling delayed payment methods
      • Subscription acquisitions
        • Handling subscription acquisitions
        • Handling external subscription acquisitions
        • Subscription information
      • Digital River coordinated fulfillments
        • Checking inventory levels
        • Using shipping quotes
        • Reserving inventory items
        • Managing a fulfillment order
        • Cancelling a fulfillment order
    • Connectors
  • Order management
    • Processing orders
    • Handling a rejected order
    • Accessing invoices and credit memos
    • Fulfilling goods and services
    • Capturing and cancelling charges
    • Payment reauthorizations
    • Handling reversals
      • Return basics
        • Digital River coordinated returns
        • Third party coordinated returns
      • Refund basics
        • Issuing refunds
        • Refunding asynchronous payment methods
      • Disputes and chargebacks
    • Customer notifications
    • Responding to events
      • Events
        • Key event types
        • All event types
      • Webhooks
        • Creating a webhook
        • Digital River API safelist
        • Digital River signature
      • Expanding events
      • Preventing webhooks from getting disabled
    • Distributor model
  • Subscription Management
    • Managing a subscription
    • Managing an external subscription
  • Payments
    • Payment 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 BNP Paribas
          • Configuring BLIK
          • 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
      • BNP Paribas
      • BLIK
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • Pay with Installments France
      • 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
    • Authorization declines
    • PSD2 and SCA
      • How to ensure SCA compliance
    • Payment testing scenarios
  • Product management
    • Product basics
    • Managing SKUs
    • Using product details
    • Grouping SKUs
    • SKU-inventory item pairs
    • Managing inventory items
    • Regulatory fees
      • What are regulatory fees?
        • Fees terminology
        • Regulatory fee management
        • European regulatory fees
        • Compliance obligations
        • WEEE directive requirements
        • Copyright directive requirements
        • Compliance challenges
      • Managing regulatory fees
  • Customer management
    • Customer basics
    • Creating and updating customers
    • Setting up tax exemptions
    • Recording a customer's request to be forgotten
  • Financial reporting
    • Financials basics
    • Sales transactions
      • Returning a list of sales transactions
      • Getting a sales transaction by ID
    • Sales summaries
      • Returning a list of sales summaries
      • Getting a sales summary by ID
    • Payouts
      • Returning a list of payouts
      • Getting a payout by ID
      • Get a list of transactions included in payout by ID
  • Developer resources
    • Digital River API 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 elements
        • Online Banking elements
        • Tax Identifier element
        • Invoice attribute element
        • Delayed Payment Instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
    • DigitalRiverCheckout.js reference
      • Including DigitalRiverCheckout.js
      • Initializing DigitalRiverCheckout.js
        • DigitalRiverCheckout configuration object
      • DigitalRiverCheckout object
        • Configuring Prebuilt Checkout
          • Performing actions
          • Defining experience
        • Components
          • Configuring components
          • Address component
          • Shipping component
          • Tax identifier component
          • Invoice component
          • Wallet component
          • Payment component
          • Compliance component
          • Order summary component
          • Thank you component
        • Rendering a checkout button
          • Performing actions on the checkout button
        • Determining the checkout's status
      • Accessing country and currency
    • DynamicPricing.js reference
    • Postman collection
  • administration
    • Sign in
    • Digital River Dashboard
      • Digital River Dashboard quick start guide
      • Key features
      • Reset your password
      • Test and production environments
      • Account
        • Adding an account
        • Switching accounts
        • Account access
      • Profile settings
        • Viewing your personal information
        • Changing your password
        • Updating your phone number
        • Enabling multi-factor authentication
      • Finance
        • Payouts
          • Viewing your payout details
          • Filtering your payouts
          • Exporting your payouts
        • Sales summaries
          • Viewing your sales summaries details
          • Filtering your sales summaries
          • Exporting your sales summaries
          • Exporting your sales summary details
        • Transactions
          • Viewing your transaction details
          • Filtering your transactions
          • Exporting your transactions
      • Order management
        • Orders
          • Searching for orders
          • Filtering your orders
          • Viewing the order details
          • Cancelling items
          • Fulfilling items
          • Downloading an invoice
          • Downloading a credit memo
          • Creating shipping labels
          • Recording a customer's request to be forgotten
          • Viewing returns and refunds
          • Creating a return
          • Accepting a return
          • Creating a refund
          • Viewing the order's timeline
        • Checkouts
          • Searching for checkouts
          • Filtering your checkouts
          • Viewing the checkout details
        • Prebuilt Checkout links
          • Generate Prebuilt Checkout links
          • View and work with Prebuilt Checkout link details
          • Add a customer during Prebuilt Checkout
          • Add a product during Prebuilt Checkout
      • Customers
        • Viewing customer details
        • Searching for customers
        • Filtering your customers
        • Editing account information
        • Adding a customer
        • Tax IDs and certificates
          • Adding a tax certificate
          • Adding a tax ID
          • Deleting a tax ID
        • Metadata
          • Adding metadata
          • Editing metadata
        • Manage subscriptions from the Customer Details page
        • Disabling a customer
        • Recording a customer's request to be forgotten
        • Deleting a customer
      • Catalog
        • SKUs
          • Viewing the SKU details
          • Searching for SKUs
          • Filtering your SKUs
          • Adding a SKU
          • Editing a SKU
          • Deleting a SKU
          • Adding a fee to a SKU
          • Editing a fee
          • Deleting a fee
          • Viewing product tariff codes
        • Managing customer subscriptions from Digital River Dashboard
      • Developers
        • API keys
          • Updating your API version
          • Getting your API keys
          • Changing the API version for your key
          • Creating a restricted key
          • Editing a restricted key
          • Deleting a restricted key
          • Rotating keys
        • Webhooks
          • Creating a webhook
          • Editing a webhook
          • Deleting a webhook
          • Rotating a webhook's secret
        • API logs
          • Filtering the API log
          • Viewing the API log details
        • Event logs
          • Filtering the events log
          • Viewing the event details
      • Settings
        • Users and roles
          • Roles
          • Searching for a user by name or email
          • Filtering your users and roles
          • Adding a user
          • Editing a user
          • Deleting a user
        • Prebuilt Checkout
        • Payment methods
          • Viewing your payment methods
          • Viewing payment method details
            • Enabling currencies
            • Managing countries
          • Enabling or disabling a payment method
  • General Resources
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2023
      • 2022
      • 2021
      • 2020
      • 2019
    • Standards and certifications
      • Certification process
      • Compliance requirements
      • Documentation requirements
      • Integration checklists
        • Admin portal
        • Products and SKUs
        • Customers and tax exemptions
        • Checkouts, payment sources, and orders
        • Disclosures, compliance statements, and emails
        • Fulfillments and cancellations
        • Customer portal
        • Order refund synchronization
        • Reversals
        • Error handling
      • Test and use cases
    • Commerce infrastructure
    • Versioning
    • Glossary
Powered by GitBook
On this page
  • Submitting a reservation request
  • Unique identifier
  • Product data
  • Shipping data
  • Expiration period
  • Releasing a reservation
  • Attaching a reservation to a fulfillment order
  • Cancelling a reservation
  • Handling failed reservations
  1. Integration options
  2. Direct integrations
  3. Digital River coordinated fulfillments

Reserving inventory items

Learn how to place a hold on one or more inventory items.

PreviousUsing shipping quotesNextManaging a fulfillment order

Last updated 2 months ago

In , you can use the to place a hold on products. Once you , we dynamically select the optimal warehouses to ship the items from. We do this by looking at the ship to country you provide and the product's availability

Once the reservation is successfully created, you must use its to .

Submitting a reservation request

A call to the typically occurs late in the , after customers have finalized their carts and selected a . So, when defining a , you can retrieve data from the .

You are required to send and data in the request. We also recommend you specify a that matches the . In addition, your request can set an .

Unique identifier

When submitting a POST/reservations request, you should designate a unique id. We recommend you retrieve the and use that value to set the reservation's id.

Checkout

POST/reservations

id

âž”

id

This is so that later in the process when you , you can retrieve checkoutId from the upstream order and use this value to set .

In , you only need to to a when using the . In the, we handle releasing a reservation's hold on products.

Product data

In your request, you must pass an array of items. These are the you want to place a hold on. Each element in this array needs to specify an inventoryItemId and the quantity of the item you'd like to reserve.

In the , SKUs and inventory items form . So the checkout's skuId can be used to set the reservation's inventoryItemId.

Checkout

POST/reservations

items[].skuId

âž”

items[].inventoryItemId

items[].quantity

âž”

items[].quantity

Shipping data

Ship to address

Checkout

POST/reservations

shipTo.address.city

âž”

shipTo.address.city

shipTo.address.postalCode

âž”

shipTo.address.postalCode

shipTo.address.state

âž”

shipTo.address.state

shipTo.address.country

âž”

shipTo.address.country

Shipping choice

Shipping Quote

Checkout

POST/reservations

currency

âž”

shippingChoice.currency

quotes[].total

âž”

shippingChoice.amount

âž”

shippingChoice.amount

quotes[].id

âž”

shippingChoice.serviceLevel

âž”

shippingChoice.serviceLevel

Expiration period

When making a reservation request, you can tell us when you want the hold to expire. The expiresInSeconds value that you provide must be a positive integer.

curl --location --request POST 'http://api.digitalriver.com/reservations' \
--header 'Authorization: Bearer <API_key>' \
--header 'Content-Type: application/json' \
...
--data-raw '{
    "id": "5744204322",
    "items": [
        {
            "inventoryItemId": "9b32defe-76ff-4c95-abb8-7dd607af92d5",
            "quantity": 1,
            "allowOversell": false
        }
    ],
    "shipTo": {
        "address": {
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
        }
    },
    "shippingChoice": {
        "currency": "USD",
        "amount": 5.95,
        "serviceLevel": "SG"
    },
    "expiresInSeconds": 300
}'

Releasing a reservation

{
    "id": "5678901234",
    "createdTime": "2018-04-25T20:36:00Z",
    "shipTo": {
        "address": {
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
      }
    },
    "shippingChoice": {
        "currency": "USD",
        "amount": 5.95,
        "serviceLevel": "SG"
    },
    "items": [
      {
        "inventoryItemId": "9234276173",
        "quantity": 1,
        "allowOversell": false
      }
    ],
    "expiresInSeconds": 300,
    "liveMode": false
}

Attaching a reservation to a fulfillment order

Order in an accepted state

POST/fulfillment-orders

checkoutId

âž”

reservationId

Cancelling a reservation

Handling failed reservations

You can remedy this in one of two ways. For the items whose inventory levels are insufficient, you could either set their allowOversell values to true or remove those products from the request.

To make a reservation, Digital River needs both the customer's and . This allows us to determine which warehouses, can ship the product to the customer's country using the desired shipping method.

The shipTo.address represents a customer's shipping address. You're only required to provide the ship to country. When defining the request, you should retrieve the and use them to set the reservation's corresponding attributes.

To set a shippingChoice, retrieve the , and then pass the values in a POST/reservations.

The checkout's shippingChoice is set by using a customer's selected .

Once you successfully submit a , the clock starts ticking. If the hold expires before a containing the is created, then the reservation expires, and we delete it. At that point, the inventory is .

When you submit a request, a 201 Created response contains a reservation with a unique identifier.

In that use the , the should be configured so that its is the same as the .

You should persist this identifier. When you , make sure you to the request. Alternatively, you can use the identifier to .

If you don't perform one of these operations, then the products in the reservation won't be available until the . This prevents us from maintaining an accurate, up-to-date accounting of your inventory.

This operation passes the reservation's shipping, product, and expiration date to our fulfillment services, which reduces the product's inventory levels and closes the reservation. In that use the , you can release a reservation by to a request. This operation passes the reservation's shipping, product, and expiration date to our fulfillment services, which reduces the product's inventory levels and closes the reservation.

In that use the , we send an internal request that and releases a reservation's hold on inventory.

If you , it should match the . So, when you or receive an in an accepted state, you can retrieve checkoutId and use that value to set reservationId in a POST/fulfillment-orders.

Cancelling a allows us to release the hold and make the products available for inclusion in other .

To cancel a reservation, send its unique identifier in a } request. This removes the hold on all the inventory items in that reservation. You can't remove a hold on specific items within a reservation.

If you're using the or fulfillment model and during the checkout process but don't , make sure you delete the reservation.

You should also delete a reservation if you're using the and convert the checkout to an order but, for whatever reason, fail to .

When you submit a , if any in the request has an value that is set to false, and for that item are insufficient, the entire hold request will fail. In this case, none of the requested products will be reserved.

shipping quote
ship-to address
shipping choice
hold expires
Digital River coordinated fulfillments
checkout process
Digital River coordinated fulfillments
Digital River-coordinated fulfillments
synchronous pairs
submit a reservation request
unique identifier
release the hold on the products
checkout
product
shipping
unique identifier
expiration period
shippingChoice
Digital River coordinated fulfillments
create reservation request
unique identifier
Digital River coordinated fulfillments
Digital River-coordinated fulfillments
inventory levels
released back into circulation
cancel the reservation
properly configure a reservation identifier
order
create a reservation
attach the reservation to the fulfillment order
distributed model
distributed model
shipping quote
distributed model
distributed model
orchestrated model
distributed
orchestrated
create a fulfillment order
attach the reservation identifier
reservationId
attach a reservation identifier
create fulfillment order request
orchestrated model
fulfillment order
attached reservation identifier
attaching its unique identifier
allowOversell
reservation's
checkout's
POST /reservations
POST /reservations
POST /fulfillment-orders
creates a fulfillment order
reservation
fulfillment orders
DELETE /reservations/{id
POST /reservations
inventory item
inventory items
Reservations API
Reservations API
POST /reservations
create a fulfillment order
POST /reservations
convert the checkout to an order
synchronously
asynchronously
checkout's ship-to values
checkout's identifier
checkout's identifier
checkout's identifier
checkout's identifier