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

/api/serviceproviders/{serviceproviderId}/orders/{orderId}

PATCH
/api/serviceproviders/{serviceproviderId}/orders/{orderId}

Request

Path Params

Header Params

Body Params application/json

Example
{
    "reference": "string",
    "currency": "string",
    "status": "string",
    "details": [
        {
            "state": "string",
            "sender_address": {
                "first_name": "string",
                "last_name": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "phone": "string"
            },
            "invoice_address": {
                "first_name": "string",
                "last_name": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "phone": "string"
            },
            "delivery_address": {
                "first_name": "string",
                "last_name": "string",
                "company": "string",
                "street": "string",
                "house_number": "string",
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "phone": "string"
            },
            "reference": "string",
            "remoteReference": "string"
        }
    ]
}

Responses

🟠401Unauthorized request
application/json
Body

Example
{
    "jsonapi": {
        "version": "string"
    },
    "data": {
        "type": "string",
        "id": "string",
        "attributes": {
            "details": [
                {
                    "type": "string",
                    "id": "string",
                    "attributes": {
                        "product_type": "string",
                        "partial_deliveries": [
                            "string"
                        ],
                        "sku": {
                            "price": null,
                            "combinations": null,
                            "created_at": null,
                            "updated_at": null
                        },
                        "price": null,
                        "remoteReference": null,
                        "order_combination": null,
                        "page_information": null,
                        "state": "string",
                        "trackingData": null,
                        "reference": "string",
                        "created_at": "string",
                        "updated_at": "string"
                    },
                    "relationships": {
                        "files": {
                            "data": [
                                {
                                    "type": "string",
                                    "id": "string"
                                }
                            ]
                        },
                        "sender_address": {
                            "data": {
                                "type": "string",
                                "id": "string"
                            }
                        },
                        "delivery_address": {
                            "data": {
                                "type": "string",
                                "id": "string"
                            }
                        },
                        "invoice_address": {
                            "data": {
                                "type": "string",
                                "id": "string"
                            }
                        }
                    }
                }
            ],
            "client": {
                "type": "string",
                "id": "string",
                "attributes": {
                    "name": "string"
                }
            },
            "reference": "string",
            "order_custom_fields": [
                "string"
            ],
            "files": [
                "string"
            ],
            "order-uploads": [
                "string"
            ],
            "state": "string",
            "currency": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    },
    "included": [
        {
            "type": "string",
            "id": "string",
            "attributes": {
                "url": null,
                "status": 0,
                "created_at": "string",
                "updated_at": "string",
                "first_name": "string",
                "last_name": "string",
                "salutation": null,
                "company": "string",
                "street": "string",
                "house_number": "string",
                "additional_line": null,
                "zip_code": "string",
                "city": "string",
                "country": "string",
                "email": null,
                "phone": "string",
                "comment": null,
                "vat_number": null
            }
        }
    ]
}
🟢200OK
Modified at 2024-06-21 10:16:44
Previous
/api/serviceproviders/{serviceproviderId}/orders/{orderId}
Next
create an order
Built with