Get v1 user rma

GET /V1/user/rma

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- id string Required
- status string Required
- increment_id string Required
- order_id string Required
- order_date string Required
- date_requested string Required
- customer_custom_email string Required
- customer_firstname string Required
- customer_lastname string
- date_received string
- date_processed string
- is_received_email_sent boolean Required
- is_return_center boolean Required
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  is_qty_decimal boolean Required
  
  qty_requested string Required
  
  qty_authorized string
  
  qty_approved string Required
  
  status string Required
  
  order_item_id string Required
  
  product_name string Required
  
  product_sku string Required
  
  qty_returned string
  
  product_admin_name string Required
  
  product_admin_sku string Required
  
  product_options string
  
  product_color string
  
  product_size string
  
  product_merchant_code string
  
  product_merchant_name string
  
  product_manufacturer_code string
  
  product_manufacturer_name string
  
  exchange_size string
  
  reason string
  
  resolution string
  
  merchant_resolution string
  
  condition string
Hide response attributes Show response attributes object
- id string Required
- status string Required
- increment_id string Required
- order_id string Required
- order_date string Required
- date_requested string Required
- customer_custom_email string Required
- customer_firstname string Required
- customer_lastname string
- date_received string
- date_processed string
- is_received_email_sent boolean Required
- is_return_center boolean Required
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  is_qty_decimal boolean Required
  
  qty_requested string Required
  
  qty_authorized string
  
  qty_approved string Required
  
  status string Required
  
  order_item_id string Required
  
  product_name string Required
  
  product_sku string Required
  
  qty_returned string
  
  product_admin_name string Required
  
  product_admin_sku string Required
  
  product_options string
  
  product_color string
  
  product_size string
  
  product_merchant_code string
  
  product_merchant_name string
  
  product_manufacturer_code string
  
  product_manufacturer_name string
  
  exchange_size string
  
  reason string
  
  resolution string
  
  merchant_resolution string
  
  condition string
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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

GET /V1/user/rma

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/user/rma'

Response examples (200)

[
  {
    "id": "string",
    "status": "string",
    "increment_id": "string",
    "order_id": "string",
    "order_date": "string",
    "date_requested": "string",
    "customer_custom_email": "string",
    "customer_firstname": "string",
    "customer_lastname": "string",
    "date_received": "string",
    "date_processed": "string",
    "is_received_email_sent": true,
    "is_return_center": true,
    "items": [
      {
        "is_qty_decimal": true,
        "qty_requested": "string",
        "qty_authorized": "string",
        "qty_approved": "string",
        "status": "string",
        "order_item_id": "string",
        "product_name": "string",
        "product_sku": "string",
        "qty_returned": "string",
        "product_admin_name": "string",
        "product_admin_sku": "string",
        "product_options": "string",
        "product_color": "string",
        "product_size": "string",
        "product_merchant_code": "string",
        "product_merchant_name": "string",
        "product_manufacturer_code": "string",
        "product_manufacturer_name": "string",
        "exchange_size": "string",
        "reason": "string",
        "resolution": "string",
        "merchant_resolution": "string",
        "condition": "string"
      }
    ]
  }
]

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <id>string</id>
    <status>string</status>
    <increment-id>string</increment-id>
    <order-id>string</order-id>
    <order-date>string</order-date>
    <date-requested>string</date-requested>
    <customer-custom-email>string</customer-custom-email>
    <customer-firstname>string</customer-firstname>
    <customer-lastname>string</customer-lastname>
    <date-received>string</date-received>
    <date-processed>string</date-processed>
    <is-received-email-sent type="boolean">true</is-received-email-sent>
    <is-return-center type="boolean">true</is-return-center>
    <items type="array">
      <item>
        <is-qty-decimal type="boolean">true</is-qty-decimal>
        <qty-requested>string</qty-requested>
        <qty-authorized>string</qty-authorized>
        <qty-approved>string</qty-approved>
        <status>string</status>
        <order-item-id>string</order-item-id>
        <product-name>string</product-name>
        <product-sku>string</product-sku>
        <qty-returned>string</qty-returned>
        <product-admin-name>string</product-admin-name>
        <product-admin-sku>string</product-admin-sku>
        <product-options>string</product-options>
        <product-color>string</product-color>
        <product-size>string</product-size>
        <product-merchant-code>string</product-merchant-code>
        <product-merchant-name>string</product-merchant-name>
        <product-manufacturer-code>string</product-manufacturer-code>
        <product-manufacturer-name>string</product-manufacturer-name>
        <exchange-size>string</exchange-size>
        <reason>string</reason>
        <resolution>string</resolution>
        <merchant-resolution>string</merchant-resolution>
        <condition>string</condition>
      </item>
    </items>
  </root>
</root>

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 (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

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"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>