Example be.open API
  1. 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. Schemas

Order

{
    "client": {
        "name": "string"
    },
    "reference": "string",
    "details": [
        {
            "partial_deliveries": [
                {
                    "delivery_address": {
                        "first_name": "string",
                        "last_name": "string",
                        "salutation": "string",
                        "company": "string",
                        "street": "string",
                        "house_number": "string",
                        "additional_line": "string",
                        "zip_code": "string",
                        "city": "string",
                        "country": "string",
                        "email": "string",
                        "phone": "string",
                        "comment": "string"
                    },
                    "quantity": "string"
                }
            ],
            "files": [
                {
                    "url": "string",
                    "status": 0,
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "sku": {
                "price": {
                    "prices": [
                        {
                            "price_net": 0,
                            "price_gross": 0,
                            "shipping_net": 0,
                            "shipping_gross": 0,
                            "price_fixed": 0,
                            "price_color": 0,
                            "price_copies": 0,
                            "price_total_copies_site": 0,
                            "price_discount_copies": {},
                            "tax_rate": 0,
                            "tax_value": 0,
                            "shipping_tax_value": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                },
                "combinations": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "sender_address": {
                "first_name": "string",
                "last_name": "string",
                "salutation": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "additional_line": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "email": "string",
                "phone": "string",
                "comment": "string"
            },
            "delivery_address": {
                "first_name": "string",
                "last_name": "string",
                "salutation": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "additional_line": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "email": "string",
                "phone": "string",
                "comment": "string"
            },
            "invoice_address": {
                "first_name": "string",
                "last_name": "string",
                "salutation": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "additional_line": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "email": "string",
                "phone": "string",
                "comment": "string"
            },
            "price": {
                "currency": {
                    "name": "string",
                    "abbr": "string",
                    "symbol": "string",
                    "prices": [
                        {
                            "price_net": 0,
                            "price_gross": 0,
                            "shipping_net": 0,
                            "shipping_gross": 0,
                            "price_fixed": 0,
                            "price_color": 0,
                            "price_copies": 0,
                            "price_total_copies_site": 0,
                            "price_discount_copies": {},
                            "tax_rate": 0,
                            "tax_value": 0,
                            "shipping_tax_value": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z"
                        }
                    ],
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                },
                "price_net": 0,
                "price-gross": 0,
                "shipping-net": 0,
                "shipping-gross": 0
            },
            "remoteReference": "string",
            "order_combination": {
                "data": {},
                "configuration_options": [
                    {
                        "id": "string",
                        "value_id": "string",
                        "sizes": [
                            {
                                "id": "string",
                                "quantity": 0
                            }
                        ]
                    }
                ],
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
            },
            "page_information": {
                "copies": 0,
                "pages": 0,
                "color_pages": 0
            },
            "state": "string",
            "trackingData": "string",
            "reference": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "order_custom_fields": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "files": [
        {
            "url": "string",
            "type": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "order-uploads": [
        {
            "path": "string",
            "name": "string"
        }
    ],
    "state": "string",
    "currency": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}
Built with