Developer documentation

Articles

Use the Articles API to create, retrieve, and update articles (products) and their variants.

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

Response models

These response models describe the objects returned by this resource.

The article model

Field	Description
`id` stringOptional	Read-only. Unique identifier for the article.
`customer` uuidOptional	-
`name` stringOptional	-
`variants` array of variantOptional	-
`created_at` datetimeOptional	Read-only.

List all articles

GET/wms/articles/

Retrieves a collection of articles

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

Field	Description
`article_code` stringOptional	Search for a specific article code.
`ean` stringOptional	Search for a specific EAN.
`sku` stringOptional	Search for a specific SKU.
`limit` integerOptional	Limit the number of results. Default is 50.
`page` integerOptional	The page number to retrieve.
`direction` stringOptional	Sort direction. Options: `asc` or `desc`. Default is `asc`.
`sort` stringOptional	You can sort on `createdAt` and `name`. Default is `name`.

Request examplecURL

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

Response exampleJSON

[
  {
    "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
      }
    ]
  },
  {
    "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
      }
    ]
  }
]

Retrieve an article

GET/wms/articles/:id/

Retrieve a single article.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL

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

Response exampleJSON

{
  "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
    }
  ]
}

Create an article

POST/wms/articles/

This endpoint allows you to add a new article

Try it

Send a live request against the development middleware using your current API test session.

POST

Request attributes

Field	Description	Example value
`name` stringRequired	Name of the article.
`variants` array of variantsOptional	One or more variants to attach to the article.	Not editable here

Request examplecURL

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 exampleJSON

{
  "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
    }
  ]
}

Create articles in bulk

POST/wms/articles/bulks/

This endpoint allows you to add new articles in bulk.

Try it

Send a live request against the development middleware using your current API test session.

POST

Request attributes

Field	Description	Example value
`articles` array of articlesRequired	Collection of article payloads to create in one request.	See nested fields below
Expand articles→ `articles[].name`stringRequired Name of each article in the bulk payload. `articles[].variants`array of variantsOptional Variants to create for each article. Not editable here

Request examplecURL

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 exampleJSON

{
  "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
    }
  ]
}

Update an article

PATCH/wms/articles/:id/

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

Try it

Send a live request against the development middleware using your current API test session.

PATCH

Path parameters

Request attributes

Field	Description	Example value
`name` stringOptional	Updated name for the article.

Request examplecURL

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 exampleJSON

{
  "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
    }
  ]
}