System Status

Fulfillments

The Fulfillments resource is a crucial component of the order management system. It allows, allowing you to track the progression of an order from initial requisition to the delivery of goods or services. This resource facilitates real-time updates on the status of both physical logistics and digital deliveries, ensuring seamless operational workflows and enhanced customer satisfaction. With comprehensive details about the type and quantity of items fulfilled, it provides 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.

Authorizations
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
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_5678901234",
  "orderDetails": {
    "id": "ord_5823594809",
    "checkoutId": "5823594809",
    "createdTime": "2018-04-25T20:36:00Z",
    "customerId": "cus_5774321009",
    "currency": "usd",
    "email": "[email protected]",
    "locale": "en_US",
    "browserIp": "111.111.111.111",
    "applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
    "taxIdentifiers": [
      {
        "id": "5774321009",
        "createdTime": "2018-04-25T20:36:00Z",
        "customerId": "5774321009",
        "type": "de",
        "value": "DE123456789",
        "state": "pending",
        "stateTransitions": {
          "pending": "2018-04-25T20:36:00Z",
          "verified": "2018-04-25T20:36:00Z",
          "not_valid": "2018-04-25T20:36:00Z"
        },
        "verifiedName": ".",
        "verifiedAddress": ".",
        "updatedTime": "2018-04-25T20:36:00Z"
      }
    ],
    "invoiceAttributes": {
      "id": "1234",
      "type": "cn_business_general",
      "customerId": "5678",
      "atttributes": [
        {
          "invoiceTitle": "Invoice title",
          "regAccount": "87654",
          "regAddress": "123 Example st.",
          "regBank": "Bank",
          "regPhone": "8005551234"
        }
      ],
      "createdTime": "2018-04-25T20:36:00Z",
      "updatedTime": "2018-04-25T20:36:00Z",
      "liveMode": false
    },
    "shipFrom": {
      "address": {
        "line1": "10380 Bren Rd W",
        "line2": "text",
        "city": "Minnetonka",
        "postalCode": "55129",
        "state": "MN",
        "country": "US"
      },
      "additionalAddressInfo": {
        "neighborhood": "Centro",
        "division": "営業部",
        "phoneticName": "ヤマダ タロ"
      }
    },
    "shipTo": {
      "address": {
        "line1": "10380 Bren Rd W",
        "line2": "text",
        "city": "Minnetonka",
        "postalCode": "55129",
        "state": "MN",
        "country": "US"
      },
      "name": "John Smith",
      "phone": "952-111-1111",
      "email": "[email protected]",
      "organization": "Digital River",
      "additionalAddressInfo": {
        "neighborhood": "Centro",
        "division": "営業部",
        "phoneticName": "ヤマダ タロ"
      }
    },
    "billTo": {
      "address": {
        "line1": "10380 Bren Rd W",
        "line2": "text",
        "city": "Minnetonka",
        "postalCode": "55129",
        "state": "MN",
        "country": "US"
      },
      "name": "John Smith",
      "phone": "952-111-1111",
      "email": "[email protected]",
      "organization": "Digital River",
      "additionalAddressInfo": {
        "neighborhood": "Centro",
        "division": "営業部",
        "phoneticName": "ヤマダ タロ",
        "title": "M"
      }
    },
    "organization": {
      "id": "123456789"
    },
    "subtotal": 1094.5,
    "totalTax": 82.76,
    "totalImporterTax": 82.76,
    "importerOfRecordTax": true,
    "totalFees": 0,
    "totalDuty": 0,
    "totalDiscount": 0,
    "totalShipping": 5.76,
    "totalAmount": 1180.26,
    "discount": {
      "amountOff": 5.95,
      "percentOff": 100
    },
    "availableToRefundAmount": 18.58,
    "refundedAmount": 1,
    "cancelledAmount": 1,
    "capturedAmount": 1,
    "items": [
      {
        "id": "100067660336",
        "skuId": "sku_5823594809",
        "productDetails": {
          "id": "100067660336",
          "skuGroupId": "wireless-keyboards",
          "name": "Keyboard",
          "description": "Top rated keyboard",
          "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
          "url": "https://producturl.com",
          "countryOfOrigin": "US",
          "image": "https://imageurl.com",
          "weight": 20.5,
          "weightUnit": "oz",
          "partNumber": "SWG1224J10L",
          "partnerAccountId": "00g6atnynbl2wFsFG357"
        },
        "logisticsOptions": {
          "deliveryOptions": [
            "[\"direct_delivery_only\",\"additional_handling\"]"
          ],
          "dangerousGoods": [
            "nimh_battery"
          ]
        },
        "subscriptionInfo": {
          "freeTrial": true,
          "autoRenewal": true,
          "terms": "Please accept these terms.",
          "planId": "654321",
          "subscriptionId": "665430999",
          "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
          "startTime": "2020-05-21T00:00:00Z",
          "endTime": "2021-05-20T11:59:59Z"
        },
        "fees": {
          "details": [
            {
              "type": "battery",
              "amount": 3,
              "perUnitAmount": 1.5,
              "id": "asdkj1h239lkj123j9123"
            }
          ],
          "amount": 4.5,
          "taxAmount": 1.2
        },
        "quantity": 2,
        "state": "created",
        "stateTransitions": {
          "created": "2025-06-25T14:26:42.343Z",
          "fulfilled": "2025-06-25T14:26:42.343Z",
          "paid": "2025-06-25T14:26:42.343Z",
          "cancelled": "2025-06-25T14:26:42.343Z",
          "blocked": "2025-06-25T14:26:42.343Z",
          "returned": "2025-06-25T14:26:42.343Z"
        },
        "amount": 18.58,
        "availableToRefundAmount": 18.58,
        "sellerTaxIdentifier": "IE6426071C",
        "tax": {
          "rate": 0.0675,
          "amount": 89
        },
        "importerTax": {
          "amount": 12.34
        },
        "duties": {
          "amount": 12.34
        },
        "discount": {
          "amountOff": 5.95,
          "percentOff": 100,
          "quantity": 1
        },
        "shipFrom": {
          "address": {
            "line1": "10380 Bren Rd W",
            "line2": "text",
            "city": "Minnetonka",
            "postalCode": "55129",
            "state": "MN",
            "country": "US"
          },
          "additionalAddressInfo": {
            "neighborhood": "Centro",
            "division": "営業部",
            "phoneticName": "ヤマダ タロ"
          }
        },
        "shipping": {
          "amount": 5.99,
          "taxAmount": 1.99
        },
        "metadata": {
          "coupon": "iOS"
        }
      }
    ],
    "invoicePDFs": [
      {
        "id": "text",
        "url": "text"
      }
    ],
    "creditMemoPDFs": [
      {
        "id": "text",
        "url": "text"
      }
    ],
    "requestToBeForgotten": true,
    "shippingChoice": {
      "id": "100067660336",
      "amount": 5.95,
      "taxAmount": 0.1,
      "description": "USPS: Priority (1 day delivery)",
      "serviceLevel": "Standard Ground",
      "shippingTerms": "DDP"
    },
    "state": "created",
    "stateTransitions": {
      "accepted": "2025-06-25T14:26:42.343Z",
      "pending_payment": "2025-06-25T14:26:42.343Z",
      "in_review": "2025-06-25T14:26:42.343Z",
      "complete": "2025-06-25T14:26:42.343Z",
      "dispute": "2025-06-25T14:26:42.343Z",
      "cancelled": "2025-06-25T14:26:42.343Z",
      "fulfilled": "2025-06-25T14:26:42.343Z",
      "blocked": "2025-06-25T14:26:42.343Z",
      "returned": "2025-06-25T14:26:42.343Z"
    },
    "fraudState": "passed",
    "fraudStateTransitions": {
      "blocked": "2025-06-25T14:26:42.343Z",
      "review_opened": "2025-06-25T14:26:42.343Z",
      "passed": "2025-06-25T14:26:42.343Z"
    },
    "liveMode": true,
    "metadata": {
      "coupon": "iOS"
    },
    "sellingEntity": {
      "id": "C5_INC-ENTITY",
      "name": "DR globalTech Inc."
    },
    "purchaseLocation": {
      "country": "US",
      "state": "MN",
      "postalCode": "55364"
    },
    "customerType": "individual",
    "upstreamId": "0916805858",
    "updatedTime": "2018-04-25T20:37:00Z"
  },
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}

