Fulfillment cancellation

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

PreviousFiles NextFulfillment orders

Last updated 4 months ago

Returns a list of fulfillment cancellations

Get all fulfillment cancellations.

get

/fulfillment-cancellations

Query parameters

createdTimeobject

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

eq—return values where the createdTime field equals to this timestamp
gt—return values where the createdTime field is after this timestamp
gte—return values where the createdTime field is after or equal to this timestamp
lt—return values where the createdTime field is before this timestamp
lte—return values where the createdTime field is before or equal to this timestamp

Example: createdTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

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.

startingAfterstring

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: 100

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

idsstring[]

Only return objects with these IDs.

upstreamIdsstring[]

Only return objects with these upstreamIds.

statestring

Only return objects in the given state

fulfillmentOrderIdstring

The fulfillment order to retrieve cancellations for.

inventoryItemIdstring

The inventory item id to retrieve cancellations for.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/fulfillment-cancellations'

200

400

401

403

405

406

408

429

500

502

503

504

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

200 OK

Creates a cancellation

Cancels all or part of a previously created fulfillment order.

post

/fulfillment-cancellations

Body

fulfillmentOrderIdstringrequired

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

Example: 6645940010

upstreamIdstring

The unique identifier of the upstream order.

Example: 6645940010

reasonstring

The reason for the cancellation.

Example: requested_by_customer

itemsGlobalFulfillmentCancellationItemRequest[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fulfillment-cancellations' \
  --header 'Content-Type: application/json' \
  --data '{"fulfillmentOrderId":"6645940010","upstreamId":"6645940010","reason":"requested_by_customer","items":[{"fulfillmentOrderItemId":"99341140336","quantity":1}]}'

201

400

401

403

405

406

408

409

429

500

502

503

504

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

201 Created

Gets a fulfillment cancellation by its unique identifier

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

get

/fulfillment-cancellations/{id}

Path parameters

idstringrequired

Cancellation ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/fulfillment-cancellations/{id}'

200

400

401

403

404

405

406

408

429

500

502

503

504

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

OK.