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
  • Requesting a fulfillment cancellation
  • Ensuring the correct item state
  • Defining and submitting a fulfillment cancellation request
  • A fulfillment cancellation
  • Items accepted for cancellation
  • The fulfillment cancellation life cycle
  • Handling fulfillment cancellation state change events
  • Responding to cancellation events
  • Retrieving a fulfillment cancellation
  1. Integration options
  2. Direct integrations
  3. Digital River coordinated fulfillments

Cancelling a fulfillment order

In Digital River coordinated fulfillments, learn how to cancel fulfillment of physical products

PreviousManaging a fulfillment orderNextProcessing orders

Last updated 3 months ago

In , you can use the to cancel the delivery of . When you , you must specify the items to cancel and in what quantity.

Your integration should also be set up to .

Requesting a fulfillment cancellation

If your site allows customers to cancel purchases, before sending a , you should . Once you've done that, you can .

Ensuring the correct item state

Before you activate a cancellation option in your UI, check that the relevant items[] in the are either or . Customers shouldn't be allowed to cancel items. However, your integration can provide customers the option to .

Defining and submitting a fulfillment cancellation request

When customers opt to cancel all or part of a , respond to their request by defining and submitting a . The request needs to provide:

Fulfillment order identifier

A fulfillmentOrderId represents the .

Fulfillment order
POST/fulfillment-cancellations

id

âž”

fulfillmentOrderId

Order identifier

Order
POST/fulfillment-cancellations

id

âž”

upstreamId

Item data

Fulfillment order
POST/fulfillment-cancellations

items[].id

âž”

items[].fulfillmentOrderItemId

A fulfillment cancellation

Items accepted for cancellation

The fulfillment cancellation life cycle

Fulfillment cancellation states

(1) When the fulfillment cancellation...

(2) its state transitions to...

is created but not yet approved for cancellation by the fulfiller

pending

is approved for cancellation by the fulfiller

accepted

is rejected for cancellation by the fulfiller

rejected

Line item states

(1) When the line item...

(2) its state transitions to...

is not yet approved for cancellation by the fulfiller

pending

is approved for cancellation by the fulfiller

accepted

is rejected for cancellation by the fulfiller

rejected

Handling fulfillment cancellation state change events

Responding to cancellation events

Fulfillment cancellation created events

Fulfillment cancellation approved events

Fulfillment cancellation rejected events

A fulfillment_cancellation.rejected event indicates that the fulfiller has declined the cancellation request.

Retrieving a fulfillment cancellation

An upstreamId represents the . We recommend setting this value for tracking purposes and maintaining data consistency.

For each item a customer wants to cancel, provide its assigned to it. You must also specify the quantity of that line item.

A successful returns a .

You can use this resource to . Additionally, we provide the for each item you request to cancel

A fulfillment cancellation also contains a unique id. You can use this identifier when and .

In a , each items[] provides the quantity you specified in the POST/fulfillment-cancellations as well as the quantityAccepted by the fulfiller. If quantityAccepted is less than quantity, then the fulfiller didn't approve all the items for cancellation.

A , as well as its items[], have a defined lifecycle, each stage of which is represented by a state.

We recommend that you .

A contains a state. It indicates where the resource is in its lifecycle. The values for a successful fulfillment cancellation (i.e., the happy path) are pending > accepted.

Eachitems[] in a also contains a state. The state values of a successfully cancelled line item (i.e., the happy path) are pending > accepted.

Your integration should be capable of . You can also determine a fulfillment cancellation's state by .

You can to listen for fulfillment cancellation created, approved, and rejected events. Each data.object consists of a .

When a POST /fulfillment-cancellations request is successfully submitted, we create a fulfillment_cancellation.created . This event indicates that your cancellation request has been received by Digital River but has not yet been approved or rejected by the fulfiller.

If the fulfiller approves a cancellation request, we create a fulfillment_cancellation.accepted event that provides the .

In that use the , you should respond to each fulfillment cancellation approved event by submitting a payment cancellation request through the .

If you're using the , we listen for fulfillment cancellation-approved events and submit the appropriate payment cancellation request.

For more details, refer to .

We recommend you respond to these events by notifying customers (typically through email and their order management page) that the cancellation request has been rejected. In the notification, you can provide customers instructions on and .

Two requests can be used to :

You can by sending its unique identifier.

You can filtered by optional query parameters.

event
Capturing and cancelling payment charges
returning physical products
requesting refunds
determine the state of the cancellation
accepted quantity
.
responding to cancellation state change events
retrieving the fulfillment cancellation
monitor and respond to fulfillment cancellation state change events
responding to fulfillment cancellation state change events
calling the API directly
quantity of items they accepted for cancellation
Digital River coordinated fulfillments
return shipped items
request a fulfillment cancellation
respond to fulfillment cancellation events
ensure the items you want to cancel are in the correct state
define and submit the cancellation request
The fulfillment order identifier
The order identifier
Data on the items that the customer wants to cancel
event's
fulfillment cancellation
Digital River coordinated fulfillments
Fulfillments API
configure your webhooks
inventory items
identifier of the order
POST /fulfillment-cancellations
fulfillment cancellation
fulfillment cancellation
fulfillment cancellation
fulfillment cancellation
fulfillment cancellation
retrieve fulfillment cancellations
get a specific fulfillment cancellation
get a list of fulfillment cancellations
distributed model
orchestrated model
fulfillment cancellations API
create fulfillment cancellation request
fulfillment order
POST /fulfillment-cancellations
pending
backordered
shipped
fulfillment order
identifier of the fulfillment order
fulfillment order line item identifier