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

# Shipide API

Send shipment details directly from your software to Shipide. Keep your existing order and warehouse workflow, and use the API to exchange shipment records, labels, and events.

**Base URL:** `https://portal.shipide.com/api/v1`

**Version:** `v1` | **Format:** JSON | **Authentication:** Bearer API key

{% hint style="warning" %}
Live carrier booking is awaiting activation. Live keys currently accept order and shipment records only. Rates, labels, voids, and tracking are available in the sandbox; sandbox labels cannot be shipped and never incur charges. Check `GET /account` for current capabilities.
{% endhint %}

## The shipping flow

1. Your order system sends an order, or your warehouse creates a shipment directly.
2. Your warehouse supplies the packed parcel's weight and dimensions.
3. Request rates for the shipment, then create a label using a returned rate.
4. Download the PDF. Store Shipide's shipment ID and tracking number in your system.
5. Receive signed webhook events, or retrieve the shipment by ID.

Start with the [quickstart](/quickstart.md), create a key in the [Developer page](https://portal.shipide.com/developer.html), or browse the [API reference](/api-reference.md).

## Conventions

Weights are kilograms and dimensions are centimetres. Amounts use the stated currency, in major units: `5.00` means EUR 5.00. Addresses use two-letter country codes. Timestamps are ISO 8601 UTC. IDs are opaque strings; do not derive business information from them.

Every write requires `Idempotency-Key`. Keep it stable when retrying the same operation. Successful JSON responses use `data`; failures use `error` and include a `request_id` for support.


---

# 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 dynamically by asking a question.

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

```
GET https://docs.shipide.com/shipide-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.