Dock Nxt

Get v1 winkelstraat dock nxt merchant code rma increment

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

Path parameters

  • merchantCode string Required
  • incrementId string Required

Responses

  • 200

    200 Success.

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

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

    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

    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/{incrementId} 
curl \
 --request GET 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/dock_nxt/{merchantCode}/rma/{incrementId}'
Response examples (200) 
{
  "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"
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <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>
</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>