Jump to Content

Shipper Documentation Support

v0

Shipper Documentation Support

Guides

v0

Milestone Types

All

Pages

Start typing to search…

Getting Started

INTRODUCTION

AUTHENTICATION

Introduction
Generate Bearer Token

CARRIER RELATIONSHIP SERVICES

POST - Carrier Relationship
PUT - Update Carrier Relationship
GET - Carrier Relationship

Shipment Services

POST - Create Shipment
PUT - Shipment Update
GET - Shipment Details
GET - Shipment Details (New)
GET - Shipments by Trip ID
DELETE - Shipment

Order Services

GET - Orders

Position Event Services

POST - Position Event
GET - Shipment Positions

Temperature Services

POST - Current Temperature

Exception Services

POST - Exceptions
- Adding an Exception to an Order
- Adding a File to an Exception
PATCH - Update Exceptions
GET - Organization Exceptions
DELETE - Exception

Fixed Location Services

POST - Location
PUT - Update Location
GET - Fixed Location
PATCH - Update Fixed Location
DELETE - Fixed Location

Notification Services

POST - Notification
- [OPTIONAL] Filtering a Custom Notification
PUT - Update Notification
GET - Notification
DELETE - Notification

Organization Preferences

PATCH - Update Preferences
GET - Organization Preferences

Shipment Reopen Services

POST - Reopen Shipment
POST - Reopen Shipment (New)

StopStatus Services

PATCH - Stop Status

LTL and Parcel Milestones

POST - Add Shipment Milestone

Shipment Tracking Services

POST - Shipment Tracking
- Tracking a Shipment

Shipment Untrack Services

POST - Remove Shipment Tracking
- Untracking a Shipment

Shipment Document Services

POST - Document
- Uploading a Document
GET - Documents

Shipment Notes Services

POST - Shipment Notes
- Creating a Shipment Note

Driver Profiles

POST - Driver
PUT - Driver
GET - Drivers
GET - Driver

Webhooks

GET - Webhook Token
POST - Subscription
PUT - Subscription
GET - Subscriptions
DELETE - Subscription
Callback Overview

Object Collections

CustomNotification
CustomNotification Filters
FixedLocation
FixedLocationPoint
Orders
OrdersCommodity
PositionEvent
ShipmentDocument
ShipmentNote
StopStatus
ShipmentContent
ShipmentStop
ShipmentStopAppointment
Temperature
Organizational Preferences

Enumerations:Values

ContainerType
Default Sort Order sortOptionFieldType
DeliveryStatus
DocumentType
FilterDomains
FixedLocationType
FreightHaulerIdentifierType
HaulLinearUnitType
HazmatTypes
LinearUnits
Milestone Types
ModeType
Notification Filter Accepted Values
NotificationRecipientType
NotificationTypes
NotificationTypeLabel
PieceUnit
PositionEventType
ReferenceNumberType
ShipmentStatusType
ShipmentStopAppointmentType
ShipmentTrackingType
StopType
TemperatureDisplayUnit
VolumeUnit
Webhook Event Types
WeightUnit

Powered by

Milestone Types

Value	Name
pending	Pending
pickedUp	Picked Up
inTransit	In Transit
outForDelivery	Out For Delivery
delivered	Delivered

Updated 7 months ago