E-commerce Products API

Get products

If you want to get products for the given shop, send this GET request

GET https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products
1

Request body

ParameterTypeRequiredLimitations
shop_idintegeryesMust provide valid shop id
limitintegernoDefaults to 100
pageintegernoDefaults to 1

Response

{
  "data": [
    {
      "id": "31986843543567834",
      "name": "Product name",
      "price": 123.4,
      "url": "https://shop-url.com/product-name",
      "image": "https://shop-url.com/product-image.jpg",
      "exclude_from_automations": false,
      "categories": [
        {
          "id": "1234566457534276",
          "name": "Category 1",
          "exclude_from_automations": false,
          "created_at": "2021-09-01 14:03:50",
          "updated_at": "2021-09-01 14:03:50"
        },
        {
          "id": "1234566457534278",
          "name": "Category 2",
          "exclude_from_automations": false,
          "created_at": "2021-09-01 14:03:50",
          "updated_at": "2021-09-01 14:03:50"
        }
      ]
    }
  ],
  "links": {
    "first": "https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products?page=1",
    "last": "https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products",
    "per_page": 100,
    "to": 1,
    "total": 1
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

Create/update product

You can create or update a product for the given shop.

To create a product for the given shop, send this POST request

POST https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products
1

To update a product for the given shop, send this PUT request

PUT https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products/:product_id
1

Request body

ParameterTypeRequiredLimitations
namestringyesThe product's name
pricefloatnoThe product's price in the shop's currency. Defaults to 0.
exclude_from_automationsbooleannoIf true this product will not trigger any automations. Defaults to false
urlstringnoThe products url.
imagestringnoThe products main image url.
{
    "name": "Product name",
    "price": 123.40,
    "url": "https://shop-url.com/product-name",
    "image": "https://shop-url.com/product-image.jpg",
    "exclude_from_automations": false,
}
1
2
3
4
5
6
7

Response

If the product was created:

Response Code: 201 Created
1
{
  "data": {
    "id": "31986843543567834",
    "name": "Product name",
    "price": 123.4,
    "url": "https://shop-url.com/product-name",
    "image": "https://shop-url.com/product-image.jpg",
    "exclude_from_automations": false,
    "categories": []
  }
}
1
2
3
4
5
6
7
8
9
10
11

Error

Response Code: 422 Unprocessable Entity
1

The error response will contain information about the invalid data.

{
  "message": "The given data was invalid.",
  "errors": {
    "name": ["The name must be provided."]
  }
}
1
2
3
4
5
6

Fetch a product

If you want to fetch a product for the given shop, send this GET request

GET https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products/:product_id
1

Request body

ParameterTypeRequiredLimitations
product_idintegeryesMust provide valid product id
shop_idintegeryesMust provide valid shop id
GET https://connect.mailerlite.com/api/ecommerce/shops/31986843064993537/products/319868430643456756
1

Response

If the shop and the product exist:

Response Code: 200 OK
1
{
  "data": {
    "id": "31986843543567834",
    "name": "Product name",
    "price": 123.4,
    "url": "https://shop-url.com/product-name",
    "image": "https://shop-url.com/product-image.jpg",
    "exclude_from_automations": false,
    "categories": [
      {
        "id": "1234566457534276",
        "name": "Category 1",
        "exclude_from_automations": false,
        "created_at": "2021-09-01 14:03:50",
        "updated_at": "2021-09-01 14:03:50"
      },
      {
        "id": "1234566457534278",
        "name": "Category 2",
        "exclude_from_automations": false,
        "created_at": "2021-09-01 14:03:50",
        "updated_at": "2021-09-01 14:03:50"
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Error

If the product or shop cannot be found:

Response Code: 404 Not Found
1

Fetch total products count

If you want to fetch the total products count for the given shop, send this GET request

GET https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products?limit=0
1

Request body

ParameterTypeRequiredLimitations
shop_idintegeryesMust provide valid shop id
limitintegeryesValue must be 0

Response

Response Code: 200 OK
1
{
  "total": 123
}
1
2
3

Delete a product

If you want to delete a product for the given shop, send this DELETE request

   DELETE https://connect.mailerlite.com/api/ecommerce/shops/:shop_id/products/:product_id
1

Request body

ParameterTypeRequiredLimitations
product_idintegeryesMust provide valid product id
shop_idintegeryesMust provide valid shop id

Response

Response code: 200 OK
1
{
  "data": {
    "id": "31986843543567834",
    "name": "Product name",
    "price": 123.4,
    "url": "https://shop-url.com/product-name",
    "image": "https://shop-url.com/product-image.jpg",
    "exclude_from_automations": false,
    "categories": []
  }
}
1
2
3
4
5
6
7
8
9
10
11

Error

Response code: 404 Not Found
1
Last Updated: