# RT11 - List returns

Call Frequency

Recommended usage: Every 15 minutes
Maximum usage: Every 5 minutes
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:date_created (Default) - Sort by return date creation (asc by default)

Endpoint: GET /api/returns

## Query parameters:

  - `return_id` (array)
    Return id for filtering. This parameter can be supplied multiple times (return_id=58fd00d1-4ea4-453e-9a56-ec28c5c156ea&return_id=3071c162-dcd9-414b-a39d-ac3165f29453...).

  - `return_state` (array)
    Return state for filtering. This parameter can be supplied multiple times (return_state=WAITING_ACCEPTANCE&return_state=IN_PROGRESS...).

  - `return_creation_date_from` (string)
    Filter returns with a creation date after the given date.

  - `return_creation_date_to` (string)
    Filter returns with a creation date before the given date.

  - `return_last_updated_from` (string)
    Filter returns updated after the given date.

  - `return_last_updated_to` (string)
    Filter returns updated before the given date.

  - `order_commercial_id` (array)
    Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...).

  - `order_line_id` (array)
    Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).

  - `return_rma` (array)
    Return RMA for filtering. This parameter can be supplied multiple times (return_rma=RMA-1&return_rma=RMA-2...).

  - `customer_id` (array)
    Customer id for filtering. This parameter can be supplied multiple times (customer_id=id1&customer_id=id2...).

  - `shop_id` (integer)
    Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

## Response 200 fields (application/json):

  - `data` (array, required)
    Page of data

  - `data.date_created` (string, required)
    Return creation date

  - `data.description` (string)
    Description

  - `data.documents` (array)
    Return documents

  - `data.documents.id` (integer, required)
    Return document id

  - `data.documents.type` (string, required)
    Return document type

  - `data.id` (string, required)
    Return id

  - `data.label_url` (string)
    Label URL

  - `data.last_updated` (string, required)
    Return last updated date

  - `data.method_code` (string, required)
    Return method code

Enum: "RETURN_METHOD_BY_MAIL", "RETURN_METHOD_DROP_OFF_POINT", "RETURN_METHOD_HOME_PICKUP", "RETURN_METHOD_IN_STORE", "RETURN_METHOD_RETURNLESS"

  - `data.order_commercial_id` (string, required)
    Order commercial id

  - `data.order_id` (string, required)
    Order id

  - `data.reason_code` (string)
    Return reason code

Enum: "RETURN_BROKEN_ITEM", "RETURN_CHANGED_MIND", "RETURN_COUNTERFEIT_ITEM", "RETURN_DAMAGED_PACKAGING", "RETURN_DEFECTIVE_ITEM", "RETURN_DELIVERED_PRODUCT_DIFFERENT", "RETURN_MISSING_ITEM", "RETURN_OTHER", "RETURN_CM_DONT_WANT", "RETURN_CM_DONT_LIKE", "RETURN_CM_QUALITY", "RETURN_DPD_WRONG_SIZE", "RETURN_DPD_WRONG_COLOR", "RETURN_DEFECTIVE_ON_ARRIVAL", "RETURN_PRODUCT_DOES_NOT_FIT", "RETURN_PDNT_TOO_BIG", "RETURN_PDNT_TOO_SMALL", "RETURN_INACCURATE_ITEM_DESCRIPTION", "RETURN_WARRANTY"

  - `data.rejection_reason_code` (string)
    Return rejection reason code

Enum: "RETURN_REJECTION_NOT_ELIGIBLE", "RETURN_REJECTION_NOT_NEEDED", "RETURN_REJECTION_WINDOW_CLOSED"

  - `data.return_address` (object, required)
    The address where items must be returned

  - `data.return_address.city` (string, required)
    City

  - `data.return_address.country_iso_code` (string, required)
    Country ISO code

  - `data.return_address.state` (string)
    State

  - `data.return_address.street1` (string, required)
    First line of the return address

  - `data.return_address.street2` (string)
    Second line of the return address

  - `data.return_address.zip_code` (string, required)
    Zip code

  - `data.return_lines` (array, required)
    Return lines

  - `data.return_lines.compliance` (array)
    Compliance

  - `data.return_lines.compliance.compliant` (boolean, required)
    Compliant

  - `data.return_lines.compliance.non_compliance_additional_info` (string)
    Non compliance additional info

  - `data.return_lines.compliance.non_compliance_reason_code` (string)
    Non compliance reason code

  - `data.return_lines.order_line_id` (string, required)
    Order line id

  - `data.return_lines.quantity` (integer, required)
    Quantity

  - `data.return_lines.reason_code` (string, required)
    Return reason code for this line.

Enum: "RETURN_BROKEN_ITEM", "RETURN_CHANGED_MIND", "RETURN_COUNTERFEIT_ITEM", "RETURN_DAMAGED_PACKAGING", "RETURN_DEFECTIVE_ITEM", "RETURN_DELIVERED_PRODUCT_DIFFERENT", "RETURN_MISSING_ITEM", "RETURN_OTHER", "RETURN_CM_DONT_WANT", "RETURN_CM_DONT_LIKE", "RETURN_CM_QUALITY", "RETURN_DPD_WRONG_SIZE", "RETURN_DPD_WRONG_COLOR", "RETURN_DEFECTIVE_ON_ARRIVAL", "RETURN_PRODUCT_DOES_NOT_FIT", "RETURN_PDNT_TOO_BIG", "RETURN_PDNT_TOO_SMALL", "RETURN_INACCURATE_ITEM_DESCRIPTION", "RETURN_WARRANTY"

  - `data.rma` (string)
    Return RMA

  - `data.state` (string, required)
    Return state

Enum: "WAITING_ACCEPTANCE", "IN_PROGRESS", "REFUSED", "RECEIVED", "NO_RECEPTION", "CLOSED", "CANCELED"

  - `data.tracking` (object)
    Return tracking details

  - `data.tracking.carrier_code` (string)
    Carrier code

  - `data.tracking.carrier_name` (string)
    Carrier name

  - `data.tracking.carrier_standard_code` (string)
    Carrier standard code

  - `data.tracking.tracking_number` (string)
    Tracking number

  - `data.tracking.tracking_url` (string)
    Return tracking URL

  - `next_page_token` (string)
    Token to access the next page. Absent if the current page is the last one.

  - `previous_page_token` (string)
    Token to access the previous page. Absent if the current page is the first one.