Process returned items by shipment increment id

POST /V3/winkelstraat/rma_api/rma/{incrementId}/track

Process returned items by shipment increment id, return items data. Requires a shipment token to authorize the request.

Path parameters

incrementId string Required

RMA increment id

Body

shipmentToken string Required

Shipment token (that has also been used to create the RMA). The shipment token is provided through the Shipment Push API.
track object Required
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

Body

shipmentToken string Required

Shipment token (that has also been used to create the RMA). The shipment token is provided through the Shipment Push API.
track object Required
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

Responses

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

POST /V3/winkelstraat/rma_api/rma/{incrementId}/track

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V3/winkelstraat/rma_api/rma/{incrementId}/track' \
 --header "Content-Type: application/json" \
 --data '{"shipmentToken":"string","track":{"tracking_number":"string","carrier":"string","method":"string","tracking_url":"string"}}'

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V3/winkelstraat/rma_api/rma/{incrementId}/track' \
 --header "Content-Type: application/xml"

Request examples

{
  "shipmentToken": "string",
  "track": {
    "tracking_number": "string",
    "carrier": "string",
    "method": "string",
    "tracking_url": "string"
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <shipmentToken>string</shipmentToken>
  <track>
    <tracking-number>string</tracking-number>
    <carrier>string</carrier>
    <method>string</method>
    <tracking-url>string</tracking-url>
  </track>
</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>