1. Attributes & Options
Example be.open API
  • be.open API
    • be.open API
    • Samples
    • Auth
      • Get api auth token
    • Attributes & Options
      • attributes
        • get country options of a product
      • get all available attributes
        GET
      • create or update an attribute
        POST
      • get a single attribute by id
        GET
      • adds or updates an option
        POST
      • list attribute categories
        GET
      • returns options for an attribute type of a service provider
        POST
    • Basket
      • get Basket
    • Price
      • get Price list
    • Categories
      • get product categories
      • Returns the products of a category.
    • Products & Combinations
      • get product configuration
      • get option configuration
      • get product attributes
      • get product independent attributes
      • Returns the products.
      • adds or updates a product with attributes, options and combinations.
      • Returns the single product.
      • adds or updates attributes, options and combinations of a product. Used to import combinations in parts
      • delete combinations.
      • get country attribute with options
    • Serviceprovider
      • change attribute settings just for this service provider
      • change option settings just for this service provider
      • change attribute category setting just for this service provider
      • list orders for a service provider
      • get an order for a service provider
      • update order status from service provider
    • Order
      • create an order
      • get order
    • change attribute category setting just for this service provider
      PATCH
    • change attribute category setting just for this service provider
      PATCH
    • Schemas
      • Schemas
        • Attribute
        • AttributeCategory
        • CategoryModel
        • Product
        • BasicOrder
        • Order
        • Option
        • ProductMetaInformation
        • Client
        • OrderDetail
        • OrderCustomField
        • OrderFile
        • OrderUpload
        • File
        • PartialDelivery
        • OrderDetailFile
        • ProductCombination
        • Address
        • OrderDetailPrice
        • OrderDetailCombination
        • Address2
        • PriceConfiguration
        • Currency
        • ConfigurationOption
        • Price
        • ConfigurationOptionSize
      • Improved Schemas
        • ExampleAttributesCollection
        • Attribute
        • AttributeMetaData
        • Category
      • Responses
      • Custom Schemas
        • UpdateServiceproviderOrderResponse
      • AttributeOption
      • CreateProduct
      • QuantityShipping
      • QuantityDelivery
      • DeleteQuantityShipping
      • placedOrder
      • DeleteQuantityDelivery
      • Authentication
      • AuthenticationResponse
      • CreateAttribute
      • CreateOption
      • CreateProductCombination
      • DeleteProductCombination
      • ProductTypeData
      • DependableAttribute
      • ProductVariant
      • DeleteProductVariant
      • ServiceproviderOrderDetail
      • DependableOption
      • ProductQuantity
      • ProductAttribute
      • DeleteProductQuantity
      • OrderDetailPage
      • OptionOfAttribute
      • ProductResponse
      • LooseLeafData
      • AttributeResponse
      • OrderResponse
      • OrderDetailResponse
      • OrderAttributeOption
      • BasketPrice
      • OrderAddressResponse
      • CreateOrderAddress
      • CreateOrder
      • PatchServiceProviderOrder
      • JsonApi
      • PaginationMeta
      • PaginationLinks
      • AttributesListResponse
      • AttributeSingleResponse
      • OptionSingleResponse
      • AttributeResource
      • OptionIdentifier
      • AttributeCategoryEmbedded
      • AttributeCategoryResource
      • OptionResource
  • Druckshop API
    • Cart
      • getByJobNumber
    • Tracking
      • getByJobNumber
      • addTrackingId
    • Order
      • getOrder
      • getOrders
      • getOrderByReference
      • getOrderCart
    • FreeOrder
      • addFreeOrder
    • Schemas
      • FreeOrder
      • FreeOrderResponse
      • ApiAddress
      • FreeOrderPrice
      • FreeOrderCart
      • FreeOrderArticle
      • FreeOrderDataKeyValuePrice
  • be.print Dashboard API
    • PlacedOrder
      • Store a newly created placedOrder
      • Update an existing placedOrder
    • PlacedOrderCart
      • Store a newly created placedOrderCart
      • Update an existing placedOrderCart
    • Sso
      • sso.getTokenCheck
      • sso.setUserMapping
    • ValidateCustomerApi
      • validateCustomerApi.whoAmI
      • validateCustomerApi.postExternalClient
    • Dashboard API (MOVE TO ANOTHER PROJECT)!
      • Customer
        • whoAmI
        • addExternalClient
      • Orders
        • create order
        • update order
        • update order cart
    • Schemas
      • Schemas
        • AddExternalClientRequest
        • PlacedOrderCartRequest
        • PlacedOrderRequest
        • SsoExternalLinkRequest
        • SsoExternalUserMapping
      • Response
        • AuthenticationException
        • ValidationException
        • AuthorizationException
        • ModelNotFoundException
      • placedOrder
  1. Attributes & Options

