Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Products

Attributes

PreviousSamplesNextOptions

catalog Product Attribute Repository V1Delete By Id Delete

delete

Delete Attribute by id

Path parameters
attributeCodestringRequired

(Required)

Example: <string>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
delete
DELETE /V1/products/attributes/{attributeCode} HTTP/1.1
Host: {{baseurl}}
Accept: */*
true

catalog Product Attribute Repository V1Get List Get

get

Retrieve all attributes for entity type

Query parameters
searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>
searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>
searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>
searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>
searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>
searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>
searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>
Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/products/attributes HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "attribute_code": "incididunt ut sunt",
      "frontend_input": "dolor dolore",
      "entity_type_id": "ad aute proident laborum",
      "is_required": true,
      "frontend_labels": [
        {
          "store_id": 74994133,
          "label": "in irure"
        },
        {
          "store_id": -60425686,
          "label": "minim elit Ut"
        }
      ],
      "extension_attributes": {},
      "is_wysiwyg_enabled": false,
      "is_html_allowed_on_front": true,
      "used_for_sort_by": true,
      "is_filterable": true,
      "is_filterable_in_search": false,
      "is_used_in_grid": true,
      "is_visible_in_grid": true,
      "is_filterable_in_grid": true,
      "position": 45603066,
      "apply_to": [
        "enim",
        "deserunt"
      ],
      "is_searchable": "culpa eiusmod qui veniam",
      "is_visible_in_advanced_search": "sed commodo quis culpa magna",
      "is_comparable": "cupidatat ex in mollit",
      "is_used_for_promo_rules": "labore ipsum quis",
      "is_visible_on_front": "Duis ea ut",
      "used_in_product_listing": "velit incididunt nisi ex",
      "is_visible": true,
      "scope": "ea Ut aliquip",
      "attribute_id": -62820172,
      "options": [
        {
          "label": "ullamco eiusmod dolore",
          "value": "o",
          "sort_order": 5223853,
          "is_default": true,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        },
        {
          "label": "ullamco amet sint",
          "value": "qui ex culpa",
          "sort_order": -85748043,
          "is_default": true,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        }
      ],
      "is_user_defined": true,
      "default_frontend_label": "nulla id magna",
      "note": "dolor",
      "backend_type": "veniam mollit",
      "backend_model": "ex culpa exercitation",
      "source_model": "irure aute",
      "default_value": "mollit cillum",
      "is_unique": "eiusmod Lorem nisi",
      "frontend_class": "pariatur adipisicing ad do",
      "validation_rules": [
        {
          "key": "pariatur in adipisicing consectetur",
          "value": "proident quis"
        },
        {
          "key": "officia cillum incididunt sit",
          "value": "cillum in"
        }
      ],
      "custom_attributes": [
        {
          "attribute_code": "Lorem aliquip in minim",
          "value": "sint fugiat Lorem in"
        },
        {
          "attribute_code": "amet in in",
          "value": "occaecat"
        }
      ]
    },
    {
      "attribute_code": "dolore Duis",
      "frontend_input": "sin",
      "entity_type_id": "culpa cupidatat",
      "is_required": false,
      "frontend_labels": [
        {
          "store_id": -53662551,
          "label": "in dolor"
        },
        {
          "store_id": -54743549,
          "label": "aliquip dolore nostrud quis eu"
        }
      ],
      "extension_attributes": {},
      "is_wysiwyg_enabled": true,
      "is_html_allowed_on_front": false,
      "used_for_sort_by": false,
      "is_filterable": false,
      "is_filterable_in_search": false,
      "is_used_in_grid": false,
      "is_visible_in_grid": true,
      "is_filterable_in_grid": false,
      "position": -15507507,
      "apply_to": [
        "Lorem cupidatat sint",
        "exercitation esse veniam mollit"
      ],
      "is_searchable": "ut est dolor",
      "is_visible_in_advanced_search": "in nisi enim non do",
      "is_comparable": "cillum ullamco ex ut",
      "is_used_for_promo_rules": "nostrud sunt fugiat incididunt",
      "is_visible_on_front": "in",
      "used_in_product_listing": "id deserunt aliqua",
      "is_visible": false,
      "scope": "ad",
      "attribute_id": 13650821,
      "options": [
        {
          "label": "labore ut",
          "value": "aute tempor voluptate",
          "sort_order": 63627743,
          "is_default": true,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        },
        {
          "label": "enim officia Excepteur quis",
          "value": "amet dolor",
          "sort_order": -65950407,
          "is_default": true,
          "store_labels": [
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            },
            {
              "store_id": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              "label": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            }
          ]
        }
      ],
      "is_user_defined": true,
      "default_frontend_label": "minim nostrud anim Excepteur",
      "note": "exercitation do",
      "backend_type": "cillum in labor",
      "backend_model": "Ut magna culpa sint",
      "source_model": "quis ullamco aliquip consectetur exercitation",
      "default_value": "incididunt ",
      "is_unique": "laboris ad Ut Lorem",
      "frontend_class": "magna in do ipsum",
      "validation_rules": [
        {
          "key": "in",
          "value": "dolore occaecat aliquip"
        },
        {
          "key": "velit esse sunt aliquip",
          "value": "ut consequat in"
        }
      ],
      "custom_attributes": [
        {
          "attribute_code": "sint incididunt irure in",
          "value": "tempor consequat"
        },
        {
          "attribute_code": "Lorem pariatur in",
          "value": "velit dolore tempor"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "tempor in ut eiusmod sunt",
            "value": "magna reprehenderit",
            "condition_type": "et dolor"
          },
          {
            "field": "reprehenderit",
            "value": "magna ut Excepteur a",
            "condition_type": "irure dolor minim"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "reprehend",
            "value": "incididunt consequat ipsum quis laboris",
            "condition_type": "occaecat laboris mollit non"
          },
          {
            "field": "mollit in ",
            "value": "sed sint ex deserunt labore",
            "condition_type": "reprehenderit anim minim id exercitation"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "eu do est ex",
        "direction": "ex in labore cupidatat sed"
      },
      {
        "field": "laborum in ea",
        "direction": "officia tempor occaecat magna Duis"
      }
    ],
    "page_size": -81071857,
    "current_page": 63591594
  },
  "total_count": 39826156
}
  • GETcatalog Product Attribute Repository V1Get Get
  • PUTcatalog Product Attribute Repository V1Save Put
  • DELETEcatalog Product Attribute Repository V1Delete By Id Delete
  • GETcatalog Product Attribute Repository V1Get List Get
  • POSTcatalog Product Attribute Repository V1Save Post

catalog Product Attribute Repository V1Get Get

get

Retrieve specific attribute

Path parameters
attributeCodestringRequired

(Required)

Example: <string>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/products/attributes/{attributeCode} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "attribute_code": "elit ullamco nostrud",
  "frontend_input": "do in in exercitation",
  "entity_type_id": "Duis enim dolor",
  "is_required": true,
  "frontend_labels": [
    {
      "store_id": 89363399,
      "label": "Excepteur incididunt minim"
    },
    {
      "store_id": -83498383,
      "label": "culpa laboris elit"
    }
  ],
  "extension_attributes": {},
  "is_wysiwyg_enabled": true,
  "is_html_allowed_on_front": false,
  "used_for_sort_by": false,
  "is_filterable": false,
  "is_filterable_in_search": false,
  "is_used_in_grid": true,
  "is_visible_in_grid": false,
  "is_filterable_in_grid": true,
  "position": 6659512,
  "apply_to": [
    "incididunt officia voluptate eu",
    "ipsum veniam deserunt ex"
  ],
  "is_searchable": "labore fugiat sed ipsum",
  "is_visible_in_advanced_search": "consequat nisi reprehenderit Excepteur esse",
  "is_comparable": "dolor Excepteur consequat dolore",
  "is_used_for_promo_rules": "voluptate",
  "is_visible_on_front": "commodo",
  "used_in_product_listing": "nostrud consequat et quis",
  "is_visible": true,
  "scope": "dolore officia labore",
  "attribute_id": 67359095,
  "options": [
    {
      "label": "ullamco",
      "value": "irure",
      "sort_order": -75942097,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    },
    {
      "label": "ea",
      "value": "nisi cupidatat fugiat amet",
      "sort_order": 23952711,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  ],
  "is_user_defined": true,
  "default_frontend_label": "aliquip do et in enim",
  "note": "ut cupidatat",
  "backend_type": "aute qui laborum do",
  "backend_model": "cillum ea ipsum ex",
  "source_model": "tempor est irure",
  "default_value": "dolor fugiat deserunt",
  "is_unique": "do enim laborum quis",
  "frontend_class": "cillum fugiat nostrud ex in",
  "validation_rules": [
    {
      "key": "exercitation et anim",
      "value": "do reprehenderit ut"
    },
    {
      "key": "anim nisi",
      "value": "labore cillum"
    }
  ],
  "custom_attributes": [
    {
      "attribute_code": "aliqua voluptate",
      "value": "anim eiusmod mollit in"
    },
    {
      "attribute_code": "aute",
      "value": "qui Duis veniam in"
    }
  ]
}

catalog Product Attribute Repository V1Save Put

put

Save attribute data

Path parameters
attributeCodestringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"attribute":{"attribute_code":"incididunt cillum cupidatat magna","frontend_input":"eiusmod consequat fugiat adipisicing","entity_type_id":"ex do","is_required":true,"frontend_labels":[{"store_id":58336445,"label":"voluptate "},{"store_id":-9448356,"label":"ex fugiat"}],"extension_attributes":{},"is_wysiwyg_enabled":true,"is_html_allowed_on_front":false,"used_for_sort_by":true,"is_filterable":false,"is_filterable_in_search":true,"is_used_in_grid":false,"is_visible_in_grid":true,"is_filterable_in_grid":false,"position":-75965978,"apply_to":["Ut","reprehenderit"],"is_searchable":"nostrud reprehenderit sunt ullamco sit","is_visible_in_advanced_search":"Duis elit","is_comparable":"dolore","is_used_for_promo_rules":"nulla","is_visible_on_front":"cupidatat id","used_in_product_listing":"sunt laborum","is_visible":false,"scope":"proident ad Ut deserunt","attribute_id":123152,"options":[{"label":"reprehenderit laborum Lorem amet","value":"enim fugiat veniam","sort_order":30835420,"is_default":true,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]},{"label":"ipsum esse","value":"amet ad","sort_order":36026483,"is_default":false,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}],"is_user_defined":true,"default_frontend_label":"eu veniam nulla","note":"dolor elit minim nostrud nisi","backend_type":"dolore pariatur vel","backend_model":"id dolor","source_model":"Ut ad minim velit","default_value":"aute ullamco ea laboris","is_unique":"commodo sed in repreh","frontend_class":"ut","validation_rules":[{"key":"aliqua velit","value":"dolore veniam et aliquip tempor"},{"key":"eiusmod ut ","value":"in aliquip"}],"custom_attributes":[{"attribute_code":"Lorem dolor et v","value":"quis Duis sint"},{"attribute_code":"velit aliquip cupidatat dolor","value":"tempor sunt laborum reprehenderit"}]}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
put
PUT /V1/products/attributes/{attributeCode} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 2366

{
  "attribute": {
    "attribute_code": "incididunt cillum cupidatat magna",
    "frontend_input": "eiusmod consequat fugiat adipisicing",
    "entity_type_id": "ex do",
    "is_required": true,
    "frontend_labels": [
      {
        "store_id": 58336445,
        "label": "voluptate "
      },
      {
        "store_id": -9448356,
        "label": "ex fugiat"
      }
    ],
    "extension_attributes": {},
    "is_wysiwyg_enabled": true,
    "is_html_allowed_on_front": false,
    "used_for_sort_by": true,
    "is_filterable": false,
    "is_filterable_in_search": true,
    "is_used_in_grid": false,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": false,
    "position": -75965978,
    "apply_to": [
      "Ut",
      "reprehenderit"
    ],
    "is_searchable": "nostrud reprehenderit sunt ullamco sit",
    "is_visible_in_advanced_search": "Duis elit",
    "is_comparable": "dolore",
    "is_used_for_promo_rules": "nulla",
    "is_visible_on_front": "cupidatat id",
    "used_in_product_listing": "sunt laborum",
    "is_visible": false,
    "scope": "proident ad Ut deserunt",
    "attribute_id": 123152,
    "options": [
      {
        "label": "reprehenderit laborum Lorem amet",
        "value": "enim fugiat veniam",
        "sort_order": 30835420,
        "is_default": true,
        "store_labels": [
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      {
        "label": "ipsum esse",
        "value": "amet ad",
        "sort_order": 36026483,
        "is_default": false,
        "store_labels": [
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    ],
    "is_user_defined": true,
    "default_frontend_label": "eu veniam nulla",
    "note": "dolor elit minim nostrud nisi",
    "backend_type": "dolore pariatur vel",
    "backend_model": "id dolor",
    "source_model": "Ut ad minim velit",
    "default_value": "aute ullamco ea laboris",
    "is_unique": "commodo sed in repreh",
    "frontend_class": "ut",
    "validation_rules": [
      {
        "key": "aliqua velit",
        "value": "dolore veniam et aliquip tempor"
      },
      {
        "key": "eiusmod ut ",
        "value": "in aliquip"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "Lorem dolor et v",
        "value": "quis Duis sint"
      },
      {
        "attribute_code": "velit aliquip cupidatat dolor",
        "value": "tempor sunt laborum reprehenderit"
      }
    ]
  }
}
{
  "attribute_code": "elit ullamco nostrud",
  "frontend_input": "do in in exercitation",
  "entity_type_id": "Duis enim dolor",
  "is_required": true,
  "frontend_labels": [
    {
      "store_id": 89363399,
      "label": "Excepteur incididunt minim"
    },
    {
      "store_id": -83498383,
      "label": "culpa laboris elit"
    }
  ],
  "extension_attributes": {},
  "is_wysiwyg_enabled": true,
  "is_html_allowed_on_front": false,
  "used_for_sort_by": false,
  "is_filterable": false,
  "is_filterable_in_search": false,
  "is_used_in_grid": true,
  "is_visible_in_grid": false,
  "is_filterable_in_grid": true,
  "position": 6659512,
  "apply_to": [
    "incididunt officia voluptate eu",
    "ipsum veniam deserunt ex"
  ],
  "is_searchable": "labore fugiat sed ipsum",
  "is_visible_in_advanced_search": "consequat nisi reprehenderit Excepteur esse",
  "is_comparable": "dolor Excepteur consequat dolore",
  "is_used_for_promo_rules": "voluptate",
  "is_visible_on_front": "commodo",
  "used_in_product_listing": "nostrud consequat et quis",
  "is_visible": true,
  "scope": "dolore officia labore",
  "attribute_id": 67359095,
  "options": [
    {
      "label": "ullamco",
      "value": "irure",
      "sort_order": -75942097,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    },
    {
      "label": "ea",
      "value": "nisi cupidatat fugiat amet",
      "sort_order": 23952711,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  ],
  "is_user_defined": true,
  "default_frontend_label": "aliquip do et in enim",
  "note": "ut cupidatat",
  "backend_type": "aute qui laborum do",
  "backend_model": "cillum ea ipsum ex",
  "source_model": "tempor est irure",
  "default_value": "dolor fugiat deserunt",
  "is_unique": "do enim laborum quis",
  "frontend_class": "cillum fugiat nostrud ex in",
  "validation_rules": [
    {
      "key": "exercitation et anim",
      "value": "do reprehenderit ut"
    },
    {
      "key": "anim nisi",
      "value": "labore cillum"
    }
  ],
  "custom_attributes": [
    {
      "attribute_code": "aliqua voluptate",
      "value": "anim eiusmod mollit in"
    },
    {
      "attribute_code": "aute",
      "value": "qui Duis veniam in"
    }
  ]
}

catalog Product Attribute Repository V1Save Post

post

Save attribute data

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"attribute":{"attribute_code":"incididunt cillum cupidatat magna","frontend_input":"eiusmod consequat fugiat adipisicing","entity_type_id":"ex do","is_required":true,"frontend_labels":[{"store_id":58336445,"label":"voluptate "},{"store_id":-9448356,"label":"ex fugiat"}],"extension_attributes":{},"is_wysiwyg_enabled":true,"is_html_allowed_on_front":false,"used_for_sort_by":true,"is_filterable":false,"is_filterable_in_search":true,"is_used_in_grid":false,"is_visible_in_grid":true,"is_filterable_in_grid":false,"position":-75965978,"apply_to":["Ut","reprehenderit"],"is_searchable":"nostrud reprehenderit sunt ullamco sit","is_visible_in_advanced_search":"Duis elit","is_comparable":"dolore","is_used_for_promo_rules":"nulla","is_visible_on_front":"cupidatat id","used_in_product_listing":"sunt laborum","is_visible":false,"scope":"proident ad Ut deserunt","attribute_id":123152,"options":[{"label":"reprehenderit laborum Lorem amet","value":"enim fugiat veniam","sort_order":30835420,"is_default":true,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]},{"label":"ipsum esse","value":"amet ad","sort_order":36026483,"is_default":false,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}],"is_user_defined":true,"default_frontend_label":"eu veniam nulla","note":"dolor elit minim nostrud nisi","backend_type":"dolore pariatur vel","backend_model":"id dolor","source_model":"Ut ad minim velit","default_value":"aute ullamco ea laboris","is_unique":"commodo sed in repreh","frontend_class":"ut","validation_rules":[{"key":"aliqua velit","value":"dolore veniam et aliquip tempor"},{"key":"eiusmod ut ","value":"in aliquip"}],"custom_attributes":[{"attribute_code":"Lorem dolor et v","value":"quis Duis sint"},{"attribute_code":"velit aliquip cupidatat dolor","value":"tempor sunt laborum reprehenderit"}]}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/products/attributes HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 2366

{
  "attribute": {
    "attribute_code": "incididunt cillum cupidatat magna",
    "frontend_input": "eiusmod consequat fugiat adipisicing",
    "entity_type_id": "ex do",
    "is_required": true,
    "frontend_labels": [
      {
        "store_id": 58336445,
        "label": "voluptate "
      },
      {
        "store_id": -9448356,
        "label": "ex fugiat"
      }
    ],
    "extension_attributes": {},
    "is_wysiwyg_enabled": true,
    "is_html_allowed_on_front": false,
    "used_for_sort_by": true,
    "is_filterable": false,
    "is_filterable_in_search": true,
    "is_used_in_grid": false,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": false,
    "position": -75965978,
    "apply_to": [
      "Ut",
      "reprehenderit"
    ],
    "is_searchable": "nostrud reprehenderit sunt ullamco sit",
    "is_visible_in_advanced_search": "Duis elit",
    "is_comparable": "dolore",
    "is_used_for_promo_rules": "nulla",
    "is_visible_on_front": "cupidatat id",
    "used_in_product_listing": "sunt laborum",
    "is_visible": false,
    "scope": "proident ad Ut deserunt",
    "attribute_id": 123152,
    "options": [
      {
        "label": "reprehenderit laborum Lorem amet",
        "value": "enim fugiat veniam",
        "sort_order": 30835420,
        "is_default": true,
        "store_labels": [
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      {
        "label": "ipsum esse",
        "value": "amet ad",
        "sort_order": 36026483,
        "is_default": false,
        "store_labels": [
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "store_id": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "label": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    ],
    "is_user_defined": true,
    "default_frontend_label": "eu veniam nulla",
    "note": "dolor elit minim nostrud nisi",
    "backend_type": "dolore pariatur vel",
    "backend_model": "id dolor",
    "source_model": "Ut ad minim velit",
    "default_value": "aute ullamco ea laboris",
    "is_unique": "commodo sed in repreh",
    "frontend_class": "ut",
    "validation_rules": [
      {
        "key": "aliqua velit",
        "value": "dolore veniam et aliquip tempor"
      },
      {
        "key": "eiusmod ut ",
        "value": "in aliquip"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "Lorem dolor et v",
        "value": "quis Duis sint"
      },
      {
        "attribute_code": "velit aliquip cupidatat dolor",
        "value": "tempor sunt laborum reprehenderit"
      }
    ]
  }
}
{
  "attribute_code": "elit ullamco nostrud",
  "frontend_input": "do in in exercitation",
  "entity_type_id": "Duis enim dolor",
  "is_required": true,
  "frontend_labels": [
    {
      "store_id": 89363399,
      "label": "Excepteur incididunt minim"
    },
    {
      "store_id": -83498383,
      "label": "culpa laboris elit"
    }
  ],
  "extension_attributes": {},
  "is_wysiwyg_enabled": true,
  "is_html_allowed_on_front": false,
  "used_for_sort_by": false,
  "is_filterable": false,
  "is_filterable_in_search": false,
  "is_used_in_grid": true,
  "is_visible_in_grid": false,
  "is_filterable_in_grid": true,
  "position": 6659512,
  "apply_to": [
    "incididunt officia voluptate eu",
    "ipsum veniam deserunt ex"
  ],
  "is_searchable": "labore fugiat sed ipsum",
  "is_visible_in_advanced_search": "consequat nisi reprehenderit Excepteur esse",
  "is_comparable": "dolor Excepteur consequat dolore",
  "is_used_for_promo_rules": "voluptate",
  "is_visible_on_front": "commodo",
  "used_in_product_listing": "nostrud consequat et quis",
  "is_visible": true,
  "scope": "dolore officia labore",
  "attribute_id": 67359095,
  "options": [
    {
      "label": "ullamco",
      "value": "irure",
      "sort_order": -75942097,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    },
    {
      "label": "ea",
      "value": "nisi cupidatat fugiat amet",
      "sort_order": 23952711,
      "is_default": false,
      "store_labels": [
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "store_id": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "label": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  ],
  "is_user_defined": true,
  "default_frontend_label": "aliquip do et in enim",
  "note": "ut cupidatat",
  "backend_type": "aute qui laborum do",
  "backend_model": "cillum ea ipsum ex",
  "source_model": "tempor est irure",
  "default_value": "dolor fugiat deserunt",
  "is_unique": "do enim laborum quis",
  "frontend_class": "cillum fugiat nostrud ex in",
  "validation_rules": [
    {
      "key": "exercitation et anim",
      "value": "do reprehenderit ut"
    },
    {
      "key": "anim nisi",
      "value": "labore cillum"
    }
  ],
  "custom_attributes": [
    {
      "attribute_code": "aliqua voluptate",
      "value": "anim eiusmod mollit in"
    },
    {
      "attribute_code": "aute",
      "value": "qui Duis veniam in"
    }
  ]
}