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
  • Key attributes
  • Responding to an inventory.out_of_stock event
  • inventory.out_of_stock use case

Was this helpful?

  1. Events
  2. Event types
  3. Inventory event types

Inventory out of stock event

Understand the inventory out of stock event.

PreviousInventory event typesNextInventory source and management

Last updated 1 year ago

Was this helpful?

In inventory management, staying updated on stock levels is crucial for smooth operations and customer satisfaction. The inventory.out_of_stock event plays a pivotal role in this context. It serves as an alert mechanism, triggered when a product's inventory level falls to zero signaling that the item is no longer available for purchase or back ordered upon order submission. This real-time notification lets your business respond quickly to stock shortages by updating its online product availability, informing interested customers, and initiating restocking procedures. With detailed information like product ID, the exact time of occurrence, and inventory settings, you can make informed decisions to mitigate the adverse effects of running out of stock.

See for instructions on configuring the webhook events.

Key attributes

The inventory.out_of_stock event contains crucial information that facilitates immediate and informed responses to stock shortages. Below are the key attributes:

  • id: A unique identifier for the event instance allows easy tracking and reference.

  • type: Specifies the event type, in this case, inventory.out_of_stock, to differentiate from other inventory or system events.

  • data: Encapsulates the event-specific data, including:

    • object: Contains details about the out-of-stock item, such as:

      • quantity: The product's inventory level will be 0 for an out-of-stock event.

      • timestamp: The exact time when the product inventory reached zero.

      • products: AContains an array of products affected by the inventory update. Each product has:

        • externalReferenceId: A unique external reference identifier for the product (null if not provided).

        • productId: The unique identifier of the product.

      • eventType: Identifies the specific action that triggered the inventory update event. This attribute is crucial for understanding the nature of the event, such as inventory.out_of_stock, indicating the product is out of stock. This helps in filtering and responding to various types of inventory-related events effectively.

      • partNumber: The part number related to the inventory item.

      • fulfiller: The name of the third-party fulfiller managing the inventory (DR globalTech).

      • allowBackOrder: Indicates whether backorders are allowed for the out-of-stock product (false).

      • inventoryManagement: Specifies the inventory management type, which is Self Managed.

  • previousAttributes: Contains critical product information regarding the state of inventory before the out_of_stock event was triggered, allowing for a comparison of the inventory status before and after the event. This can include:

    • quantity: Shows the product's inventory level just before it reached zero, providing insight into the rate of stock depletion.

  • liveMode: Indicates if the event was triggered in a live operational environment or a test mode (false).

  • createdTime: Records the timestamp of when the webhook event was generated, providing a chronology.

Understanding these key attributes is essential for leveraging the inventory.out_of_stock event to maintain optimal inventory levels and respond effectively to stock shortages.

The inventory.out_of_stock event is a critical notification in inventory management systems, indicating that a product has reached a quantity of zero and is no longer available for sale. This event is triggered in real-time, allowing businesses to respond swiftly to potential stock shortages. It contains essential data, including:

{
    "id": "cda6bf91-96e6-463b-959b-8e82dd81addd",
    "type": "inventory.out_of_stock",
    "data": {
        "object": {
            "quantity": 0,
            "timestamp": "2024-01-30T08:49:44.331Z",
            "products": [
                {
                    "externalReferenceId": null,
                    "productId": "15116720197"
                }
            ],
            "eventType": "inventory.out_of_stock",
            "partNumber": "CCC",
            "fulfiller": "DR globalTech",
            "allowBackOrder": false,
            "inventoryManagement": "Self Managed"
        },
        "previousAttributes": {
            "quantity": 1
        }
    },
    "liveMode": false,
    "createdTime": "2024-01-30T14:49:45.55875Z"
}

Responding to an inventory.out_of_stock event

When the inventory.out_of_stock event is triggered, here are steps a business should consider taking to manage the situation effectively:

  1. Review the notification: Examine the event details, particularly the products array to identify which specific products are affected.

  2. Update product listings: Temporarily disable or update the listings of the out-of-stock products to reflect their availability status, especially if allowBackOrder is false.

  3. Notify relevant departments: Alert purchasing, sales, and customer service teams about the stockout situation to prepare for potential customer inquiries and expedite restocking.

  4. Communicate with customers: If necessary, inform customers about the stockout, particularly those who have already placed orders. Offer alternatives or estimated restock dates to maintain customer satisfaction.

  5. Analyze inventory patterns: Use the timestamp information to analyze inventory patterns and identify any trends or recurring stockout issues.

  6. Adjust inventory management: Depending on the inventoryManagement setting, consider adjusting ordering strategies or inventory levels to prevent future stockouts.

  7. Monitor restocking efforts: Work closely with the fulfiller or suppliers to ensure a timely restocking of the affected products.

By following these steps, businesses can minimize the negative impact of stockouts and maintain a positive customer experience.

inventory.out_of_stock use case

If a product's inventory drops from 1 to 0 due to a customer's purchase, the system sends the webhook payload for the inventory.out_of_stock event. The following image displays the payload for this webhook event.

See the section for instructions on creating the webhook.

Creating a webhook
Getting started with webhooks in Commerce API
inventory.out_of_stock event