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)
HTTP Headers
HTTP Headers.

Request headers

Specifies in which media type the request is expressed. Recommended value, unless stated otherwise for specific rels: application/hal+json
Required by HTTP when sending a payload.
Required when updating a resource. See individual Rels for which requests require it. The value comes from the ETag header of a relevant response.
Expresses in which media type to return the response. Recommended value, unless stated otherwise for specific rels: application/hal+json

Response headers

Specifies in which media type the response is expressed. Will attempt to conform to the request's Accept header through appropriate content type negotiation.
Required by HTTP when returning a payload.
Value to be used in a subsequent request updating the resource. See above: Request headers> If-Match.
If present, is usually rel of the response.
Currently used internally. May be expanded in the future for external use.

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.