# Starshipit API reference guide
URL: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide
Canonical: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide
Markdown: https://support.starshipit.com/articles/14700000001009-starshipit-api-reference-guide.md
Updated: 2026-10-08

> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).

> Use the Starshipit API reference to find endpoint groups, request methods, models, and the workflow guide each group supports.

Use the Starshipit API reference when you need exact endpoint paths, request parameters, request bodies, response models, and example responses. Start with the workflow guide first, then use the [Starshipit API reference](/developers/api-reference/starshipit) to confirm the technical details.

## Endpoint groups

The current Starshipit API reference is organised into these groups:

| Group | What it supports |
| --- | --- |
| Orders | Create, update, search, list, archive, restore, merge, and assign orders. |
| Shipments | Create labels, print packing slips, create commercial invoices, clone shipments, and replace shipments. |
| Tracking | Retrieve tracking details and delivery updates. |
| Tracking-only orders | Register externally generated tracking numbers with Starshipit. |
| Rates | Retrieve courier rates from your Starshipit courier configuration. |
| Address book | Manage address book records used in Starshipit. |
| Manifests | Manifest shipments and retrieve manifest information. |
| Pickup | List booked pickups and book a carrier pickup. |
| Order Documents | Upload, list, preview, download, replace, and delete documents attached to an order. |
| Products | Sync Product Catalogue data such as SKU, dimensions, weight, and customs fields. |
| Tags | List user-defined tags and add or remove tags on an order. |
| Models | Shared request and response shapes used by endpoint groups. |

## Find order tags and archived orders

Use the following references when you need to register a tag on an order or look up a known archived order.

| Goal | Endpoint reference | What to expect |
| --- | --- | --- |
| List existing tags | [Get Tags](/developers/api-reference/starshipit/tags/get-tags) — `GET /api/tags` | Returns a paged list of the account's tags. |
| Add or register order tags | [Add Order Tags](/developers/api-reference/starshipit/tags/add-order-tags) — `POST /api/tags/order` | Send the Starshipit `order_id` and tag names in the JSON body. A missing tag name is created before it is added to the order. |
| Remove tags from an order | [Delete Order Tags](/developers/api-reference/starshipit/tags/delete-order-tags) — `DELETE /api/tags/order` | Send the Starshipit `order_id` and tag names in the JSON body. |
| Find a known archived order | [Search Orders](/developers/api-reference/starshipit/orders/search-orders) — `GET /api/orders/search` | Supply a known phrase with `status=All` and `fields=All`. The result's `archived` flag identifies an archived order. |
| Archive an order | [Archive Order](/developers/api-reference/starshipit/orders/archive-order) — `POST /api/orders/archive` | Archives by the Starshipit `order_id`. Follow the reference's query-string request format. |
| Restore an archived order | [Restore Order](/developers/api-reference/starshipit/orders/restore-order) — `POST /api/orders/restore` | Restores by the Starshipit `order_id`. Follow the reference's query-string request format. |

For example, use `GET https://api.starshipit.com/api/orders/search?phrase=EXAMPLE-ORDER&status=All&fields=All` to search by a known order number. Replace `EXAMPLE-ORDER` with the order number you want to find, then check the returned `order_id`, `order_number` and `archived` value.

This endpoint searches order numbers, tracking numbers, references or receiver names. It does not provide an archived-only list or a tag-based search of archived orders. Use the Tags endpoints to manage tags separately.

## Use reference pages with guides

| If you are building | Start with |
| --- | --- |
| Import orders, print in Starshipit, and update source system | [Import orders, print in Starshipit, and update the source system](/articles/developer-center/starshipit-api/import-orders-into-starshipit) |
| Import or update orders, then print outside Starshipit | [Print outside Starshipit and return tracking](/articles/developer-center/starshipit-api/print-outside-starshipit-and-return-tracking) |
| Checkout or live rates | [Get checkout and live rates](/articles/developer-center/starshipit-api/get-live-rates-at-checkout) |
| Print labels for orders imported by Starshipit | [Print labels for orders Starshipit imported](/articles/developer-center/starshipit-api/print-labels-for-orders-starshipit-imported) |
| Update orders before printing | [Update orders before printing](/articles/developer-center/starshipit-api/update-orders-before-printing) |
| Product sync | [Sync product data with Product Catalogue](/articles/developer-center/starshipit-api/sync-product-data-with-product-catalogue) |
| Tracking writeback | [Use webhooks and tracking updates](/articles/developer-center/starshipit-api/use-webhooks-and-tracking-updates) |
| Request failures | [Troubleshoot API integrations](/articles/developer-center/getting-started/troubleshooting-api-integrations) |

## What the reference is for

The [Starshipit API reference](/developers/api-reference/starshipit) helps you confirm exact endpoint paths, request fields, response examples, and shared models after you have chosen the workflow you want to build.

The reference is a customer-facing API reference, not a complete inventory of every controller route in the codebase. Internal, partner-specific, or unreleased routes should only be added after the endpoint contract is confirmed for public developer use.