Webshipper API Documentation

This is the complete API documentation for connecting to the Webshipper API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Webshipper: Manage shipping, orders, rates, and returns in Webshipper. Keep reading to get started.

Quickstart

Before you run your first Webshipper request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Webshipper connection — create or choose one in Connections. Note its connectionId.

Every Webshipper action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/webshipper/latest/actions/{actionSlug}

You need a MindCloud API Key and a Webshipper connection. Then call an action such as Get Carrier:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/webshipper/latest/actions/get-carrier" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Webshipper account that should run the action. MindCloud stores and refreshes the Webshipper credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Webshipper actions

All 50 published actions for this Webshipper version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Order
• POSTCreate Report
• POSTCreate Return Cause
• POSTCreate Return Portal
• POSTCreate Return Shipping Method
• POSTCreate Shipment
• POSTCreate Shipping Rate
• DELETEDelete Shipping Rate
• GETGet Carrier
• GETGet Carrier Type
• GETGet Document
• GETGet Label
• GETGet Order
• GETGet Order Channel
• GETGet Report
• GETGet Return Cause
• GETGet Return Portal
• GETGet Return Shipping Method
• GETGet Shipment
• GETGet Shipping Rate
• GETList Carrier Types
• GETList Carriers
• GETList Documents
• GETList Labels
• GETList Order Channel Types
• GETList Order Channels
• GETList Order Documents
• GETList Order Print Jobs
• GETList Order Returns
• GETList Order Shipments
• GETList Orders
• GETList Printer Clients
• GETList Printer Jobs
• GETList Reports
• GETList Return Causes
• GETList Return Portals
• GETList Return Shipments
• GETList Return Shipping Methods
• GETList Shipment Activities
• GETList Shipment Events
• GETList Shipments
• GETList Shipping Rates
• POSTQuote Carrier Services
• POSTQuote Order Channel Rates
• PUTUpdate Order
• PUTUpdate Return Cause
• PUTUpdate Return Portal
• PUTUpdate Return Shipping Method
• PUTUpdate Shipment
• PUTUpdate Shipping Rate

Related apps

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareWooCommerceXeroThinkificWhopGumroad