Post v2 external fulfillment shipment track

POST /V2/external_fulfillment/shipment/track

Body

track object Required
Hide track attributes Show track attributes object
- increment_id string Required
- track_number string Required
- carrier_code string Required
- carrier_method string Required
- shipment_token string Required
- logistics_service_provider_code string Required

Body

track object Required
Hide track attributes Show track attributes object
- increment_id string Required
- track_number string Required
- carrier_code string Required
- carrier_method string Required
- shipment_token string Required
- logistics_service_provider_code string Required

Responses

500

application/json

application/json application/xml

Internal Server 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
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 /V2/external_fulfillment/shipment/track

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/external_fulfillment/shipment/track' \
 --header "Content-Type: application/json" \
 --data '{"track":{"increment_id":"string","track_number":"string","carrier_code":"string","carrier_method":"string","shipment_token":"string","logistics_service_provider_code":"string"}}'

curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/external_fulfillment/shipment/track' \
 --header "Content-Type: application/xml"

Request examples

{
  "track": {
    "increment_id": "string",
    "track_number": "string",
    "carrier_code": "string",
    "carrier_method": "string",
    "shipment_token": "string",
    "logistics_service_provider_code": "string"
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <track>
    <increment-id>string</increment-id>
    <track-number>string</track-number>
    <carrier-code>string</carrier-code>
    <carrier-method>string</carrier-method>
    <shipment-token>string</shipment-token>
    <logistics-service-provider-code>string</logistics-service-provider-code>
  </track>
</root>

Response examples (500)

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

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