# Shipmondo

> Shipmondo is a shipping platform for booking freight, printing labels, and managing
> orders across carriers. The Shipmondo API v3 is a REST API for integrating shipping
> into webshops, ERP, and WMS systems. This site is the developer documentation;
> help.shipmondo.com covers the end-user product.

- Base URL: https://app.shipmondo.com/api/public/v3
- Auth: HTTP Basic, using an API user and key generated in the Shipmondo app.
- A free sandbox account is available for testing.

## Machine-readable specification
- [OpenAPI 3.0 specification](https://app.shipmondo.com/api/public/v3/openapi.json): Complete definition of all 72 endpoints with schemas, parameters and responses. Prefer this over the HTML API reference, which is rendered client-side.

## Getting started
- [Getting Started](https://shipmondo.dev/docs/getting-started): Creating an account and generating API credentials.
- [Intro](https://shipmondo.dev/docs/api/intro): Orientation to the REST API v3.
- [Sandbox](https://shipmondo.dev/docs/sandbox): Free test environment for validating an integration.
- [Getting help](https://shipmondo.dev/docs/getting_help): Support channels for API questions.

## Working with the API
- [Authentication](https://shipmondo.dev/docs/api/auth): How to authenticate requests.
- [Rate limit](https://shipmondo.dev/docs/api/rate-limit): Request limits and throttling behaviour.
- [Creating Shipments](https://shipmondo.dev/docs/api/create-shipment): Product selection, booking, and label printing.
- [Creating Sales Orders](https://shipmondo.dev/docs/api/sales-orders): Working with the sales order resource.
- [Service points](https://shipmondo.dev/docs/api/service-points): Looking up carrier pickup points.
- [Customs](https://shipmondo.dev/docs/api/customs): Customs declarations and goods lines for cross-border shipments.
- [Parties](https://shipmondo.dev/docs/api/parties): The parties model for senders, receivers and other addresses.
- [Migrating to parties](https://shipmondo.dev/docs/api/parties-migration): Upgrading an existing integration to the parties model.
- [Label overlay](https://shipmondo.dev/docs/api/label-overlay): Adding custom content to carrier labels.
- [Retrieve and use the carrier setup file](https://shipmondo.dev/docs/api/retrieve-and-use-the-carrier-setup-file): Discovering available carriers, products and add-ons.

## Carrier-specific options
- [Advanced Parcels](https://shipmondo.dev/docs/api/carrier-specific/advanced-parcels)
- [Dangerous Goods / Limited Quantity](https://shipmondo.dev/docs/api/carrier-specific/dangerous-goods-and-limited-quantity)
- [Bulk waybill / Routing Label](https://shipmondo.dev/docs/api/carrier-specific/waybill)
- [Pickup](https://shipmondo.dev/docs/api/carrier-specific/pickup)
- [Document Upload](https://shipmondo.dev/docs/api/carrier-specific/document_upload)
- [Bring - Cash on Delivery](https://shipmondo.dev/docs/api/carrier-specific/bring-cod)
- [GLS - Click&Collect](https://shipmondo.dev/docs/api/carrier-specific/gls-click-and-collect)
- [UPS - Declared Value](https://shipmondo.dev/docs/api/carrier-specific/declared-value-ups)

## Webhooks
- [Intro](https://shipmondo.dev/docs/webhooks/intro): What webhooks are used for.
- [Requirements and structure](https://shipmondo.dev/docs/webhooks/requirements-and-structure): Endpoint requirements and payload format.
- [Resources and actions](https://shipmondo.dev/docs/webhooks/resources-and-actions): Which resources emit which events.

## Delivery checkout (shipping module)
- [Introduction](https://shipmondo.dev/docs/shipping_module/intro): Embedding pickup point selection in a custom checkout.
- [Authentication](https://shipmondo.dev/docs/shipping_module/authentication): Authenticating the shipping module.
- [Listing service points](https://shipmondo.dev/docs/shipping_module/listing_service_points): Querying nearby pickup points.

## Printing
- [Print Client](https://shipmondo.dev/docs/print-client): Local client for sending labels to a printer.

## Optional
- [Changelog](https://shipmondo.dev/changelog): API updates, new endpoints and deprecation notices.
- [Interactive API Reference](https://shipmondo.dev/api-reference): Browser viewer for the spec above. Client-rendered, so not useful to fetch directly.