Product

Module endpoints

• DELETE /products/:id​

• DELETE /products/:productId/questions/:id​

• ​GET /products​

• ​GET /products/:id​

• ​PATCH /products/:id​

• ​POST /products​

• POST /products/:id/questions

• POST /products/:id/reorder

• POST /products/:productId/questions/:id/reorder

DELETE /products/:id

DELETE http://api.slyk.io/products/:id

Deletes the product with given id.

Response

204 No Content

DELETE /products/:productId/questions/:id

DELETE http://api.slyk.io/products/:productId/questions/:id

Deletes the product question with given id and productId.

Response

204 No Content

GET /products

GET https://api.slyk.io/products

Returns a paginated list of products.

Available Filters

Name	Type	Example
available	=	filter[available]=true
categoryId	= in nin	filter[categoryId]=in:foo,bar
description	ilike	filter[description]=foo
featured	=	filter[featured]=false
id	= in nin	filter[id]=7938e446-1c77-4513-8cb0-8b1f2e9f47b9
name	ilike	filter[name]=foo
order	= gte lte	filter[order]=gte:0.5
requiresIdentity	=	filter[requiresIdentity]=true
typeCode	= in nin	filter[typeCode]=nin:bar
visible	=	filter[visible]=true

Available Sorts

Name	Example
createdAt	sort=createdAt sort=-createdAt
featured	sort=featured sort=-featured
order	sort=order sort=-order

Paginate Options

Name	Description	Example
size	Defines the number of results per page. Default = 30.	page[size]=2
number	Defines the number of the page to retrieve. Default = 1	page[number]=2

Response

{
  "data": [
    {
      "allowChoosingQuantity": true,
      "assetCode": "eur",
      "available": true,
      "bonus": "1.34000000",
      "buttonLabel": "bar",
      "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c5",
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Pop music album",
      "featured": false,
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c8",
      "imageUrl": "http://slyk.io/album.png",
      "listLabel": "biz",
      "metadata": {},
      "name": "Music album",
      "price": "2.50000000",
      "priceWithTax": "3.00000000",
      "requiresIdentity": false,
      "taxAmount": "0.50000000",
      "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
      "thumbnailUrl": "http://slyk.io/album-thumbnail.png",
      "updatedAt": "2020-08-10T10:00:00.000Z",
      "url": "http://albums.com",
      "visible": true
    },
    {
      "allowChoosingQuantity": true,
      "assetCode": "eur",
      "available": true,
      "bonus": "1.74000000",
      "buttonLabel": "biz",
      "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c5",
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Pop music t-shirt",
      "featured": true,
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c9",
      "imageUrl": "http://slyk.io/tshirt.png",
      "listLabel": "bar",
      "metadata": {},
      "name": "Music t-shirt",
      "price": "6.50000000",
      "priceWithTax": "6.80000000",
      "requiresIdentity": false,
      "taxAmount": "0.30000000",
      "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
      "thumbnailUrl": "http://slyk.io/tshirt-thumbnail.png",
      "updatedAt": "2020-08-10T10:00:00.000Z",
      "url": "http://tshirts.com",
      "visible": true
    }
  ],
  "total": 2
}

GET /products/:id

GET https://api.slyk.io/products/:id‌

Gets the product details of the given id.

Response

{
  "data": {
      "allowChoosingQuantity": true,
      "assetCode": "eur",
      "available": true,
      "bonus": "1.34000000",
      "buttonLabel": "biz",
      "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c5",
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Pop music t-shirt",
      "featured": false,
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c8",
      "imageUrl": "http://slyk.io/tshirt.png",
      "listLabel": "bar",
      "metadata": {},
      "name": "Music t-shirt",
      "price": "2.50000000",
      "priceWithTax": "2.80000000",
      "requiresIdentity": false,
      "taxAmount": "0.30000000",
      "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
      "thumbnailUrl": "http://slyk.io/tshirt-thumbnail.png",
      "updatedAt": "2020-08-10T10:00:00.000Z",
      "url": "http://tshirts.com",
      "visible": true
    }
}

PATCH /products/:id

PATCH https://api.slyk.io/products/:id

Patches the product details of the given id.

Request Parameters

Field	Type	Required	Description
allowChoosingQuantity	boolean	false	Product choosing quantity allow indicator.
assetCode	string	false	Asset code related to the product.
available	boolean	false	Product availability indicator.
bonus	string	false	Product bonus value.
buttonLabel	string	false	Product button label.
categoryId	string	false	Associated category identifier. Format: uuid.
customData	object	false	Can store any additional information about the product.
description	string	false	Product description.
featured	boolean	false	Product featuring indicator.
image	string	false	Product image.
listLabel	string	false	Product list label.
name	string	false	Product name.
order	string	false	Product order value.
price	string	false	Product price value.
requiresIdentity	boolean	false	Identity required indicator.
taxRateId	string	false	Associated tax rate identifier. Format: uuid.
thumbnail	string	false	Product thumbnail.
url	string	false	Product URL.
visible	boolean	false	Product visibility indicator.