Updates an existing fulfillment

post

Updates an existing fulfillment.

Authorizations
Path parameters
idstringRequired

Fulfillment ID

Body
trackingCompanystringOptional

The name of the tracking company

Example: Fedex
trackingNumberstringOptional

A 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
metadataany ofOptional
or
or
Responses
200
200 OK
application/json
post
POST /fulfillments/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "items": [
    {
      "itemId": "98784590336",
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234"
    }
  ],
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "currency": "USD",
  "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.

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

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.

trackingNumberstringOptional

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

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

{
  "hasMore": true,
  "data": [
    {
      "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
      "createdTime": "2018-04-25T20:36:00Z",
      "orderId": "ord_5678901234",
      "shipmentId": "321765",
      "items": [
        {
          "itemId": "98784590336",
          "skuId": "98784590336",
          "shipmentItemId": "321765",
          "quantity": 1,
          "cancelQuantity": 1,
          "trackingCompany": "Fedex",
          "trackingNumber": "5678901234",
          "trackingUrl": "http://www.digitalriver.com?code=5678901234",
          "subfulfillerId": "hjueo9g",
          "distributorCost": 10,
          "shippingCost": 10
        }
      ],
      "currency": "USD",
      "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.

Authorizations
Body
orderIdstringRequired

The identifier of the Order associated with this Fulfillment.

Example: 5678901234
shipmentIdstringOptional

The unique identifier associated to the shipment

Example: 321765
currencystringOptional

A valid ISO 4217 code that represents the currency the distributor should be paid in. If items[].distributorCost or items[].shippingCost are specified, then currency is required. The value doesn't have to be the same as the Order's currency.

Example: USD
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
partnerIdstringOptional

The unique identifier of the partner associated with the sku.

Example: partner123
Responses
201
201 Created
application/json
post
POST /fulfillments HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "orderId": "5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "currency": "USD",
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234",
  "partnerId": "partner123"
}
{
  "id": "ful_25c651d0-8079-48d7-b22e-eb1e2f451966",
  "createdTime": "2018-04-25T20:36:00Z",
  "orderId": "ord_5678901234",
  "shipmentId": "321765",
  "items": [
    {
      "itemId": "98784590336",
      "skuId": "98784590336",
      "shipmentItemId": "321765",
      "quantity": 1,
      "cancelQuantity": 1,
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234",
      "subfulfillerId": "hjueo9g",
      "distributorCost": 10,
      "shippingCost": 10
    }
  ],
  "currency": "USD",
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "trackingCompany": "Fedex",
  "trackingNumber": "5678901234",
  "trackingUrl": "http://www.digitalriver.com?code=5678901234"
}
PreviousFile basicsNextFulfillment cancellations

Last updated