AttributeSpec can be used to retrieve a single AttributeSpec

GET

/v2/storefront/taxonomy/attribute_spec/{productTypeId}/{attributeSpecId}

curl --request GET \
  --url https://api.zentail.com/v2/storefront/taxonomy/attribute_spec/example/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• zentail_oauth

Parameters

Path Parameters

productTypeId

required

string

attributeSpecId

required

string

Responses

200

A successful response.

Media typeapplication/json

AttributeSpec is the specification of an attribute within a Product Type on your channel.

object

attributeSpecId

This is the ID that will be used when retrieving listing data or submitting error to Zentail. It should reflect whatever meaningful identifier can be used to ingest this attribute into your system. In the past we have seen it be a numeric identifier or an xpath/jsonpath string

string

displayName

Human-readable name for the attribute. Used for display purposes only.

string

type

Type specifies what form the related attribute should be rendered into

string

default: TYPE_UNSPECIFIED

Allowed values: TYPE_UNSPECIFIED TYPE_TEXT TYPE_SELECT TYPE_NUMERIC TYPE_NUMERIC_WITH_UNITS TYPE_MULTI_TEXT TYPE_MULTI_SELECT TYPE_MONEY TYPE_MULTI_OBJECT

validValues

If the type is SELECT or MULTI_SELECT, provide the valid values here

Array<string>

validUnits

If the type is NUMERIC_WITH_UNITS, provide the valid units here

Array<string>

objectSpec

The object_spec is used to specify the structure of an object. This is only used when the type is TYPE_MULTI_OBJECT.

object

key

additional properties

Type specifies what form the related attribute should be rendered into

string

default: TYPE_UNSPECIFIED

Allowed values: TYPE_UNSPECIFIED TYPE_TEXT TYPE_SELECT TYPE_NUMERIC TYPE_NUMERIC_WITH_UNITS TYPE_MULTI_TEXT TYPE_MULTI_SELECT TYPE_MONEY TYPE_MULTI_OBJECT

objectFieldSpecs

The object_field_specs describes each sub-attribute of a TYPE_MULTI_OBJECT attribute, including per-sub-field valid values for enum sub-fields.

object

key

additional properties

ObjectFieldSpec carries the type and, for enum sub-fields, the valid values of a single sub-attribute within a TYPE_MULTI_OBJECT attribute. object_spec cannot carry per-sub-field valid values (it maps to Type only), so object_field_specs supersedes it for multi-object enums.

object

type

Type specifies what form the related attribute should be rendered into

string

default: TYPE_UNSPECIFIED

Allowed values: TYPE_UNSPECIFIED TYPE_TEXT TYPE_SELECT TYPE_NUMERIC TYPE_NUMERIC_WITH_UNITS TYPE_MULTI_TEXT TYPE_MULTI_SELECT TYPE_MONEY TYPE_MULTI_OBJECT

validValues

Array<string>

unit

Optional, used to specify the unit of the numeric value when the type is TYPE_NUMERIC This will allow Zentail to convert values with units in Zentail to a single numeric value if your channel does not support units

string

level

Level specifies whether this AttributeSpec should be rendered on the Listing-level or the Variant-level

string

default: LEVEL_UNSPECIFIED

Allowed values: LEVEL_UNSPECIFIED LEVEL_LISTING LEVEL_VARIANT

classification

Classification specifies whether this AttributeSpec relates to Product, Inventory, or Pricing data

string

default: CLASSIFICATION_UNSPECIFIED

Allowed values: CLASSIFICATION_UNSPECIFIED CLASSIFICATION_PRODUCT CLASSIFICATION_INVENTORY CLASSIFICATION_PRICING CLASSIFICATION_LOGISTICS CLASSIFICATION_IDENTIFIER

usage

Usage indicates if the spec is required or just recommended

string

default: USAGE_UNSPECIFIED

Allowed values: USAGE_UNSPECIFIED USAGE_AVAILABLE USAGE_REQUIRED USAGE_RECOMMENDED

description

Description is a human-readable description of the attribute

string

examples

Examples is a string containing examples of valid values for the attribute these are just for human consumption and are strings not neccessarily valid attribute values

Array<string>

maxUniqueItems

Max unique items indicates the largest number of unique items that can be set for this attribute.

string format: int64

suggestedValues

Suggested values is an array of values provided as an optional enumeration of specific values that are recommended for this attribute.

Array<string>

updatedAt

string format: date-time

createdAt

string format: date-time

Example

{
  "type": "TYPE_UNSPECIFIED",
  "objectSpec": {
    "additionalProperty": "TYPE_UNSPECIFIED"
  },
  "objectFieldSpecs": {
    "additionalProperty": {
      "type": "TYPE_UNSPECIFIED"
    }
  },
  "level": "LEVEL_UNSPECIFIED",
  "classification": "CLASSIFICATION_UNSPECIFIED",
  "usage": "USAGE_UNSPECIFIED"
}

default

An unexpected error response.

Media typeapplication/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}