Get a specific return

GET /V1/stock-hub/rma/{rmaIncrementId}

Get a specific return

Path parameters

  • rmaIncrementId string Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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

  • 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

GET /V1/stock-hub/rma/{rmaIncrementId}
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stock-hub/rma/{rmaIncrementId}'
Response examples (200)
{
  "increment_id": "string",
  "order_increment_id": "string",
  "date_requested": "string",
  "items": [
    {
      "id": 42,
      "sku": "string",
      "resolution": "string",
      "reason": "string",
      "qty_requested": 42,
      "qty_approved": 42,
      "qty_returned": 42,
      "manufacturer": "string",
      "color": "string",
      "size": "string",
      "mpn": "string",
      "merchant_product_reference": "string",
      "merchant_resolution": "string",
      "parent_sku": "string",
      "item_return_fee": 42.0,
      "row_line_return_fee": 42.0
    }
  ],
  "status": "string",
  "track": {
    "tracking_number": "string",
    "carrier": "string",
    "method": "string",
    "tracking_url": "string"
  },
  "date_received": "string",
  "date_processed": "string",
  "currency": "string"
}
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}