### GET /api/v1/layouts Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of available layout templates. ```APIDOC ## GET /api/v1/layouts ### Description Retrieves a list of available layout templates. ### Method GET ### Endpoint /api/v1/layouts ### Response #### Success Response (200) - **Schema**: [Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Models.LayoutTemplate](#Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Models.LayoutTemplate) ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### GET /api/v1/products/{id} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries a single product by its ID or SKU. ```APIDOC ## GET /api/v1/products/{id} ### Description Queries a single product by its ID or SKU. ### Method GET ### Endpoint /api/v1/products/{id} ### Parameters #### Path Parameters - **id** (string) - Yes - The id or the sku of the article to query #### Query Parameters - **lookupBy** (string) - Optional - Either the value id, ean or the value sku to specify the meaning of the id parameter. ### Response #### Success Response (200) - **Schema** - [Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleApiModel] ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Get Single Product using cURL Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Fetches detailed information for a specific product using a GET request. Can look up by ID, SKU, or EAN. Response includes all product attributes like pricing, stock, and metadata. ```bash curl -X GET "https://api.billbee.io/api/v1/products/PROD-123?lookupBy=sku" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" # lookupBy options: "id", "sku", "ean" # Response: { "ErrorMessage": null, "ErrorCode": 0, "Data": { "Id": 1001, "SKU": "PROD-123", "Title": [{"Text": "Sample Product", "LanguageCode": "en"}], "Description": [{"Text": "Detailed product description", "LanguageCode": "en"}], "Price": 49.99, "CostPrice": 25.00, "VatIndex": 1, "Vat1Rate": 19.0, "StockCurrent": 150, "StockDesired": 200, "StockWarning": 20, "Weight": 500, "WeightNet": 450, "EAN": "1234567890123", "Type": 1, "Manufacturer": "ACME Corp" } } ``` -------------------------------- ### GET /api/v1/products/category Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all defined product categories. ```APIDOC ## GET /api/v1/products/category ### Description Retrieves a list of all defined product categories. ### Method GET ### Endpoint /api/v1/products/category ### Response #### Success Response (200) - **Schema** - object ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Billbee API Order States Example Response Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt An example JSON response illustrating the structure for order states returned by the Billbee API. It maps numerical state identifiers to human-readable string values. ```json { "1": "Ordered", "2": "Confirmed", "3": "Paid", "4": "Shipped", "5": "Reclamation", "6": "Deleted", "7": "Closed", "8": "Canceled" } ``` -------------------------------- ### GET /api/v1/products Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all products. Supports pagination and filtering by creation date or article ID. ```APIDOC ## GET /api/v1/products ### Description Get a list of all products. Supports pagination and filtering by creation date or article ID. ### Method GET ### Endpoint /api/v1/products ### Parameters #### Query Parameters - **page** (integer) - Optional - The current page to request starting with 1 - **pageSize** (integer) - Optional - The pagesize for the result list. Values between 1 and 250 are allowed - **minCreatedAt** (dateTime) - Optional - Optional the oldest create date of the articles to be returned - **minimumBillBeeArticleId** (long) - Optional - - **maximumBillBeeArticleId** (long) - Optional - ### Response #### Success Response (200) - **Schema** - [Rechnungsdruck.WebApp.Controllers.Api.ApiPagedResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Model.ArticleApiModel] ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Get List of Products using cURL Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Retrieves a paginated list of products using a GET request. Supports filtering by creation date and pagination parameters like page number and size. Response includes paging information and product data. ```bash curl -X GET "https://api.billbee.io/api/v1/products?page=1&pageSize=50&minCreatedAt=2024-01-01T00:00:00Z" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" # Response: { "Paging": { "Page": 1, "TotalPages": 5, "TotalRows": 245, "PageSize": 50 }, "Data": [ { "Id": 1001, "SKU": "PROD-123", "Title": [{"Text": "Sample Product", "LanguageCode": "en"}], "Price": 49.99, "VatIndex": 1, "Vat1Rate": 19.0, "StockCurrent": 150, "StockWarning": 20, "Weight": 500, "EAN": "1234567890123", "Type": 1, "IsDigital": false, "Images": [ { "Id": 501, "Url": "https://example.com/images/product-123.jpg", "IsDefault": true, "Position": 0 } ] } ] } ``` -------------------------------- ### GET /api/v1/enums/orderstates Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all defined order states. ```APIDOC ## GET /api/v1/enums/orderstates ### Description Returns a list with all defined orderstates. ### Method GET ### Endpoint /api/v1/enums/orderstates ### Parameters ### Request Example ```json {} ``` ### Response #### Success Response (200) - **object** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get All Customers Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all customers. Supports pagination to manage large datasets. ```APIDOC ## GET /api/v1/customers ### Description Get a list of all customers. Supports pagination. ### Method GET ### Endpoint /api/v1/customers ### Parameters #### Query Parameters - **page** (integer) - Optional - The current page to request starting with 1 - **pageSize** (integer) - Optional - The pagesize for the result list. Values between 1 and 250 are allowed ### Response #### Success Response (200) - **Data** (ApiPagedResultOfListOfCustomerApiModel) - The paged list of customers. #### Response Example { "Data": { "Page": 1, "PageSize": 25, "TotalPages": 10, "TotalEntries": 250, "Data": [ { "Id": 1, "Name": "Example Customer", "Email": "customer@example.com" } ] } } ``` -------------------------------- ### GET /api/v1/products/{productId}/images Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Returns a list of all images associated with a specific product, identified by its ID. ```APIDOC ## GET /api/v1/products/{productId}/images ### Description Returns a list of all images of the product. ### Method GET ### Endpoint /api/v1/products/{productId}/images ### Parameters #### Path Parameters - **productId** (string) - Required - The ID of the product whose images are to be retrieved. ### Response #### Success Response (200) - **Data** (Array of strings) - A list of URLs for the product images. #### Response Example ```json { "succeeded": true, "errors": [], "data": [ "https://example.com/image1.jpg", "https://example.com/image2.png" ] } ``` ``` -------------------------------- ### GET /api/v1/products/custom-fields Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries a list of all custom fields available for products. Supports pagination. ```APIDOC ## GET /api/v1/products/custom-fields ### Description Queries a list of all custom fields. ### Method GET ### Endpoint /api/v1/products/custom-fields ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. - **pageSize** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **Data** ([Rechnungsdruck.WebApp.Controllers.Api.ApiPagedResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Model.ArticleApiCustomFieldDefinitionModel][]) - A paged list of custom field definitions. #### Response Example ```json { "succeeded": true, "errors": [], "data": { "page": 1, "pageSize": 20, "totalResources": 5, "resources": [ { "id": 1, "name": "CustomField1", "type": "Text" } ] } } ``` ``` -------------------------------- ### GET /api/v1/enums/accountsyncstate Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all defined account synchronization states. ```APIDOC ## GET /api/v1/enums/accountsyncstate ### Description Returns a list with all defined account sync states. ### Method GET ### Endpoint /api/v1/enums/accountsyncstate ### Parameters ### Request Example ```json {} ``` ### Response #### Success Response (200) - **object** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### GET /api/v1/products/stocks Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries all defined stock locations within the Billbee system. ```APIDOC ## GET /api/v1/products/stocks ### Description Queries all defined stock locations within the Billbee system. ### Method GET ### Endpoint /api/v1/products/stocks ### Response #### Success Response (200) - **Schema** - [Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Model.StockResponseData] ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### GET /api/v1/products/{productId}/images/{imageId} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a single image associated with a specific product by its ID. Requires X-Billbee-Api-Key for authentication. ```APIDOC ## GET /api/v1/products/{productId}/images/{imageId} ### Description Returns a single image by id. Requires X-Billbee-Api-Key for authentication. ### Method GET ### Endpoint /api/v1/products/{productId}/images/{imageId} ### Parameters #### Path Parameters - **productId** (long) - Required - The Id of the product - **imageId** (long) - Required - The Id of the image ### Response #### Success Response (200) - **data** (ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleImageRelationApiModel) - OK #### Response Example { "isSuccess": true, "errors": [], "data": { "imageUrl": "http://example.com/image1.jpg", "isDefault": true } } ``` -------------------------------- ### GET /api/v1/products/PatchableFields Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Returns a list of fields that can be updated using the PATCH method. ```APIDOC ## GET /api/v1/products/PatchableFields ### Description Returns a list of fields that can be updated using the PATCH method. ### Method GET ### Endpoint /api/v1/products/PatchableFields ### Response #### Success Response (200) - **Schema** - object ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### GET /api/v1/products/images/{imageId} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a single image by its ID, irrespective of the product it belongs to. Authenticated using X-Billbee-Api-Key. ```APIDOC ## GET /api/v1/products/images/{imageId} ### Description Returns a single image by id. Authenticated using X-Billbee-Api-Key. ### Method GET ### Endpoint /api/v1/products/images/{imageId} ### Parameters #### Path Parameters - **imageId** (long) - Required - The Id of the image ### Response #### Success Response (200) - **data** (ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleImageRelationApiModel) - OK #### Response Example { "isSuccess": true, "errors": [], "data": { "imageUrl": "http://example.com/image1.jpg", "isDefault": true } } ``` -------------------------------- ### GET /api/v1/automaticprovision/termsinfo Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves information about Billbee's terms and conditions. Requires API key authentication. ```APIDOC ## GET /api/v1/automaticprovision/termsinfo ### Description Retrieves information regarding Billbee's terms and conditions. ### Method GET ### Endpoint /api/v1/automaticprovision/termsinfo ### Response #### Success Response (200) - **TermsInfo** (object) - An object containing details about Billbee's terms and conditions. #### Response Example ```json { "TermsInfo": { "version": "1.2", "url": "https://billbee.io/terms" } } ``` ``` -------------------------------- ### GET /api/v1/shipment/shippingproviders Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries all defined shipping providers available in Billbee. Requires API key authentication. ```APIDOC ## GET /api/v1/shipment/shippingproviders ### Description Retrieves a list of all shipping providers configured within Billbee. ### Method GET ### Endpoint /api/v1/shipment/shippingproviders ### Response #### Success Response (200) - **ShippingProviders** (array of objects) - A list of available shipping providers. #### Response Example ```json [ { "Id": 101, "Name": "DHL Express" }, { "Id": 102, "Name": "UPS Ground" } ] ``` ``` -------------------------------- ### GET /api/v1/orders/findbyextref/{extRef} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Get a single order by its external order number. ```APIDOC ## GET /api/v1/orders/findbyextref/{extRef} ### Description Get a single order by its external order number. ### Method GET ### Endpoint /api/v1/orders/findbyextref/{extRef} ### Parameters #### Path Parameters - **extRef** (string) - Required - The extern order number of the order ### Response #### Success Response (200) - **Order** ([Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.Order]) - OK #### Response Example ```json { "orderId": 123, "orderNumber": "ORD-123", "externalOrderNumber": "EXT-123" } ``` ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### POST /api/v1/products Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates a new product in the Billbee system. ```APIDOC ## POST /api/v1/products ### Description Creates a new product in the Billbee system. ### Method POST ### Endpoint /api/v1/products ### Parameters #### Request Body - **model** (object) - Yes - [Billbee.Interfaces.BillbeeAPI.Model.ArticleApiModel] ### Response #### Success Response (200) - **Schema** - object ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Create New Customer - Bash Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Creates a new customer record with contact details and an optional address. Requires API key and authentication. Returns the ID and number of the newly created customer or an error. ```bash curl -X POST "https://api.billbee.io/api/v1/customers" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" \ -d '{ "Name": "Jane Smith", "Email": "jane.smith@example.com", "Tel1": "+49987654321", "VatId": "DE987654321", "Type": 0, "Address": { "FirstName": "Jane", "LastName": "Smith", "Company": "Smith Enterprises", "Street": "Business Ave", "Housenumber": "456", "Zip": "54321", "City": "Munich", "CountryCode": "DE", "Email": "jane.smith@example.com", "Tel1": "+49987654321" } }' ``` -------------------------------- ### GET /api/v1/orders/{id} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute. ```APIDOC ## GET /api/v1/orders/{id} ### Description Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute. ### Method GET ### Endpoint /api/v1/orders/{id} ### Parameters #### Path Parameters - **id** (long) - Required - The internal billbee id of the order #### Query Parameters - **articleTitleSource** (integer) - Optional - The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text ### Response #### Success Response (200) - **Order** ([Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.Order]) - OK #### Response Example ```json { "orderId": 123, "orderNumber": "ORD-123", "orderDate": "2023-10-27T10:00:00Z", "customer": { "name": "John Doe" } } ``` ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Create Customer Model Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Model used for creating a new customer. ```APIDOC ## Create Customer Model ### Description Used to create a new customer in the Billbee system. ### Fields #### `Address` (CustomerAddressApiModel) - Optional #### `Id` (long) - Optional The Billbee Id of the customer. #### `Name` (string) - Optional #### `Email` (string) - Optional #### `Tel1` (string) - Optional #### `Tel2` (string) - Optional #### `Number` (integer) - Optional #### `PriceGroupId` (long) - Optional #### `LanguageId` (integer) - Optional #### `DefaultMailAddress` (CustomerMetaDataApiModel) - Optional #### `DefaultCommercialMailAddress` (CustomerMetaDataApiModel) - Optional #### `DefaultStatusUpdatesMailAddress` (CustomerMetaDataApiModel) - Optional #### `DefaultPhone1` (CustomerMetaDataApiModel) - Optional #### `DefaultPhone2` (CustomerMetaDataApiModel) - Optional #### `DefaultFax` (CustomerMetaDataApiModel) - Optional #### `VatId` (string) - Optional The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order. #### `Type` (integer) - Optional Customer Type. #### `MetaData` (array of CustomerMetaDataApiModel) - Optional #### `ArchivedAt` (dateTime) - Optional If set, the customer was already archived at the given date. Further modification is disabled. #### `RestoredAt` (dateTime) - Optional If set, the customer was restored from the archive at the given date. ``` -------------------------------- ### PUT /api/v1/products/{productId}/images/{imageId} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Adds or updates an existing image for a product. If imageId is 0, a new image is added. Authentication via X-Billbee-Api-Key. ```APIDOC ## PUT /api/v1/products/{productId}/images/{imageId} ### Description Add or update an existing image of a product. If imageId is 0, the image will be added. Authentication via X-Billbee-Api-Key. ### Method PUT ### Endpoint /api/v1/products/{productId}/images/{imageId} ### Parameters #### Path Parameters - **productId** (long) - Required - The product id - **imageId** (long) - Required - The image id. If you pass 0, the image will be added #### Request Body - **model** (ArticleImageRelationApiModel) - Required - The ArticleApiImageModel ### Request Example { "imageUrl": "http://example.com/updated_image.jpg", "isDefault": false } ### Response #### Success Response (200) - **data** (ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleImageRelationApiModel) - OK #### Response Example { "isSuccess": true, "errors": [], "data": { "imageUrl": "http://example.com/updated_image.jpg", "isDefault": false } } ``` -------------------------------- ### Create Customer Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates a new customer in the system. Requires customer details in the request body. ```APIDOC ## POST /api/v1/customers ### Description Creates a new customer. ### Method POST ### Endpoint /api/v1/customers ### Parameters #### Request Body - **model** (CreateCustomerApiModel) - Required - The data for the new customer. ### Request Example { "Name": "New Customer", "Email": "new.customer@example.com" } ### Response #### Success Response (200) - **Data** (CustomerApiModel) - The newly created customer object. #### Response Example { "Data": { "Id": 123, "Name": "New Customer", "Email": "new.customer@example.com" } } ``` -------------------------------- ### GET /api/v1/enums/shipmenttypes Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all defined shipment types. ```APIDOC ## GET /api/v1/enums/shipmenttypes ### Description Returns a list with all defined shipmenttypes. ### Method GET ### Endpoint /api/v1/enums/shipmenttypes ### Parameters ### Request Example ```json {} ``` ### Response #### Success Response (200) - **object** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### PUT /api/v1/products/{productId}/images Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Adds multiple images to a product or replaces existing product images with the provided ones. Authentication is handled via X-Billbee-Api-Key. ```APIDOC ## PUT /api/v1/products/{productId}/images ### Description Adds multiple images to a product or replaces the product images by the given images. Authentication is handled via X-Billbee-Api-Key. ### Method PUT ### Endpoint /api/v1/products/{productId}/images ### Parameters #### Path Parameters - **productId** (long) - Required - The id of the product #### Query Parameters - **replace** (boolean) - Optional - If true, the images will be replaced by the passed images. Otherwise, the passed images will be appended to the product. #### Request Body - **models** (array[ArticleImageRelationApiModel]) - Required - An array of ArticleApiImageModel ### Request Example { "models": [ { "imageUrl": "http://example.com/image1.jpg", "isDefault": true }, { "imageUrl": "http://example.com/image2.jpg", "isDefault": false } ] } ### Response #### Success Response (200) - **data** (ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleImageRelationApiModel) - OK #### Response Example { "isSuccess": true, "errors": [], "data": { "imageUrl": "http://example.com/image1.jpg", "isDefault": true } } ``` -------------------------------- ### GET /api/v1/enums/shopaccounttype Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all defined shop account types. ```APIDOC ## GET /api/v1/enums/shopaccounttype ### Description Returns a list with all defined account types. ### Method GET ### Endpoint /api/v1/enums/shopaccounttype ### Parameters ### Request Example ```json {} ``` ### Response #### Success Response (200) - **object** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Create New Product using cURL Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Creates a new product in the catalog using a POST request. Requires a JSON payload with product details like SKU, title, price, stock, and EAN. Returns an error code if creation fails. ```bash curl -X POST "https://api.billbee.io/api/v1/products" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" \ -d '{ "SKU": "NEW-PROD-456", "Title": [{"Text": "New Product", "LanguageCode": "en"}], "Description": [{"Text": "Product description", "LanguageCode": "en"}], "Price": 29.99, "CostPrice": 15.00, "VatIndex": 1, "Vat1Rate": 19.0, "Vat2Rate": 7.0, "StockCurrent": 100, "StockDesired": 150, "StockWarning": 25, "Weight": 350, "EAN": "9876543210987", "Type": 1, "IsDigital": false, "Manufacturer": "Example Brand" }' # Response: { "ErrorMessage": null, "ErrorCode": 0 } ``` -------------------------------- ### POST /api/v1/automaticprovision/createaccount Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates a new Billbee user account with the provided account details. Requires API key authentication. ```APIDOC ## POST /api/v1/automaticprovision/createaccount ### Description Creates a new Billbee user account using the data provided in the request body. ### Method POST ### Endpoint /api/v1/automaticprovision/createaccount ### Parameters #### Request Body - **model** (object) - Required - Contains the necessary details to create a new Billbee account. ### Request Example ```json { "model": { "email": "user@example.com", "password": "securepassword", "companyName": "Example Corp" } } ``` ### Response #### Success Response (200) - **Success** (boolean) - Indicates if the account creation was successful. - **Message** (string) - A message providing details about the outcome. #### Response Example ```json { "Success": true, "Message": "Account created successfully." } ``` ``` -------------------------------- ### GET /api/v1/products/custom-fields/{id} Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries a single custom field by its unique ID. ```APIDOC ## GET /api/v1/products/custom-fields/{id} ### Description Queries a single custom field. ### Method GET ### Endpoint /api/v1/products/custom-fields/{id} ### Parameters #### Path Parameters - **id** (long) - Required - The id of the custom field to query. ### Response #### Success Response (200) - **Data** ([Rechnungsdruck.WebApp.Controllers.Api.ApiResultOfBillbee.Interfaces.BillbeeAPI.Model.ArticleApiCustomFieldDefinitionModel][]) - The custom field definition. #### Response Example ```json { "succeeded": true, "errors": [], "data": { "id": 1, "name": "CustomField1", "type": "Text" } } ``` ``` -------------------------------- ### Get List of Customers - Bash Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Retrieves a paginated list of customers with their contact information. Supports filtering by page and page size. Requires API key and authentication. Returns customer data and pagination details. ```bash curl -X GET "https://api.billbee.io/api/v1/customers?page=1&pageSize=50" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" ``` -------------------------------- ### GET /api/v1/orders Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all orders, with various filtering options available. ```APIDOC ## GET /api/v1/orders ### Description Get a list of all orders optionally filtered by date. ### Method GET ### Endpoint /api/v1/orders ### Parameters #### Query Parameters - **minOrderDate** (dateTime) - Optional - Specifies the oldest order date to include in the response - **maxOrderDate** (dateTime) - Optional - Specifies the newest order date to include in the response - **page** (integer) - Optional - Specifies the page to request - **pageSize** (integer) - Optional - Specifies the pagesize. Defaults to 50, max value is 250 - **shopId** (long) - Optional - Specifies a list of shop ids for which invoices should be included - **orderStateId** (integer) - Optional - Specifies a list of state ids to include in the response - **tag** (string) - Optional - Specifies a list of tags the order must have attached to be included in the response - **minimumBillBeeOrderId** (long) - Optional - If given, all delivered orders have an Id greater than or equal to the given minimumOrderId - **modifiedAtMin** (dateTime) - Optional - If given, the last modification has to be newer than the given date - **modifiedAtMax** (dateTime) - Optional - If given, the last modification has to be older or equal than the given date. - **articleTitleSource** (integer) - Optional - The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text - **excludeTags** (boolean) - Optional - If true the list of tags passed to the call are used to filter orders to not include these tags ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **ApiPagedResultOfSystem.Collections.Generic.ListOfBillbee.Interfaces.BillbeeAPI.Model.Order** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Create Invoice API Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates an invoice for an existing order. This request is extra throttled to a maximum of 1 per 5 minutes per order and API key. ```APIDOC ## POST /api/v1/orders/CreateInvoice/{id} ### Description Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes. ### Method POST ### Endpoint /api/v1/orders/CreateInvoice/{id} ### Parameters #### Path Parameters - **id** (long) - Required - The internal billbee id of the order ### Response #### Success Response (200) - **object** - OK ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Get Customer Addresses Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of addresses associated with a specific customer ID. ```APIDOC ## GET /api/v1/customers/{id}/addresses ### Description Queries a list of addresses from a customer. ### Method GET ### Endpoint /api/v1/customers/{id}/addresses ### Parameters #### Path Parameters - **id** (long) - Required - The id of the customer ### Response #### Success Response (200) - **Data** (ApiResultOfListOfCustomerAddressApiModel) - The list of customer addresses. #### Response Example { "Data": [ { "Id": 1, "Street": "123 Main St", "City": "Anytown", "PostalCode": "12345", "Country": "USA" } ] } ``` -------------------------------- ### GET /api/v1/shipment/shippingcarriers Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Queries the currently available shipping carriers. Requires API key authentication. ```APIDOC ## GET /api/v1/shipment/shippingcarriers ### Description Retrieves a list of shipping carriers that are currently available for use. ### Method GET ### Endpoint /api/v1/shipment/shippingcarriers ### Response #### Success Response (200) - **ShippingCarriers** (array of objects) - A list of available shipping carriers. #### Response Example ```json [ { "Id": 501, "Name": "FedEx" }, { "Id": 502, "Name": "USPS" } ] ``` ``` -------------------------------- ### GET /api/v1/orders/PatchableFields Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of fields that can be updated using the orders/{id} patch call. ```APIDOC ## GET /api/v1/orders/PatchableFields ### Description Returns a list of fields which can be updated with the orders/{id} patch call. ### Method GET ### Endpoint /api/v1/orders/PatchableFields ### Response #### Success Response (200) - **Schema**: object ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### Get Customer by ID Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a single customer's details using their unique ID. ```APIDOC ## GET /api/v1/customers/{id} ### Description Queries a single customer by id. ### Method GET ### Endpoint /api/v1/customers/{id} ### Parameters #### Path Parameters - **id** (long) - Required - The id of the customer to query ### Response #### Success Response (200) - **Data** (CustomerApiModel) - The customer object. #### Response Example { "Data": { "Id": 1, "Name": "Example Customer", "Email": "customer@example.com" } } ``` -------------------------------- ### Create Delivery Note API Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates a delivery note for an existing order. This request is extra throttled to a maximum of 1 per 5 minutes per order and API key. The PDF can be optionally included. ```APIDOC ## POST /api/v1/orders/CreateDeliveryNote/{id} ### Description Create an delivery note for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes. ### Method POST ### Endpoint /api/v1/orders/CreateDeliveryNote/{id} ### Parameters #### Path Parameters - **id** (long) - Required - The internal billbee id of the order #### Query Parameters - **includePdf** (boolean) - Optional - If true, the PDF is included in the response as base64 encoded string - **sendToCloudId** (long) - Optional - Optionally specify the id of a billbee connected cloud device to send the pdf to ### Response #### Success Response (200) - **object** - OK ### Security - **X-Billbee-Api-Key** ``` -------------------------------- ### GET /api/v1/shipment/ping Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md A simple endpoint to check the availability of the shipment API. Requires API key authentication. ```APIDOC ## GET /api/v1/shipment/ping ### Description Pings the shipment API to check its availability and responsiveness. ### Method GET ### Endpoint /api/v1/shipment/ping ### Response #### Success Response (200) - **Status** (string) - Indicates the status of the ping, typically "OK". #### Response Example ```json { "Status": "OK" } ``` ``` -------------------------------- ### Get List of Orders (Bash) Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Retrieves a paginated list of orders from Billbee. Supports filtering by date, shop, state, tags, and modification date. Requires API Key and Basic Auth credentials. Returns order data in JSON format. ```bash curl -X GET "https://api.billbee.io/api/v1/orders?page=1&pageSize=50&minOrderDate=2024-01-01T00:00:00Z&maxOrderDate=2024-12-31T23:59:59Z&orderStateId=3" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" ``` -------------------------------- ### POST /api/accounts Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Creates a new Billbee user account with the provided details, including contact information and preferences. ```APIDOC ## POST /api/accounts ### Description Creates a new Billbee user account with the provided details, including contact information and preferences. ### Method POST ### Endpoint /api/accounts ### Parameters #### Request Body - **EMail** (string) - Required - The Email address of the user to create - **Password** (string) - Optional - - **AcceptTerms** (boolean) - Optional - Set to true, if the user has accepted the Billbee terms & conditions - **Address** (object) - Optional - Gets or sets the invoice address of the Billbee user - **Company** (string) - Optional - - **Name** (string) - Optional - - **Address1** (string) - Optional - - **Address2** (string) - Optional - - **Zip** (string) - Optional - - **City** (string) - Optional - - **Country** (string) - Optional - The ISO2 country code of the users country - **VatId** (string) - Optional - - **AffiliateCouponCode** (string) - Optional - Specifies an billbee affiliate code to attach to the user - **Vat1Rate** (double) - Optional - Optionally specify the vat1 (normal) rate of the user - **Vat2Rate** (double) - Optional - Optionally specify the vat2 (reduced) rate of the user - **DefaultVatMode** (integer) - Optional - Optionally specify the default vat mode of the user - **DefaultCurrency** (string) - Optional - Optionally specify the default currency of the user - **DefaultVatIndex** (integer) - Optional - Optionally specify the default vat index of the user ### Request Example ```json { "EMail": "user@example.com", "Password": "securepassword", "AcceptTerms": true, "Address": { "Company": "Example Inc.", "Name": "John Doe", "Address1": "123 Main St", "Zip": "12345", "City": "Anytown", "Country": "US", "VatId": "" }, "AffiliateCouponCode": "COUPON123", "Vat1Rate": 19.0, "DefaultCurrency": "USD" } ``` ### Response #### Success Response (200) - **UserId** (integer) - The ID of the newly created user. - **Status** (string) - The status of the account creation. #### Response Example ```json { "UserId": 12345, "Status": "AccountCreated" } ``` ``` -------------------------------- ### GET /api/v1/events Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of all events, optionally filtered by date. This endpoint has a reduced rate limit. ```APIDOC ## GET /api/v1/events ### Description Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour. ### Method GET ### Endpoint /api/v1/events ### Parameters #### Query Parameters - **minDate** (dateTime) - Optional - Specifies the oldest date to include in the response - **maxDate** (dateTime) - Optional - Specifies the newest date to include in the response - **page** (integer) - Optional - Specifies the page to request - **pageSize** (integer) - Optional - Specifies the pagesize. Defaults to 50, max value is 250 - **typeId** (integer) - Optional - Filter for specific event types - **orderId** (long) - Optional - Filter for specific order id ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **object** (object) - OK #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Customer Orders Source: https://github.com/alexkroeker177/billbee-api-documentation/blob/main/README.md Retrieves a list of orders associated with a specific customer ID. Supports pagination. ```APIDOC ## GET /api/v1/customers/{id}/orders ### Description Queries a list of orders from a customer. Supports pagination. ### Method GET ### Endpoint /api/v1/customers/{id}/orders ### Parameters #### Path Parameters - **id** (long) - Required - The id of the customer #### Query Parameters - **page** (integer) - Optional - The current page to request starting with 1 - **pageSize** (integer) - Optional - The pagesize for the result list. Values between 1 and 250 are allowed ### Response #### Success Response (200) - **Data** (ApiPagedResultOfListOfOrder) - The paged list of orders for the customer. #### Response Example { "Data": { "Page": 1, "PageSize": 10, "TotalPages": 5, "TotalEntries": 50, "Data": [ { "OrderId": "ORD-123", "OrderDate": "2023-10-27T10:00:00Z" } ] } } ``` -------------------------------- ### Create New Order (Bash) Source: https://context7.com/alexkroeker177/billbee-api-documentation/llms.txt Creates a new order in the Billbee system. Requires customer details, order items, and shipping information. Accepts a JSON payload and returns the newly created order's basic information. ```bash curl -X POST "https://api.billbee.io/api/v1/orders" \ -H "X-Billbee-Api-Key: YOUR_API_KEY" \ -H "Authorization: Basic BASE64_ENCODED_CREDENTIALS" \ -H "Content-Type: application/json" \ -d '{ "OrderNumber": "EXT-ORD-001", "State": 1, "CreatedAt": "2024-01-15T10:00:00Z", "Currency": "EUR", "PaymentMethod": 1, "ShippingCost": 5.99, "TotalCost": 49.99, "InvoiceAddress": { "FirstName": "Jane", "LastName": "Smith", "Company": "Example Corp", "Street": "Main Street", "HouseNumber": "123", "Zip": "12345", "City": "Berlin", "CountryISO2": "DE", "Email": "jane.smith@example.com", "Phone": "+49123456789" }, "ShippingAddress": { "FirstName": "Jane", "LastName": "Smith", "Street": "Main Street", "HouseNumber": "123", "Zip": "12345", "City": "Berlin", "CountryISO2": "DE" }, "OrderItems": [ { "Product": { "Id": "prod-001", "Title": "Test Product", "SKU": "SKU-001", "Weight": 500 }, "Quantity": 2, "TotalPrice": 49.99, "TaxAmount": 9.52, "TaxIndex": 1 } ] }' ```