Variant bundles
A variant-bundle is a collection of multiple variants
All variant-bundles must have at least 1 variant.
The variant bundle model
Properties
- Name
id- Type
- string
- Readonly
- readonly
- Description
Unique identifier for the variant bundle
- Name
bundled_variant- Type
- object
- Description
Article codes are unique on customer level.
GET/wms/variant-bundles/
List all variant bundles
Retrieves a collection of variant bundles
Optional attributes
- 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
Request
GET
/wms/variant-bundles/curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/ \
-H 'Expand: variant_bundle_items'
Response
[
{
"id": "5c35f98a-92eb-4f19-b8bb-8fdd4f81f8a7",
"bundled_variant": {
"id": "757d4446-f68b-4d32-9a2f-f1ce1195e74c",
"article_code": "papier_bundle",
"name": "papier_bundle",
"description": null,
"ean": "papier_bundle",
"sku": "papier_bundle",
"hs_tariff_code": null,
"height": null,
"depth": null,
"width": null,
"weight": null,
"expirable": false,
"country_of_origin": null,
"using_serial_numbers": false,
"value": null
},
"variant_bundle_items":
[
{
"id": "049395e5-7b44-4b1c-a262-0e60b828bbe0",
"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": 25
}
]
},
{
"id": "98c15f1d-ccab-4513-b198-6a3a370da1bd",
"bundled_variant": {
"id": "a7ab2940-6ebc-4811-81e1-c77b9dfcb0e3",
"article_code": "papier_bundle_2",
"name": "papier_bundle_2",
"description": null,
"ean": "papier_bundle_2",
"sku": "papier_bundle_2",
"hs_tariff_code": null,
"height": null,
"depth": null,
"width": null,
"weight": null,
"expirable": false,
"country_of_origin": null,
"using_serial_numbers": false,
"value": null
},
"variant_bundle_items":
[
{
"id": "8291e95b-c537-4ff4-9920-9bfe27508014",
"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": 1
},
{
"id": "f782a565-749d-4b01-b4fc-558d544a8536",
"variant": {
"id": "757d4446-f68b-4d32-9a2f-f1ce1195e74c",
"article_code": "papier_bundle",
"name": "papier_bundle",
"description": null,
"ean": "papier_bundle",
"sku": "papier_bundle",
"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": 1
}
]
}
]
GET/wms/variant-bundles/:id/
Retrieve a single variant bundle
Retrieve a single variant bundle.
Request
GET
/wms/variant-bundles/:id/curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/e710389a-5505-49d4-9b99-8314f3543427
Response
{
"id": "5c35f98a-92eb-4f19-b8bb-8fdd4f81f8a7",
"bundled_variant": {
"id": "757d4446-f68b-4d32-9a2f-f1ce1195e74c",
"article_code": "papier_bundle",
"name": "papier_bundle",
"description": null,
"ean": "papier_bundle",
"sku": "papier_bundle",
"hs_tariff_code": null,
"height": null,
"depth": null,
"width": null,
"weight": null,
"expirable": false,
"country_of_origin": null,
"using_serial_numbers": false,
"value": null
},
"variant_bundle_items":
[
{
"id": "049395e5-7b44-4b1c-a262-0e60b828bbe0",
"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": 25
}
]
}
POST/wms/variant-bundles/
Create a variant bundle
This endpoint allows you to add a new variant
Required attributes
- Name
variant_bundle- Type
- string
- Description
- Name
variant_bundle_items- Type
- array
- Description
Request
POST
/wms/variant-bundles/curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/' \
-H 'Content-Type: application/json' \
--data-raw '{
"variant_bundle": "test_variant_bundle",
"variant_bundle_items": [
{
"article_code": "12345",
"quantity": 1
}
]
}'
Response
{
"id": "cf886020-efcc-44e0-8fb6-f03e9aec00c4",
"bundled_variant": {
"id": "2d3c05c5-80fb-4f35-bee5-ea7b1999d2f5",
"article_code": "test_variant_bundle",
"name": "test_variant_bundle",
"description": "test_variant_bundle",
"ean": "test_variant_bundle",
"sku": "test_variant_bundle",
"hs_tariff_code": null,
"height": null,
"depth": null,
"width": null,
"weight": null,
"expirable": false,
"country_of_origin": null,
"using_serial_numbers": false,
"value": null
},
"variant_bundle_items":
[
{
"id": "643f9967-dd5f-48d1-8aee-064296f3a015",
"variant": {
"id": "334b85c0-6b20-4a10-bca8-13fb1974740d",
"article_code": "12345",
"name": "12345",
"description": null,
"ean": "12345",
"sku": "12345",
"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": 1
}
]
}
PATCH/wms/variant-bundles/:id/
Update a variant bundle
This endpoint allows you to perform an update on a variant bundle.
Request
PATCH
/wms/variant-bundles/:id/curl -X PATCH
https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/774bf6ee-90cf-11e9-b36d-0242ac120005/ \
--data-raw '{
"variant_bundle_items": [{
"article_code": "12345",
"quantity": 2
}]
}'
Response
{
"id": "cf886020-efcc-44e0-8fb6-f03e9aec00c4",
"bundled_variant": {
"id": "2d3c05c5-80fb-4f35-bee5-ea7b1999d2f5",
"article_code": "test_variant_bundle",
"name": "test_variant_bundle",
"description": "test_variant_bundle",
"ean": "test_variant_bundle",
"sku": "test_variant_bundle",
"hs_tariff_code": null,
"height": null,
"depth": null,
"width": null,
"weight": null,
"expirable": false,
"country_of_origin": null,
"using_serial_numbers": false,
"value": null
},
"variant_bundle_items":
[
{
"id": "643f9967-dd5f-48d1-8aee-064296f3a015",
"variant": {
"id": "334b85c0-6b20-4a10-bca8-13fb1974740d",
"article_code": "12345",
"name": "12345",
"description": null,
"ean": "12345",
"sku": "12345",
"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": 2
}
]
}