ZAzalando
outlines

List outline schemas for a business partner

Returns the schema of all outlines configured for the given business partner: for each outline, its tiers (model, config, simple) and the attribute types that belong to each tier, along with any restrictions on the allowed attribute values. Returns an empty list if no master data is found. Pass includeAllOutlines=true to get every active, exposed outline instead; use each outline's configured_for_partner field to tell which ones are actually part of the partner's master data.

get/partners/{businessPartnerId}/outlines

Request

  • Base URL
    https://developers.merchants.zalando.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

businessPartnerIdstring uuid required

Query parameters

includeAllOutlinesboolean

When true, returns all active outlines regardless of the partner's configuration. Defaults to false.

Response

List of outline schemas

Example response

{
  "items": [
    {
      "name": {
        "en": "Footwear",
        "de": "Schuhe",
        "fr": "Chaussures"
      },
      "tiers": {
        "config": {
          "attribute_types": [
            "color",
            "brand"
          ],
          "restricted_attributes": []
        },
        "simple": {
          "attribute_types": [
            "color",
            "brand",
            "metric.model_height"
          ],
          "restricted_attributes": []
        },
        "model": {
          "attribute_types": [
            "color",
            "brand",
            "metric.model_height"
          ],
          "restricted_attributes": [
            {
              "type": {
                "label": "color",
                "version": "1.0.0"
              },
              "values": [
                "red",
                "blue",
                "black"
              ]
            }
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.