latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillment Orders

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

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.

Response

200 OK

Example response

{
  "data": [
    {
      "id": 9292981838,
      "createdTime": "2018-04-25T20:36:00Z",
      "currency": "USD",
      "locale": "en_US",
      "upstreamOrderTime": "2018-04-25T20:36:00Z",
      "name": "John Smith",
      "email": "jsmith@digitalriver.com",
      "phone": "612-258-1966",
      "reservationId": "7765374748",
      "upstreamId": "7765374748",
      "shipTo": {
        "address": {
          "line1": "10380 Bren Rd W",
          "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": ".",
        "id": "SG"
      },
      "items": [
        {
          "id": 449838789,
          "upstreamId": "123",
          "inventoryItemId": "abc",
          "shipping": 5,
          "subtotal": 10,
          "total": 10,
          "name": ".",
          "quantity": 1,
          "pending": 1,
          "giftMessage": ".",
          "tax": {
            "items": [
              {
                "authorityType": "City",
                "amount": 9.99
              }
            ],
            "amount": 9.99
          },
          "state": "pending",
          "metadata": {
            "coupon": "iOS"
          }
        }
      ],
      "state": "pending",
      "metadata": {
        "coupon": "iOS"
      }
    }
  ]
}