PRODUCTS #

URLs #

• https://api.ichhabnemacke.de/products—refer to all products. Only GET and POST are supported.
• https://api.ichhabnemacke.de/products/:id—refer to a particular product. GET, PUT, and DELETE are supported.
• https://api.ichhabnemacke.de/categories/:id/products—refer to all products of a particular category.
• https://api.ichhabnemacke.de/categories/:id/products/:id—refer to a particular product in a particular category.

Filtering #

In order to get products based on a filter, you can use one of the available filters. Product filtering is similar to the advanced search performed in the admin panel.

The request URL is as follows (separated into several lines for readability):

https://api.ichhabnemacke.de/products?

<filter>=Y&

<additional_param>=<value>&

<another_param>=<value>&

...

sort_by=<sorting>&

sort_order=<sort_order>&

q=<query>

• filter is one of the available filters. It is possible to use any number of filters at a time by appending the URL with &<another_filter>=Y
• additional_param is one of the available additional params. It is possible to use any number of additional params at a time by appending the URL with &<another_param>=<value>
• sorting is one of the available sortings
• sort_order is the sort direction; asc or desc for ascending and descending accordingly
• query is the search query

Filters #

Available filter attribute values:

Additional Params #

Sorting #

It is possible to set the sort order by defining the sort_order URL param to asc or desc.

Pagination #

To get a specific number of products or list of products from a concrete page in a response, use pagination parameters:

Examples #

GET-Requests #

• https://api.ichhabnemacke.de/products?page=5

Response is an array with 10 products from the 5th page (10 is the default value of the items_per_page parameter).

• https://api.ichhabnemacke.de/products?items_per_page=20

Response is an array with 20 products from the first page.

• https://api.ichhabnemacke.de/products?page=5&items_per_page=20

Response is an array with 20 products from the 5th page.

(PUT) Update Stock-Amount from Product #

PUT  /products/:productID

Example JSON-Body: Update Product-Amount

{
    "code": "ART_32231",  //PRODUCT_ID
    "amount": "1"
}

Fields #

A product has a number of properties, represented by fields.

The full list of supported fields is given below (mandatory fields are marked with *).

Any field not listed in the table below will be ignored if occurs in an API request JSON data.

Main Pair (Product-Image) #

A pair of the full product image and (optionally) a thumbnail.