# Trackings

### Requirements – API Key

For this section you will be requested for an [<mark style="color:purple;">API Key</mark>](#user-content-fn-1)[^1].

{% hint style="info" %}
Before you start using our REST API services, you will need to obtain your <mark style="color:purple;">API key</mark> with your SHIPTIFY sales representative. <mark style="color:purple;">Api-key</mark> is persistant and has no time limit.
{% endhint %}

### Workflow

<figure><img src="/files/TQbLuDUz8pC2p7q4y4ZS" alt=""><figcaption></figcaption></figure>

### Summary of available actions

<table><thead><tr><th width="194">TP Type</th><th width="210">Action</th><th width="278">Endpoint to use</th><th>#ID Required</th></tr></thead><tbody><tr><td>Necessary TP</td><td>Replan Pickup</td><td>/shipments/{id}/pickup/replan</td><td>#SH ID</td></tr><tr><td>Necessary TP</td><td>Confirm Pickup</td><td>/shipments/{id}/pickup/confirm</td><td>#SH ID</td></tr><tr><td>Necessary TP</td><td>Replan Delivery</td><td>/shipments/{id}/delivery/replan</td><td>#SH ID</td></tr><tr><td>Necessary TP</td><td>Confirm Delivery</td><td>/shipments/{id}/delivery/confirm</td><td>#SH ID</td></tr><tr><td>Complementary TP</td><td>Create New</td><td>/shipments/{id}/tracking-points</td><td>#SH ID</td></tr><tr><td>Complementary TP</td><td>Replan</td><td>/tracking-points/{id}/replan</td><td>#TP ID</td></tr><tr><td>Complementary TP</td><td>Confirm</td><td>/tracking-points/{id}/confirm</td><td>#TP ID</td></tr><tr><td>Complementary TP</td><td>Archive</td><td>/tracking-points/{id}/cancel</td><td>#TP ID</td></tr><tr><td>Complementary TP</td><td>Modify &#x26; Confirm</td><td>/tracking-points/{id}</td><td>#TP ID</td></tr><tr><td>Complementary TP</td><td>Modify Address</td><td>/tracking-points/{id}/location</td><td>#TP ID</td></tr></tbody></table>

### Endpoints to use

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/tracking-points" method="get" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/tracking-points" method="post" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/pickup/confirm" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/delivery/confirm" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/pickup/replan" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/shipments/{id}/delivery/replan" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}" method="get" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}" method="patch" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}/confirm" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}/replan" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}/cancel" method="put" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

{% openapi src="/files/RdvwQjMuuDxIpncDw9W4" path="/tracking-points/{id}/location" method="patch" %}
[shiptify-public-api.openapi.json](https://126269492-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FSUDs2RghltJWD9LPsGGQ%2Fuploads%2FRjiijD54qhlygdJLVPq7%2Fshiptify-public-api.openapi.json?alt=media\&token=b64eb81b-d262-4bf5-98d5-254e00aec99f)
{% endopenapi %}

[^1]: Please see [Integration section](/general-overview/introduction/integration.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shiptify.com/i-am-a-carrier/trackings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.