Developer documentation

Variant bundles

Use the Variant Bundles API to create, retrieve, and manage variant bundles.

A variant-bundle is a collection of multiple variants

All variant-bundles must have at least 1 variant.

Response models

These response models describe the objects returned by this resource.

The variant bundle model

FieldDescription
id
stringOptional
Read-only. Unique identifier for the variant bundle
bundled_variant
objectOptional
Article codes are unique on customer level.

List all variant bundles

GET/wms/variant-bundles/

Retrieves a collection of variant bundles

New to the Expand header? See how it works, available groups, and request examples: Expanding responses.

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

FieldDescription
limit
integerOptional
Limit the number of results. Default is 50.
page
integerOptional
The page number to retrieve.
direction
stringOptional
Sort direction. Options: `asc` or `desc`.
sort
stringOptional
Sorting field for the variant bundle collection.
Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/ \
            -H 'Expand: variant_bundle_items'
Response exampleJSON
[
  {
    "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
        },
        "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
        },
        "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
      }
    ]
  }
]

Retrieve a single variant bundle

GET/wms/variant-bundles/:id/

Retrieve a single variant bundle.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/variant-bundles/e710389a-5505-49d4-9b99-8314f3543427
Response exampleJSON
{
  "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
      },
      "quantity": 25
    }
  ]
}

Create a variant bundle

POST/wms/variant-bundles/

This endpoint allows you to add a new variant

Required attributes

Try it

Send a live request against the development middleware using your current API test session.

POST
Request examplecURL
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 exampleJSON
{
  "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
      },
      "quantity": 1
    }
  ]
}

Update a variant bundle

PATCH/wms/variant-bundles/:id/

This endpoint allows you to perform an update on a variant bundle.

Try it

Send a live request against the development middleware using your current API test session.

PATCH

Path parameters

Request examplecURL
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 exampleJSON
{
  "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
      },
      "quantity": 2
    }
  ]
}