get all available attributes

GET
/api/attributes
Returns a paginated list of all attributes in JSON:API format. With verbose=1 the related options are delivered in the included block.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Header Params

Responses

🟢200Unauthorized request
application/json
Returns the paginated attribute list.
Bodyapplication/json

Example
{
    "jsonapi": {
        "version": "1.0"
    },
    "meta": {
        "page": 1,
        "limit": 100,
        "pages": 1,
        "total": 11
    },
    "links": {
        "first": "https://api.example.com/api/attributes?verbose=1&page=1",
        "last": "https://api.example.com/api/attributes?verbose=1&page=1",
        "next": null,
        "previous": null
    },
    "data": [
        {
            "type": "attributes",
            "id": "a76e4ea8-420d-4e08-987b-04c017ee3a3b",
            "attributes": {
                "name": "Ausführung",
                "original_name": "Ausführung",
                "sort": 3,
                "description": null,
                "key": "1001",
                "category": "none",
                "attribute_category": {
                    "type": "attribute_categories",
                    "id": "5117a596-fd4f-4fba-a27e-5affde564b2c",
                    "attributes": {
                        "name": "none",
                        "sort": 0,
                        "key": "none"
                    }
                },
                "sort_type": 0,
                "field_type": "single",
                "attribute_style": "normal",
                "attribute_type": "other",
                "base_url": ""
            },
            "relationships": {
                "options": {
                    "data": [
                        {
                            "type": "options",
                            "id": "06dc8c77-097e-4ed6-b225-d468e3c0f3f2"
                        },
                        {
                            "type": "options",
                            "id": "c0fab864-3d14-4c66-8bcf-468fd84191f9"
                        }
                    ]
                }
            }
        },
        {
            "type": "attributes",
            "id": "0e2e958e-ea2c-45e6-b1f0-b0d383b5cecb",
            "attributes": {
                "name": "Farbe",
                "original_name": "Farbe",
                "sort": 1,
                "description": null,
                "key": "color",
                "category": "none",
                "attribute_category": {
                    "type": "attribute_categories",
                    "id": "5117a596-fd4f-4fba-a27e-5affde564b2c",
                    "attributes": {
                        "name": "none",
                        "sort": 0,
                        "key": "none"
                    }
                },
                "sort_type": 1,
                "field_type": "single",
                "attribute_style": "normal",
                "attribute_type": "other",
                "base_url": ""
            },
            "relationships": {
                "options": {
                    "data": [
                        {
                            "type": "options",
                            "id": "7fff7f85-1869-43d3-a831-8ac14d77aea5"
                        },
                        {
                            "type": "options",
                            "id": "17d3f17e-67c3-4a85-97aa-db614caba671"
                        }
                    ]
                }
            }
        },
        {
            "type": "attributes",
            "id": "be1f1710-bec4-4680-acb6-94c7fbc72355",
            "attributes": {
                "name": "Menge",
                "original_name": "Menge",
                "sort": 1,
                "description": null,
                "key": "quantity",
                "category": "none",
                "attribute_category": {
                    "type": "attribute_categories",
                    "id": "475b3109-da2b-4fd6-bd53-556864ed09ea",
                    "attributes": {
                        "name": "quantity",
                        "sort": 0,
                        "key": "quantity"
                    }
                },
                "sort_type": 0,
                "field_type": "single",
                "attribute_style": "normal",
                "attribute_type": "quantity",
                "base_url": ""
            },
            "relationships": {
                "options": {
                    "data": [
                        {
                            "type": "options",
                            "id": "a83eb679-73e3-4017-b897-4887622f9c99",
                            "attributes": {
                                "key": "1",
                                "name": "1",
                                "original_name": "1",
                                "description": null,
                                "sort": 0,
                                "icon_name": "",
                                "is_highlight": false,
                                "meta": {
                                    "quantity": 1
                                }
                            }
                        },
                        {
                            "type": "options",
                            "id": "3224e705-8826-4a51-a5d4-b6ec552a9b81",
                            "attributes": {
                                "key": "5",
                                "name": "5",
                                "original_name": "5",
                                "description": null,
                                "sort": 0,
                                "icon_name": "",
                                "is_highlight": false,
                                "meta": {
                                    "quantity": 5
                                }
                            }
                        },
                        {
                            "type": "options",
                            "id": "dee917c3-4825-44d0-a7b2-4ed3a27d0d53",
                            "attributes": {
                                "key": "10",
                                "name": "10",
                                "original_name": "10",
                                "description": null,
                                "sort": 0,
                                "icon_name": "",
                                "is_highlight": false,
                                "meta": {
                                    "quantity": 10
                                }
                            }
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "type": "options",
            "id": "06dc8c77-097e-4ed6-b225-d468e3c0f3f2",
            "attributes": {
                "name": "DIN-Format",
                "original_name": "DIN-Format",
                "key": "din_format",
                "description": "desc",
                "sort": 1,
                "icon_name": "testIcon",
                "is_highlight": false,
                "meta": []
            }
        },
        {
            "type": "options",
            "id": "c0fab864-3d14-4c66-8bcf-468fd84191f9",
            "attributes": {
                "name": "Rechteck",
                "original_name": "Rechteck",
                "key": "rechteck",
                "description": null,
                "sort": 2,
                "icon_name": "",
                "is_highlight": false,
                "meta": []
            }
        },
        {
            "type": "options",
            "id": "7fff7f85-1869-43d3-a831-8ac14d77aea5",
            "attributes": {
                "name": "Blau",
                "original_name": "Blau",
                "key": "blue",
                "description": null,
                "sort": 0,
                "icon_name": "",
                "is_highlight": false,
                "meta": []
            }
        },
        {
            "type": "options",
            "id": "17d3f17e-67c3-4a85-97aa-db614caba671",
            "attributes": {
                "name": "Rot",
                "original_name": "Rot",
                "key": "red",
                "description": null,
                "sort": 50,
                "icon_name": "main_icon",
                "is_highlight": true,
                "meta": []
            }
        },
        {
            "type": "options",
            "id": "a83eb679-73e3-4017-b897-4887622f9c99",
            "attributes": {
                "name": "1",
                "original_name": "1",
                "key": "1",
                "description": null,
                "sort": 0,
                "icon_name": "",
                "is_highlight": false,
                "meta": {
                    "quantity": 1
                }
            }
        },
        {
            "type": "options",
            "id": "3224e705-8826-4a51-a5d4-b6ec552a9b81",
            "attributes": {
                "name": "5",
                "original_name": "5",
                "key": "5",
                "description": null,
                "sort": 0,
                "icon_name": "",
                "is_highlight": false,
                "meta": {
                    "quantity": 5
                }
            }
        },
        {
            "type": "options",
            "id": "dee917c3-4825-44d0-a7b2-4ed3a27d0d53",
            "attributes": {
                "name": "10",
                "original_name": "10",
                "key": "10",
                "description": null,
                "sort": 0,
                "icon_name": "",
                "is_highlight": false,
                "meta": {
                    "quantity": 10
                }
            }
        }
    ]
}
🟠401Attribute not found
🟠404OK
Modified at 2026-05-29 10:44:16
Previous
get country options of a product
Next
create or update an attribute
Built with