Inbounds

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

The inbound model

Properties

Name
id
Type
string
Readonly
readonly
Description
Unique identifier for the inbound.
Name
customer
Type
uuid
Description
Name
is_return
Type
bool
Description
Name
created_at
Type
datetime
Readonly
readonly
Description
Name
reference
Type
string
Readonly
readonly
Description
Name
external_reference
Type
string
Description
Name
status
Type
string
Readonly
readonly
Description
Name
inbound_date
Type
date
Description
Name
note
Type
string
Description
Name
inbound_lines
Type
array of inbound lines
Description
Name
meta_data
Type
array
Description
An object of key-value pairs.
Retrieve all available metadata that are associated with this inbound. Metadata is a valuable tool for making your inbound management more flexible and insightful. Metadata allows you to customize your inbound data to suit your unique business requirements.

The inbound line model

Properties

Name
variant
Type
Variant
Description
Name
quantity
Type
integer
Description
Name
processed
Type
integer
Description
Name
packing_slip
Type
integer
Description
Name
meta_data
Type
array
Description
An object of key-value pairs.
Retrieve all available metadata that are associated with this inbound line. Metadata is a valuable tool for making your inbound management more flexible and insightful. Metadata allows you to customize your inbound line data to suit your unique business requirements.

The meta data model

Meta data is available for both inbound and inbound lines. Make sure you add 'meta_data' within the expand header

We will throw an error when identical inbound lines are being merged and each line consists of meta_data

Properties

Name
{key: value}
Type
object
Description
An object of key-value pairs.

Example

GET

/wms/inbounds/

[
    {
        "meta_data": {
            "external_inbound_id": "5502369235240",
            "foo": "dev"
        }
    }
]

GET/wms/inbounds/

List all inbounds

Retrieves a collection of inbounds

Optional attributes

Name
reference
Type
string
Description
Search for a specific reference.
Name
status
Type
string
Description
Search for a specific status.
Name
type
Type
string
Description
Search for a specific type. Options: import | announced | unannounced.
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
- status
- modifiedAt
- inboundDate
Default
Default: inboundDate

Request

GET

/wms/inbounds/

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

Response

[
    {
        "id": "15dca9c4-eed3-452f-8bfb-015aefb45f6b",
        "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
        "created_at": "2022-07-07T17:03:27+00:00",
        "reference": "INB00000000001",
        "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
        "status": "completed",
        "inbound_date": "2022-07-07T17:03:28+00:00",
        "note": null
    },
    {
        "id": "a531b110-48f4-410a-98f8-053051130016",
        "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
        "created_at": "2022-07-07T17:03:27+00:00",
        "reference": "INB00000000002",
        "external_reference": "INITIAL_STOCK_2016-11-23-09-05-02a",
        "status": "completed",
        "inbound_date": "2022-07-07T17:03:28+00:00",
        "note": null
    }
]

GET/wms/inbounds/:id/

Retrieve an inbound

Retrieve a single inbound.

Request

GET

/wms/inbounds/:id/

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

Response

{
    "id": "03ed9a0a-812a-42e2-b622-f0fd7fc9e906",
    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
    "created_at": "2022-07-07T17:03:27+00:00",
    "reference": "INB00000000001",
    "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
    "status": "completed",
    "inbound_date": "2022-07-07T17:03:28+00:00",
    "note": null,
    "inbound_lines": [
        {
            "variant": {
                "id": "108af557-3614-42fa-8bd5-7662e47e1927",
                "article_code": "6047",
                "name": "6047",
                "description": null,
                "ean": "6047",
                "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": 0.0
            },
            "quantity": 30,
            "processed": null,
            "packing_slip": 30
        }
    ]
}

POST/wms/inbounds/

Create an inbound

This endpoint allows you to add a new inbound

Required attributes

Name
external_reference
Type
string
Description
Name
inbound_lines
Type
array of inbound lines
Description
Name
inbound_date
Type
date
Description

Optional attributes

Name
meta_data
Type
array
Description

Request

POST

/wms/inbounds/

curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/' \
-H 'Content-Type: application/json' \
--data-raw '{
    "external_reference": "1560520952",
    "note": "Priority Inbound",
    "inbound_date": "2018-11-14",
    "inbound_lines": [
        {
            "quantity": 30,
            "packing_slip": 30,
            "article_code": "VBP_C"
        },
        {
            "quantity": 20,
            "packing_slip": 30,
            "article_code": "VBP_B"
        }
    ]
}'

Response

{
    "external_reference": "1560520952",
    "note": "Priority Inbound",
    "inbound_date": "2018-11-14",
    "inbound_lines": [
        {
            "quantity": 30,
            "packing_slip": 30,
            "article_code": "VBP_C"
        },
        {
            "quantity": 20,
            "packing_slip": 30,
            "article_code": "VBP_B"
        }
    ]
}

PATCH/wms/inbounds/:id/

Update an inbound

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

Request

PATCH

/wms/inbounds/:id/

curl -X PATCH https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/774bf6ee-90cf-11e9-b36d-0242ac120005/ \
--data-raw '{
"note": "Update Note"
}'

Response

{
    "id": "4fdb3055-4b1d-4352-96d5-2a89f9f50680",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "created_at": "2022-10-27T13:14:45+00:00",
    "reference": "INB00000000272",
    "external_reference": "PO-1569",
    "status": "announced",
    "inbound_date": "2022-12-30T00:00:00+00:00",
    "note": "Update Note",
    "inbound_lines": [
        {
            "variant": {
                "id": "5060691c-2812-48e2-bd07-82ff3fd19382"
            },
            "quantity": 30,
            "processed": null,
            "packing_slip": 30
        },
        {
            "variant": {
                "id": "b04f5233-9980-4307-bb20-bc7460b49933"
            },
            "quantity": 20,
            "processed": null,
            "packing_slip": 20
        }
    ]
}

PATCH/wms/inbounds/:id/cancel/

Cancel an inbound

This endpoint allows you to perform cancel an inbound.

Request

PATCH

/wms/inbounds/:id/cancel/

curl -X PATCH https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/774bf6ee-90cf-11e9-b36d-0242ac120005/cancel/

GET/wms/inbounds/:id/quality-controls/

List quality controls for inbound

List quality controls for a single inbound.

Request

GET

/wms/inbounds/:id/quality-controls/

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

Response

[
    {
        "id": "cac4da93-355a-4ffc-916e-5f3577cbd188",
        "created_at": "2023-07-05T12:54:24+00:00",
        "pallet_count": "150",
        "was_delivery_appointment": true,
        "had_packing_list": true,
        "was_correct_quantity": true,
        "had_proper_markings": true,
        "box_condition": "good",
        "comments": "Everything looked good.",
        "documents": [
            {
                "id": "880b668f-2748-4e18-92e1-5c836cea40f4",
                "title": "dummy.jpeg",
                "mime_type": "image/jpeg",
                "created_at": "2023-07-25T12:30:54+00:00"
            }
        ]
    }
]