Request

{
  "available": true,
  "bonus": "1.34000000",
  "description": "Pop music t-shirt",
  "image": "tshirt.png",
  "name": "Music t-shirt",
  "url": "http://tshirts.com"
}

Response

{
  "data": {
      "allowChoosingQuantity": true,
      "assetCode": "eur",
      "available": true,
      "bonus": "1.34000000",
      "buttonLabel": "biz",
      "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c5",
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Pop music t-shirt",
      "featured": false,
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c8",
      "imageUrl": "http://slyk.io/tshirt.png",
      "listLabel": "bar",
      "metadata": {},
      "name": "Music t-shirt",
      "price": "2.50000000",
      "priceWithTax": "2.80000000",
      "requiresIdentity": false,
      "taxAmount": "0.30000000",
      "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
      "thumbnailUrl": "http://slyk.io/tshirt-thumbnail.png",
      "updatedAt": "2020-08-10T10:00:00.000Z",
      "url": "http://tshirts.com",
      "visible": true
    }
}

POST /products

POST https://api.slyk.io/products

Creates a new product.

Request Parameters

Field	Type	Required	Description
allowChoosingQuantity	boolean	false	Product choosing quantity allow indicator.
assetCode	string	false	Asset code related to the product.
available	boolean	false	Product availability indicator.
bonus	string	false	Product bonus value.
buttonLabel	string	false	Product button label.
categoryId	string	true	Associated category identifier. Format: uuid.
customData	object	false	Can store any additional information about the product.
description	string	false	Product description.
featured	boolean	false	Product featuring indicator.
image	string	false	Product image.
listLabel	string	false	Product list label.
name	string	false	Product name.
order	string	false	Product order value.
price	string	true	Product price value.
requiresIdentity	boolean	false	Identity required indicator.
taxRateId	string	false	Associated tax rate identifier. Format: uuid.
thumbnail	string	false	Product thumbnail.
url	string	false	Product URL.
visible	boolean	false	Product visibility indicator.

Request

{
    "allowChoosingQuantity": true,
    "assetCode": "eur",
    "available": true,
    "bonus": "1.34000000",
    "buttonLabel": "qux",
    "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c3",
    "description": "Pop music t-shirt",
    "featured": false,
    "image": "tshirt.png",
    "listLabel": "quux",
    "name": "Music t-shirt",
    "price": "2.50000000",
    "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
    "thumbnail": "tshirt-thumbnail.png",
    "url": "http://tshirts.com",
    "visible": true
}

Response

{
  "data": {
      "allowChoosingQuantity": true,
      "assetCode": "eur",
      "available": true,
      "bonus": "1.34000000",
      "buttonLabel": "qux",
      "categoryId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c5",
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Pop music t-shirt",
      "featured": false,
      "id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c8",
      "imageUrl": "http://slyk.io/tshirt.png",
      "listLabel": "quux",
      "metadata": {},
      "name": "Music t-shirt",
      "price": "2.50000000",
      "priceWithTax": "2.80000000",
      "requiresIdentity": false,
      "taxAmount": "0.30000000",
      "taxRateId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c4",
      "thumbnailUrl": "http://slyk.io/tshirt-thumbnail.png",
      "updatedAt": "2020-08-10T10:00:00.000Z",
      "url": "http://tshirts.com",
      "visible": true
    }
}

POST /products/:id/questions

POST http://api.slyk.io/products/:id/questions

Creates a new product question.

Request Parameters

Field	Type	Required	Description
questionId	string	true	Associated question identifier. Format: uuid.

Request

{
    "questionId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c3"
}

Response

{
  "data": {
    "order": "1",
    "productId": "ec78d28f-a8dd-49de-a32f-722fe3bd26c8",
    "questionId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c3"
  }
}

POST /products/:id/reorder

POST http://api.slyk.io/products/:id/reorder

Reorders the product with the given id.

Request Parameters

Field	Type	Required	Description
subsequentId	string	false	Subsequent product identifier.

Request

{
  "subsequentId": "174c3e0d-226f-443a-a010-12b2140de03c"
}

Response

204 No Content

POST /products/:productId/questions/:id/reorder

POST http://api.slyk.io/products/:productId/questions/:id/reorder

Reorders the product question with the given id and productId.

Request Parameters

Field	Type	Required	Description
subsequentId	string	false	Subsequent product question identifier.

Request

{
  "subsequentId": "174c3e0d-226f-443a-a010-12b2140de03c"
}

Response

204 No Content