ZAzalando
outlines

Get a single outline schema for a business partner

Returns the schema of the outline with the given label, including its tiers (model, config, simple) and the attribute types that belong to each tier, along with any restrictions on the allowed attribute values. The outline is returned if it's active and exposed, regardless of the business partner's master data configuration. Use the response's configured_for_partner field to check whether the outline is part of that partner's configuration.

get/partners/{businessPartnerId}/outlines/{outlineLabel}

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
outlineLabelstring required

Response

The requested outline schema

current_versionstring required
labelstring required
configured_for_partnerboolean required

Whether this outline is part of the business partner's master data configuration.

nameobject required

Locale-keyed display names

Example response

{
  "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.