Please note that this is a BETA version of the GetResponse ecommerce API. It is still undergoing final testing before its official release.

Method returns shop according to given shopsId

Returns status code

200

Request url

/shops/p

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "shopId": "p",
    "href": "https://api.getresponse.com/v3/shops/p",
    "name": "shop58da437117287",
    "locale": "PL",
    "currency": "USD",
    "createdOn": "2017-03-28T11:05:20+0000",
    "updatedOn": "2017-03-29T07:00:25+0000"
}

Possible Errors


Please note that this is a BETA version of the GetResponse ecommerce API. It is still undergoing final testing before its official release.

Sending GET request to this url, returns collection of SHOPS resources.

You can narrow down list of resources by passing proper query parameters (list of which you can find below in request params section). You can basically search by:

  • name

`name` fields can be a pattern and we will try to match this phrase.

You can specify which page of results you want and how many results per page should be there. You can also specify sort-order using one or more of allowed fields (listed below in request params section).

Last but not least you can even specify which fields from resource you want to get. If you pass param `fields` with list of fields (separated by comma [,]) we will return list of resources with only those fields (we will always add resource id to ensure that you can use that data later on)

Returns status code

200

Request url

/shops?query[name]=test&page=1&perPage=100&sort[name]=asc

Request params

Field nameField typeField description
queryhashUsed to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
KeyPossible values if fixed
name*
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
KeyPossible values if fixed
nameasc,desc
createdOnasc,desc
pageintegerSpecify which page of results return.
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "shopId": "p",
        "href": "https://api.getresponse.com/v3/shops/p",
        "name": "shop58da437117287",
        "locale": "PL",
        "currency": "USD",
        "createdOn": "2017-03-28T11:05:20+0000",
        "updatedOn": "2017-03-29T07:07:11+0000"
    }
]

Possible Errors


Please note that this is a BETA version of the GetResponse ecommerce API. It is still undergoing final testing before its official release.

This method allows to create a new shop

Returns status code

201

Example Request Body

{
    "name": "testShopReview",
    "locale": "pl",
    "currency": "USD"
}

Body params

Field nameField typeField description
name (required)stringName of the shop
locale (required)stringLanguage locale ( ISO 639-1 )
currency (required)stringCurrency code ( ISO 4217 )

Example Response

{
    "shopId": "Vt",
    "href": "https://api.getresponse.com/v3/shops/Vt",
    "name": "testShopReview",
    "locale": "PL",
    "currency": "USD",
    "createdOn": "2017-03-29T07:12:07+0000",
    "updatedOn": "2017-03-29T07:12:07+0000"
}

Possible Errors


Please note that this is a BETA version of the GetResponse ecommerce API. It is still undergoing final testing before its official release.

Allows you to update shop preferences. You should send only those fields that need to be changed. The rest of the properties remain the same.

Returns status code

200

Example Request Body

{
    "name": "testShop22newReview",
    "locale": "de",
    "currency": "PLN"
}

Body params

Field nameField typeField description
namestringName of the shop
localestringLanguage locale ( ISO 639-1 )
currencystringCurrency code ( ISO 4217 )

Example Response

{
    "shopId": "p",
    "href": "https://api.getresponse.com/v3/shops/p",
    "name": "testShop22newReview",
    "locale": "DE",
    "currency": "PLN",
    "createdOn": "2017-03-28T11:05:20+0000",
    "updatedOn": "2017-03-29T07:24:16+0000"
}

Possible Errors


Please note that this is a BETA version of the GetResponse ecommerce API. It is still undergoing final testing before its official release.

Deletes a shop

Returns status code

204

Possible Errors