> For the complete documentation index, see [llms.txt](https://docs.parcellab.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parcellab.com/docs/developers/getting-started/api-reference.md).

# API Reference

Our API v4 Enhanced provides you with great flexibility and scope to retrieve and send data as you need.

## API List

This collection of calls features in the parcelLab API v4 Enhanced and is used by different services, including the App. The available endpoints are grouped corresponding to their usage.

### Common Read Requests

Use the base URL `https://api.parcellab.com`. The following table covers common read requests; the linked API pages contain the full parameters and response schemas.

| Need                                 | GET endpoint                                      | Details                                                                                                        |
| ------------------------------------ | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| List orders                          | `/v4/track/orders/`                               | [Order API](/docs/developers/orders/full-order-api-spec.md#retrieve-all-orders).                               |
| Read one order and its trackings     | `/v4/track/orders/{unique_id}/`                   | [Lookup by external ID or order number](/docs/developers/orders/full-order-api-spec.md#retrieve-orders-by-id). |
| Read shipment status and checkpoints | `/v4/track/orders/info/`                          | [Order Status](/docs/developers/status-updates/order-status.md).                                               |
| List return registrations            | `/v4/returns/return-registrations/`               | [Return Registrations](/docs/developers/returns/return-registrations.md).                                      |
| Read one return registration         | `/v4/returns/return-registrations/{external_id}/` | [Return Registration Details](/docs/developers/returns/return-registrations.md#get-a-return-registration).     |

See [Authentication](/docs/developers/getting-started/authentication.md#access-by-endpoint) for access requirements and [Supported Filters and Pagination](/docs/developers/orders/full-order-api-spec.md#supported-filters-and-pagination) for order-list queries.

### Orders

Use the following API pages to manage data for trackings and orders in the parcelLab system.

{% content-ref url="/pages/U7MQ07RqCyYjsccBgGn0" %}
[Create Orders/Trackings](/docs/developers/orders/create-orders-trackings.md)
{% endcontent-ref %}

{% content-ref url="/pages/-M3LegGGICm4sUIsClT1" %}
[Full Order API Spec](/docs/developers/orders/full-order-api-spec.md)
{% endcontent-ref %}

### Status Updates

Use the following API pages to send, update, and retrieve status updates of an order or tracking in the parcelLab system.

{% content-ref url="/pages/-MXqvJjywxA1uA0mbCIS" %}
[Order/Warehouse Events](/docs/developers/status-updates/send-shop-events.md)
{% endcontent-ref %}

{% content-ref url="/pages/DugFoG9SGRM7zZdaaWxH" %}
[Order Status](/docs/developers/status-updates/order-status.md)
{% endcontent-ref %}

### PUDO Locations

Use the following API page to find nearby pickup or drop-off (PUDO) locations.

{% content-ref url="/pages/9vY5pXbfCT9TxuGDdjDg" %}
[Pickup/Drop-Off Locations](/docs/developers/pudo-locations/pickup-drop-off-locations.md)
{% endcontent-ref %}

### Promise

Use the following API page to retrieve forecasted delivery dates to display pre-checkout in your web shop.

{% content-ref url="/pages/kcO2poMVo9LpuQkzpm1X" %}
[Promise Dates](/docs/developers/promise/api.md)
{% endcontent-ref %}

### Campaign Manager

Use the following API page to retrieve campaign data and track campaign event data.

{% content-ref url="/pages/Y9MCLrFC4QVNQeEXOnPQ" %}
[Campaigns](/docs/developers/campaign-manager/campaigns.md)
{% endcontent-ref %}

### Surveys

Use the following API page to retrieve survey information and submit survey responses.

{% content-ref url="/pages/B1sjH4FN7rxReX6JYch5" %}
[Surveys](/docs/developers/surveys/surveys.md)
{% endcontent-ref %}

### Returns

Use the following API pages to manage return configurations and return registrations.

{% content-ref url="/pages/REjE2gizAP9nT71lcOwq" %}
[Return Configurations](/docs/developers/returns/return-configurations.md)
{% endcontent-ref %}

{% content-ref url="/pages/458qEw6uFjwnXjaDVguh" %}
[Return Registrations](/docs/developers/returns/return-registrations.md)
{% endcontent-ref %}

### Size Recommender

Use the following API page to display AI-powered size recommendations on product detail pages.

{% content-ref url="/pages/d5d2pklaiCl6w1BMqT50" %}
[Size Recommender API](/docs/developers/size-recommender/size-recommender/api.md)
{% endcontent-ref %}

### Agents

Use the following API page to integrate your parcelLab agent into your application or chat interfaces.

{% content-ref url="/pages/OyzYYnYQHqKWKMjE3dJC" %}
[Agents](/docs/developers/agents/agents.md)
{% endcontent-ref %}

### Webhooks

Trackings created through the v4 order API can trigger the configured shipment webhooks. Webhook delivery is configured on the account and its Journeys; it is separate from the order ingestion request. The [shared tracking webhook reference](https://github.com/parcelLab/gitbook-documentation/tree/main/developers/data-elements/get-status-updates/webhooks.md) describes the standard events and payload.

To set up delivery:

1. Provide an HTTPS receiver URL and agree on receiver authentication with your parcelLab implementation contact.
2. Configure the webhook integration, message template, and [Journey trigger](https://github.com/parcelLab/gitbook-documentation/tree/main/how-parcellab-works/engage/messages-and-journeys/configuration/trigger-builder.md) for the required account and client.
3. Preview the payload, then send a test to your receiver and check its request body and HTTP response.
4. Publish the verified message and Journey configuration before enabling live delivery.

For return-registration exports and their separate event contracts, see [Receive Data](https://github.com/parcelLab/gitbook-documentation/tree/main/developers/returns/receive-data.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parcellab.com/docs/developers/getting-started/api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.