Sending GET request to this url, returns collection of PRODUCTS resources that belong to given shop.
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
- vendor
- category
- categoryId
- externalId
- variantName
- metaFieldNames
- metaFieldValues
- createdOn
`metaFieldNames` and`metaFieldValues` fields can be a list of values separated by comma [,].
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/p/products?query[name]=foo&query[metaFieldNames]=made_in,craft&query[createdOn][from]=2010-10-13&query[createdOn][to]=2020-03-15
Request params
Field name | Field type | Field description |
---|
query | hash | Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.Key | Possible values if fixed |
---|
name | * | vendor | * | category | * | categoryId | * | externalId | * | variantName | * | metaFieldNames | List of meta-fields name. (string separated with ",") | metaFieldValues | List of meta-fields value. (string separated with ",") | createdOn | createdOn[from]={Y-m-d}&createdOn[to]={Y-m-d} - It can be also UTC format |
|
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma |
sort | hash | Enable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.Key | Possible values if fixed |
---|
createdOn | asc,desc |
|
perPage | int | Number results on page |
page | int | Page number |
Example Response
[
{
"productId": "9I",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I",
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"categoryId": "atQ",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/atQ",
"parentId": "amh",
"externaId": null,
"isDefault": true
},
{
"name": "Accessories",
"categoryId": "amh",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/amh",
"parentId": null,
"externaId": null,
"isDefault": false
}
],
"variants": [
{
"variantId": "VTB",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I/variants/VTB",
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "1278945",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"imageId": "hY",
"href": "https://api.getresponse.com/v3/shops/nM/images/hY",
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"metaFieldId": "p0U",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p0U",
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"metaFieldId": "hyk",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/hyk",
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"taxId": "pZz",
"href": "https://api.getresponse.com/v3/shops/nM/taxes/pZz",
"name": "VAT",
"rate": 23
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
],
"metaFields": [
{
"metaFieldId": "p2B",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p2B",
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"metaFieldId": "vUd",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/vUd",
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
]
Possible Errors
Method returns PRODUCT according to given productId in context of given shopId.
Returns status code
200
Request url
/shops/V/products/P?fields=name
Request params
Field name | Field type | Field description |
---|
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Example Response
{
"productId": "9I",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I",
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"categoryId": "atQ",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/atQ",
"parentId": "amh",
"externaId": null,
"isDefault": true
},
{
"name": "Accessories",
"categoryId": "amh",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/amh",
"parentId": null,
"externaId": null,
"isDefault": false
}
],
"variants": [
{
"variantId": "VTB",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I/variants/VTB",
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "127889",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"imageId": "hY",
"href": "https://api.getresponse.com/v3/shops/nM/images/hY",
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"metaFieldId": "p0U",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p0U",
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"metaFieldId": "hyk",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/hyk",
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"taxId": "pZz",
"href": "https://api.getresponse.com/v3/shops/nM/taxes/pZz",
"name": "VAT",
"rate": 23
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
],
"metaFields": [
{
"metaFieldId": "p2B",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p2B",
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"metaFieldId": "vUd",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/vUd",
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
Possible Errors
Sending a POST request to this url, will create a new PRODUCT resource.
In order to create a new PRODUCT, you need to send PRODUCT resource in BODY of the request (remember that you need to serialize body into JSON string)
You don’t need a separate endpoint for each element (e.g. variant, category, meta-field). You can create them all with this method.
Please note that categories are not required, but if product has at least one category then one of those must be marked as default. It can be set by field `isDefault`, but if no one of elements contains isDefault=true then system by default pick the first one from the collection.
Returns status code
201
Example Request Body
{
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"url": null,
"parentId": "amh",
"externalId": "ext123",
"isDefault": true
}
],
"variants": [
{
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "127788",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"name": "VAT",
"rate": 23
}
]
}
],
"metaFields": [
{
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
]
}
Body params
Field name | Field type | Field description |
---|
name (required) | string | Product name |
url | string | External url to product |
type | string | Product type |
vendor | string | Product vendor |
externalId | string | Product external ID |
categories | collection | Collection of product categoriesField name | Field type | Field description |
---|
name (required) | string | Name of the category | parentId | string | Id of parent category | externalId | string | External Id of category | url | string | External url of the category |
|
variants (required) | collection | Collection of product variantsField name | Field type | Field description |
---|
name (required) | string | Name of the variant | url | string | External url of the variant | price (required) | float | Price | priceTax (required) | float | Price including tax | sku (required) | string | Stock-keeping unit of variant. Must be unique within product | previousPrice | float | Price before change | previousPriceTax | float | Price before change including tax | quantity | integer | Quantity of variant items. Set 1 by default | position | integer | Position of variant | barcode | string | Barcode of variant, maximum 255 characters | externalId | string | Variant external ID | description | string | Description of variant, maximum 1000 characters | images | collection | Collection of variant imagesField name | Field type | Field description |
---|
src (required) | string | Source url of image | position (required) | integer | Position of image |
| metaFields | collection | Collection of variant meta fieldsField name | Field type | Field description |
---|
name (required) | string | Name, minLength=3, maxLength=63 | value (required) | string | Meta value , minLength=0, maxLength=65000 | valueType (required) | string | One of values: 'string' or 'integer' | description | string | Meta description minLength=0, maxLength=255 |
| taxes | collection | Collection of variant taxesField name | Field type | Field description |
---|
name (required) | string | Name | rate (required) | string | Rate value, min=0, max=99.9 |
|
|
metaFields | collection | Collection of product meta fieldsField name | Field type | Field description |
---|
name (required) | string | Name, minLength=3, maxLength=63 | value (required) | string | Meta value , minLength=0, maxLength=65000 | valueType (required) | string | One of values: 'string' or 'integer' | description | string | Meta description minLength=0, maxLength=255 |
|
Example Response
{
"productId": "9I",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I",
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"categoryId": "atQ",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/atQ",
"parentId": "amh",
"externalId": "ext123",
"isDefault": true
},
{
"name": "Accessories",
"categoryId": "amh",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/amh",
"parentId": null,
"externalId": null,
"isDefault": false
}
],
"variants": [
{
"variantId": "VTB",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I/variants/VTB",
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "127788",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"imageId": "hY",
"href": "https://api.getresponse.com/v3/shops/nM/images/hY",
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"metaFieldId": "p0U",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p0U",
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"metaFieldId": "hyk",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/hyk",
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"taxId": "pZz",
"href": "https://api.getresponse.com/v3/shops/nM/taxes/pZz",
"name": "VAT",
"rate": 23
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
],
"metaFields": [
{
"metaFieldId": "p2B",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p2B",
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"metaFieldId": "vUd",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/vUd",
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
Possible Errors
Update the properties of shops PRODUCT. You should only send those fields that need to be changed. The remaining properties will stay the same. However, when updating variants, categories, and meta-fields, you need to send entire collections. Individual fields can’t be updated. If you want to update particular fields, you can do so by POSTING to their specific endpoints, i.e.:
- categories - /v3/shops/{shopId}/categories/{categoryId}
- variants - /v3/shops/{shopId}/products/{productId}/variants/{variantId}
- metaFields - /v3/shops/{shopId}/meta-fields/{metaFieldId}
Returns status code
200
Example Request Body
{
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"url": null,
"parentId": "amh",
"externalId": "ext123",
"isDefault": true
}
],
"variants": [
{
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "127788",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"name": "VAT",
"rate": 23
}
]
}
],
"metaFields": [
{
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
]
}
Body params
Field name | Field type | Field description |
---|
name | string | Product name |
url | string | External url to product |
type | string | Product type |
vendor | string | Product vendor |
externalId | string | Product external ID |
categories | collection | Collection of product categoriesField name | Field type | Field description |
---|
name (required) | string | Name of the category | parentId | string | Id of parent category | externalId | string | External Id of category | url | string | External url of the category |
|
variants | collection | Collection of product variantsField name | Field type | Field description |
---|
name (required) | string | Name of the variant | url | string | External url of the variant | price (required) | float | Price | priceTax (required) | float | Price including tax | sku (required) | string | Stock-keeping unit of variant. Must be unique within product | previousPrice | float | Price before change | previousPriceTax | float | Price before change including tax | quantity | integer | Quantity of variant items. Set 1 by default | position | integer | Position of variant | barcode | string | Barcode of variant, maximum 255 characters | externalId | string | Variant external ID | description | string | Description of variant, maximum 1000 characters | images | collection | Collection of variant imagesField name | Field type | Field description |
---|
src (required) | string | Source url of image | position (required) | integer | Position of image |
| metaFields | collection | Collection of variant meta fieldsField name | Field type | Field description |
---|
name (required) | string | Name, minLength=3, maxLength=63 | value (required) | string | Meta value , minLength=0, maxLength=65000 | valueType (required) | string | One of values: 'string' or 'integer' | description | string | Meta description minLength=0, maxLength=255 |
| taxes | collection | Collection of variant taxesField name | Field type | Field description |
---|
name (required) | string | Name | rate (required) | string | Rate value, min=0, max=99.9 |
|
|
metaFields | collection | Collection of product meta fieldsField name | Field type | Field description |
---|
name (required) | string | Name, minLength=3, maxLength=63 | value (required) | string | Meta value , minLength=0, maxLength=65000 | valueType (required) | string | One of values: 'string' or 'integer' | description | string | Meta description minLength=0, maxLength=255 |
|
Example Response
{
"productId": "9I",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I",
"name": "Monster Cap",
"url": "https://somedomain.com/products/456",
"type": "Headwear",
"vendor": "GetResponse",
"externalId": "123456",
"categories": [
{
"name": "Headwear",
"categoryId": "atQ",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/atQ",
"parentId": "amh",
"externalId": "ext123",
"isDefault": true
},
{
"name": "Accessories",
"categoryId": "amh",
"url": null,
"href": "https://api.getresponse.com/v3/shops/nM/categories/amh",
"parentId": null,
"externalId": null,
"isDefault": false
}
],
"variants": [
{
"variantId": "VTB",
"href": "https://api.getresponse.com/v3/shops/nM/products/9I/variants/VTB",
"name": "Red Monster Cap",
"url": "https://somedomain.com/products/456/variant/4",
"price": 20,
"priceTax": 23,
"previousPrice": null,
"previousPriceTax": null,
"quantity": 200,
"position": 1,
"barcode": "12455687",
"sku": "SKU-1254-56-457-5689",
"externalId": "127788",
"description": "Red Cap with GetResponse Monster print",
"images": [
{
"imageId": "hY",
"href": "https://api.getresponse.com/v3/shops/nM/images/hY",
"src": "http://somedomain.com/images/src/img58db7ec64bab9.png",
"position": "1"
}
],
"metaFields": [
{
"metaFieldId": "p0U",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p0U",
"name": "colour",
"value": "red",
"valueType": "string"
},
{
"metaFieldId": "hyk",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/hyk",
"name": "size",
"value": "large",
"valueType": "string"
}
],
"taxes": [
{
"taxId": "pZz",
"href": "https://api.getresponse.com/v3/shops/nM/taxes/pZz",
"name": "VAT",
"rate": 23
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
],
"metaFields": [
{
"metaFieldId": "p2B",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/p2B",
"name": "made_in",
"value": "Poland",
"valueType": "string"
},
{
"metaFieldId": "vUd",
"href": "https://api.getresponse.com/v3/shops/nM/meta-fields/vUd",
"name": "craft",
"value": "handcrafted",
"valueType": "string"
}
],
"createdOn": "2017-03-29T09:30:46+0000",
"updatedOn": "2017-04-05T10:29:40+0000"
}
Possible Errors
Returns status code
204
Possible Errors
The method allows assigning product categories and setting a default product category. This method does not remove or unassign product categories. Returns list of product categories.
Please note that if you assign only one category to a given product, that category is marked as default. If you try to unmark it, your change won’t be executed.
Returns status code
200
Example Request Body
{
"categories": [
{
"categoryId": "hYo",
"isDefault": true
},
{
"categoryId": "u0v"
}
]
}
Body params
Field name | Field type | Field description |
---|
categories (required) | collection | Collection of product categories to assignField name | Field type | Field description |
---|
categoryId (required) | string | Category ID | isDefault | boolean | Set 'true' if this category must be mark as default |
|
Example Response
[
{
"categoryId": "hYo",
"name": "category-58da4383b8af6",
"url": null,
"href": "https://api.getresponse.com/v3/shops/p/categories/hYo",
"parentId": null,
"isDefault": true
},
{
"categoryId": "u0v",
"name": "category-7h7dsf9023900",
"url": null,
"href": "https://api.getresponse.com/v3/shops/p/categories/u0v",
"parentId": null,
"isDefault": false
}
]
Possible Errors