Modifications

Modifications are used to adjust product inventory for one or more products. A reason for a modification can be a stock correction or a defect product.

The modification model

Properties

Name
id
Type
string
Readonly
readonly
Description
Name
reference
Type
string
Description
Name
reason
Type
string
Description
Name
status
Type
string
Description
Name
note
Type
string
Description
Name
created_at
Type
datetime
Readonly
readonly
Description
Name
modified_at
Type
datetime
Readonly
readonly
Description

The modification line model

Properties

Name
variant
Type
Variant
Description
Name
location
Type
object
Description
Name
quantity
Type
integer
Description

GET/wms/modifications/

List all modifications

Retrieves a collection of modifications

Optional attributes

Name
status
Type
string
Description
Options: created | approved | disapproved
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: desc
Name
sort
Type
string
Description
You can sort on the following fields:
- createdAt
- reference
Default
Default: reference

Request

GET

/wms/modifications/

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

Response

[
{
    "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
    "created_at": "2022-04-25T08:32:52+00:00",
    "reference": "MOD00000000006",
    "reason": "CORRECTION",
    "status": "approved",
    "note": "Coffee spilled over jacket"
},
{
    "id": "058508a3-f7eb-4e99-b134-6f22002ede43",
    "created_at": "2021-12-22T09:08:28+00:00",
    "reference": "MOD00000000004",
    "reason": "CORRECTION",
    "status": "created",
    "note": "Create correction"
}
]

GET/wms/modifications/:id/

Retrieve a modification

Retrieve a single modification.

Request

GET

/wms/modifications/:id/

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

Response

{
    "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
    "created_at": "2022-04-25T08:32:52+00:00",
    "reference": "MOD00000000006",
    "reason": "CORRECTION",
    "status": "approved",
    "note": "Koffie over het jacket heen gevallen",
    "modification_lines": [
        {
            "variant": {
                "id": "f9cc7e9c-7ac2-45df-b4a3-1a19321c144d",
                "article_code": "green_jacket",
                "name": "Green",
                "description": "The best green jacket ever created",
                "ean": "123",
                "sku": null,
                "hs_tariff_code": "123456789",
                "height": 40,
                "depth": 40,
                "width": 40,
                "weight": 400,
                "expirable": false,
                "country_of_origin": "NL",
                "using_serial_numbers": false,
                "value": 50.45
            },
            "location": {
                "id": "ecb6ad58-4e43-401f-a0e1-51a5fa53704d"
            },
            "quantity": -1
        }
    ]
}

POST/wms/modification/

Create a modification

This endpoint allows you to add a new modification

Required attributes

Name
note
Type
string
Description
Name
modification_lines
Type
array of modification lines
Description
Name
reason
Type
string
Description
Options: LOST | DEFECTIVE | CORRECTION"

Request

POST

/wms/modifications/

curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/modifications/' \
-H 'Content-Type: application/json' \
--data-raw '{
"note": "Koffie over het jacket heen gevallen",
"reason": "CORRECTION",
"modification_lines": [
    {
        "quantity": -1,
        "variant": "f2894c16-399e-4ca1-9151-489775a6519c",
        "location": "a875f7fb-415c-4c0b-bc84-c1f2de25a246"
    }
]
}'

Response

{
    "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
    "created_at": "2022-04-25T08:32:52+00:00",
    "reference": "MOD00000000006",
    "reason": "CORRECTION",
    "status": "created",
    "note": "Koffie over het jacket heen gevallen",
    "modification_lines": [
        {
            "variant": {
                "id": "f2894c16-399e-4ca1-9151-489775a6519c",
                "article_code": "green_jacket",
                "name": "Green",
                "description": "The best green jacket ever created",
                "ean": "123",
                "sku": null,
                "hs_tariff_code": "123456789",
                "height": 40,
                "depth": 40,
                "width": 40,
                "weight": 400,
                "expirable": false,
                "country_of_origin": "NL",
                "using_serial_numbers": false,
                "value": 50.45
            },
            "location": {
                "id": "a875f7fb-415c-4c0b-bc84-c1f2de25a246"
            },
            "quantity": -1
        }
    ]
}