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}

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

Request

Path Params

Responses

🟢200Returns the order.
application/json
Body

Example
{
    "jsonapi": {
        "version": "1.0"
    },
    "data": {
        "type": "orders",
        "id": "07685c7a-fb56-4406-8463-f3b94d8bc621",
        "attributes": {
            "reference": "pl_local_YTBAQR 1995",
            "created_at": [],
            "updated_at": [],
            "details": [
                {
                    "type": "order_details",
                    "id": "9661184d-af86-4500-a382-8be5e32591fc",
                    "attributes": {
                        "reference": "pl_local_YTBAQR 1995",
                        "created_at": "2023-06-02T09:40:05+02:00",
                        "updated_at": "2023-06-02T09:40:08+02:00",
                        "partial_deliveries": [],
                        "sku": "140ad68e-4b90-4950-8bbf-c8a9feb19e19",
                        "price": null,
                        "remoteReference": null,
                        "order_combination": {
                            "type": "order_combination",
                            "attributes": {
                                "attribute_options": [
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "0090d106-2bb0-4894-bad9-fd07acec0fc4",
                                            "external_attribute_id": "",
                                            "option_id": "84d550ea-ea9d-4ec1-a633-e07b0a629d64",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "0131fe29-4cfc-43d3-a633-f96a4dd2bcf0",
                                            "external_attribute_id": "",
                                            "option_id": "85eb3bb4-a9f3-4bf3-bb6f-30b4c370cc6f",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "7e3589dd-6ccb-4c75-b39e-6ec2ca130b9b",
                                            "external_attribute_id": "",
                                            "option_id": "ef731df9-5227-424d-843c-1802eb33df3d",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "a94a9bae-43a9-4d2c-81e2-2b05a7c19bf9",
                                            "external_attribute_id": "",
                                            "option_id": "f65dd747-eeaf-4f31-a91a-98b7dbad811a",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "b6e97197-5080-4265-b92d-178f5773ed84",
                                            "external_attribute_id": "",
                                            "option_id": "18c29bae-7ff5-465b-be38-264e075a1ef3",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "d33c7c65-2054-432e-bded-0a50ed311e6a",
                                            "external_attribute_id": "",
                                            "option_id": "a5384fff-011c-4f78-b275-5c0dffc1d0fd",
                                            "external_option_id": ""
                                        }
                                    },
                                    {
                                        "type": "attribute_option",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "e8bc14fb-f011-49d4-b40a-45d502f177d9",
                                            "external_attribute_id": "",
                                            "option_id": "25c347d4-21d9-42f8-bbff-7fbf6e0070ac",
                                            "external_option_id": ""
                                        }
                                    }
                                ]
                            }
                        },
                        "page_information": null
                    },
                    "relationships": {
                        "files": {
                            "data": [
                                {
                                    "type": "order_detail_files",
                                    "id": "20dfb5f4-0fc7-44b2-b5f8-121a56806c1d"
                                }
                            ]
                        },
                        "sender_address": {
                            "data": {
                                "type": "addresses",
                                "id": "9183ecdd-6fc1-4388-be94-3e3227617e11"
                            }
                        },
                        "delivery_address": {
                            "data": {
                                "type": "addresses",
                                "id": "192a7326-de8f-43d4-b505-7bd7a6b3582a"
                            }
                        },
                        "invoice_address": {
                            "data": {
                                "type": "addresses",
                                "id": "62f3da73-90da-4880-af56-4e7aad509d90"
                            }
                        }
                    }
                }
            ],
            "order_custom_fields": [],
            "files": [],
            "order-uploads": [],
            "state": "in_progress",
            "currency": "EUR",
            "client": {
                "type": "client",
                "id": "69381c0c-7ab8-47ac-8b09-1a38eba5a15f",
                "attributes": {
                    "name": "FlyeralarmTest (DE)"
                }
            }
        }
    },
    "included": [
        {
            "type": "order_detail_files",
            "id": "20dfb5f4-0fc7-44b2-b5f8-121a56806c1d",
            "attributes": {
                "url": null,
                "status": 0,
                "created_at": "2023-06-02T09:40:05+02:00",
                "updated_at": "2023-06-02T09:40:05+02:00"
            }
        },
        {
            "type": "addresses",
            "id": "9183ecdd-6fc1-4388-be94-3e3227617e11",
            "attributes": {
                "first_name": "test",
                "last_name": "tester",
                "salutation": null,
                "company": "dennis_djeraba",
                "street": "Holterhöfe",
                "house_number": "15",
                "additional_line": null,
                "zip_code": "47877",
                "city": "Willich",
                "country": "DE",
                "email": null,
                "phone": "0000000000",
                "comment": null,
                "vat_number": null
            }
        },
        {
            "type": "addresses",
            "id": "192a7326-de8f-43d4-b505-7bd7a6b3582a",
            "attributes": {
                "first_name": "test",
                "last_name": "tester",
                "salutation": null,
                "company": "dennis_djeraba",
                "street": "teststr",
                "house_number": "12",
                "additional_line": null,
                "zip_code": "47877",
                "city": "testhausen",
                "country": "DE",
                "email": null,
                "phone": "0000000000",
                "comment": null,
                "vat_number": null
            }
        },
        {
            "type": "addresses",
            "id": "62f3da73-90da-4880-af56-4e7aad509d90",
            "attributes": {
                "first_name": "test",
                "last_name": "tester",
                "salutation": null,
                "company": "testfirma",
                "street": "teststr.",
                "house_number": "12",
                "additional_line": null,
                "zip_code": "47877",
                "city": "willich",
                "country": "DE",
                "email": null,
                "phone": "12345",
                "comment": null,
                "vat_number": null
            }
        }
    ]
}
🟠401Unauthorized request
Modified at 2024-05-21 12:07:43
Previous
/api/serviceproviders/{serviceproviderId}/orders
Next
/api/serviceproviders/{serviceproviderId}/orders/{orderId}
Built with