System Status

Fulfillment cancellation

When Digital River coordinates a physical fulfillment, you can use the Fulfillment Cancellations resource to cancel the delivery of inventory items.

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
get
GET /fulfillment-cancellations HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "ret_5823594809",
      "createdTime": {
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        },
        "nano": 0,
        "year": 2018,
        "monthValue": 4,
        "dayOfMonth": 25,
        "hour": 20,
        "minute": 36,
        "second": 0,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 115,
        "month": "APRIL"
      },
      "fulfillmentOrderId": "ord_6645940010",
      "upstreamId": "ord_6645940010",
      "items": [
        {
          "fulfillmentOrderItemId": "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
post
POST /fulfillment-cancellations HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "fulfillmentOrderId": "6645940010",
  "upstreamId": "6645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "quantity": 1
    }
  ]
}
{
  "id": "ret_5823594809",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted"
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "livemode": false
}

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
get
GET /fulfillment-cancellations/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "ret_5823594809",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted"
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "livemode": false
}
PreviousFilesNextFulfillment orders

Last updated