Example be.open API
  1. Products & Combinations
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
  1. Products & Combinations

adds or updates a product with attributes, options and combinations.

POST
/api/products

Request

Header Params

Body Params application/json

Example

Responses

🟢200Returns the product.
application/json
Body

Example
{
    "jsonapi": {
        "version": "string"
    },
    "data": {
        "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"
        }
    }
}
🟠401Unauthorized request
Modified at 2024-05-21 11:57:04
Previous
Returns the products.
Next
Returns the single product.
Built with