attribute

attribute.add

Add new attribute

post/attribute.add.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/attribute.add.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

type'text' | 'select' | 'media' | 'color' | 'textarea' | 'date' | 'price' | 'multiselect' | 'boolean' required

Defines attribute's type

namestring required

Defines attributes's name

codestring

Entity code

store_idstring

Store Id

lang_idstring

Language id

visibleboolean

Set visibility status

requiredboolean

Defines if the option is required

positioninteger

Attribute`s position

attribute_group_idstring

Filter by attribute_group_id

is_globalstring

Attribute saving scope

is_searchableboolean

Use attribute in Quick Search

is_filterablestring

Use In Layered Navigation

is_comparableboolean

Comparable on Front-end

is_html_allowed_on_frontboolean

Allow HTML Tags on Frontend

is_filterable_in_searchboolean

Use In Search Results Layered Navigation

is_configurableboolean

Use To Create Configurable Product

is_visible_in_advanced_searchboolean

Use in Advanced Search

is_used_for_promo_rulesboolean

Use for Promo Rule Conditions

used_in_product_listingboolean

Used in Product Listing

used_for_sort_byboolean

Used for Sorting in Product Listing

apply_tostring

Types of products which can have this attribute

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

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