latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fulfillments

Returns a list of Fulfillments

Gets all the Fulfillments specified in the request.

get/fulfillments

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:

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

orderIdstring

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

skuIdstring

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

trackingCompanystring

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

trackingNumberstring

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

Response

200 OK

hasMoreboolean

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example response

{
  "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",
      "metadata": {
        "coupon": "iOS"
      },
      "trackingCompany": "Fedex",
      "trackingNumber": "5678901234",
      "trackingUrl": "http://www.digitalriver.com?code=5678901234"
    }
  ]
}