Returns V3

Get all the items filtered on return status

Changed on

The items will be sorted on status modified time in reverse chronological order. Additionally we provide cursor based pagination via next link. This endpoint is limited to at max 50 results per page

get/v3/returns

Request

  • Base URL
    https://api.otto.market
  • URL
    https://api.otto.market/v3/returns
  • Auth
    HTTP bearer

Query parameters

limitinteger

Page size to limit the number of items returned in the response. Maximum value for limit can 50

pageinteger

Page number to fetch. This parameter is required to fetch data for specific page number

status'MISDIRECTED' | 'ANNOUNCED' | 'ACCEPTED' | 'REJECTED'

Return status for which items are being queried for (case-insensitive)

Response

Ok

Example response

{
  "positionItems": [
    {
      "positionItemId": "7423afd2-e7ab-4bae-ac30-048b7c0346c1",
      "salesOrderId": "7423afd2-e7ab-4bae-ac30-048b7c0346c1",
      "status": "MISDIRECTED",
      "occurredTime": "2019-08-04T22:00:00.00Z",
      "details": {
        "condition": "A for originalverpackt / in original packaging; B for wie neu / in mint condition; C for leicht gebraucht / slightly used; D for stark gebraucht / heavily used; E for Irrtum (Ware unvollständig, nicht vorhanden, …) / mistake (Delivery incomplete, not available,...)",
        "reason": "RETURN_RECEIVED"
      }
    }
  ],
  "links": [
    {
      "href": "/v3/returns?status=Accepted",
      "rel": "next"
    }
  ]
}

Changes

    • breaking

      removed the media type application/json;charset=UTF-8 for the response with the status

    • breaking

      the response property //// became optional for the status

    • warning

      added the new CUSTOMER_CLARIFICATION enum value to the //// response property for the response status

    • warning

      added the new FAST_REFUND enum value to the //// response property for the response status

    • warning

      added the new LACK_OF_COOPERATION enum value to the //// response property for the response status

    • warning

      added the new OVERDUE_CREDIT enum value to the //// response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status