GitHub

Batches

Batch resource

Properties

idstringreadonly

Unique UUID identifier for the batch resource.

expiration_datedatetime
quantityint
variantobject
inboundobject

GET Collection

Retrieves a collection of batches.

Query parameters

article_codestring

Filter by article code

eanstring

Filter by ean

skustring

Filter by sku

positive_onlybool

Show only positive batches

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/batches/'

Response

1[
2 {
3 "id": "f7827cad-f857-4ebb-aba4-c5116bd6bbc9",
4 "expiration_date": null,
5 "quantity": 10,
6 "variant": {
7 "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
8 "article_code": "VBP_A",
9 "name": "VBP_A",
10 "description": "VBP_A",
11 "ean": null,
12 "sku": null,
13 "hs_tariff_code": null,
14 "height": null,
15 "depth": null,
16 "width": null,
17 "weight": null,
18 "expirable": false,
19 "country_of_origin": null,
20 "using_serial_numbers": false,
21 "value": null
22 },
23 "inbound": {
24 "id": "6784554e-98ac-4528-8a62-72f933d34ba9",
25 "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
26 "created_at": "2022-04-14T13:03:56+00:00",
27 "reference": "INB00000000179",
28 "external_reference": "VB_INB_001AAA",
29 "status": "process_no_announcement",
30 "inbound_date": "2022-04-14T00:00:00+00:00",
31 "note": null,
32 "inbound_lines": [
33 {
34 "variant": {
35 "id": "b80e4926-a6ba-4686-91ca-0b5b1c6933a2",
36 "article_code": "VBP_A",
37 "name": "VBP_A",
38 "description": "VBP_A",
39 "ean": null,
40 "sku": null,
41 "hs_tariff_code": null,
42 "height": null,
43 "depth": null,
44 "width": null,
45 "weight": null,
46 "expirable": false,
47 "country_of_origin": null,
48 "using_serial_numbers": false,
49 "value": null
50 },
51 "quantity": 10,
52 "processed": 10,
53 "packing_slip": null
54 }
55 ]
56 }
57 },
58 {
59 "id": "edeeb31e-01f2-4620-b6cb-2cd1c3e5a3f2",
60 "expiration_date": null,
61 "quantity": 3999,
62 "variant": {
63 "id": "20664efa-ec55-4eaf-a7ad-a05157b9d3da",
64 "article_code": "papier123",
65 "name": "papier123",
66 "description": null,
67 "ean": "papier123",
68 "sku": null,
69 "hs_tariff_code": null,
70 "height": null,
71 "depth": null,
72 "width": null,
73 "weight": null,
74 "expirable": false,
75 "country_of_origin": null,
76 "using_serial_numbers": false,
77 "value": 0.0
78 },
79 "inbound": {
80 "id": "0caa1ab0-f2f5-4a7f-a3b7-6ebfe3098b87",
81 "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
82 "created_at": "2022-04-22T10:15:03+00:00",
83 "reference": "INB00000000187",
84 "external_reference": "ADD_SANDBOX_STOCK_2022-04-22-10-15-03",
85 "status": "completed",
86 "inbound_date": "2022-04-22T10:15:03+00:00",
87 "note": null,
88 "inbound_lines": [
89 {
90 "variant": {
91 "id": "20664efa-ec55-4eaf-a7ad-a05157b9d3da",
92 "article_code": "papier123",
93 "name": "papier123",
94 "description": null,
95 "ean": "papier123",
96 "sku": null,
97 "hs_tariff_code": null,
98 "height": null,
99 "depth": null,
100 "width": null,
101 "weight": null,
102 "expirable": false,
103 "country_of_origin": null,
104 "using_serial_numbers": false,
105 "value": 0.0
106 },
107 "quantity": 4000,
108 "processed": 4000,
109 "packing_slip": 4000
110 }
111 ]
112 }
113 },
114]

GET Single

Retrieve a single batch.

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

Response

1{
2 "id": "e710389a-5505-49d4-9b99-8314f3543427",
3 "expiration_date": null,
4 "quantity": 1650,
5 "variant": {
6 "id": "1e19da60-4d2b-4c15-8f4e-8978f6113c00",
7 "article_code": "default_variant_a_id",
8 "name": "default_variant_a_id",
9 "description": null,
10 "ean": "default_variant_a_id",
11 "sku": null,
12 "hs_tariff_code": null,
13 "height": null,
14 "depth": null,
15 "width": null,
16 "weight": null,
17 "expirable": false,
18 "country_of_origin": null,
19 "using_serial_numbers": false,
20 "value": 0.0
21 },
22 "inbound": {
23 "id": "f3f9950e-28a6-42f7-ac5c-80df7b1933c9",
24 "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
25 "created_at": "2021-11-24T10:09:09+00:00",
26 "reference": "INB00000000001",
27 "external_reference": "INITIAL_STOCK_2021-11-24-10-09-09",
28 "status": "completed",
29 "inbound_date": "2021-11-24T10:09:09+00:00",
30 "note": null
31 }
32}