Variants

A variant is a variation of an article. Every variant has its own unique article code, sku, ean and stock. An example of an article with 3 variants can be sized t-shirts (small, medium, large).

All articles must have at least 1 variant.

Variant resource

GET Collection

For the retrieval of a collection of variants.

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/variants/' \
2--header 'Expand: article'

Response

1[
2  {
3    "id": "f2894c16-399e-4ca1-9151-489775a6519c",
4    "article_code": "VBP_A",
5    "name": "Voorbeeld product - A",
6    "description": "Voorbeeld product - A",
7    "ean": "978020137962",
8    "sku": "VBP_A",
9    "hs_tariff_code": null,
10    "height": 2,
11    "depth": 3,
12    "width": 1,
13    "weight": 0,
14    "expirable": false,
15    "country_of_origin": null,
16    "using_serial_numbers": false,
17    "value": 15.95,
18    "article": {
19      "id": "f195e1e6-1558-4518-a34a-30783156b8c4",
20      "name": "T-Shirt",
21      "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce"
22    }
23  },
24  {
25    "id": "a3042f0b-fcb5-4b28-b02f-eced8316195d",
26    "article_code": "VBP_B",
27    "name": "Voorbeeld product - B",
28    "description": "Voorbeeld product - B",
29    "ean": "978020137963",
30    "sku": "VBP_B",
31    "hs_tariff_code": null,
32    "height": 2,
33    "depth": 3,
34    "width": 1,
35    "weight": 0,
36    "expirable": false,
37    "country_of_origin": null,
38    "using_serial_numbers": false,
39    "value": null,
40    "article": {
41      "id": "af7c1fe6-d669-414e-b066-e9733f0de7a8",
42      "name": "Broek",
43      "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce"
44    }
45  }
46]

GET Single

For the retrieval of a single variant.

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/variants/f2894c16-399e-4ca1-9151-489775a6519c/' \
2--header 'Expand: article'

Response

1{
2  "id": "f2894c16-399e-4ca1-9151-489775a6519c",
3  "article_code": "VBP_A",
4  "name": "Voorbeeld product - A",
5  "description": "Voorbeeld product - A",
6  "ean": "978020137962",
7  "sku": "VBP_A",
8  "hs_tariff_code": null,
9  "height": 2,
10  "depth": 3,
11  "width": 1,
12  "weight": 0,
13  "expirable": false,
14  "country_of_origin": null,
15  "using_serial_numbers": false,
16  "value": 15.95,
17  "article": {
18    "id": "9b67aea7-bb5c-4626-80fa-c6473f420ab3",
19    "name": "Voorbeeld product 1",
20    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b"
21  }
22}

POST Create

Creates a new variant.

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/variants/' \
2--header 'Expand: article' \
3--data-raw '{
4    "article": "f195e1e6-1558-4518-a34a-30783156b8c4",
5    "article_code": "TB001",
6    "name": "T-Shirt Blauw",
7    "description": "Mooi T-shirt in het blauw",
8    "ean": 871040031114,
9    "sku": "PDVL_001",
10    "hs_tariff_code": null,
11    "width": 100,
12    "height": null,
13    "depth": 0,
14    "weight": null,
15    "expirable": false,
16    "country_of_origin": "NL",
17    "value": 0.0,
18    "using_serial_numbers": false,
19}'

Response

1{
2  "id": "98fcffc2-8d47-4bf3-9bd0-f07ee0596562",
3  "article_code": "TB001",
4  "name": "T-Shirt Blauw",
5  "description": null,
6  "ean": "871040031114",
7  "sku": "PDVL_001",
8  "hs_tariff_code": null,
9  "height": null,
10  "depth": 0,
11  "width": 100,
12  "weight": null,
13  "expirable": false,
14  "country_of_origin": "NL",
15  "using_serial_numbers": false,
16  "value": 0.0,
17  "article": {
18    "id": "f195e1e6-1558-4518-a34a-30783156b8c4",
19    "name": "T-Shirt",
20    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce"
21  }
22}

PATCH Update

Updates an existing variant.

Example

1curl --location --request PATCH 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/variants/8700a223-785c-4234-8279-6a807808b543' \
2--header 'Expand: article' \
3--data-raw '{
4    "description": "Mooi T-shirt in het blauw",
5}'

Response

1{
2  "id": "8700a223-785c-4234-8279-6a807808b543",
3  "article_code": "TB001",
4  "name": "T-Shirt Blauw",
5  "description": "Mooi T-shirt in het blauw",
6  "ean": 871040031114,
7  "sku": "PDVL_001",
8  "hs_tariff_code": null,
9  "width": 100,
10  "height": null,
11  "depth": 0,
12  "weight": null,
13  "expirable": false,
14  "country_of_origin": "NL",
15  "value": 0.0,
16  "using_serial_numbers": false,
17  "article": {
18    "id": "f195e1e6-1558-4518-a34a-30783156b8c4",
19    "name": "1337",
20    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce"
21  }
22}