# Webshipper API Documentation

This is the complete API documentation for connecting to the Webshipper API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Webshipper connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/webshipper/actions/{actionSlug}/run
```

## Webshipper actions

- POST `create-order` Create Order
- POST `create-report` Create Report
- POST `create-return-cause` Create Return Cause
- POST `create-return-portal` Create Return Portal
- POST `create-return-shipping-method` Create Return Shipping Method
- POST `create-shipment` Create Shipment
- POST `create-shipping-rate` Create Shipping Rate
- DELETE `delete-shipping-rate` Delete Shipping Rate
- GET `get-carrier` Get Carrier
- GET `get-carrier-type` Get Carrier Type
- GET `get-document` Get Document
- GET `get-label` Get Label
- GET `get-order` Get Order
- GET `get-order-channel` Get Order Channel
- GET `get-report` Get Report
- GET `get-return-cause` Get Return Cause
- GET `get-return-portal` Get Return Portal
- GET `get-return-shipping-method` Get Return Shipping Method
- GET `get-shipment` Get Shipment
- GET `get-shipping-rate` Get Shipping Rate
- GET `list-carrier-types` List Carrier Types
- GET `list-carriers` List Carriers
- GET `list-documents` List Documents
- GET `list-labels` List Labels
- GET `list-order-channel-types` List Order Channel Types
- GET `list-order-channels` List Order Channels
- GET `list-order-documents` List Order Documents
- GET `list-order-print-jobs` List Order Print Jobs
- GET `list-order-returns` List Order Returns
- GET `list-order-shipments` List Order Shipments
- GET `list-orders` List Orders
- GET `list-printer-clients` List Printer Clients
- GET `list-printer-jobs` List Printer Jobs
- GET `list-reports` List Reports
- GET `list-return-causes` List Return Causes
- GET `list-return-portals` List Return Portals
- GET `list-return-shipments` List Return Shipments
- GET `list-return-shipping-methods` List Return Shipping Methods
- GET `list-shipment-activities` List Shipment Activities
- GET `list-shipment-events` List Shipment Events
- GET `list-shipments` List Shipments
- GET `list-shipping-rates` List Shipping Rates
- POST `quote-carrier-services` Quote Carrier Services
- POST `quote-order-channel-rates` Quote Order Channel Rates
- PUT `update-order` Update Order
- PUT `update-return-cause` Update Return Cause
- PUT `update-return-portal` Update Return Portal
- PUT `update-return-shipping-method` Update Return Shipping Method
- PUT `update-shipment` Update Shipment
- PUT `update-shipping-rate` Update Shipping Rate