System Status

Fulfillments

The Fulfillments resource is a crucial component of the order management system. It allows you to track an order's progression from initial requisition to the delivery of goods or services. This resource facilitates real-time updates on physical logistics and digital delivery status, ensuring seamless operational workflows and enhanced customer satisfaction. Comprehensive details about the type and quantity of items fulfilled provide a transparent view of the supply chain process. See Capturing and cancelling charges for more information.

Gets a Fulfillment by unique identifier

get

Retrieves the details of a Fulfillment.

Path parameters
idstringRequired

The unique identifier of a Fulfillment.

Responses
200
OK.
application/json
get
GET /fulfillments/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-06-30T18:42:41.733Z",
  "orderId": "ord_5678901234",
  "items": [
    {
      "itemId": "98784590336",
      "quantity": 1,
      "cancelQuantity": 1
    }
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}

Returns a list of Fulfillments

get

Gets all the Fulfillments specified in the request.

Query parameters
createdTimestring · date-timeOptional

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:

  • 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
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.

orderIdstringOptional

The identifier of the order associated with the Fulfillment you want to retrieve.

skuIdstringOptional

The identifier of the SKU associated with the Fulfillments you want to retrieve.

trackingCompanystringOptional

The tracking company associated with the Fulfillments you want to retrieve.

Responses
200
200 OK
application/json
get
GET /fulfillments HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdTime": "2025-06-30T18:42:41.733Z",
      "orderId": "ord_5678901234",
      "items": [
        {
          "itemId": "98784590336",
          "quantity": 1,
          "cancelQuantity": 1
        }
      ],
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234"
    }
  ]
}

Creates a Fulfillment

post

Fulfills and/or cancels all or part of an order.

Body
orderIdstringRequired

The identifier of the Order associated with this Fulfillment.

Example: 5678901234
metadataany ofOptional
or
or
trackingCompanystringOptional

The name of the tracking company.

Example: Fedex
trackingNumberstringOptional

The tracking number provided by the shipping company.

Example: 5678901234
trackingUrlstringOptional

The URL of the tracking page for the fulfillment.

Example: http://www.digitalriver.com?code=5678901234
Responses
201
201 Created
application/json
post
POST /fulfillments HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "orderId": "5678901234",
  "items": [
    {
      "itemId": "98784590336",
      "quantity": 1,
      "cancelQuantity": 1
    }
  ],
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-06-30T18:42:41.733Z",
  "orderId": "ord_5678901234",
  "items": [
    {
      "itemId": "98784590336",
      "quantity": 1,
      "cancelQuantity": 1
    }
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}
PreviousFilesNextOrders

Last updated