Query parameters

• searchCriteria[filterGroups][0][filters][0][field] string

  Field

• searchCriteria[filterGroups][0][filters][0][value] string

  Value

• searchCriteria[filterGroups][0][filters][0][conditionType] string

  Condition type

• searchCriteria[sortOrders][0][field] string

  Sorting field.

• searchCriteria[sortOrders][0][direction] string

  Sorting direction.

• searchCriteria[pageSize] integer

  Page size.

• searchCriteria[currentPage] integer

  Current page.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • items array[object] Required

    RMA entity

    RMA entity

    Hide items attributes Show items attributes object

    • increment_id string Required

      RMA increment id

    • order_increment_id string Required

      Order_increment_id

    • date_requested string Required

      Date_requested

    • items array[object] Required

      RMA item entity

      RMA item entity

      Hide items attributes Show items attributes object

      • id integer Required

        Id of RMA item

      • sku string Required
      • resolution string Required

        Resolution desired by customer

      • reason string

        Reason of return

      • qty_requested integer Required

        Number of items requested to be return

      • qty_approved integer

        Number of items approved by merchant. When the value is absent or null the merchant has not yet approved any items.

      • qty_returned integer

        Number of items returned to merchant. When the value is absent or null the merchant has not received any items.

      • manufacturer string

        Manufacturer

      • color string

        Color

      • size string

        Size

      • mpn string

        Manufacturer product number

      • merchant_product_reference string

        Merchant product number.

      • merchant_resolution string

        Merchant resolution.

      • parent_sku string

        Parent SKU

      • item_return_fee number Required

        Return fee for single item.

      • row_line_return_fee number Required

        Return fee for row line (number of requested items * return item fee)

    • status string Required

      Status

    • track object
      Hide track attributes Show track attributes object

      • tracking_number string Required

        Tracking number

      • carrier string Required

        Carrier code

      • method string

        Carrier method

      • tracking_url string

        Tracking URL

    • date_received string

      Datetime received by merchant. When value is null or absent the RMA has not been received by the merchant.

    • date_processed string

      Datetime processed by merchant. When value is null or absent the RMA has not been processed by the merchant.

    • currency string Required

      Currency code

  • search_criteria object Required

    Search criteria interface.

    Hide search_criteria attributes Show search_criteria attributes object

    • filter_groups array[object] Required

      Groups two or more filters together using a logical OR

      Groups two or more filters together using a logical OR

      Hide filter_groups attribute Show filter_groups attribute object

      • filters array[object]

        Filter which can be used by any methods from service layer.

        Filter which can be used by any methods from service layer.

        Hide filters attributes Show filters attributes object

        • field string Required

          Field

        • value string Required

          Value

        • condition_type string

          Condition type

    • sort_orders array[object]

      Data object for sort order.

      Data object for sort order.

      Hide sort_orders attributes Show sort_orders attributes object

      • field string Required

        Sorting field.

      • direction string Required

        Sorting direction.

    • page_size integer

      Page size.

    • current_page integer

      Current page.

  • total_count integer Required

    Total count.

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace