Home page
GitHub

Inbounds

Inbounds are used to determine what goods / articles are brought into the warehouse.

Inbound resource

Inbound properties

idstringreadonly

Unique UUID identifier for the inbound resource.

customerstring
created_atdatetime
referencestringreadonly
external_referencestring
statusstringreadonly

announced | processing | process_no_announcement | on_hold | transfer | awaiting_transfer | cancelled | completed

inbound_datedatetime
notestring
inbound_lines[]array

Inbound Line properties

variantobject
quantityint
processedint
packing_slipint

GET Collection

Retrieves a collection of inbounds.

Query parameters

referencestring

Filter by reference

statusstring

announced | processing | process_no_announcement | on_hold | transfer | awaiting_transfer | cancelled | completed

typestring

import | announced | unannounced

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/inbounds'

Response

1[
2  {
3    "id": "15dca9c4-eed3-452f-8bfb-015aefb45f6b",
4    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
5    "created_at": "2022-07-07T17:03:27+00:00",
6    "reference": "INB00000000001",
7    "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
8    "status": "completed",
9    "inbound_date": "2022-07-07T17:03:28+00:00",
10    "note": null
11  },
12  {
13    "id": "a531b110-48f4-410a-98f8-053051130016",
14    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
15    "created_at": "2022-07-07T17:03:27+00:00",
16    "reference": "INB00000000002",
17    "external_reference": "INITIAL_STOCK_2016-11-23-09-05-02a",
18    "status": "completed",
19    "inbound_date": "2022-07-07T17:03:28+00:00",
20    "note": null
21  }
22]

GET Single

Retrieves a single inbound.

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/03ed9a0a-812a-42e2-b622-f0fd7fc9e906'

Response

1{
2  "id": "03ed9a0a-812a-42e2-b622-f0fd7fc9e906",
3  "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
4  "created_at": "2022-07-07T17:03:27+00:00",
5  "reference": "INB00000000001",
6  "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
7  "status": "completed",
8  "inbound_date": "2022-07-07T17:03:28+00:00",
9  "note": null,
10  "inbound_lines": [
11    {
12      "variant": {
13        "id": "108af557-3614-42fa-8bd5-7662e47e1927",
14        "article_code": "6047",
15        "name": "6047",
16        "description": null,
17        "ean": "6047",
18        "sku": null,
19        "hs_tariff_code": null,
20        "height": null,
21        "depth": null,
22        "width": null,
23        "weight": null,
24        "expirable": false,
25        "country_of_origin": null,
26        "using_serial_numbers": false,
27        "value": 0.0
28      },
29      "quantity": 30,
30      "processed": null,
31      "packing_slip": 30
32    },
33}

POST Create

Creates a new inbound.

Parameters

external_referencerequiredstring

inbound_lines[]array

inbound_datedate

notestring

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/' \
2--header 'Expand: inbound_lines' \
3--data-raw '{
4    "external_reference": "1560520952",
5    "note": "Priority Inbound",
6    "inbound_date": "2018-11-14",
7    "inbound_lines": [
8        {
9            "quantity": 30,
10            "article_code": "VBP_C"
11        },
12        {
13            "quantity": 20,
14            "article_code": "VBP_B"
15        }
16    ]
17}'

Response

1{
2  "external_reference": "1560520952",
3  "note": "Priority Inbound",
4  "inbound_date": "2018-11-14",
5  "inbound_lines": [
6    {
7      "quantity": 30,
8      "article_code": "VBP_C"
9    },
10    {
11      "quantity": 20,
12      "article_code": "VBP_B"
13    }
14  ]
15}

PATCH Update

Updates an existing inbound.

Parameters

notestring

Example

1curl --location --request PATCH 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/774bf6ee-90cf-11e9-b36d-0242ac120005/' \
2--header 'Expand: inbound_lines' \
3--data-raw '{
4	"note": "Update Note"
5}'
1{
2  "id": "4fdb3055-4b1d-4352-96d5-2a89f9f50680",
3  "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
4  "created_at": "2022-10-27T13:14:45+00:00",
5  "reference": "INB00000000272",
6  "external_reference": "PO-1569",
7  "status": "announced",
8  "inbound_date": "2022-12-30T00:00:00+00:00",
9  "note": "Update Note",
10  "inbound_lines": [
11    {
12      "variant": {
13        "id": "5060691c-2812-48e2-bd07-82ff3fd19382"
14      },
15      "quantity": 30,
16      "processed": null,
17      "packing_slip": 30
18    },
19    {
20      "variant": {
21        "id": "b04f5233-9980-4307-bb20-bc7460b49933"
22      },
23      "quantity": 20,
24      "processed": null,
25      "packing_slip": 20
26    }
27  ]
28}

PATCH Cancel

Cancels an inbound.

Can only cancel an inbound when status is equal to: announced

Example

1curl --location --request PATCH 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/b6c01c80-2335-4765-9337-2d120197ae1b/cancel/'
Next
Getting started →