---
title: "Returns a list of fulfillment returns"
method: GET
path: "/fulfillment-returns"
tags: ["Fulfillment Returns"]
---

# Returns a list of fulfillment returns

`GET /fulfillment-returns`

Get all returns.

## Query parameters

- `createdTime` object
- `endingBefore` string
- `startingAfter` string
- `limit` integer
- `ids` string[]
- `upstreamIds` string[]
- `state` string
- `fulfillmentOrderId` string
- `inventoryItemId` string

## Response `200`

200 OK

- object
  - `hasMore` boolean — Whether or not there are more elements available after this set. If false this set represents the end of the list.
  - `data` GlobalFulfillmentReturnResponse[]
    - `id` string — The unique identifier for the fulfillment return.
    - `createdTime` string, date-time — The time when the fulfillment return was created.
    - `fulfillmentOrderId` string — The unique identifier of the fulfillment order associated with the fulfillment return.
    - `upstreamId` string — The unique identifier of the upstream order.
    - `items` GlobalFulfillmentReturnItemResponse[]
      - `fulfillmentOrderItemId` string — The identifier of the fulfillment order item.
      - `inventoryItemId` string — The identifier of the inventory item.
      - `quantity` integer — The quantity specified in the fulfillment return request.
      - `quantityAccepted` integer — The quantity accepted for return by the fulfiller.
      - `state` 'pending' | 'accepted' | 'rejected' — The current state of the return item.
      - `location` Location — The address where the customer should return the products.
        - `address` GlobalFulfillmentAddress, required
          - `line1` string, nullable, required
          - `line2` string
          - `city` string, nullable, required
          - `postalCode` string, nullable, required
          - `state` string, nullable, required
          - `country` string, required
        - `name` string, nullable
        - `phone` string, nullable
        - `email` string, email, nullable
      - `unitAttributes` UnitAttributes[]
        - `serialNumber` string — .
        - `imeiNumber` string — .
        - `simCardNumber` string — .
      - `unitAttributesAccepted` UnitAttributes[]
        - `serialNumber` string — .
        - `imeiNumber` string — .
        - `simCardNumber` string — .
    - `reason` string — The reason for the return.
    - `state` 'created' | 'pending' | 'accepted' | 'rejected' — An enumeration indicating the state of the fulfillment return.
    - `type` 'client' | 'warehouse' — An enumeration indicating the type of the fulfillment return.
    - `location` Location — The address where the customer should return the products.
      - `address` GlobalFulfillmentAddress, required
        - `line1` string, nullable, required
        - `line2` string
        - `city` string, nullable, required
        - `postalCode` string, nullable, required
        - `state` string, nullable, required
        - `country` string, required
      - `name` string, nullable
      - `phone` string, nullable
      - `email` string, email, nullable
    - `livemode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden
- `405` — 405 Method Not Allowed
- `406` — 406 Not Acceptable
- `408` — 408 Request Timeout
- `429` — 429 Too Many Requests
- `500` — 500 Internal Server Error
- `502` — 502 Bad Gateway Error
- `503` — 503 Service Unavailable Error
- `504` — 504 Gateway Timeout Error

---

[API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)