API changes: ACTION REQUIRED. Click the following for more info.
Thousands of requests each hour are currently being received with misspelled query parameters or otherwise ill-formed URL syntax.
The REST API currently silently ignores the invalid query params, so the developer isn't aware their intent is not well formed.
Frequent Mistakes Description
/orders?pgsize=100 (or orderspgsiz, pg_siz, pgziz) It must be spelled pgsiz. Close only counts in horseshoes and hand grenades.
/orders?order?pgsiz=100&pgnum=12 The ill-formed second ? makes "order?pgsiz" a query parameter. Therefore, the intended page size of 100 is ignored.
/orders?customerid=5&facilityid=7 Neither customerid nor facilityid are defined parameters for /orders. Numerous other examples similar to this for other URIs are received every day.
Billboard
Rels on the Billboard

A client should access the billboard to obtain beginning resources. Each resource contains links to related resources.
This concept is called HATEOAS - Hypermedia As The Engine Of Application State.

Do not hardcode URIs because these links may change. Instead, start with the billboard. Use template substitution if needed, as per RFC6570.

Obtain additional links within each resource and use template substitution if needed.
Note: Operator rels are present only if the state change is valid for the given resource.

The beginning billboard URI is simply /billboard.

Rel Description
/rels/customers/... maintains resources related to customers and their item descriptions, may be limited to a subset based on credential
alertcontents
alerts
channels
customerbriefs skinny customers
customers
customersactivate activate/deactivate customers
customersummaries
errorlogs A log of errors for customer use
eventalerter create one or more alerts based upon changes
invoicebinder bind an invoice number to billed transactions
itembriefs skinny items
itemexchanges items update via exchange format
itemimports items add via import format
itemindex item index in the list of items
itemizedchargeslist a list of orders, receivers, adjustments and/or assemblies having charges
items
itemsactivate
itemsasync
itemscreate items add
itemsummaries
itemsummariesacrosscustomers
wteventraiser raise events for recent changes to orders, receivers, adjustments and/or assemblies
/rels/inventory/... inventory resources, including receivers, adjustments, assemblies, purchase orders, count schedules, and available inventory lists
adjustments
assemblies
c2ctransfers transfer of inventory to different customer
digestbriefs skinny receiver digests
export create an export file for a group of receivers
fileimport
fileimportasync
fileparse parse receiver import file
import create a group of receivers
importasync
inventory inventory for management purposes
inventoryasync
inventorybriefs skinny inventory
inventoryexpiring inventory expiring
inventoryheldreallocate hold/release inventory
inventoryhold hold/release inventory
inventoryitem an inventory increase
inventoryreduction an inventory decrease
mover move of inventory to a different location
multiexport create a group of export files for a receiver
pallets
purchaseorderindex PO index in the list of POs
purchaseorders
receiverdigests receiver partial info
receiverdigestsasync
receivers
receiversautocharges add automatic charges (AutoCalcHandling and scripted charges)
receiverscancel
receiversconfirm
receiversconfirmasync
receiversramark
receiversrasent
receiversummaries receiver short synopsis
receiversunconfirm
shaker change trackbys and saved elements on inventory
stockdetails item trackbys, availability, by receive item
stockinfosforris item information to support events for a list of receive items
stockinfosforwts item information to support events for a list of orders, receivers, adjustments and/or assemblies
stocksummaries item availability
stocksummariesfororder item availability for order
stocksummariesforris item availability for a list of receive items
stocksummariesforwts item availability for a list of orders, receivers, adjustments and/or assemblies
/rels/jobs/... inspects the headless horseman job queue
jobmethods
jobs
jobsstats the statistics of jobs
/rels/master/... Resources at supra-tenant scope: threepls, master logins, api provisioning; must use a token based upon Multi-Tenant credentials
apicredentials
apiroles
countries the list of countries with their states, to be referenced by country code in threepl records
handlerparameter a background process handler parameter
handlerparameters
jobtypequeues
logins
persons
smallparcelstatistics a set of statistics regarding small parcel for a given threepl. Tpl 0 lists all TPLs.
threepls
threeplstatistics a set of statistics for a given threepl
threeplsummaries the list of third party logisitics company summaries
/rels/orders/... maintains resources relevant to shipping inventory, including orders with line items, allocation, packages, picking and packing
batches
batchsummaries
batchsummaryindex item index in the list of batch summaries
bolsgenerate
digestbriefs skinny digests
digests order partial info
export create an export file for a group of orders
fileimport
fileimportasync
fileparse parse order import file
import create a group of orders
importasync
masterbolclear Clear MasterBillOfLading id for multiple orders
masterbolgenerate Generate BillOfLading id for each order without one, and a common MasterBillOfLading id for multiple orders
multiexport create a group of export files for an order
order order including routing, fulfillment invoicing, saved elements and order items (with allocations and saved elements)
orders
ordersallocate
ordersasnmark
ordersasnprecheck Prior to sending an ASN, list orders that fail the chosen customer ASN pre checks
ordersasnsent
ordersautocharges
ordersbybin open orders in a given bin
orderscancel
orderscomplete
ordersconfirm
ordersconfirmaftermath With respect to one or more newly orders, mark affected receive items as 'fully shipped' and insert appropriate move histories
ordersconfirmasync
ordersdeallocate
ordersparcelautorateshop parcel auto rate shop for orders
ordersparcelbatcherrors request a list of batch errors
ordersparcelbatches request a list of batches
ordersparcelbatchlabels request a completed batch, get its labels and update tracking, charges, labels, and int'l docs
ordersparcelcanceler
ordersparcelfinalizer
ordersparceloptions request parcel options
ordersparcelreturnlabel
ordersparcelshippinglabel
ordersparcelshippinglabelhighvolume async process for high volume shipping
ordersparceltmwexporter
orderspickticketdatesetter
ordersrouting
ordersshort
orderssplit
ordersunconfirm
packagehavenots packageless orders
packagesconsolidates
packagesgenerates
packageslabeltemplates request the label templates
packagesucc128label request the Ucc128 labels for multiple orders and all of their packages
pickcandidates order pick information for determining whether to start picking
pickjobs
summaries order short synopsis
/rels/properties/... maintains resources shared across services, such as facilities and their locations, units of measure, movable unit types, etc.
apicredentials
capacitytypes
carrieraccount the settings for a carrier account.
carrieraccountregistrar registers carrier account with external shipping partner
carrieraccountsmanifests carrier account manifests by facility
carriers
cellcarriers
countries list of countries with states (regions)
enum name/value pairs
enums
facilities
facilitiesactivate activate/inactivate a list of facilities
facilitysummaries
flushcache flush all caches
importproviders resource import providers, used for defining customer import channels
itemclassifications
itemcommodities
locationbillingtypes
locationindex location index in the list of locations
locations
locationsactivate activate/inactivate list of locations
locationsactivatebyfac activate/inactivate list of locations
locationsbyfac
locationsbyfacbriefs skinny locations
packagedefs
pallettypes
queryparametervalues
storagecountscripts storage recurring billing scripts for counting inventory
threepl threepl application settings
threeplsummary threepl without application settings
threeplsummarybyguid threepl without application settings
transformcustoms
transforms a group of transform objects, each of which transforms a file into internal models or transforms internal models to a file.
unitofmeasuretypes
xactionbillingscripttemplates
/rels/reportdefs/... maintains resources related to report definitions, including report generation and customization
ssrsdefs
ssrsnames base report names
ssrssummary base report and its customizations, no RDL
/rels/uiproperties/... maintains resources for the V2 user interface
clientmetadata custom storage of client-specific metadata, such as UI preferences, none of which controls internal business logic
clientmetadatas
customroles
customrolesummaries collection: custom role summaries
policies collection: all rights granted to a given user, derived from user's role(s)
rights collection: names of all UI features requiring authorization
systemrolesummaries collection: system role summaries
textoverrides
threepllogo ThreePL Logo
user a user
users
usersactivate activate/deactivate users
usersassignrole assign role to users

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact [email protected] with any questions about this documentation.