Get v1 winkelstraat dock nxt merchant code rma

GET /V1/winkelstraat/dock_nxt/{merchantCode}/rma/

Path parameters

merchantCode string Required

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

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Items.
  
  RmaInterface provides methods to manage and manipulate data specific to Return Merchandise Authorization (RMA) processes.
  
  Hide items attributes Show items attributes object
  
  customer_name string Required
  
  The customer's name.
  
  items array[object] Required
  
  Items.
  
  Hide items attributes Show items attributes object
  
  sku string Required
  
  SKU
  
  name string Required
  
  Name
  
  reference string
  
  Reference
  
  article_number string
  
  Article number
  
  size string Required
  
  Size
  
  color string Required
  
  Color
  
  image_url string Required
  
  Image URL
  
  price number Required
  
  Price
  
  return_reason string Required
  
  The return reason
  
  resolution string Required
  
  The resolution
  
  retailer_resolution string
  
  The retailer resolution
  
  status string Required
  
  The status
  
  qty_requested integer
  
  The quantity requested
  
  qty_returned integer
  
  The quantity returned
  
  qty_approved integer
  
  The quantity approved
  
  rma_increment_id string Required
  
  The RMA increment ID.
  
  shipment_increment_id string Required
  
  The shipment increment ID.
  
  order_increment_id string Required
  
  The order increment ID.
  
  created_at string Required
  
  The shipment date.
  
  grand_total number Required
  
  The grand total amount.
  
  customer_address object
  
  Hide customer_address attributes Show customer_address attributes object
  
  name string Required
  
  Name
  
  street string Required
  
  Street
  
  housenumber string Required
  
  House number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City
  
  province string
  
  Province
  
  country string Required
  
  Country
  
  merchant_return_address object
  
  Hide merchant_return_address attributes Show merchant_return_address attributes object
  
  name string Required
  
  Name
  
  street string Required
  
  Street
  
  housenumber string Required
  
  House number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City
  
  province string
  
  Province
  
  country string Required
  
  Country
  
  purchase_origin string
  
  The purchase origin.
  
  po_number string
  
  The PO number.
  
  track object
  
  Hide track attributes Show track attributes object
  
  track_number string
  
  The track number.
  
  carrier_code string
  
  The carrier code.
  
  shipping_method string
  
  The shipping method.
  
  tracking_url string
  
  The tracking URL.
  
  received_at string
  
  The date the RMA was received.
  
  processed_at string
  
  The date the RMA was processed.
  
  status string Required
  
  The status of the RMA.
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  A list of filter groups.
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  A list of filters in this group
  
  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]
  
  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.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Items.
  
  RmaInterface provides methods to manage and manipulate data specific to Return Merchandise Authorization (RMA) processes.
  
  Hide items attributes Show items attributes object
  
  customer_name string Required
  
  The customer's name.
  
  items array[object] Required
  
  Items.
  
  Hide items attributes Show items attributes object
  
  sku string Required
  
  SKU
  
  name string Required
  
  Name
  
  reference string
  
  Reference
  
  article_number string
  
  Article number
  
  size string Required
  
  Size
  
  color string Required
  
  Color
  
  image_url string Required
  
  Image URL
  
  price number Required
  
  Price
  
  return_reason string Required
  
  The return reason
  
  resolution string Required
  
  The resolution
  
  retailer_resolution string
  
  The retailer resolution
  
  status string Required
  
  The status
  
  qty_requested integer
  
  The quantity requested
  
  qty_returned integer
  
  The quantity returned
  
  qty_approved integer
  
  The quantity approved
  
  rma_increment_id string Required
  
  The RMA increment ID.
  
  shipment_increment_id string Required
  
  The shipment increment ID.
  
  order_increment_id string Required
  
  The order increment ID.
  
  created_at string Required
  
  The shipment date.
  
  grand_total number Required
  
  The grand total amount.
  
  customer_address object
  
  Hide customer_address attributes Show customer_address attributes object
  
  name string Required
  
  Name
  
  street string Required
  
  Street
  
  housenumber string Required
  
  House number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City
  
  province string
  
  Province
  
  country string Required
  
  Country
  
  merchant_return_address object
  
  Hide merchant_return_address attributes Show merchant_return_address attributes object
  
  name string Required
  
  Name
  
  street string Required
  
  Street
  
  housenumber string Required
  
  House number
  
  postcode string Required
  
  Postcode
  
  city string Required
  
  City
  
  province string
  
  Province
  
  country string Required
  
  Country
  
  purchase_origin string
  
  The purchase origin.
  
  po_number string
  
  The PO number.
  
  track object
  
  Hide track attributes Show track attributes object
  
  track_number string
  
  The track number.
  
  carrier_code string
  
  The carrier code.
  
  shipping_method string
  
  The shipping method.
  
  tracking_url string
  
  The tracking URL.
  
  received_at string
  
  The date the RMA was received.
  
  processed_at string
  
  The date the RMA was processed.
  
  status string Required
  
  The status of the RMA.
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  A list of filter groups.
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  A list of filters in this group
  
  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]
  
  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

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

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
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  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 list
  
  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/winkelstraat/dock_nxt/{merchantCode}/rma/

