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.
The customer/customeralertdefinitions rel has been replaced by the following rels:
Rel Description
customers/emailalertdef and customers/emailalertdefs To setup notitications via email for a customer (c2).
properties/emailtemplate To modify email templates at the threepl (c1) level.
customers/emailtemplate To create/modify email templates at the customer (c2) level
customers/ftpalertdef and customers/ftpalertdefs To setup notitications via ftp for a customer (c2)
Resources at supra-tenant scope: threepls, master logins, api provisioning; must use a token based upon Multi-Tenant credentials
Rel (/rels/master/ + ) On Billboard Description
apicredential an api credential, either specific to one tpl or not
apicredentials yes Collection: of apicredential
apirole an api role together with the set of policies defining the access rights of an ApiCredential assigned such role
apiroles yes Collection: of apirole
attacheddoc yes a document attached to a warehouse transaction or batch
countries yes the list of countries with their states, to be referenced by country code in threepl records
handlerparameter yes a background process handler parameter
handlerparameters yes Collection: of handlerparameter
httptestdelete yes a pass-through http test endpoint for DELETE
httptestget yes a pass-through http test endpoint for GET
httptestpost yes a pass-through http test endpoint for POST
httptestput yes a pass-through http test endpoint for PUT
jobtypequeue a mapping between HeadlessHorseman job type and Hangfire queue
jobtypequeues yes Collection: of jobtypequeue
login a master login
logins yes Collection: of login
person a person, to be referenced in threepl records
persons yes Collection: of person
smallparcelstatistics yes a set of statistics regarding small parcel for a given threepl. Tpl 0 lists all TPLs.
threepl a third party logistics company
threepls yes Collection: of threepl
threeplstatistics yes a set of statistics for a given threepl
threeplsummaries yes the list of third party logisitics company summaries
webhooksconfig yes master web hooks configuration

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.