# JUMiNGO API

> With the JUMiNGO shipping API you import your shipments into your JUMiNGO account from any source, fetch the shipping rates available for them, buy the shipping labels and retrieve tracking data, labels and documents for every shipment you purchased.

Every operation needs `Authorization: Bearer <personal access token>`; the legacy `X-AUTH-TOKEN` API key stops working on 1 July 2027. There is no sandbox: requests act on the live account, and `POST /v1/orders` charges it.

## Docs

- [Full documentation](https://developers.jumingo.com/llms-full.txt): introduction, every guide and every operation in one Markdown file
- [OpenAPI document](https://developers.jumingo.com/openapi.json): the complete 3.1.0 specification with schemas and examples
- [Postman collection](https://developers.jumingo.com/jumingo-api-v1.postman_collection.json) and [environment](https://developers.jumingo.com/jumingo-api-v1.postman_environment.json)

## Guides

- [Quickstart](https://developers.jumingo.com/#description/quickstart): Five calls take a shipment from your system to a printable label: create the shipment, fetch its rates, assign one, pay, download the documents.
- [Shipments](https://developers.jumingo.com/#description/shipments): A shipment is one consignment from one sender to one recipient with one or more packages.
- [Rates and pickup](https://developers.jumingo.com/#description/rates-and-pickup): A rate is one carrier product with a price, a transit time and constraints, valid for one concrete shipment.
- [Customs, insurance and export](https://developers.jumingo.com/#description/customs-insurance-and-export): International shipments are cleared by customs in the origin and the destination country, and that process is digital: the carrier receives the invoice data as structured fields, not as a scanned document.
- [Orders, payment and documents](https://developers.jumingo.com/#description/orders-payment-and-documents): An order is the payment for one or more shipments.
- [Tracking](https://developers.jumingo.com/#description/tracking): `GET /v1/shipments/{uuid}` carries the carrier tracking in `tracking` once the shipment has a tracking number (`null` before, and `null` again for a cancelled shipment).
- [Listing, filtering and pagination](https://developers.jumingo.com/#description/listing-filtering-and-pagination): `GET /v1/shipments` and `GET /v1/orders` return one page at a time: `page` selects the page (starting at 1) and `itemsPerPage` its size, 10 by default and 100 at most.
- [Tokens and scopes](https://developers.jumingo.com/#description/tokens-and-scopes): Every v1 request carries exactly one credential: a personal access token in `Authorization: Bearer <token>`, or, for existing integrations, the legacy API key in `X-AUTH-TOKEN`.
- [Errors, limits and troubleshooting](https://developers.jumingo.com/#description/errors-limits-and-troubleshooting): The status codes and the error format are described at the top of this reference.
- [Go-live checklist](https://developers.jumingo.com/#description/go-live-checklist): Work through this list before you let your integration buy labels on its own.

## Operations

- GET /v1/shipments: List shipments
- POST /v1/shipments: Create a shipment
- GET /v1/shipments/{uuid}: Get a shipment
- PUT /v1/shipments/{uuid}: Replace a shipment
- PATCH /v1/shipments/{uuid}: Update parts of a shipment
- DELETE /v1/shipments/{uuid}: Delete a shipment
- POST /v1/shipments/cheapest: Select the cheapest rate for shipments
- POST /v1/shipments/{uuid}/file/upload/{type}: Upload a customs document
- DELETE /v1/shipments/{uuid}/file/upload/{type}: Delete a customs document
- POST /v1/shipment-rates: Get the rates for a shipment
- POST /v1/cart/total: Get the cart total
- GET /v1/orders: List orders
- POST /v1/orders: Pay for shipments
- GET /v1/orders/{orderNumber}: Get an order
- GET /v1/orders/{orderNumber}/documents: Get the documents of an order
- GET /v1/orders/{orderNumber}/file/{type}/{name}: Download a document of an order
- GET /v1/connections: List connections
- POST /v1/connections: Create a connection
- GET /v1/connections/{uuid}: Get a connection
- POST /v1/carrier/access-points-search: Search carrier access points