Path parameters

• rmaIncrementId string Required

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  RMA entity

  • 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

    Hide items attributes Show items attributes object

    RMA item entity

    • 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

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • 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

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace