Batches

The batch model

Properties

Name
id
Type
string
Readonly
readonly
Description
Name
expiration_date
Type
date
Description
Expiration date of the batch.
Name
quantity
Type
integer
Description
Name
variant
Type
Variant
Description
Name
inbound
Type
Inbound
Description

GET/wms/batches/

List all batches

Retrieves a collection of batches

Optional attributes

Name
article_code
Type
string
Description
Search for a specific article code.
Name
ean
Type
string
Description
Search for a specific ean.
Name
sku
Type
string
Description
Search for a specific sku.
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
- id
Default
Default: id

Request

GET

/wms/batches/

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

Response

[
    {
        "id": "f7827cad-f857-4ebb-aba4-c5116bd6bbc9",
        "expiration_date": null,
        "quantity": 10,
        "variant": {
            "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
            "article_code": "VBP_A",
            "name": "VBP_A",
            "description": "VBP_A",
            "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
        },
        "inbound": {
            "id": "6784554e-98ac-4528-8a62-72f933d34ba9",
            "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
            "created_at": "2022-04-14T13:03:56+00:00",
            "reference": "INB00000000179",
            "external_reference": "VB_INB_001AAA",
            "status": "process_no_announcement",
            "inbound_date": "2022-04-14T00:00:00+00:00",
            "note": null,
            "inbound_lines": [
                {
                    "variant": {
                        "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
                        "article_code": "VBP_A",
                        "name": "VBP_A",
                        "description": "VBP_A",
                        "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
                    },
                    "quantity": 10,
                    "processed": 10,
                    "packing_slip": null
                }
            ]
        }
    },
    {
        "id": "edeeb31e-01f2-4620-b6cb-2cd1c3e5a3f2",
        "expiration_date": null,
        "quantity": 3999,
        "variant": {
            "id": "20664efa-ec55-4eaf-a7ad-a05157b9d3da",
            "article_code": "papier123",
            "name": "papier123",
            "description": null,
            "ean": "papier123",
            "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
        },
        "inbound": {
            "id": "0caa1ab0-f2f5-4a7f-a3b7-6ebfe3098b87",
            "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
            "created_at": "2022-04-22T10:15:03+00:00",
            "reference": "INB00000000187",
            "external_reference": "ADD_SANDBOX_STOCK_2022-04-22-10-15-03",
            "status": "completed",
            "inbound_date": "2022-04-22T10:15:03+00:00",
            "note": null,
            "inbound_lines": [
                {
                    "variant": {
                        "id": "20664efa-ec55-4eaf-a7ad-a05157b9d3da",
                        "article_code": "papier123",
                        "name": "papier123",
                        "description": null,
                        "ean": "papier123",
                        "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": 4000,
                    "processed": 4000,
                    "packing_slip": 4000
                }
            ]
        }
    }
]

GET/wms/batches/:id/

Retrieve a batch

Retrieve a single batch.

Request

GET

/wms/batches/:id/

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

Response

{
    "id": "e710389a-5505-49d4-9b99-8314f3543427",
    "expiration_date": null,
    "quantity": 1650,
    "variant": {
        "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
        "article_code": "default_variant_a_id",
        "name": "default_variant_a_id",
        "description": null,
        "ean": "default_variant_a_id",
        "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
    },
    "inbound": {
        "id": "f3f9950e-28a6-42f7-ac5c-80df7b1933c9",
        "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
        "created_at": "2021-11-24T10:09:09+00:00",
        "reference": "INB00000000001",
        "external_reference": "INITIAL_STOCK_2021-11-24-10-09-09",
        "status": "completed",
        "inbound_date": "2021-11-24T10:09:09+00:00",
        "note": null
    }
}