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.
uiproperties
maintains resources for the V2 user interface
Rel (/rels/uiproperties/ + ) On Billboard Description
clientmetadata yes custom storage of client-specific metadata, such as UI preferences, none of which controls internal business logic
clientmetadatas yes Collection: of clientmetadata
customrole list of rights, customizable
customroles yes Collection: of customrole
customrolesummaries yes collection: custom role summaries
policies yes collection: all rights granted to a given user, derived from user's role(s)
rights yes collection: names of all UI features requiring authorization
systemrole list of rights, immutable
systemrolesummaries yes collection: system role summaries
textoverride
textoverrides yes Collection: of textoverride
threepllogo yes ThreePL Logo
user yes a user
users yes Collection: of user
usersactivate yes GroupOperator: activate/deactivate users
usersassignrole yes GroupOperator: 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.