API Documentation

This service is in BETA. For access please Fill out the application

CONTENTS
RESOURCES
MACROS
VERBS
REPORTS
RESEARCH API

Settings /v1/settings

The settings resource describes settings available on the account. Settings can be used as a way to store a small amount of persistent information for an account, and for applications to communicate some information between themselves.


Methods:

GET /settings Returns all of the settings currently enabled for the account
GET /settings/someSetting Returns all information about the 'someSetting' settings
POST /settings Creates a new setting. Overwrites an existing setting if it already exists
POST /settings/someSetting Creates a new setting. Overwrites an existing setting if it already exists
PUT /settings Not Permitted. Returns HTTP 405
PUT /settings/someSetting Updates the existing 'someSetting' setting. Overrides existing values
DELETE /settings Not Permitted. Returns HTTP 405
DELETE /settings/someSetting Delete's the specified setting

Request Parameters

The Parameters Common to Collections are supported. No other request parameters are available.


Collection GET /v1/settings

This method gets all the settings store in a user's account. We recommend that client applications that utilize settings frequently to use this method instead of requesting each setting individually.


    GET https://api.sellerlabs.com/v1/settings HTTP/1.1

HTTP/1.1 200 OK
Content-Length: 253
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Content-Type: application/json

{
    "status": "success",
    "code": 200,
    "httpCode": "200",
    "user": "117",
    "data": {
        "offset": 0,
        "limit": 50,
        "count": "2",
        "prev": "",
        "next": "",
        "first": "https:\/\/api.sellerlabs.com\/v1\/settings?offset=0&limit=50",
        "last": "https:\/\/api.sellerlabs.com\/v1\/settings?offset=0&limit=50",
        "pages": 1,
        "settings": [{
            "name": "internalSetting",
            "value": "someValue",
            "modified": "2013-12-06T21:05:00-05:00Z",
            "readOnly": "y",
            "link": "https:\/\/api.sellerlabs.com\/settings\/internalSetting"
        }, {
            "name": "someOtherSetting",
            "value": "my-Value-abc123",
            "modified": "2013-12-06T21:05:21-05:00Z",
            "readOnly": "n",
            "link": "https:\/\/api.sellerlabs.com\/settings\/someOtherSetting"
        }]
    }
}