Merchants
- Mark Rachelski
Overview
The Merchant endpoint allows a Channel to retrieve the identifiers and a set of descriptive properties about the merchants that are configured to that channel. It is a read-only endpoint.
Implemented verbs and end-points
Merchants List
GET https://fulfillment.api.acommerce.asia/channel/:channelId/merchants
This endpoint is used to allow a channel (identified by :channelId) to query a list of merchants that have been configured to sell on that channel. This API call is subject to rate limiting. If a channel begins regularly exceeding rate limits, please contact aCommerce customer service to have them increased.
The result will be returned in a JSON body that conforms to the description in the Merchant Schema.
This API is subject to paging as described in the Pagination section of the API overview. At the time of this writing a single page will return up to 100 records. Although this value is subject to change over time without prior notification. A caller is expected to simply follow the next link in the HTTP link header until there is no more next link.
Query Parameters
URI component | Description | Type | Example |
|---|---|---|---|
channelId | The aCommerce identifier for the channel requesting this information. This value to use for this string will be communicated to the channel development team at the time they apply for an application name and secret key. | String except '#', '/' and '?' | channel1 |
Merchant Schema
Attribute | Description | Type | Example |
|---|---|---|---|
| [] | The return result contains a list of merchant objects | Array of merchantObject | see below |
Merchant Object
Attribute | Description | Type | Example |
|---|---|---|---|
| merchantId | A valid identifier that can be used to construct URIs. | String | 01 |
| name | A descriptive name for the merchant | String | Bob's Plumbing Supplies |
Merchant Retrieval Example
GET https://fulfillment.api.acommerce.asia/channel/channel1/merchants
X-Subject-Token: //Please refer to the token format from https://acommerce.atlassian.net/wiki/display/TA/Authentication Content-Type: application/json;charset=UTF-8 User-Agent: Awesome-Products-App
Example Response
Link: <http://fulfillment.acommerce.asia/channel/channel1/merchants>; rel="first", <http://fulfillment.acommerce.asia/channel/channel1/merchants?page=2&page_size=100>; rel="next", <http://fulfillment.acommerce.asia/channel/channel1/merchants?page=last&page_size=100>; rel="last"
[{
"merchantId": "1",
"name": "Merchant 1"
},
{
"merchantId": "2",
"name": "Merchant 2"
},
{
"merchantId": "3",
"name": "Merchant 3"
},
{
"merchantId": "4",
"name": "Merchant 4"
},
{
"merchantId": "5",
"name": "Merchant 5"
},
{
"merchantId": "6",
"name": "Merchant 6"
},
{
"merchantId": "7",
"name": "Merchant 7"
},
{
"merchantId": "8",
"name": "Merchant 8"
},
{
"merchantId": "9",
"name": "Merchant 9"
},
{
"merchantId": "10",
"name": "Merchant 10"
}]