Products API¶

Sylius products catalogue API endpoint is /api/products and it allows for browsing, creating & editing product information.

Index of all products¶

To browse all products available in the store you should call the following GET request:

GET /api/products/

Parameters¶

page: Number of the page, by default = 1
limit: Number of items to display per page
criteria[channel]: Id of the channel (optional)
criteria[name]: Name of the product (optional)

Response¶

Response will contain a paginated list of products.

STATUS: 200 OK

{
    "page":1,
    "limit":10,
    "pages":12,
    "total":120,
    "_links":{
        "self":{
            "href":"\/api\/products\/?page=1"
        },
        "first":{
            "href":"\/api\/products\/?page=1"
        },
        "last":{
            "href":"\/api\/products\/?page=12"
        },
        "next":{
            "href":"\/api\/products\/?page=2"
        }
    },
    "_embedded":{
        "items":[
            {
                "created_at": "2014-11-26T23:00:20+0000",
                "description": "Facere ipsum id eveniet rem omnis et. Totam vero eos eveniet nihil sint. Labore occaecati qui placeat fugit.",
                "id": 2173,
                "masterVariant": {
                    "available_on": "2014-03-29T01:30:04+0000",
                    "created_at": "2014-11-26T23:00:20+0000",
                    "id": 13403,
                    "master": true,
                    "options": [],
                    "sku": "68051",
                    "updated_at": "2014-11-26T23:00:20+0000"
                },
                "name": "T-Shirt \"ipsam\"",
                "short_description": "Aut rerum quasi neque.",
                "updated_at": "2014-11-26T23:00:20+0000"
            }
        ]
    }
}

Getting a single product¶

You can view a single product by executing the following request:

GET /api/products/2173

Response¶

STATUS: 200 OK

{
    "created_at": "2014-11-26T23:00:20+0000",
    "description": "Facere ipsum id eveniet rem omnis et. Totam vero eos eveniet nihil sint. Labore occaecati qui placeat fugit.",
    "id": 2173,
    "masterVariant": {
        "available_on": "2014-03-29T01:30:04+0000",
        "created_at": "2014-11-26T23:00:20+0000",
        "id": 13403,
        "master": true,
        "options": [],
        "sku": "68051",
        "updated_at": "2014-11-26T23:00:20+0000"
    },
    "name": "T-Shirt \"ipsam\"",
    "short_description": "Aut rerum quasi neque.",
    "updated_at": "2014-11-26T23:00:20+0000"
}

Create an product¶

To create a new product, you can execute the following request:

POST /api/products/

Parameters¶

name: Name of the product
description: Description of the product
price: Price of the product
shortDescription (optional): Short description of the product (for lists)

Response¶

STATUS: 201 CREATED

{
    "created_at": "2014-11-29T14:23:57+0000",
    "description": "Bar",
    "id": 2181,
    "masterVariant": {
        "available_on": "2014-11-29T14:23:57+0000",
        "created_at": "2014-11-29T14:23:57+0000",
        "id": 13468,
        "master": true,
        "options": [],
        "updated_at": "2014-11-29T14:23:58+0000"
    },
    "name": "Foo",
    "updated_at": "2014-11-29T14:23:58+0000"
}

Updating a product¶

You can update an existing product using PUT or PATCH method:

PUT /api/products/2181

PATCH /api/products/2181

Parameters¶

name: Name of the product
description: Description of the product
price: Price of the product
shortDescription (optional): Short description of the product (for lists)

Response¶

STATUS: 204 NO CONTENT

Deleting a product¶

You can delete (soft) a product from the catalog by making the following DELETE call:

DELETE /api/products/24

Response¶

STATUS: 204 NO CONTENT