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)
maintains resources related to customers and their item descriptions, may be limited to a subset based on credential
Rel (/rels/customers/ + ) On Billboard Description
alert alert: record representing notification of a system event
alertcontents yes Collection: of alertcontent
alertfailer increment failed attempts; after the fourth failed attempt, archive the alert as a failure and delete it
alertqueuer Operator: queue an alert if the customer is setup for the type specified
alerts yes Collection: of alert
customeralertdefinitions configuration for notifying when certain events occur related to the customer
emailalertdef customer email alert definition
emailalertdefs Collection: of emailalertdef
emailtemplate customer email template
eventalerter yes Operator: create one or more alerts based upon changes
eventnotifyhistoryremover yes Operator: remove 'old' rows from the EventNotifyHistory table
ftpalertdef customer ftp alert definition
ftpalertdefs Collection: of ftpalertdef
channel defines periodic import/export
channels yes Collection: of channel
charges yes ad hoc charge transaction
chargeslist yes Collection: of charges
chargesreverser ad hoc charge reverser
invoicebinder yes Operator: bind an invoice number to billed transactions
itemizedchargeslist yes a list of orders, receivers, adjustments and/or assemblies having charges
customer contacts
ordercontact contact referenced on a customer's orders or with customerid set
ordercontacts Collection: of ordercontact
retailer retailer referencable on customer's contact
retailers Collection: of retailer
supplier customer supplier
supplierindex item index in the list of customer supplier
suppliers Collection: of supplier
carriermarkup customer carrier markup used for small parcel shipping
carriermarkups Collection: of carriermarkup
customer customer: company contact, primary contact, groups, facilities, options
customerautorates standard (default) rates for system-calculated charges such as storage and handling; overridable by item rates
customerbarcodedef inventory barcode content
customerbarcodedefs Collection: of customerbarcodedef
customerbolmessage bill of lading templates for given customer
customerbolmessages Collection: of customerbolmessage
customerboltemplate bill of lading templates for given customer
customerboltemplates Collection: of customerboltemplate
customerbriefs yes skinny customers
customercarrieraccount carrier account used for small parcel shipping
customercarrieraccounts Collection: of customercarrieraccount
customerlogo customer logo
customermanualrates rates for standard transaction fees charged on an as needed basis
customers yes Collection: of customer
customersactivate yes GroupOperator: activate/deactivate customers
customersummaries yes Collection: of customersummary
customersummary active customer summary: id, name
customertransform transform available to a customer, for importing objects from a file or exporting object data as a file
customertransforms Collection: of customertransform
errorlogs yes A log of errors for customer use
markforlist list of store ids marked for grouped processing
markforlists Collection: of markforlist
packinglisttemplate packing list template enabled for given customer
packinglisttemplates Collection: of packinglisttemplate
item item: sku, units of measure, track-bys, kits, qualifiers, other descriptive aspects
itemactivate Operator: activate/deactivate item
itemalias surrogate for ordering a list of items with quantities
itemaliases Collection: of itemalias
itembriefs yes skinny items
itemexchanges yes GroupOperator: items update via exchange format
itemimage image for item
itemimports yes items add via import format
itemindex yes item index in the list of items
itemrates overrides of standard transaction and storage rates, by facility
itemratesgroup GroupOperator: batch override of standard transaction and storage rates
itemratesgroups grouping by like rate properties of standard transaction and storage rates
items yes Collection: of item
itemsactivate yes GroupOperator: of itemactivate
itemsasync yes Async: items
itemsasyncdata item: sku, units of measure, track-bys, kits, qualifiers, other descriptive aspects - obtained asynchronously
itemsasyncstatus Status: of itemsasync
itemscreate yes items add
itemsummaries yes Collection: of itemsummary
itemsummariesacrosscustomers yes Collection: of itemsummary
itemsummary item subset sufficient for most operations during receiving and shipping
skusunionaliases list combining abbreviated info about skus and item aliases

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.