curl \
 --request GET 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/dock_nxt/{merchantCode}/rma/'

Response examples (200)

{
  "items": [
    {
      "customer_name": "string",
      "items": [
        {
          "sku": "string",
          "name": "string",
          "reference": "string",
          "article_number": "string",
          "size": "string",
          "color": "string",
          "image_url": "string",
          "price": 42.0,
          "return_reason": "string",
          "resolution": "string",
          "retailer_resolution": "string",
          "status": "string",
          "qty_requested": 42,
          "qty_returned": 42,
          "qty_approved": 42
        }
      ],
      "rma_increment_id": "string",
      "shipment_increment_id": "string",
      "order_increment_id": "string",
      "created_at": "string",
      "grand_total": 42.0,
      "customer_address": {
        "name": "string",
        "street": "string",
        "housenumber": "string",
        "postcode": "string",
        "city": "string",
        "province": "string",
        "country": "string"
      },
      "merchant_return_address": {
        "name": "string",
        "street": "string",
        "housenumber": "string",
        "postcode": "string",
        "city": "string",
        "province": "string",
        "country": "string"
      },
      "purchase_origin": "string",
      "po_number": "string",
      "track": {
        "track_number": "string",
        "carrier_code": "string",
        "shipping_method": "string",
        "tracking_url": "string"
      },
      "received_at": "string",
      "processed_at": "string",
      "status": "string"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <customer-name>string</customer-name>
      <items type="array">
        <item>
          <sku>string</sku>
          <name>string</name>
          <reference>string</reference>
          <article-number>string</article-number>
          <size>string</size>
          <color>string</color>
          <image-url>string</image-url>
          <price type="float">42.0</price>
          <return-reason>string</return-reason>
          <resolution>string</resolution>
          <retailer-resolution>string</retailer-resolution>
          <status>string</status>
          <qty-requested type="integer">42</qty-requested>
          <qty-returned type="integer">42</qty-returned>
          <qty-approved type="integer">42</qty-approved>
        </item>
      </items>
      <rma-increment-id>string</rma-increment-id>
      <shipment-increment-id>string</shipment-increment-id>
      <order-increment-id>string</order-increment-id>
      <created-at>string</created-at>
      <grand-total type="float">42.0</grand-total>
      <customer-address>
        <name>string</name>
        <street>string</street>
        <housenumber>string</housenumber>
        <postcode>string</postcode>
        <city>string</city>
        <province>string</province>
        <country>string</country>
      </customer-address>
      <merchant-return-address>
        <name>string</name>
        <street>string</street>
        <housenumber>string</housenumber>
        <postcode>string</postcode>
        <city>string</city>
        <province>string</province>
        <country>string</country>
      </merchant-return-address>
      <purchase-origin>string</purchase-origin>
      <po-number>string</po-number>
      <track>
        <track-number>string</track-number>
        <carrier-code>string</carrier-code>
        <shipping-method>string</shipping-method>
        <tracking-url>string</tracking-url>
      </track>
      <received-at>string</received-at>
      <processed-at>string</processed-at>
      <status>string</status>
    </item>
  </items>
  <search-criteria>
    <filter-groups type="array">
      <filter-group>
        <filters type="array">
          <filter>
            <field>string</field>
            <value>string</value>
            <condition-type>string</condition-type>
          </filter>
        </filters>
      </filter-group>
    </filter-groups>
    <sort-orders type="array">
      <sort-order>
        <field>string</field>
        <direction>string</direction>
      </sort-order>
    </sort-orders>
    <page-size type="integer">42</page-size>
    <current-page type="integer">42</current-page>
  </search-criteria>
  <total-count type="integer">42</total-count>
</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>