LogoLogo
System Status
2021-12-13
2021-12-13
  • 2021-12-13
  • Charges
    • Charge basics
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File Links
    • File link basics
  • Files
    • File basics
  • Fulfillments
  • Fulfillment cancellations
  • Fulfillment orders
  • Fulfillment returns
  • Inventory items
  • Inventory levels
  • Invoices
    • Invoice basics
  • Logistics returns
  • Orders
    • Order basics
  • Payouts
  • Plans
    • Plan basics
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping labels
  • Shipping quotes
  • SKUs
  • SKU Groups
  • Sources
  • Subscriptions
    • Subscription basics
  • Tax identifiers
  • Webhooks
  • Drop-in checkout links
  • Drop-in checkout sessions
    • Checkout-sessions basics
  • Drop-in shipping quotes
  • Store credit callout
Powered by GitBook
On this page

Fulfillment cancellations

PreviousFulfillmentsNextFulfillment orders

Last updated 6 months ago

The Fulfillment Cancellations resource enables businesses to streamline inventory management by providing a reliable method to cancel the delivery of inventory items when coordinated through Digital River's fulfillment services. This API is essential for managing changes in order details or customer requests, ensuring efficient handling of cancellations, and maintaining customer satisfaction. By leveraging this resource, businesses can maintain accurate inventory levels and minimize logistical overhead.

Gets a fulfillment cancellation by its unique identifier

get

Retrieves the details of a fulfillment cancellation. Supply the unique identifier of the cancellation.

Path parameters
idstringRequired

Cancellation ID

Responses
200
OK.
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
404
404 Not Found
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /fulfillment-cancellations/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "fulfillmentOrderItemUpstreamId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted"
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "livemode": false
}
  • GETReturns a list of fulfillment cancellations
  • POSTCreates a cancellation
  • GETGets a fulfillment cancellation by its unique identifier

Returns a list of fulfillment cancellations

get

Get all fulfillment cancellations.

Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

upstreamIdsstring[]Optional

Only return objects with these upstreamIds.

statestringOptional

Only return objects in the given state

fulfillmentOrderIdstringOptional

The fulfillment order to retrieve cancellations for.

inventoryItemIdstringOptional

The inventory item id to retrieve cancellations for.

Responses
200
200 OK
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
get
GET /fulfillment-cancellations HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "hasMore": true,
  "data": [
    {
      "id": "ret_5823594809",
      "createdTime": "2018-04-25T20:36:00Z",
      "fulfillmentOrderId": "ord_6645940010",
      "upstreamId": "ord_6645940010",
      "items": [
        {
          "fulfillmentOrderItemId": "99341140336",
          "fulfillmentOrderItemUpstreamId": "99341140336",
          "inventoryItemId": "5823594809",
          "quantity": 1,
          "quantityAccepted": 1,
          "state": "accepted"
        }
      ],
      "reason": "requested_by_customer",
      "state": "pending",
      "livemode": false
    }
  ]
}

Creates a cancellation

post

Cancels all or part of a previously created fulfillment order.

Body
fulfillmentOrderIdstringRequired

The unique identifier of the fulfillment order associated with the fulfillment cancellation.

Example: 6645940010
upstreamIdstringOptional

The unique identifier of the upstream order.

Example: 6645940010
reasonstringOptional

The reason for the cancellation.

Example: requested_by_customer
Responses
201
201 Created
application/json
400
400 Bad Request
application/json
401
401 Unauthorized
application/json
403
403 Forbidden
application/json
405
405 Method Not Allowed
application/json
406
406 Not Acceptable
application/json
408
408 Request Timeout
application/json
409
409 Conflict
application/json
429
429 Too Many Requests
application/json
500
500 Internal Server Error
application/json
502
502 Bad Gateway Error
application/json
503
503 Service Unavailable Error
application/json
504
504 Gateway Timeout Error
application/json
post
POST /fulfillment-cancellations HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "fulfillmentOrderId": "6645940010",
  "upstreamId": "6645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "fulfillmentOrderItemUpstreamId": "99341140336",
      "quantity": 1
    }
  ]
}
{
  "id": "ret_5823594809",
  "createdTime": "2018-04-25T20:36:00Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "fulfillmentOrderItemUpstreamId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted"
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "livemode": false
}