Example be.open API
  1. Improved Schemas
Example be.open API
  • be.open API
  • Auth
    • Get api auth token
      POST
  • Attributes & Options
    • get all available attributes
      GET
    • add or update an attribute
      POST
    • get an attribute
      GET
    • adds or updates an option
      POST
    • get attribute categories
      GET
    • get options of a type
      POST
  • Basket
    • get Basket
      POST
  • Price
    • get Price list
      POST
  • Categories
    • get product categories
      GET
    • Returns the products of a category.
      GET
  • Products & Combinations
    • get product configuration
      POST
    • get option configuration
      POST
    • get product attributes
      GET
    • get product independant attributes
      GET
    • Returns the products.
      GET
    • adds or updates a product with attributes, options and combinations.
      POST
    • Returns the single product.
      GET
    • adds or updates attributes, options and combinations of a product. Used to import combinations in parts
      POST
    • delete combinations.
      DELETE
    • get country attribute with options
      GET
  • 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. Improved Schemas

ExampleAttributesCollection

{
    "jsonapi": {
        "version": "1.0"
    },
    "meta": {
        "page": 1,
        "limit": 0,
        "pages": 0,
        "total": 0
    },
    "links": {
        "first": "http://example.com",
        "last": "http://example.com",
        "next": "http://example.com",
        "previous": "http://example.com"
    },
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "attributes": {
            "name": "string",
            "sort": 0,
            "description": "string",
            "category": "string",
            "attribute_category": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "type": "string",
                "attributes": {
                    "key": "string",
                    "name": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            },
            "original_name": "string",
            "sort_type": 0,
            "field_type": "string",
            "attribute_style": "string",
            "attribute_type": "string"
        }
    }
}
Built with