Example be.open API
  1. Custom Schemas
Example be.open API
  • be.open API
  • Auth
    • Get api auth token
  • Attributes & Options
    • get all available attributes
    • add or update an attribute
    • get an attribute
    • adds or updates an option
    • get attribute categories
    • get options of a type
  • 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 independant 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
    • /api/serviceproviders/{serviceproviderId}/orders
    • /api/serviceproviders/{serviceproviderId}/orders/{orderId}
    • /api/serviceproviders/{serviceproviderId}/orders/{orderId}
  • Order
    • create an order
    • create order with upload
    • get order
  • Dashboard API (MOVE TO ANOTHER PROJECT)!
    • Customer
      • whoAmI
      • addExternalClient
    • Orders
      • create order
      • update order
      • update order cart
  • Schemas
    • Schemas
      • Attribute
      • DeleteQuantityShipping
      • DeleteQuantityDelivery
      • Authentication
      • AuthenticationResponse
      • AttributeCategory
      • CreateAttribute
      • CreateOption
      • CategoryModel
      • Product
      • CreateProductCombination
      • DeleteProductCombination
      • BasicOrder
      • Order
      • Option
      • ProductMetaInformation
      • DeleteProductVariant
      • Client
      • OrderDetail
      • OrderCustomField
      • OrderFile
      • OrderUpload
      • File
      • ProductAttribute
      • DeleteProductQuantity
      • PartialDelivery
      • OrderDetailFile
      • ProductCombination
      • Address
      • OrderDetailPrice
      • OrderDetailCombination
      • Address2
      • PriceConfiguration
      • Currency
      • ConfigurationOption
      • Price
      • ConfigurationOptionSize
    • Improved Schemas
      • ExampleAttributesCollection
      • Attribute
      • AttributeMetaData
      • Category
    • Responses
    • Custom Schemas
      • ProductResponse
      • OptionOfAttribute
      • CreateProduct
      • ProductTypeData
      • ProductQuantity
      • QuantityShipping
      • QuantityDelivery
      • LooseLeafData
      • DependableAttribute
      • DependableOption
      • ProductVariant
      • AttributeResponse
      • OrderResponse
      • OrderDetailResponse
      • OrderDetailPage
      • OrderAttributeOption
      • UpdateServiceproviderOrderResponse
      • ServiceproviderOrderDetail
      • BasketPrice
      • OrderAddressResponse
      • AttributeOption
      • CreateOrderAddress
      • CreateOrder
      • PatchServiceProviderOrder
    • placedOrder
  1. Custom Schemas

ProductResponse

{
    "type": "string",
    "id": "string",
    "attributes": {
        "meta": {
            "type": "string",
            "id": "string",
            "attributes": {
                "characteristics": null,
                "info": null,
                "shipping_packing_info": null,
                "product_number": null,
                "product_type": "string",
                "fix_price": null,
                "seo_url": null,
                "canonical_url": null,
                "browser_title": null,
                "meta_key_words": null,
                "meta_description": null,
                "production_period": null,
                "number_of_pages": null,
                "icons": [
                    "string"
                ],
                "images": [
                    "string"
                ],
                "uploads": [
                    "string"
                ]
            }
        },
        "key": "string",
        "status": 0,
        "isClosedShop": true,
        "hasExternalPrice": true,
        "name": "string",
        "description": null,
        "serviceprovider": "string",
        "custom_format": {
            "type": "string",
            "attributes": {
                "min_width": null,
                "max_width": null,
                "min_height": null,
                "max_height": null
            },
            "links": {
                "self": "string"
            }
        },
        "loose_leaf_data": {
            "type": "string",
            "attributes": {
                "min_pages": null,
                "max_pages": null,
                "min_copies": null,
                "max_copies": null,
                "divisible_by": null,
                "pages_default": null,
                "copies_default": null,
                "hide_pages": true,
                "hide_copies": true,
                "hide_color_pages": true
            },
            "links": {
                "self": "string"
            }
        },
        "categoryId": "string",
        "has_sets": true
    },
    "links": {
        "self": "string"
    }
}
Built with