Add track

POST /V1/returns/{id}/tracking-numbers

Add track

Path parameters

id integer Required

Body

track object Required

Interface TrackInterface
Hide track attributes Show track attributes object
- entity_id integer Required
  
  Entity id
- rma_entity_id integer Required
  
  Rma entity id
- track_number string Required
  
  Track number
- carrier_title string Required
  
  Carrier title
- carrier_code string Required
  
  Carrier code
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  status string
  
  delivery_time string
  
  external_updated_at string
  
  label_filename string

Body

track object Required

Interface TrackInterface
Hide track attributes Show track attributes object
- entity_id integer Required
  
  Entity id
- rma_entity_id integer Required
  
  Rma entity id
- track_number string Required
  
  Track number
- carrier_title string Required
  
  Carrier title
- carrier_code string Required
  
  Carrier code
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  status string
  
  delivery_time string
  
  external_updated_at string
  
  label_filename string

Responses

200

application/json

application/json application/xml

200 Success.
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

POST /V1/returns/{id}/tracking-numbers

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/returns/{id}/tracking-numbers' \
 --header "Content-Type: application/json" \
 --data '{"track":{"entity_id":42,"rma_entity_id":42,"track_number":"string","carrier_title":"string","carrier_code":"string","extension_attributes":{"status":"string","delivery_time":"string","external_updated_at":"string","label_filename":"string"}}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/returns/{id}/tracking-numbers' \
 --header "Content-Type: application/xml"

Request examples

{
  "track": {
    "entity_id": 42,
    "rma_entity_id": 42,
    "track_number": "string",
    "carrier_title": "string",
    "carrier_code": "string",
    "extension_attributes": {
      "status": "string",
      "delivery_time": "string",
      "external_updated_at": "string",
      "label_filename": "string"
    }
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <track>
    <entity-id type="integer">42</entity-id>
    <rma-entity-id type="integer">42</rma-entity-id>
    <track-number>string</track-number>
    <carrier-title>string</carrier-title>
    <carrier-code>string</carrier-code>
    <extension-attributes>
      <status>string</status>
      <delivery-time>string</delivery-time>
      <external-updated-at>string</external-updated-at>
      <label-filename>string</label-filename>
    </extension-attributes>
  </track>
</root>

Response examples (200)

true

Response examples (200)

true

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>