Shipwell API

Home
User Guide
API Reference

{{user.name}}Log In

The Shipwell Developer Hub

Welcome to the Shipwell developer hub. You'll find comprehensive guides and documentation to help you start working with Shipwell API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started API Reference

v10.28.2020
(v2)
v11.13.2020
(APIv2)
v12.11.2020stable
(APIv2)

HomeUser GuideRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Get Connected

Getting Started with Shipwell's Supply Chain APIs
Environments
Tools
- Postman
- cURL
Authentication
Versioning

API Concepts

RESTful API Concepts
Custom Data Fields
Pagination
Keys
Updates to the API

Shipments

What are shipments?
Create your first shipment
Parts of a shipment
Address book

Webhooks

What are Webhooks?
Use Webhooks

Events

Events
Types of events
Webhook payload library

Integrations

NetSuite

Data Model & References

Data Hierarchy and Connection Model

Release Notes

Q4, 2020
Q3, 2020
Q2, 2020
March 18, 2020

Get Connected

Getting Started with Shipwell's Supply Chain APIs
Environments
Tools
- Postman
- cURL
Authentication
Versioning

API Concepts

RESTful API Concepts
Custom Data Fields
Pagination
Keys
Updates to the API

Shipments

What are shipments?
Create your first shipment
Parts of a shipment
Address book

Webhooks

What are Webhooks?
Use Webhooks

Events

Events
Types of events
Webhook payload library

Integrations

NetSuite

Data Model & References

Data Hierarchy and Connection Model

Release Notes

Q4, 2020
Q3, 2020
Q2, 2020
March 18, 2020

Companies

public
shipper-relationship
- delete
  Delete a shipper relationship
carrier-tags
carrier-relationships
contracts
carriers
companies

Analytics

carrier-prioritization

Auth

users
permissions
- get
  Returns a dictionary of all permission categories and their underlying permissions.

Automation

driver-text-flow
- get
  Gets the current text message templates.
- put
  Updates text message templates to new values.
call-log

Data Pipeline

imports

Locations

locations

Dispatching

tenders

Integrations

integrations

Parcel

shipment-master-list
- get
  List all Fedex custom package types
reference-data
- get
  List all UPS custom package types
- get
  List all USPS custom package types
registration

Rating

contracts
- get
  List contracts
- get
  Retrieve a Contract
carrier-bids
shipment-master-list
- get
  List all Fedex custom package types
loadboard
private-market
quoting
spot-negotiations

Settlement

billing
invoicing
payments

Tracking

devices
- post
  Create a device registration
- delete
  Delete a device registration

Shipments

shipments
reference-data
shipment-actions

Carrier Compliance

carrier-relationships
- delete
  Delete RMIS carrier profile

Events and Webhooks

Events
Webhooks

Orders

purchase-orders

Products

products

Pricing

public

Carriers

carrier-tags
carrier-relationships
contracts
carriers

Orders

purchase-orders
put
Update an import value

Powered by

Q4, 2020

In this section, you'll find all Shipwell platform release notes from October 14, 2020, to present:

December 11, 2020
November 27, 2020
November 13, 2020
October 28, 2020
October 14, 2020

Updated 29 days ago

Q4, 2020

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.