Add tracking to a shipment

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://merchant-order-fulfilment.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Merchant Order fulfilment API MCP server": {
    "url": "https://merchant-order-fulfilment.doc.winkelstraat.nl/mcp"
  }
}

Close
POST /V2/external_fulfillment/shipment/track

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.

Body

  • track object Required
    Hide track attributes Show track attributes object
    • increment_id string Required

      Increment id of the shipment. This is the shipment webhook shipment_id; copy it exactly.

    • track_number string Required

      Carrier tracking number for the parcel, generated by the carrier when the label is created.

    • carrier_code string Required

      Carrier code. Copy the exact carrier_code from the matching shipment webhook available_delivery_methods[] entry; do not translate or normalize it. The listed values are the carriers this platform supports — which of them a given shipment allows depends on the merchant, so the webhook entry always wins over this list.

      Values are ups, upsap, dhlparcel, postnl, dhlexpress, or fedex.

    • carrier_method string Required

      Carrier method/service code, only meaningful together with carrier_code. Copy the exact carrier_method from the matching shipment webhook available_delivery_methods[] entry. Known values per carrier: ups07 (Express), 11 (Standard); upsap → the configured UPS Access Point method id (e.g. 1); dhlparceldoor, servicepoint; tolerated (tracking-only) carriers → *.

    • shipment_token string Required

      Shipment token authorizing the request. Delivered in the shipment webhook shipment_token; copy it exactly.

    • logistics_service_provider_code string Required

      Code of the logistics service provider fulfilling the shipment. This is the shipment webhook logistics_service_provider_code; copy it exactly. It must match the provider registered on the shipment, otherwise the request is rejected.

      Values are promese or merchant.

Body

  • track object Required
    Hide track attributes Show track attributes object
    • increment_id string Required

      Increment id of the shipment. This is the shipment webhook shipment_id; copy it exactly.

    • track_number string Required

      Carrier tracking number for the parcel, generated by the carrier when the label is created.

    • carrier_code string Required

      Carrier code. Copy the exact carrier_code from the matching shipment webhook available_delivery_methods[] entry; do not translate or normalize it. The listed values are the carriers this platform supports — which of them a given shipment allows depends on the merchant, so the webhook entry always wins over this list.

      Values are ups, upsap, dhlparcel, postnl, dhlexpress, or fedex.

    • carrier_method string Required

      Carrier method/service code, only meaningful together with carrier_code. Copy the exact carrier_method from the matching shipment webhook available_delivery_methods[] entry. Known values per carrier: ups07 (Express), 11 (Standard); upsap → the configured UPS Access Point method id (e.g. 1); dhlparceldoor, servicepoint; tolerated (tracking-only) carriers → *.

    • shipment_token string Required

      Shipment token authorizing the request. Delivered in the shipment webhook shipment_token; copy it exactly.

    • logistics_service_provider_code string Required

      Code of the logistics service provider fulfilling the shipment. This is the shipment webhook logistics_service_provider_code; copy it exactly. It must match the provider registered on the shipment, otherwise the request is rejected.

      Values are promese or merchant.

Responses

  • Internal Server 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

  • 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 /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": "000000284",
    "track_number": "1Z97W1439109104347",
    "carrier_code": "ups",
    "carrier_method": "11",
    "logistics_service_provider_code": "promese",
    "shipment_token": "0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ=="
  }
}'
curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/external_fulfillment/shipment/track' \
 --header "Content-Type: application/xml"
Request examples
{
  "track": {
    "increment_id": "000000284",
    "track_number": "1Z97W1439109104347",
    "carrier_code": "ups",
    "carrier_method": "11",
    "logistics_service_provider_code": "promese",
    "shipment_token": "0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ=="
  }
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <track>
    <increment-id>000000284</increment-id>
    <track-number>1Z97W1439109104347</track-number>
    <carrier-code>ups</carrier-code>
    <carrier-method>11</carrier-method>
    <logistics-service-provider-code>promese</logistics-service-provider-code>
    <shipment-token>0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ==</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>