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
  3. Attribute sets

Attributes

PreviousAttribute setsNextGroups

catalog Product Attribute Management V1Get Attributes Get

get

Retrieve related attributes based on given attribute set ID

Path parameters
attributeSetIdstringRequired

(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/attribute-sets/{attributeSetId}/attributes HTTP/1.1
Host: {{baseurl}}
Accept: */*
[
  {
    "attribute_code": "ea",
    "frontend_input": "Excepteur tempor fugiat dolore",
    "entity_type_id": "exercitation el",
    "is_required": true,
    "frontend_labels": [
      {
        "store_id": 29471707,
        "label": "minim"
      },
      {
        "store_id": 99974466,
        "label": "commodo eli"
      }
    ],
    "extension_attributes": {},
    "is_wysiwyg_enabled": false,
    "is_html_allowed_on_front": false,
    "used_for_sort_by": true,
    "is_filterable": true,
    "is_filterable_in_search": true,
    "is_used_in_grid": false,
    "is_visible_in_grid": false,
    "is_filterable_in_grid": false,
    "position": 33007269,
    "apply_to": [
      "nul",
      "minim"
    ],
    "is_searchable": "id qui",
    "is_visible_in_advanced_search": "anim ad",
    "is_comparable": "Duis Lorem",
    "is_used_for_promo_rules": "veniam do labore",
    "is_visible_on_front": "ipsum consequat",
    "used_in_product_listing": "officia dolor Ut ut",
    "is_visible": false,
    "scope": "irure esse",
    "attribute_id": 70923517,
    "options": [
      {
        "label": "labore cillum",
        "value": "quis Ut",
        "sort_order": 5888094,
        "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": "sit",
        "value": "aute cupidatat minim",
        "sort_order": 93046185,
        "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": false,
    "default_frontend_label": "eiusmod",
    "note": "magna ut cupidatat mollit dolore",
    "backend_type": "exercitation ullamco deserunt",
    "backend_model": "exercitation quis tempor",
    "source_model": "et occaecat",
    "default_value": "Lorem id",
    "is_unique": "anim labore veniam aliquip",
    "frontend_class": "aliquip ad adipisicing minim eu",
    "validation_rules": [
      {
        "key": "pariatur do",
        "value": "in irure sint"
      },
      {
        "key": "veniam",
        "value": "amet ut"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "non officia",
        "value": "Lorem tempor sint deserunt officia"
      },
      {
        "attribute_code": "pariatur",
        "value": "elit magna eiusmod"
      }
    ]
  },
  {
    "attribute_code": "qu",
    "frontend_input": "ullamco pariatur Duis of",
    "entity_type_id": "anim dolor v",
    "is_required": true,
    "frontend_labels": [
      {
        "store_id": 20902084,
        "label": "sint laborum reprehenderit"
      },
      {
        "store_id": -35794826,
        "label": "reprehenderit veniam id ipsum eu"
      }
    ],
    "extension_attributes": {},
    "is_wysiwyg_enabled": false,
    "is_html_allowed_on_front": false,
    "used_for_sort_by": true,
    "is_filterable": true,
    "is_filterable_in_search": true,
    "is_used_in_grid": true,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": false,
    "position": 66622610,
    "apply_to": [
      "nostrud eu laborum in sunt",
      "culpa esse amet"
    ],
    "is_searchable": "Excepteur reprehenderit",
    "is_visible_in_advanced_search": "fugiat eiusmod",
    "is_comparable": "qui aute irure mollit",
    "is_used_for_promo_rules": "Excepteur proident Ut dolore consectetur",
    "is_visible_on_front": "adipisicing sit nulla ipsum",
    "used_in_product_listing": "enim pariatur in velit",
    "is_visible": true,
    "scope": "sunt enim nulla",
    "attribute_id": -33000821,
    "options": [
      {
        "label": "voluptate sint in ullamco",
        "value": "commodo deserunt ex ea",
        "sort_order": -2205486,
        "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": "est ci",
        "value": "in consequat dolor",
        "sort_order": -25194534,
        "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": "ea id dolore cillum",
    "note": "et Lorem Duis",
    "backend_type": "ea sed",
    "backend_model": "pariatur voluptate",
    "source_model": "incididunt nisi",
    "default_value": "pariatur et est Lorem",
    "is_unique": "esse dolore",
    "frontend_class": "ut Excepteur dolore",
    "validation_rules": [
      {
        "key": "consequat id cupidatat dolore",
        "value": "enim in id veniam"
      },
      {
        "key": "anim aute",
        "value": "deserunt non laboris"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "nulla ad",
        "value": "ut aute mollit"
      },
      {
        "attribute_code": "eu sint",
        "value": "in"
      }
    ]
  }
]

catalog Product Attribute Management V1Unassign Delete

delete

Remove attribute from attribute set

Path parameters
attributeSetIdstringRequired

(Required)

Example: <string>
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/attribute-sets/{attributeSetId}/attributes/{attributeCode} HTTP/1.1
Host: {{baseurl}}
Accept: */*
true
  • GETcatalog Product Attribute Management V1Get Attributes Get
  • DELETEcatalog Product Attribute Management V1Unassign Delete
  • POSTcatalog Product Attribute Management V1Assign Post

catalog Product Attribute Management V1Assign Post

post

Assign attribute to attribute set

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"attributeSetId":"<integer>","attributeGroupId":"<integer>","attributeCode":"<string>","sortOrder":"<integer>"}
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/attribute-sets/attributes HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "attributeSetId": "<integer>",
  "attributeGroupId": "<integer>",
  "attributeCode": "<string>",
  "sortOrder": "<integer>"
}
66689314