GitHub

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.


Modification resource

Properties

idstringreadonly

Unique UUID identifier for the modification resource.

created_atdatetime
referencestring
reasonstring

LOST | DEFECTIVE | CORRECTION

statusstring

created | approved | disapproved

notestring

Modification Line Properties

variantobject
locationobject
quantityint

GET Collection

Retrieves a collection of modifications.

Query parameters

statusstring

created | approved | disapproved

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/modifications/' \
2--header 'X-Customer-Code: AMZN' \
3--header 'X-Wms-Code: DEV'

Response

1[
2 {
3 "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
4 "created_at": "2022-04-25T08:32:52+00:00",
5 "reference": "MOD00000000006",
6 "reason": "CORRECTION",
7 "status": "approved",
8 "note": "Coffee spilled over jacket"
9 },
10 {
11 "id": "058508a3-f7eb-4e99-b134-6f22002ede43",
12 "created_at": "2021-12-22T09:08:28+00:00",
13 "reference": "MOD00000000004",
14 "reason": "CORRECTION",
15 "status": "created",
16 "note": "Create correction"
17 }
18]

GET Single

Retrieves a single modification.

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/modifications/cd708aa1-2e45-402f-b92b-55bc8c97b5db' \
2--header 'X-Customer-Code: AMZN' \
3--header 'X-Wms-Code: DEV'

Response

1{
2 "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
3 "created_at": "2022-04-25T08:32:52+00:00",
4 "reference": "MOD00000000006",
5 "reason": "CORRECTION",
6 "status": "approved",
7 "note": "Koffie over het jacket heen gevallen",
8 "modification_lines": [
9 {
10 "variant": {
11 "id": "f9cc7e9c-7ac2-45df-b4a3-1a19321c144d",
12 "article_code": "green_jacket",
13 "name": "Green",
14 "description": "The best green jacket ever created",
15 "ean": "123",
16 "sku": null,
17 "hs_tariff_code": "123456789",
18 "height": 40,
19 "depth": 40,
20 "width": 40,
21 "weight": 400,
22 "expirable": false,
23 "country_of_origin": "NL",
24 "using_serial_numbers": false,
25 "value": 50.45
26 },
27 "location": {
28 "id": "ecb6ad58-4e43-401f-a0e1-51a5fa53704d"
29 },
30 "quantity": -1
31 }
32 ]
33}

POST Create

Creates a new modification. You can create a modification with multiple modification lines.

Parameters

notestring

reasonstring

LOST | DEFECTIVE | CORRECTION

modification_lines[]array

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/modifications/' \
2--header 'Expand: modification_lines, variant' \
3--data-raw '{
4 "note": "Koffie over het jacket heen gevallen",
5 "reason": "CORRECTION",
6 "modification_lines": [
7 {
8 "quantity": -1,
9 "variant": "f2894c16-399e-4ca1-9151-489775a6519c",
10 "location": "a875f7fb-415c-4c0b-bc84-c1f2de25a246"
11 }
12 ]
13 }'

Response

1{
2 "id": "cd708aa1-2e45-402f-b92b-55bc8c97b5db",
3 "created_at": "2022-04-25T08:32:52+00:00",
4 "reference": "MOD00000000006",
5 "reason": "CORRECTION",
6 "status": "created",
7 "note": "Koffie over het jacket heen gevallen",
8 "modification_lines": [
9 {
10 "variant": {
11 "id": "f2894c16-399e-4ca1-9151-489775a6519c",
12 "article_code": "green_jacket",
13 "name": "Green",
14 "description": "The best green jacket ever created",
15 "ean": "123",
16 "sku": null,
17 "hs_tariff_code": "123456789",
18 "height": 40,
19 "depth": 40,
20 "width": 40,
21 "weight": 400,
22 "expirable": false,
23 "country_of_origin": "NL",
24 "using_serial_numbers": false,
25 "value": 50.45
26 },
27 "location": {
28 "id": "a875f7fb-415c-4c0b-bc84-c1f2de25a246"
29 },
30 "quantity": -1
31 }
32 ]
33}