ShipWise API Documentation

This is the complete API documentation for connecting to the ShipWise 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 ShipWise: ShipWise provides shipping, order, rate, label, tracking, packaging, carrier-service, and marketplace/channel API workflows for high-volume shipping operations. Keep reading to get started.

Quickstart

Before you run your first ShipWise 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 ShipWise connection — create or choose one in Connections. Note its connectionId.

Every ShipWise action uses the same URL pattern:

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

You need a MindCloud API Key and a ShipWise connection. Then call an action such as Validate Token V2:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/shipWise/latest/actions/validate-token-v2" \
  --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.

Authenticate with a MindCloud API Key plus a connectionId for your ShipWise account. See ShipWise API Authentication for the full flow and how to get your connection credentials.

ShipWise actions

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

• POSTAdd Carrier Service V2
• POSTAdd Location V2
• POSTAdd Marketplace Inbound Mapping V2
• POSTAdd Marketplace Inbound Return Mapping V2
• POSTAdd Marketplace Outbound Mapping V2
• PUTAdd Package To Order V2
• POSTAdd Packaging V2
• POSTAdd Profile Resolver V1
• POSTAdd Profile V2
• POSTAdd Service Group V2
• POSTAdd Tax Value Mapping V2
• POSTAdd Third Party Billing Mapping V2
• PUTAdjust Order Item Package Allocation V2
• GETCalculate Packaging Scenarios V2
• DELETECancel Batch V1
• GETCheck Packaging Automation V2
• GETCheck Shipment Duplicates V1
• PUTClose Batch V2
• PUTClose Carrier V1
• GETContinue Shipment Query V1
• POSTCreate Batch V1
• POSTCreate Carton V1
• PUTCreate Or Update Product V2
• POSTCreate Order V2
• POSTCreate Packaging Automation V2
• POSTCreate Profile Mapping V1
• POSTCreate Shipment Label V1
• DELETEDelete Location V2
• DELETEDelete Marketplace Inbound Mapping V2
• DELETEDelete Marketplace Inbound Return Mapping V2
• DELETEDelete Marketplace Outbound Mapping V2
• DELETEDelete Packaging V2
• DELETEDelete Profile V2
• DELETEDelete Service Group V2
• DELETEDelete Tax Value Mapping V2
• DELETEDelete Third Party Billing Mapping V2
• PUTEdit Carrier Service V2
• PUTEdit Global Settings V2
• PUTEdit Location V2
• PUTEdit Packaging V2
• PUTEdit Profile V2
• PUTEdit Service Group V2
• PUTEdit Tax Value Mapping V2
• PUTEdit Third Party Billing Mapping V2
• PUTEdit User V2
• POSTGenerate Internal Freight BOL V1
• GETGet Available Email Preferences V2
• GETGet Batch Summary V1
• GETGet Batch V1
• GETGet Best Email Preference IDs V2
• GETGet Channel Settings By Link V2
• GETGet Close V1
• GETGet Global Settings V2
• GETGet Order V2
• GETGet Packaging Solution V2
• GETGet Packing Slip V1
• GETGet Partner Logo V2
• GETGet Partner Theme V2
• GETGet Post Processing Label V1
• GETGet Product Chemical Record V2
• GETGet Product V2
• GETGet Shipment
• GETGet User V2
• GETGet WMS Configuration V2
• GETList Batches V1
• GETList Brokers V2
• GETList Carrier Account Info V2
• GETList Carrier Service Info V2
• GETList Carrier Services V2
• GETList Channel Mappings V2
• GETList Channel Settings V2
• GETList Channels
• GETList Channels V2
• GETList Close History V1
• GETList Existing Cartons V1
• GETList Freight Services V1
• GETList Locations V2
• GETList Marketplace Inbound Mappings V2
• GETList Marketplace Inbound Return Mappings V2
• GETList Marketplace Outbound Mappings V2
• GETList Marketplaces V2
• GETList Order Subscribed Filters V2
• GETList Orders V2
• GETList Packaging Catalog V2
• GETList Packaging V2
• GETList Products V2
• GETList Profile Advanced Markups V2
• GETList Profile Linked Carrier Accounts V2
• GETList Profile Linked Integrations V2
• GETList Profiles V1
• GETList Profiles V2
• GETList Rate Services V1
• GETList Ready Close Carriers V1
• GETList Regions V1
• GETList Service Groups V2
• GETList Shipments V1
• GETList Shipping Users V1
• GETList Special Service Info V2
• GETList Tax Value Mappings V2
• GETList Third Party Billing Mappings V2
• PUTMark Order Cancelled V2
• PUTMark Order Hold V2
• PUTMark Order New V2
• PUTMark Order Shipped V2
• PUTMark Package Printed V1
• PUTOverride Profile Advanced Markups V2
• PUTOverride Profile Linked Carrier Accounts V2
• PUTOverride Profile Linked Integrations V2
• POSTPrint Batch V1
• POSTPrint By Item V1
• POSTPrint Labels V1
• POSTPrint Labels V2
• GETQuery Profile Mapping V1
• GETQuery Shipments
• GETQuery Single Order V1
• POSTRate And Ship Order V1
• POSTRate And Ship V1
• POSTRate Batch V2
• GETRate Freight V1
• GETRate Order Package V1
• GETRate Shipment V1
• POSTReprint Close V1
• GETResolve Country Region V1
• GETSearch Carrier Hold Locations V1
• POSTShip Batch V2
• POSTShip Freight V1
• POSTSimple Ship V2
• GETTrack Shipment
• PUTUnvoid Shipment V1
• PUTUpdate External Product V2
• PUTUpsert Order Client Reference V2
• PUTUpsert Package Reference V2
• PUTUpsert Third Party Billing Account V2
• GETValidate Token V2
• GETVerify Address For Rate V1
• GETVerify Address For Rate V2
• GETVerify International Address For Rate V1
• DELETEVoid Batch V1
• DELETEVoid Shipment V1

Related apps

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

StripeShopifySquareXeroThinkificWhopGumroadEcwid