Performs persist operations for a specified shipment track

POST /V1/shipment/track

Performs persist operations for a specified shipment track.

Body

entity object Required

Shipment track interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. Merchants and customers can track shipments.
Hide entity attributes Show entity attributes object
- order_id integer Required
  
  The order_id for the shipment package.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Shipment package ID.
- parent_id integer Required
  
  Parent ID.
- updated_at string
  
  Updated-at timestamp.
- weight number Required
  
  Weight.
- qty number Required
  
  Quantity.
- description string Required
  
  Description.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  label_filename string
  
  status string
  
  insured boolean
- track_number string Required
  
  Track number.
- title string Required
  
  Title.
- carrier_code string Required
  
  Carrier code.

Body

entity object Required

Shipment track interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. Merchants and customers can track shipments.
Hide entity attributes Show entity attributes object
- order_id integer Required
  
  The order_id for the shipment package.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Shipment package ID.
- parent_id integer Required
  
  Parent ID.
- updated_at string
  
  Updated-at timestamp.
- weight number Required
  
  Weight.
- qty number Required
  
  Quantity.
- description string Required
  
  Description.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  label_filename string
  
  status string
  
  insured boolean
- track_number string Required
  
  Track number.
- title string Required
  
  Title.
- carrier_code string Required
  
  Carrier code.

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- order_id integer Required
  
  The order_id for the shipment package.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Shipment package ID.
- parent_id integer Required
  
  Parent ID.
- updated_at string
  
  Updated-at timestamp.
- weight number Required
  
  Weight.
- qty number Required
  
  Quantity.
- description string Required
  
  Description.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  label_filename string
  
  status string
  
  insured boolean
- track_number string Required
  
  Track number.
- title string Required
  
  Title.
- carrier_code string Required
  
  Carrier code.
Hide response attributes Show response attributes object
- order_id integer Required
  
  The order_id for the shipment package.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Shipment package ID.
- parent_id integer Required
  
  Parent ID.
- updated_at string
  
  Updated-at timestamp.
- weight number Required
  
  Weight.
- qty number Required
  
  Quantity.
- description string Required
  
  Description.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  label_filename string
  
  status string
  
  insured boolean
- track_number string Required
  
  Track number.
- title string Required
  
  Title.
- carrier_code string Required
  
  Carrier code.
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
400

application/json

application/json application/xml

400 Bad Request
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/shipment/track

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/shipment/track' \
 --header "Content-Type: application/json" \
 --data '{"entity":{"order_id":42,"created_at":"string","entity_id":42,"parent_id":42,"updated_at":"string","weight":42.0,"qty":42.0,"description":"string","extension_attributes":{"label_filename":"string","status":"string","insured":true},"track_number":"string","title":"string","carrier_code":"string"}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/shipment/track' \
 --header "Content-Type: application/xml"

Request examples

{
  "entity": {
    "order_id": 42,
    "created_at": "string",
    "entity_id": 42,
    "parent_id": 42,
    "updated_at": "string",
    "weight": 42.0,
    "qty": 42.0,
    "description": "string",
    "extension_attributes": {
      "label_filename": "string",
      "status": "string",
      "insured": true
    },
    "track_number": "string",
    "title": "string",
    "carrier_code": "string"
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <entity>
    <order-id type="integer">42</order-id>
    <created-at>string</created-at>
    <entity-id type="integer">42</entity-id>
    <parent-id type="integer">42</parent-id>
    <updated-at>string</updated-at>
    <weight type="float">42.0</weight>
    <qty type="float">42.0</qty>
    <description>string</description>
    <extension-attributes>
      <label-filename>string</label-filename>
      <status>string</status>
      <insured type="boolean">true</insured>
    </extension-attributes>
    <track-number>string</track-number>
    <title>string</title>
    <carrier-code>string</carrier-code>
  </entity>
</root>

Response examples (200)

{
  "order_id": 42,
  "created_at": "string",
  "entity_id": 42,
  "parent_id": 42,
  "updated_at": "string",
  "weight": 42.0,
  "qty": 42.0,
  "description": "string",
  "extension_attributes": {
    "label_filename": "string",
    "status": "string",
    "insured": true
  },
  "track_number": "string",
  "title": "string",
  "carrier_code": "string"
}

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <order-id type="integer">42</order-id>
  <created-at>string</created-at>
  <entity-id type="integer">42</entity-id>
  <parent-id type="integer">42</parent-id>
  <updated-at>string</updated-at>
  <weight type="float">42.0</weight>
  <qty type="float">42.0</qty>
  <description>string</description>
  <extension-attributes>
    <label-filename>string</label-filename>
    <status>string</status>
    <insured type="boolean">true</insured>
  </extension-attributes>
  <track-number>string</track-number>
  <title>string</title>
  <carrier-code>string</carrier-code>
</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 (400)

{
  "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 (400)

<?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>