Example be.open API
    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
        PATCH
      • change option settings just for this service provider
        PATCH
      • change attribute category setting just for this service provider
        PATCH
      • /api/serviceproviders/{serviceproviderId}/orders
        GET
      • /api/serviceproviders/{serviceproviderId}/orders/{orderId}
        GET
      • /api/serviceproviders/{serviceproviderId}/orders/{orderId}
        PATCH
    • 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

    be.open API

    Introduction#

    be.open is a production middleware that's all about collecting external print products in one place. The idea is to make them as global as possible, so they can be used in different ways.
    be.open is made up of three main areas:
    1.
    Product container (product import, for producers)
    2.
    Product delivery (product export, for resellers)
    3.
    Order management (for producers)
    The be.open system lets you import products from external sources. This is where external producers can import their products into our product database.
    Any external systems can read the imported products from our product database and connect or offer them for use in external systems.
    The third area is the order area. The idea is that resellers can push their sold orders back into our middleware so that the producer can produce them.
    The producer can read the orders from our middleware via our order API or have them pushed to him to process them further.
    Finally, the producer can import status or shipping updates into our middleware if necessary, and this information can then be accessed and further processed by the connected software.

    How to get started?#

    How can I get an introduction to the be.open?#

    The entry starts with getting ready to record products in our middleware. There are a few different ways to do this, as shown in our API.

    Attributes & Options#

    Get all available attributes#

    You can find the endpoint documentation here: How to get all the available attributes
    Example Schema
    Attribute

    Get all available options for one attribute#

    You can find the endpoint documentation here: How to get all options for an single attribute
    Example Schema
    Option

    Products & Combinations#

    What is a "combination"?#

    A product has lots of different options. A combination of products is the link between each individual attribute. This can result in a variety of different product combinations per product.
    A product has lots of different combinations. A combination is always a merger of all production variants. It is made up of attribute ID/option ID. A combination is not an attribute ID with an option ID, but a combination of many of these ID pairs.
    First, you'll need to set up an import file using an external option mapping. To import a product into our middleware successfully, you'll need to run the "Reading attributes" method in conjunction with "Read out options." Link the results to your internal product information to generate all possible combination pairings of your product and then import them into our product API.

    Importing products#

    Nachdem ein internes Matching zwischen unseren globalen Attributen und Optionen zu Ihren Produkteigenschaften stattgefunden hat, können Sie eine Importdatei aufbauen und in unsere Middleware via API importieren.
    You can find the endpoint documentation here: How to import a new product
    Example Schema
    CreateProduct

    The import file consists of several sections:
    1.
    Meta Data
    2.
    Isolated Options (dependable_attributes)
    "Isolated options" are options that are always available in all possible product combinations and don't affect the price when you choose them.
    3.
    Combinations and Pricing (product_variants)
    This is the primary area of combination and pricing.

    Update combinations#

    Combinations are imported and updated if they already exist.

    Import splitted combinations#

    If a product has many combinations, import them via the POST endpoint /api/product/combinations.
    You can find the endpoint documentation here: How to import splitted combinations
    To use this endpoint, the product must be created using the POST endpoint /api/products. Specify product_variants when creating the product.
    You can find the endpoint documentation here: How to import a new product

    Delete combinations#

    To delete product combinations, call the DELETE endpoint /api/product/combinations.
    You can find the endpoint documentation here: How to delete a combination

    Special features for loose-leaf documents#

    To import loose-leaf articles, pass the value "loose_leaf" for the product_type parameter. Pass loose-leaf-specific information in the loose_leaf_data parameter.
    For product_variants, you can also pass loose-leaf-specific prices.
    After an article has been imported, it is available for use in all connected software.

    Get prodcuts from be.open#

    We provide several API methods to read products from our middleware and integrate them into external software. You can use the function to get all products.
    You can find the endpoint documentation here: How to get all products
    This method gives you an array of all products. The product data is structured as follows:
    You receive the ID of the product. Below this is an array Attributes which contains article data such as name, description, etc.
    Further below there are two further arrays meta and customFormat.
    The array meta contains various meta information such as the article number or the seo url of the product.
    The array customFormat contains parameters for the article type "loose-leaf".
    Modified at 2024-05-27 12:44:54
    Next
    Get api auth token
    Built with