Merchant API: conventions
About this article
This article describes ChannelEngine's Merchant API's conventions, such as URL length limit, request methods, date and time formats, and more.
Table of contents
ChannelEngine’s Merchant API follows a set of conventions so you can interact with it consistently and reliably.
URL length limit
The request URL cannot be longer than 1,048 characters. If you exceed this limit, reduce the number of parameters in the call – or split the request into multiple calls.
HTTP request methods
HTTP methods indicate the action you want to perform on a resource. The Merchant API supports the below HTTP methods. Note that available methods differ across resources.
|GET||The GET method retrieves data from a specified resource on ChannelEngine.|
The POST method sends data to a specified resource on ChannelEngine. It can modify the resource or create a new one.
|PUT||The PUT method replaces a specified resource on ChannelEngine with the data in the request.|
|DELETE||The DELETE method deletes a specified resource on ChannelEngine.|
|PATCH||The PATCH method applies partial modifications to a specified resource on ChannelEngine.|
The Merchant API supports the following message formats, depending on the request type.
|Requested format||Response format|
JSON property naming
Parameters in responses returned by the Merchant API are in the UpperCamelCase format. E.g.: ChannelOrderSupport; MerchantOrderNo.
Parameters in requests passed to the Merchant API are in the lowerCamelCase format. E.g.: toUpdatedAtDate; onlyWithCancellationRequests.
Date and time formats
ChannelEngine stores date and time values as a string in the ISO 8601 format. E.g.:
Do not pass empty strings in a field that is not intended for use. An empty string is still a value and it is validated. This can lead to a 400: bad request error.
Article is closed for comments.