Articles

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

The article model

Properties

Name
id
Type
string
Readonly
readonly
Description
Unique identifier for the article.
Name
customer
Type
uuid
Description
Name
name
Type
string
Description
Name
variants
Type
array of variant
Description
Name
created_at
Type
datetime
Readonly
readonly
Description
Name
modified_at
Type
datetime
Readonly
readonly
Description

GET/wms/articles/

List all articles

Retrieves a collection of articles

Optional attributes

Name
article_code
Type
string
Description
Search for a specific article code.
Name
ean
Type
string
Description
Search for a specific ean.
Name
sku
Type
string
Description
Search for a specific sku.
Name
limit
Type
integer
Description
Limits the amount of results.
Name
page
Type
integer
Description
Only works in combination with the limit attribute.
Name
from
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
to
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
direction
Type
string
Description
Sort direction. Options: asc | desc
Default
Default: asc
Name
sort
Type
string
Description
You can sort on the following fields:
- createdAt
- name
Default
Default: name

Request

GET

/wms/articles/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/

Response

[
    {
        "id": "bb275439-1e18-490f-85f5-d26c6cf93ca8",
        "name": "T-shirt",
        "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
        "variants": [
            {
                "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
                "article_code": "VBTS_001",
                "name": "Blauw",
                "description": "T-shirt - Blauw",
                "ean": "8710400311141",
                "sku": "VBTS_001",
                "hs_tariff_code": "54353453",
                "height": null,
                "depth": 0,
                "width": 100,
                "weight": null,
                "expirable": false,
                "country_of_origin": null,
                "using_serial_numbers": false,
                "value": 0.0
            }
        ]
    },
    {
        "id": "295c3cc4-5899-486f-9c9c-9a6b1025c998",
        "name": "Broek",
        "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
        "variants": [
            {
                "id": "cdb36dc6-c8e5-4ee4-afd9-fc0caa801bb3",
                "article_code": "VBB_001",
                "name": "Zwart",
                "description": "Broek - Zwart",
                "ean": "8710400311144",
                "sku": null,
                "hs_tariff_code": "54353454",
                "height": 10,
                "depth": null,
                "width": null,
                "weight": null,
                "expirable": false,
                "country_of_origin": null,
                "using_serial_numbers": false,
                "value": null
            }
        ]
    }
]

GET/wms/articles/:id/

Retrieve an article

Retrieve a single article.

Request

GET

/wms/articles/:id/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/e710389a-5505-49d4-9b99-8314f3543427

Response

{
    "id": "bb275439-1e18-490f-85f5-d26c6cf93ca8",
    "name": "T-shirt",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
        "variants": [
        {
            "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
            "article_code": "VBTS_001",
            "name": "Blauw",
            "description": "T-shirt - Blauw",
            "ean": "8710400311141",
            "sku": "VBTS_001",
            "hs_tariff_code": "54353453",
            "height": null,
            "depth": 0,
            "width": 100,
            "weight": null,
            "expirable": false,
            "country_of_origin": null,
            "using_serial_numbers": false,
            "value": 0.0
        }
    ]
}

POST/wms/articles/

Create an article

This endpoint allows you to add a new article

Required attributes

Name
name
Type
string
Description

Optional attributes

Name
variants
Type
array of variants
Description

Request

POST

/wms/articles/

curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/' \
-H 'Content-Type: application/json' \
--data-raw '{
"name": "Jacket",
"variants": [
    {
        "name": "Yellow",
        "article_code": "yellow_jacket"
    },
    {
        "name": "Green",
        "description": "The best green jacket ever created",
        "article_code": "green_jacket",
        "ean": "8710400311142",
        "sku": "green_jacket",
        "hs_tariff_code": "54353453",
        "height": 40,
        "depth": 40,
        "width": 40,
        "weight": 400,
        "expirable": false,
        "country_of_origin": "NL",
        "using_serial_numbers": false,
        "value": 50.45
    }
]
}'

Response

