Home page
GitHub

Articles

The article resource lets you update and create products in the WMS. An article must contain at least one, or more, variants.

Article resource

Properties

idstringreadonly

Unique UUID identifier for the article resource.

namestring
customerstring
variantsarray of variants

GET Collection

Retrieves a list of articles.

Query parameters

article_codestring

Filter by article code

eanstring

Filter by ean

skustring

Filter by sku

limitint

Limits the amount of results

pageint

Only works in combination with limit

fromstring

Accepts date format %Y-%m-%d. IE: 2022-10-22

tostring

Accepts date format %Y-%m-%d. IE: 2022-10-22

directionstring

asc | desc

Example

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

Response

1[
2  {
3    "id": "bb275439-1e18-490f-85f5-d26c6cf93ca8",
4    "name": "T-shirt",
5    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
6    "variants": [
7      {
8        "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
9        "article_code": "VBTS_001",
10        "name": "Blauw",
11        "description": "T-shirt - Blauw",
12        "ean": "8710400311141",
13        "sku": "VBTS_001",
14        "hs_tariff_code": "54353453",
15        "height": null,
16        "depth": 0,
17        "width": 100,
18        "weight": null,
19        "expirable": false,
20        "country_of_origin": null,
21        "using_serial_numbers": false,
22        "value": 0.0
23      }
24    ]
25  },
26  {
27    "id": "295c3cc4-5899-486f-9c9c-9a6b1025c998",
28    "name": "Broek",
29    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
30    "variants": [
31      {
32        "id": "cdb36dc6-c8e5-4ee4-afd9-fc0caa801bb3",
33        "article_code": "VBB_001",
34        "name": "Zwart",
35        "description": "Broek - Zwart",
36        "ean": "8710400311144",
37        "sku": null,
38        "hs_tariff_code": "54353454",
39        "height": 10,
40        "depth": null,
41        "width": null,
42        "weight": null,
43        "expirable": false,
44        "country_of_origin": null,
45        "using_serial_numbers": false,
46        "value": null
47      }
48    ]
49  }
50]

GET Single

Retrieve a single article.

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/ef1a3696-fe0a-4be4-8328-8ccf4589dfa9' \
2--header 'Expand: variants'

Response

1{
2  "id": "bb275439-1e18-490f-85f5-d26c6cf93ca8",
3  "name": "T-shirt",
4  "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
5  "variants": [
6    {
7      "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
8      "article_code": "VBTS_001",
9      "name": "Blauw",
10      "description": "T-shirt - Blauw",
11      "ean": "8710400311141",
12      "sku": "VBTS_001",
13      "hs_tariff_code": "54353453",
14      "height": null,
15      "depth": 0,
16      "width": 100,
17      "weight": null,
18      "expirable": false,
19      "country_of_origin": null,
20      "using_serial_numbers": false,
21      "value": 0.0
22    }
23  ]
24}

POST Create

Creates a new article. You can create an article with multiple variants within the same call.

Parameters

namerequiredstring

variants[]requiredarray

Array of variants

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/' \
2--header 'X-Customer-Code: AMZN' \
3--header 'X-Wms-Code: DEV' \
4--header 'Expand: variant' \
5--data-raw '{
6	"name": "Jacket",
7    "variants": [
8        {
9            "name": "Yellow",
10            "article_code": "yellow_jacket"
11        },
12        {
13            "name": "Green",
14            "description": "The best green jacket ever created",
15            "article_code": "green_jacket",
16            "ean": "8710400311142",
17            "sku": "green_jacket",
18            "hs_tariff_code": "54353453",
19            "height": 40,
20            "depth": 40,
21            "width": 40,
22            "weight": 400,
23            "expirable": false,
24            "country_of_origin": "NL",
25            "using_serial_numbers": false,
26            "value": 50.45
27        }
28    ]
29  }'

Response

