1. Order
Example be.open API
  • 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
        POST
      • create order with upload
        POST
      • get order
        GET
    • 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
  • Druckshop API
    • Cart
      • getByJobNumber
    • Tracking
      • getByJobNumber
      • addTrackingId
    • Order
      • getOrder
      • getOrders
      • getOrderByReference
      • getOrderCart
    • FreeOrder
      • addFreeOrder
    • Schemas
      • FreeOrder
      • FreeOrderResponse
      • ApiAddress
      • FreeOrderPrice
      • FreeOrderCart
      • FreeOrderArticle
      • FreeOrderDataKeyValuePrice
  1. Order

get order

Developing
GET
/api/order/{orderId}
get information for an order

Request

Path Params

Responses

🟢200Success
application/json
Body

Example
{
    "jsonapi": {
        "version": "string"
    },
    "data": {
        "type": "string",
        "id": "string",
        "attributes": {
            "client": {
                "type": "string",
                "id": "string",
                "attributes": {
                    "name": "string"
                }
            },
            "reference": "string",
            "details": [
                {
                    "type": "string",
                    "id": "string",
                    "attributes": {
                        "product_type": "string",
                        "partial_deliveries": [
                            "string"
                        ],
                        "sku": "string",
                        "price": null,
                        "remoteReference": null,
                        "order_combination": {
                            "type": "string",
                            "attributes": {
                                "attribute_options": [
                                    {
                                        "type": "string",
                                        "id": 0,
                                        "attributes": {
                                            "attribute_id": "string",
                                            "external_attribute_id": "string",
                                            "option_id": "string",
                                            "external_option_id": "string"
                                        }
                                    }
                                ]
                            }
                        },
                        "page_information": {
                            "type": "string",
                            "id": "string",
                            "attributes": {
                                "copies": 0,
                                "pages": 0,
                                "color_pages": 0
                            }
                        },
                        "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"
                            }
                        }
                    }
                }
            ],
            "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": {
                "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": "string",
                "vat_number": null
            }
        }
    ]
}
Modified at 2024-06-21 07:54:42
Previous
create order with upload
Next
whoAmI
Built with