Fulfillment orders

When Digital River coordinates an order's physical fulfillment, the Fulfillment Orders API manages the process.

PreviousFulfillment cancellations NextFulfillment returns

Last updated 4 months ago

Returns a list of Fulfillment orders

Get all Fulfillment orders.

get

/fulfillment-orders

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

updatedTimeobject

A filter on the list based on the updatedTime 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 updatedTime field equals this timestamp
gt—return values where the updatedTime field is after this timestamp
gte—return values where the updatedTime field is after or equal to this timestamp
lt—return values where the updatedTime field is before this timestamp
lte—return values where the updatedTime field is before or equal to this timestamp

Example: updatedTime[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.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "data": [
    {
      "id": 9292981838,
      "currency": "USD",
      "locale": "en_US",
      "name": "John Smith",
      "email": "jsmith@digitalriver.com",
      "phone": "612-258-1966",
      "reservationId": "7765374748",
      "upstreamId": "7765374748",
      "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": "jsmith@digitalriver.com",
        "organization": "Digital River",
        "additionalAddressInfo": {
          "neighborhood": "Centro",
          "division": "???",
          "phoneticName": "??? ??"
        }
      },
      "shippingChoice": {
        "shippingInstructions": ".",
        "dutiesPaid": false,
        "id": "SG",
        "signatureRequiredType": "standard"
      },
      "liveMode": false,
      "state": "pending",
      "items": [
        [
          {
            "id": "449838789",
            "upstreamId": "123",
            "inventoryItemId": "abc",
            "name": ".",
            "quantity": 1
          }
        ]
      ],
      "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": []
          }
        }
      },
      "upstreamOrderTime": {
        "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 new Fulfillment order

Creates a new Fulfillment order.

post

/fulfillment-orders

Body

currencystringrequired

Athree-letter ISO currency code.

Example: USD

localestring

A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code.

Example: en_US

namestring

The customer's name.

Example: John Smith

emailstring · email

The customer's email address.

Example: jsmith@digitalriver.com

phonestring

The customer's phone number.

Example: 612-258-1966

reservationIdstring

An inventory reservation identifier.

Example: 7765374748

upstreamIdstring

The upstream order identifier.

Example: 7765374748

shipToShippingrequired

The ship to addresss of the customer.

shippingChoiceGlobalFulfillmentShippingChoicerequired

itemsLineItemRequest[]required

upstreamOrderTimestring · date-timerequired

The time at which the upstream order was created.

Example:

{"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":[]}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/fulfillment-orders' \
  --header 'Content-Type: application/json' \
  --data '{"currency":"USD","locale":"en_US","name":"John Smith","email":"jsmith@digitalriver.com","phone":"612-258-1966","reservationId":"7765374748","upstreamId":"7765374748","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":"jsmith@digitalriver.com","organization":"Digital River","additionalAddressInfo":{"neighborhood":"Centro","division":"???","phoneticName":"??? ??"}},"shippingChoice":{"shippingInstructions":".","dutiesPaid":false,"id":"SG","signatureRequiredType":"standard"},"items":[[{"upstreamId":"123","inventoryItemId":"abc","name":".","quantity":1}]],"upstreamOrderTime":{"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

400

401

403

405

406

408

409

429

500

502

503

504

{
  "id": 9292981838,
  "currency": "USD",
  "locale": "en_US",
  "name": "John Smith",
  "email": "jsmith@digitalriver.com",
  "phone": "612-258-1966",
  "reservationId": "7765374748",
  "upstreamId": "7765374748",
  "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": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "???",
      "phoneticName": "??? ??"
    }
  },
  "shippingChoice": {
    "shippingInstructions": ".",
    "dutiesPaid": false,
    "id": "SG",
    "signatureRequiredType": "standard"
  },
  "liveMode": false,
  "state": "pending",
  "items": [
    [
      {
        "id": "449838789",
        "upstreamId": "123",
        "inventoryItemId": "abc",
        "name": ".",
        "quantity": 1
      }
    ]
  ],
  "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": []
      }
    }
  },
  "upstreamOrderTime": {
    "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 order by ID

Retrieves the details of a Fulfillment order. You must supply the unique identifier of the Fulfillment order.

get

/fulfillment-orders/{id}

Path parameters

idstringrequired

Fulfillment order identifier.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

405

406

408

429

500

502

503

504

{
  "id": 9292981838,
  "currency": "USD",
  "locale": "en_US",
  "name": "John Smith",
  "email": "jsmith@digitalriver.com",
  "phone": "612-258-1966",
  "reservationId": "7765374748",
  "upstreamId": "7765374748",
  "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": "jsmith@digitalriver.com",
    "organization": "Digital River",
    "additionalAddressInfo": {
      "neighborhood": "Centro",
      "division": "???",
      "phoneticName": "??? ??"
    }
  },
  "shippingChoice": {
    "shippingInstructions": ".",
    "dutiesPaid": false,
    "id": "SG",
    "signatureRequiredType": "standard"
  },
  "liveMode": false,
  "state": "pending",
  "items": [
    [
      {
        "id": "449838789",
        "upstreamId": "123",
        "inventoryItemId": "abc",
        "name": ".",
        "quantity": 1
      }
    ]
  ],
  "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": []
      }
    }
  },
  "upstreamOrderTime": {
    "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.