{
    "id": "ef1a3696-fe0a-4be4-8328-8ccf4589dfa9",
    "name": "Jacket",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "variants": [
        {
            "id": "2c247dad-12f1-4f07-a502-229923f36c30",
            "article_code": "yellow_jacket",
            "name": "Yellow",
            "description": null,
            "ean": null,
            "sku": null,
            "hs_tariff_code": null,
            "height": null,
            "depth": null,
            "width": null,
            "weight": null,
            "expirable": false,
            "country_of_origin": null,
            "using_serial_numbers": false,
            "value": null
        },
        {
            "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
            "article_code": "green_jacket",
            "name": "Green",
            "description": "The best green jacket ever created",
            "ean": "8710400311142",
            "sku": "green_jacket",
            "hs_tariff_code": "54353453",
            "height": 40,
            "depth": 40,
            "width": 40,
            "weight": 400,
            "expirable": false,
            "country_of_origin": "NL",
            "using_serial_numbers": false,
            "value": 50.45
        }
    ]
}

POST/wms/articles/bulks/

Create articles in bulk

This endpoint allows you to add new articles in bulk.

Required attributes

Name
name
Type
string
Description

Optional attributes

Name
variants
Type
array of variants
Description

Request

POST

/wms/articles/bulks/

curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/' \
-H 'Content-Type: application/json' \
--data-raw '{
"articles": [
    {
        "name": "Jackets",
        "variants": [
            {
                "name": "Yellow",
                "article_code": "yellow_jacket"
            },
            {
                "article_code": "green_jacket",
                "name": "Green",
                "description": "The best green jacket ever created",
                "ean": "8710400311142",
                "sku": "green_jacket",
                "hs_tariff_code": "54353453",
                "height": 40,
                "depth": 40,
                "width": 40,
                "weight": 400,
                "expirable": false,
                "country_of_origin": "NL",
                "using_serial_numbers": false,
                "value": 50.45
            }
        ]
    },
    {
        "name": "Shoes",
        "variants": [
            {
                "name": "Yellow",
                "article_code": "yellow_shoe"
            },
            {
                "name": "Green",
                "description": "The best green shoes ever created",
                "article_code": "green_shoe",
                "ean": "8710400311144",
                "sku": "green_shoe",
                "hs_tariff_code": "123456789",
                "height": 10,
                "depth": 10,
                "width": 10,
                "weight": 400,
                "expirable": false,
                "country_of_origin": "FR",
                "using_serial_numbers": false,
                "value": 100
            }
        ]
    }
]
}'

Response

{
    "id": "ef1a3696-fe0a-4be4-8328-8ccf4589dfa9",
    "name": "Jacket",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "variants": [
        {
            "id": "2c247dad-12f1-4f07-a502-229923f36c30",
            "article_code": "yellow_jacket",
            "name": "Yellow",
            "description": null,
            "ean": null,
            "sku": null,
            "hs_tariff_code": null,
            "height": null,
            "depth": null,
            "width": null,
            "weight": null,
            "expirable": false,
            "country_of_origin": null,
            "using_serial_numbers": false,
            "value": null
        },
        {
            "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
            "article_code": "green_jacket",
            "name": "Green",
            "description": "The best green jacket ever created",
            "ean": "8710400311142",
            "sku": "green_jacket",
            "hs_tariff_code": "54353453",
            "height": 40,
            "depth": 40,
            "width": 40,
            "weight": 400,
            "expirable": false,
            "country_of_origin": "NL",
            "using_serial_numbers": false,
            "value": 50.45
        }
    ]
}

PATCH/wms/articles/:id/

Update an article

This endpoint allows you to perform an update on an article.

Request

PATCH

/wms/articles/:id/

curl -X PATCH
https://eu-dev.middleware.ewarehousing-solutions.com/wms/articles/774bf6ee-90cf-11e9-b36d-0242ac120005/ \
--data-raw '{
    "name": "New name for article"
}'

Response

{
    "id": "ef1a3696-fe0a-4be4-8328-8ccf4589dfa9",
    "name": "New name for article",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "variants": [
        {
            "id": "2c247dad-12f1-4f07-a502-229923f36c30",
            "article_code": "yellow_jacket",
            "name": "Yellow",
            "description": null,
            "ean": null,
            "sku": null,
            "hs_tariff_code": null,
            "height": null,
            "depth": null,
            "width": null,
            "weight": null,
            "expirable": false,
            "country_of_origin": null,
            "using_serial_numbers": false,
            "value": null
        },
        {
            "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
            "article_code": "green_jacket",
            "name": "Green",
            "description": "The best green jacket ever created",
            "ean": "8710400311142",
            "sku": "green_jacket",
            "hs_tariff_code": "54353453",
            "height": 40,
            "depth": 40,
            "width": 40,
            "weight": 400,
            "expirable": false,
            "country_of_origin": "NL",
            "using_serial_numbers": false,
            "value": 50.45
        }
    ]
}