What it does. Registers a carrier tracking number on an externally-fulfilled shipment.
When to use. Call this once the logistics service provider has a tracking number for the parcel.
Version. Tracking V2 — recommended.
application/json
POST
/V2/external_fulfillment/shipment/track
cURL (application/json)
curl \
--request POST 'https://m2.winkelstraat.nl/rest/all/V2/external_fulfillment/shipment/track' \
--header "Content-Type: application/json" \
--data '{"track":{"increment_id":"100000123","track_number":"3SABCD1234567","carrier_code":"postnl","carrier_method":"standard","logistics_service_provider_code":"lsp_partner","shipment_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJI..."}}'
curl \
--request POST 'https://m2.winkelstraat.nl/rest/all/V2/external_fulfillment/shipment/track' \
--header "Content-Type: application/xml"
Request examples
{
"track": {
"increment_id": "100000123",
"track_number": "3SABCD1234567",
"carrier_code": "postnl",
"carrier_method": "standard",
"logistics_service_provider_code": "lsp_partner",
"shipment_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJI..."
}
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
<track>
<increment-id>100000123</increment-id>
<track-number>3SABCD1234567</track-number>
<carrier-code>postnl</carrier-code>
<carrier-method>standard</carrier-method>
<logistics-service-provider-code>lsp_partner</logistics-service-provider-code>
<shipment-token>eyJ0eXAiOiJKV1QiLCJhbGciOiJI...</shipment-token>
</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>