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
      • create order with upload
      • get order
    • 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
        GET
      • getOrders
        GET
      • getOrderByReference
        GET
      • getOrderCart
        GET
    • FreeOrder
      • addFreeOrder
    • Schemas
      • FreeOrder
      • FreeOrderResponse
      • ApiAddress
      • FreeOrderPrice
      • FreeOrderCart
      • FreeOrderArticle
      • FreeOrderDataKeyValuePrice
  1. Order

getOrderByReference

GET
/api/component/Order/byReference/{referenceNumber}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params

Responses

🟢200
application/json
Body

Example
{
    "orderDate": "2023-04-28T10:32:12.000000Z",
    "totalNet": 1744.47,
    "totalGross": 1744.47,
    "voucher": false,
    "voucherValue": 0,
    "shippingMethod": "",
    "shippingValue": 1,
    "customerNumber": "1",
    "guestOrder": false,
    "newsletter": 2,
    "externalReferenceNumber":"Final-1",
    "billingAddress": {
        "company": "Freude & Spaß GmbH",
        "firstname": "Max",
        "lastname": "Mustermann",
        "street": "Mustergasse 7",
        "zip": "12345",
        "city": "Musterstadt",
        "country": "Deutschland",
        "mail": "max@mustermann.de",
        "phone": "0123456789",
        "mobilephone": "",
        "fax": "",
        "homepage": "",
        "ustid": "DE123456789",
        "gender": "m"
    },
    "differentDeliveryAddress": {
        "company": "",
        "firstname": "Martina",
        "lastname": "Mustermann",
        "street": "Musterstraße 37",
        "zip": "54321",
        "city": "Musterhausen",
        "country": "Deutschland",
        "mail": "martina@mustermann.de",
        "phone": "011223344",
        "mobilephone": "",
        "fax": "",
        "homepage": "",
        "ustid": "",
        "gender": "w"
    },
    "returnAddress": {
        "company": "",
        "firstname": "",
        "lastname": "",
        "street": "",
        "zip": "",
        "city": "",
        "country": "0",
        "mail": "",
        "phone": "",
        "mobilephone": "",
        "fax": "",
        "homepage": "",
        "ustid": "",
        "gender": ""
    },
    "carts": [
        {
            "serviceProviderId": 0,
            "status": "WEITERVERA",
            "deliveryDate": "2023-10-18",
            "creationDate": "2023-10-11T09:15:43.000000Z",
            "jobNumber": "3-23-07-10-0004",
            "tracking": {
                "id": null
            },
            "paymentType": "Rechnung",
            "article": {
                "name": "Seitenwände für Pavillon",
                "description": "",
                "productGroup": "7",
                "articleNumber": "Seitenwände für Pavillon"
            }
        },
        {
            "serviceProviderId": 0,
            "status": "FEHLERHAFT",
            "deliveryDate": "2023-10-18",
            "creationDate": "2023-10-11T09:16:37.000000Z",
            "jobNumber": "3-23-07-10-0005",
            "tracking": {
                "id": 123456
            },
            "paymentType": "Rechnung",
            "article": {
                "name": "Schaumdeckel",
                "description": "Aufstellen, Unterlegen, Hinlegen: Nach Ihren Wünschen bedruckte Schaumdeckel sind vielseitig einsetzbar.",
                "productGroup": "7",
                "articleNumber": "Schaumdeckel"
            }
        }
    ]
}
Modified at 2026-04-10 14:48:20
Previous
getOrders
Next
getOrderCart
Built with