1{
2  "id": "ef1a3696-fe0a-4be4-8328-8ccf4589dfa9",
3  "name": "Jacket",
4  "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
5  "variants": [
6    {
7      "id": "2c247dad-12f1-4f07-a502-229923f36c30",
8      "article_code": "yellow_jacket",
9      "name": "Yellow",
10      "description": null,
11      "ean": null,
12      "sku": null,
13      "hs_tariff_code": null,
14      "height": null,
15      "depth": null,
16      "width": null,
17      "weight": null,
18      "expirable": false,
19      "country_of_origin": null,
20      "using_serial_numbers": false,
21      "value": null
22    },
23    {
24      "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
25      "article_code": "green_jacket",
26      "name": "Green",
27      "description": "The best green jacket ever created",
28      "ean": "8710400311142",
29      "sku": "green_jacket",
30      "hs_tariff_code": "54353453",
31      "height": 40,
32      "depth": 40,
33      "width": 40,
34      "weight": 400,
35      "expirable": false,
36      "country_of_origin": "NL",
37      "using_serial_numbers": false,
38      "value": 50.45
39    }
40  ]
41}

POST Bulk Create

Creates new articles in bulk. You can create multiple articles with multiple variants within the same call.

Parameters

articles[]requiredarray

Array of articles

articlesarray

Array of articles

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/bulks/' \
2--header 'X-Customer-Code: AMZN' \
3--header 'X-Wms-Code: DEV' \
4--header 'Expand: variant' \
5--data-raw '{
6    "articles": [
7        {
8            "name": "Jackets",
9            "variants": [
10                {
11                    "name": "Yellow",
12                    "article_code": "yellow_jacket"
13                },
14                {
15                  "article_code": "green_jacket",
16                  "name": "Green",
17                  "description": "The best green jacket ever created",
18                  "ean": "8710400311142",
19                  "sku": "green_jacket",
20                  "hs_tariff_code": "54353453",
21                  "height": 40,
22                  "depth": 40,
23                  "width": 40,
24                  "weight": 400,
25                  "expirable": false,
26                  "country_of_origin": "NL",
27                  "using_serial_numbers": false,
28                  "value": 50.45
29                }
30            ]
31        },
32        {
33            "name": "Shoes",
34            "variants": [
35                {
36                    "name": "Yellow",
37                    "article_code": "yellow_shoe"
38                },
39                {
40                    "name": "Green",
41                    "description": "The best green shoes ever created",
42                    "article_code": "green_shoe",
43                    "ean": "8710400311144",
44                    "sku": "green_shoe",
45                    "hs_tariff_code": "123456789",
46                    "height": 10,
47                    "depth": 10,
48                    "width": 10,
49                    "weight": 400,
50                    "expirable": false,
51                    "country_of_origin": "FR",
52                    "using_serial_numbers": false,
53                    "value": 100
54                }
55            ]
56        }
57    ]
58}'

PATCH Update

Update an existing article.

Parameters

namestring

Example

1curl --location -g --request PATCH 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/ef1a3696-fe0a-4be4-8328-8ccf4589dfa9' \
2--header 'Content-Type: application/json' \
3--data-raw '{
4	"name": "New name for article"
5}'

Response

1{
2  "id": "ef1a3696-fe0a-4be4-8328-8ccf4589dfa9",
3  "name": "New name for article",
4  "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
5  "variants": [
6    {
7      "id": "2c247dad-12f1-4f07-a502-229923f36c30",
8      "article_code": "yellow_jacket",
9      "name": "Yellow",
10      "description": null,
11      "ean": null,
12      "sku": null,
13      "hs_tariff_code": null,
14      "height": null,
15      "depth": null,
16      "width": null,
17      "weight": null,
18      "expirable": false,
19      "country_of_origin": null,
20      "using_serial_numbers": false,
21      "value": null
22    },
23    {
24      "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
25      "article_code": "green_jacket",
26      "name": "Green",
27      "description": "The best green jacket ever created",
28      "ean": "8710400311142",
29      "sku": "green_jacket",
30      "hs_tariff_code": "54353453",
31      "height": 40,
32      "depth": 40,
33      "width": 40,
34      "weight": 400,
35      "expirable": false,
36      "country_of_origin": "NL",
37      "using_serial_numbers": false,
38      "value": 50.45
39    }
40  ]
41}
Next
Getting started →