Package: billbeeapi
Getting Started with Billbee APIGetting StartedIntroductionDocumentation of the Billbee REST API to connect a Billbee account to external aplications.EndpointThe Billbee API endpoint base url ishttps://app.billbee.io/api/v1ActivationYou have to enable the API in the settings of your Billbee account. In addition you need a Billbee API Key identifying the application you develop. To get an API key, send a mail tosupport@billbee.ioand send us a short note about what you are building.Authorization & securityBecause you can access private data with the Billbee API, every request has to be sent over https and mustContain a valid API Key identifying the application/developer. It has to be sent as the HTTP header X-Billbee-Api-KeyContain a valid user login with billbee username and api password in form of a basic auth HTTP headerThrottlingEach endpoint has a throttle of max 2 requests per second per combination of API Key and Billbee user.When you exceed these 2 calls, the API will return a HTTP 429 status codeInstall the PackageThe package is compatible with Python versions2 >=2.7.9and3 >=3.4.
Install the package from PyPi using the following pip command:pipinstallbillbeeapipackage noteThis is a fork fromhttps://pypi.python.org/pypi/billbee-1The billbee-1 package does not support API_KEYs.Initialize the API ClientThe following parameters are configurable for the API Client:ParameterTypeDescriptionbasic_auth_user_namestringThe username to use with basic authenticationbasic_auth_passwordstringThe password to use with basic authenticationtimeoutfloatThe value to use for connection timeout.Default: 60max_retriesintThe number of times to retry an endpoint call if it fails.Default: 3backoff_factorfloatA backoff factor to apply between attempts after the second try.Default: 0The API client can be initialized as follows:frombillbeeapi.billbeeapi_clientimportBillbeeapiClientfrombillbeeapi.configurationimportEnvironmentclient=BillbeeapiClient(basic_auth_user_name='BasicAuthUserName',basic_auth_password='BasicAuthPassword',api_key='ApiKey'environment=,)AuthorizationThis API usesBasic Authenticationand the API-KEY in the HTTP headerX-Billbee-Api-KeyClient Class DocumentationBillbee API ClientThe gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.ControllersNameDescriptionproductsGets ProductsControllerprovisioningGets ProvisioningControllercloud_storageGets CloudStorageControllercustomersGets CustomersControllercustomer_addressesGets CustomerAddressesControllerenum_apiGets EnumApiControllereventsGets EventsControllerordersGets OrdersControllershipmentsGets ShipmentsControllerwebhooksGets WebhooksControllerAPI ReferenceList of APIsProductsProvisioningCloud StorageCustomersCustomer AddressesEnum ApiEventsOrdersShipmentsWebhooksProductsOverviewGet instanceAn instance of theProductsControllerclass can be accessed from the API Client.products_controller = client.productsArticle Update StockThe article is specified by sku. You have to send the absolute value for the current stockdefarticle_update_stock(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelUpdateStockApiModelBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelUpdateStockResponseDataExample Usagemodel=BillbeeInterfacesBillbeeAPIModelUpdateStockApiModel()result=products_controller.article_update_stock(model)Article Get Reserved AmountQueries the reserved amount for a single article by id or by skudefarticle_get_reserved_amount(self,id,lookup_by=None,stock_id=None)ParametersParameterTypeTagsDescriptionidstringQuery, RequiredThe id or the sku of the article to querylookup_bystringQuery, OptionalEither the value id or the value sku to specify the meaning of the id parameterstock_idlong|intQuery, OptionalOptional the stock id if the multi stock feature is enabledResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelGetReservedAmountResponseDataExample Usageid='id0'result=products_controller.article_get_reserved_amount(id)Article Update Stock MultipleUpdate the stock qty for multiple articles at oncedefarticle_update_stock_multiple(self,models)ParametersParameterTypeTagsDescriptionmodelsList of BillbeeInterfacesBillbeeAPIModelUpdateStockApiModelBody, Required-Response TypeList of RechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelUpdateStockResponseDataExample Usagemodels=[]models.append(BillbeeInterfacesBillbeeAPIModelUpdateStockApiModel())models.append(BillbeeInterfacesBillbeeAPIModelUpdateStockApiModel())result=products_controller.article_update_stock_multiple(models)Article Update Stock CodeUpdate the stock code of an articledefarticle_update_stock_code(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelUpdateStockCodeApiModelBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelUpdateStockCodeResponseDataExample Usagemodel=BillbeeInterfacesBillbeeAPIModelUpdateStockCodeApiModel()result=products_controller.article_update_stock_code(model)Article Get ArticleQueries a single article by id or by skudefarticle_get_article(self,id,lookup_by=None)ParametersParameterTypeTagsDescriptionidstringTemplate, RequiredThe id or the sku of the article to querylookup_bystringQuery, OptionalEither the value id, ean or the value sku to specify the meaning of the id parameterResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleApiModelExample Usageid='id0'result=products_controller.article_get_article(id)Article Delete ArticleDeletes a productdefarticle_delete_article(self,id)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the ProductResponse TypeobjectExample Usageid=112result=products_controller.article_delete_article(id)Article Patch ArticleUpdates one or more fields of a productdefarticle_patch_article(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the ProductmodelobjectBody, Required-Response TypeobjectExample Usageid=112model=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=products_controller.article_patch_article(id,model)Article Get ListGet a list of all productsdefarticle_get_list(self,page=None,page_size=None,min_created_at=None)ParametersParameterTypeTagsDescriptionpageintQuery, OptionalThe current page to request starting with 1page_sizeintQuery, OptionalThe pagesize for the result list. Values between 1 and 250 are allowedmin_created_atdatetimeQuery, OptionalOptional the oldest create date of the articles to be returnedResponse TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiModelExample Usageresult=products_controller.article_get_list()Article Create ArticleCreates a new productdefarticle_create_article(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelArticleApiModelBody, Required-Response TypeobjectExample Usagemodel=BillbeeInterfacesBillbeeAPIModelArticleApiModel()model.vat_index=104model.price=72.12model.vat_1_rate=42.06model.vat_2_rate=167.28model.mtype=2model.is_digital=Falsemodel.is_customizable=Falseresult=products_controller.article_create_article(model)Article Get Custom FieldsQueries a list of all custom fieldsdefarticle_get_custom_fields(self,page=None,page_size=None)ParametersParameterTypeTagsDescriptionpageintQuery, Optional-page_sizeintQuery, Optional-Response TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelExample Usageresult=products_controller.article_get_custom_fields()Article Get Custom FieldQueries a single custom fielddefarticle_get_custom_field(self,id)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the custom field to queryResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelExample Usageid=112result=products_controller.article_get_custom_field(id)Article Get Patchable FieldsReturns a list of fields which can be updated with the patch calldefarticle_get_patchable_fields(self)Response TypeobjectExample Usageresult=products_controller.article_get_patchable_fields()Article Get CategoryGEts a list of all defined categoriesdefarticle_get_category(self)Response TypeobjectExample Usageresult=products_controller.article_get_category()Article Get ImagesReturns a list of all images of the productdefarticle_get_images(self,product_id)ParametersParameterTypeTagsDescriptionproduct_idlong|intTemplate, RequiredThe Id of the productResponse TypeRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelExample Usageproduct_id=98result=products_controller.article_get_images(product_id)Article Put ImagesAdd multiple images to a product or replace the product images by the given imagesdefarticle_put_images(self,product_id,models,replace=None)ParametersParameterTypeTagsDescriptionproduct_idlong|intTemplate, RequiredThe id of the productmodelsList of BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelBody, RequiredAn array of ArticleApiImageModelreplaceboolQuery, OptionalIf you pass true, the images will be replaced by the passed images. Otherwise the passed images will be appended to the product.Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelExample Usageproduct_id=98models=[]models.append(BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModel())models.append(BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModel())result=products_controller.article_put_images(product_id,models)Article Get Image From ProductReturns a single image by iddefarticle_get_image_from_product(self,product_id,image_id)ParametersParameterTypeTagsDescriptionproduct_idlong|intTemplate, RequiredThe Id of the productimage_idlong|intTemplate, RequiredThe Id of the imageResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelExample Usageproduct_id=98image_id=126result=products_controller.article_get_image_from_product(product_id,image_id)Article Put ImageAdd or update an existing image of a productdefarticle_put_image(self,product_id,image_id,model)ParametersParameterTypeTagsDescriptionproduct_idlong|intTemplate, RequiredThe product idimage_idlong|intTemplate, RequiredThe image id. If you pass 0, the image will be addedmodelBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelBody, RequiredThe ArticleApiImageModelResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelExample Usageproduct_id=98image_id=126model=BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModel()result=products_controller.article_put_image(product_id,image_id,model)Article Delete Image From ProductDeletes a single image from a productdefarticle_delete_image_from_product(self,product_id,image_id)ParametersParameterTypeTagsDescriptionproduct_idlong|intTemplate, RequiredThe product idimage_idlong|intTemplate, RequiredThe image idResponse TypeobjectExample Usageproduct_id=98image_id=126result=products_controller.article_delete_image_from_product(product_id,image_id)Article Get ImageReturns a single image by iddefarticle_get_image(self,image_id)ParametersParameterTypeTagsDescriptionimage_idlong|intTemplate, RequiredThe Id of the imageResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelExample Usageimage_id=126result=products_controller.article_get_image(image_id)Article Delete ImageDeletes a single image by iddefarticle_delete_image(self,image_id)ParametersParameterTypeTagsDescriptionimage_idlong|intTemplate, RequiredThe image idResponse TypeobjectExample Usageimage_id=126result=products_controller.article_delete_image(image_id)Article Delete ImagesDelete multiple images by iddefarticle_delete_images(self,image_ids)ParametersParameterTypeTagsDescriptionimage_idsList of long|intBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelDeletedImagesModelExample Usageimage_ids=[87,88,89]result=products_controller.article_delete_images(image_ids)Search SearchSearch for products, customers and orders.
Type can be "order", "product" and / or "customer"
Term can contains lucene query syntaxdefsearch_search(self,model)ParametersParameterTypeTagsDescriptionmodelRechnungsdruckWebAppControllersApiSearchControllerSearchModelBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultRechnungsdruckWebAppControllersApiSearchControllerSearchResultsModelExample Usagemodel=RechnungsdruckWebAppControllersApiSearchControllerSearchModel()result=products_controller.search_search(model)ProvisioningOverviewGet instanceAn instance of theProvisioningControllerclass can be accessed from the API Client.provisioning_controller = client.provisioningAutomatic Provisioning Create AccountCreates a new Billbee user account with the data passeddefautomatic_provisioning_create_account(self,model)ParametersParameterTypeTagsDescriptionmodelRechnungsdruckWebAppControllersApiAutomaticProvisioningControllerCreateAccountContainerBody, Required-Response TypeobjectExample Usagemodel=RechnungsdruckWebAppControllersApiAutomaticProvisioningControllerCreateAccountContainer()model.e_mail='EMail2'result=provisioning_controller.automatic_provisioning_create_account(model)Automatic Provisioning Terms InfoReturns infos about Billbee terms and conditionsdefautomatic_provisioning_terms_info(self)Response TypeobjectExample Usageresult=provisioning_controller.automatic_provisioning_terms_info()Cloud StorageOverviewGet instanceAn instance of theCloudStorageControllerclass can be accessed from the API Client.cloud_storage_controller = client.cloud_storageCloud Storage Api Get ListGets a list of all connected cloud storage devicesdefcloud_storage_api_get_list(self)Response TypeRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCloudStorageApiModelExample Usageresult=cloud_storage_controller.cloud_storage_api_get_list()CustomersOverviewGet instanceAn instance of theCustomersControllerclass can be accessed from the API Client.customers_controller = client.customersCustomer Get AllGet a list of all customersdefcustomer_get_all(self,page=None,page_size=None)ParametersParameterTypeTagsDescriptionpageintQuery, OptionalThe current page to request starting with 1page_sizeintQuery, OptionalThe pagesize for the result list. Values between 1 and 250 are allowedResponse TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerApiModelExample Usageresult=customers_controller.customer_get_all()Customer CreateCreates a new customerdefcustomer_create(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCreateCustomerApiModelBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerApiModelExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCreateCustomerApiModel()result=customers_controller.customer_create(model)Customer Get OneQueries a single customer by iddefcustomer_get_one(self,id)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the customer to queryResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerApiModelExample Usageid=112result=customers_controller.customer_get_one(id)Customer UpdateUpdates a customer by iddefcustomer_update(self,model,id)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCustomerApiModelBody, Required-idlong|intTemplate, RequiredThe id of the customerResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerApiModelExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCustomerApiModel()id=112result=customers_controller.customer_update(model,id)Customer Get Customer OrdersQueries a list of orders from a customerdefcustomer_get_customer_orders(self,id,page=None,page_size=None)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the customerpageintQuery, OptionalThe current page to request starting with 1page_sizeintQuery, OptionalThe pagesize for the result list. Values between 1 and 250 are allowedResponse TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListRechnungsdruckWebAppControllersApiOrderExample Usageid=112result=customers_controller.customer_get_customer_orders(id)Customer Get Customer AddressesQueries a list of addresses from a customerdefcustomer_get_customer_addresses(self,id,page=None,page_size=None)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the customerpageintQuery, OptionalThe current page to request starting with 1page_sizeintQuery, OptionalThe pagesize for the result list. Values between 1 and 250 are allowedResponse TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageid=112result=customers_controller.customer_get_customer_addresses(id)Customer Add Customer AddressId and CustomerId will be ignored in model. If Id is set, the addition will be stopped.defcustomer_add_customer_address(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredCustomerId to attach the new address to.modelBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelBody, RequiredModel containing the address, that should be attached.Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageid=112model=BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel()result=customers_controller.customer_add_customer_address(id,model)Customer Get Customer AddressQueries a single address from a customerdefcustomer_get_customer_address(self,id)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the addressResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageid=112result=customers_controller.customer_get_customer_address(id)Customer Update AddressId and CustomerId cannot be changed. Fields you do not send will become empty.defcustomer_update_address(self,model,id)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelBody, RequiredThe updated address. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed.idlong|intTemplate, RequiredThe id of the addressResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel()id=112result=customers_controller.customer_update_address(model,id)Customer Patch AddressId and CustomerId cannot be changeddefcustomer_patch_address(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the addressmodelobjectBody, RequiredThe address fields to be changed. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed.Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageid=112model=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=customers_controller.customer_patch_address(id,model)Customer AddressesOverviewGet instanceAn instance of theCustomerAddressesControllerclass can be accessed from the API Client.customer_addresses_controller = client.customer_addressesCustomer Addresses Get AllGet a list of all customer addressesdefcustomer_addresses_get_all(self,page=None,page_size=None)ParametersParameterTypeTagsDescriptionpageintQuery, OptionalThe current page to request starting with 1 (default is 1)page_sizeintQuery, OptionalThe page size for the result list. Values between 1 and 250 are allowed. (default is 50)Response TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageresult=customer_addresses_controller.customer_addresses_get_all()Customer Addresses CreateCreates a new customer addressdefcustomer_addresses_create(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel()result=customer_addresses_controller.customer_addresses_create(model)Customer Addresses Get OneQueries a single customer address by iddefcustomer_addresses_get_one(self,id)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the address to queryResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usageid=112result=customer_addresses_controller.customer_addresses_get_one(id)Customer Addresses UpdateUpdates a customer address by iddefcustomer_addresses_update(self,model,id)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelBody, Required-idlong|intTemplate, RequiredThe id of the addressResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel()id=112result=customer_addresses_controller.customer_addresses_update(model,id)Enum ApiOverviewGet instanceAn instance of theEnumApiControllerclass can be accessed from the API Client.enum_api_controller = client.enum_apiEnum Api Get Payment TypesReturns a list with all defined paymenttypesdefenum_api_get_payment_types(self)Response TypeobjectExample Usageresult=enum_api_controller.enum_api_get_payment_types()Enum Api Get Shipping CarriersReturns a list with all defined shippingcarriersdefenum_api_get_shipping_carriers(self)Response TypeobjectExample Usageresult=enum_api_controller.enum_api_get_shipping_carriers()Enum Api Get Order StatesReturns a list with all defined orderstatesdefenum_api_get_order_states(self)Response TypeobjectExample Usageresult=enum_api_controller.enum_api_get_order_states()EventsOverviewGet instanceAn instance of theEventsControllerclass can be accessed from the API Client.events_controller = client.eventsEvent Api Get ListGet a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.defevent_api_get_list(self,min_date=None,max_date=None,page=None,page_size=None,type_id=None,order_id=None)ParametersParameterTypeTagsDescriptionmin_datedatetimeQuery, OptionalSpecifies the oldest date to include in the responsemax_datedatetimeQuery, OptionalSpecifies the newest date to include in the responsepageintQuery, OptionalSpecifies the page to requestpage_sizeintQuery, OptionalSpecifies the pagesize. Defaults to 50, max value is 250type_idList of intQuery, OptionalFilter for specific event typesorder_idintQuery, OptionalFilter for specific order idResponse TypeobjectExample Usageresult=events_controller.event_api_get_list()OrdersOverviewGet instanceAn instance of theOrdersControllerclass can be accessed from the API Client.orders_controller = client.ordersLayout Api Get Listdeflayout_api_get_list(self)Response TypeRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelsLayoutTemplateExample Usageresult=orders_controller.layout_api_get_list()Order Api Get ListGet a list of all orders optionally filtered by datedeforder_api_get_list(self,min_order_date=None,max_order_date=None,page=None,page_size=None,shop_id=None,order_state_id=None,tag=None,minimum_bill_bee_order_id=None,modified_at_min=None,modified_at_max=None,article_title_source=None,exclude_tags=None)ParametersParameterTypeTagsDescriptionmin_order_datedatetimeQuery, OptionalSpecifies the oldest order date to include in the responsemax_order_datedatetimeQuery, OptionalSpecifies the newest order date to include in the responsepageintQuery, OptionalSpecifies the page to requestpage_sizeintQuery, OptionalSpecifies the pagesize. Defaults to 50, max value is 250shop_idList of long|intQuery, OptionalSpecifies a list of shop ids for which invoices should be includedorder_state_idList of intQuery, OptionalSpecifies a list of state ids to include in the responsetagList of stringQuery, OptionalSpecifies a list of tags the order must have attached to be included in the responseminimum_bill_bee_order_idlong|intQuery, OptionalIf given, all delivered orders have an Id greater than or equal to the given minimumOrderIdmodified_at_mindatetimeQuery, OptionalIf given, the last modification has to be newer than the given datemodified_at_maxdatetimeQuery, OptionalIf given, the last modification has to be older or equal than the given date.article_title_sourceArticleTitleSourceEnumQuery, OptionalThe source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Textexclude_tagsboolQuery, OptionalIf true the list of tags passed to the call are used to filter orders to not include these tagsResponse TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelOrderExample Usageresult=orders_controller.order_api_get_list()Order Api Post New OrderTo create an order POST an JSON object to the orders endpoint with the shown properties.
Not all properties are required.deforder_api_post_new_order(self,order_data,shop_id=None)ParametersParameterTypeTagsDescriptionorder_dataBillbeeInterfacesBillbeeAPIModelOrderBody, Required-shop_idlong|intQuery, Optional-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelOrderExample Usageorder_data=BillbeeInterfacesBillbeeAPIModelOrder()result=orders_controller.order_api_post_new_order(order_data)ErrorsHTTP Status CodeError DescriptionException Class400Invalid data was received in the requestAPIException500An internal exception occured. Order was not createdAPIExceptionOrder Api Tags UpdateUpdates/Sets the tags attached to an orderdeforder_api_tags_update(self,tag_data,id)ParametersParameterTypeTagsDescriptiontag_dataRechnungsdruckWebAppControllersApiOrderTagCreateBody, RequiredTags to attachidlong|intTemplate, RequiredThe internal id of the orderResponse TypeobjectExample Usagetag_data=RechnungsdruckWebAppControllersApiOrderTagCreate()id=112result=orders_controller.order_api_tags_update(tag_data,id)Order Api Tags CreateWhen a tag is already attached, it is ignored. Tags are not case sensitive.deforder_api_tags_create(self,tag_data,id)ParametersParameterTypeTagsDescriptiontag_dataRechnungsdruckWebAppControllersApiOrderTagCreateBody, RequiredTags to attachidlong|intTemplate, RequiredThe internal id of the orderResponse TypeobjectExample Usagetag_data=RechnungsdruckWebAppControllersApiOrderTagCreate()id=112result=orders_controller.order_api_tags_create(tag_data,id)Order Api GetGet a single order by its internal billbee id. This request is throttled to 6 calls per order in one minutedeforder_api_get(self,id,article_title_source=None)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe internal billbee id of the orderarticle_title_sourceArticleTitleSourceEnumQuery, OptionalThe source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice TextResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelOrderExample Usageid=112result=orders_controller.order_api_get(id)Order Api Patch OrderUpdates one or more fields of an orderdeforder_api_patch_order(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, Required-modelobjectBody, Required-Response TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelOrderExample Usageid=112model=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=orders_controller.order_api_patch_order(id,model)Order Api Get by Ext RefGet a single order by its external order numberdeforder_api_get_by_ext_ref(self,ext_ref)ParametersParameterTypeTagsDescriptionext_refstringTemplate, RequiredThe extern order number of the orderResponse TypeRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelOrderExample Usageext_ref='extRef8'result=orders_controller.order_api_get_by_ext_ref(ext_ref)Order Api Update StateREMARKSUse this call to change the state of an order to i.e. paid or sent.The state is transfered to the external shop/marketplace if configured.
This is the list of known states:1: ordered2: confirmed3: paid4: shipped5: reclamation6: deleted7: closed8: canceled9: archived10: not used11: demand note 112: demand note 213: packed14: offered15: payment reminder16: fulfillingdeforder_api_update_state(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe internal id of the ordermodelRechnungsdruckWebAppControllersApiOrderStateUpdateBody, RequiredThe data used to change the stateResponse TypeobjectExample Usageid=112model=RechnungsdruckWebAppControllersApiOrderStateUpdate()result=orders_controller.order_api_update_state(id,model)Order Api Add ShipmentAdd a shipment to a given orderdeforder_api_add_shipment(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe internal billbee id of the ordermodelRechnungsdruckWebAppControllersApiApiAddShipmentToOrderModelBody, RequiredThe shipment data to create the shipmentResponse TypeobjectExample Usageid=112model=RechnungsdruckWebAppControllersApiApiAddShipmentToOrderModel()result=orders_controller.order_api_add_shipment(id,model)Order Api Get Invoice ListGet a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDatedeforder_api_get_invoice_list(self,min_invoice_date=None,max_invoice_date=None,page=None,page_size=None,shop_id=None,order_state_id=None,tag=None,min_pay_date=None,max_pay_date=None,include_positions=None,exclude_tags=None)ParametersParameterTypeTagsDescriptionmin_invoice_datedatetimeQuery, OptionalSpecifies the oldest invoice date to includemax_invoice_datedatetimeQuery, OptionalSpecifies the newest invoice date to includepageintQuery, OptionalSpecifies the page to requestpage_sizeintQuery, OptionalSpecifies the pagesize. Defaults to 50, max value is 250shop_idList of long|intQuery, OptionalSpecifies a list of shop ids for which invoices should be includedorder_state_idList of intQuery, OptionalSpecifies a list of state ids to include in the responsetagList of stringQuery, Optional-min_pay_datedatetimeQuery, Optional-max_pay_datedatetimeQuery, Optional-include_positionsboolQuery, Optional-exclude_tagsboolQuery, OptionalIf true the list of tags passed to the call are used to filter orders to not include these tagsResponse TypeobjectExample Usageresult=orders_controller.order_api_get_invoice_list()Order Api FindFind a single order by its external id (order number)deforder_api_find(self,id,partner)ParametersParameterTypeTagsDescriptionidstringTemplate, RequiredThe order id from the external systempartnerstringTemplate, RequiredOptional the name of the shop/marketplace the order was imported fromResponse TypeobjectExample Usageid='id0'partner='partner0'result=orders_controller.order_api_find(id,partner)Order Api Create Delivery NoteCreate 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.deforder_api_create_delivery_note(self,id,include_pdf=None,send_to_cloud_id=None)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe internal billbee id of the orderinclude_pdfboolQuery, OptionalIf true, the PDF is included in the response as base64 encoded stringsend_to_cloud_idlong|intQuery, OptionalOptionally specify the id of a billbee connected cloud device to send the pdf toResponse TypeobjectExample Usageid=112result=orders_controller.order_api_create_delivery_note(id)Order Api Create InvoiceCreate an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.deforder_api_create_invoice(self,id,include_invoice_pdf=None,template_id=None,send_to_cloud_id=None)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe internal billbee id of the orderinclude_invoice_pdfboolQuery, OptionalIf true, the PDF is included in the response as base64 encoded stringtemplate_idlong|intQuery, OptionalYou can pass the id of an invoice template to overwrite the assigned template for invoice creationsend_to_cloud_idlong|intQuery, OptionalYou can pass the id of a connected cloud printer/storage to send the invoice to itResponse TypeobjectExample Usageid=112result=orders_controller.order_api_create_invoice(id)Order Api Get Patchable FieldsReturns a list of fields which can be updated with the orders/{id} patch calldeforder_api_get_patchable_fields(self)Response TypeobjectExample Usageresult=orders_controller.order_api_get_patchable_fields()Order Api Send MessageSends a message to the buyerdeforder_api_send_message(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the ordermodelRechnungsdruckWebAppControllersApiOrderApiControllerSendMessageModelBody, RequiredThe message modelResponse TypeobjectExample Usageid=112model=RechnungsdruckWebAppControllersApiOrderApiControllerSendMessageModel()result=orders_controller.order_api_send_message(id,model)Order Api Trigger EventTriggers a rule eventdeforder_api_trigger_event(self,id,model)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the ordermodelRechnungsdruckWebAppControllersApiOrderApiControllerTriggerEventContainerBody, Required-Response TypeobjectExample Usageid=112model=RechnungsdruckWebAppControllersApiOrderApiControllerTriggerEventContainer()result=orders_controller.order_api_trigger_event(id,model)Order Api Parse PlaceholdersParses a text and replaces all placeholdersdeforder_api_parse_placeholders(self,id,container)ParametersParameterTypeTagsDescriptionidlong|intTemplate, RequiredThe id of the ordercontainerRechnungsdruckWebAppControllersApiOrderApiControllerParseTextContainerBody, Required-Response TypeobjectExample Usageid=112container=RechnungsdruckWebAppControllersApiOrderApiControllerParseTextContainer()result=orders_controller.order_api_parse_placeholders(id,container)ShipmentsOverviewGet instanceAn instance of theShipmentsControllerclass can be accessed from the API Client.shipments_controller = client.shipmentsShipment Post ShipmentCreates a new shipment with the selected Shippingproviderdefshipment_post_shipment(self,model)ParametersParameterTypeTagsDescriptionmodelBillbeeInterfacesBillbeeAPIModelCreateShipmentApiModelBody, RequiredData to specify shipment parametersResponse TypeobjectExample Usagemodel=BillbeeInterfacesBillbeeAPIModelCreateShipmentApiModel()result=shipments_controller.shipment_post_shipment(model)Shipment Get ShippingprovidersQuery all defined shipping providersdefshipment_get_shippingproviders(self)Response TypeobjectExample Usageresult=shipments_controller.shipment_get_shippingproviders()Shipment Ship With LabelCreates a shipment for an order in billbeedefshipment_ship_with_label(self,shipment_information)ParametersParameterTypeTagsDescriptionshipment_informationRechnungsdruckWebAppControllersApiShipmentWithLabelBody, RequiredDetails on the order and the shipping methods, that should be used.Response TypeRechnungsdruckWebAppControllersApiApiResultRechnungsdruckWebAppControllersApiShipmentWithLabelResultExample Usageshipment_information=RechnungsdruckWebAppControllersApiShipmentWithLabel()result=shipments_controller.shipment_ship_with_label(shipment_information)Shipment Get Shipping CarrierQueries the currently available shipping carriers.defshipment_get_shipping_carrier(self)Response TypeobjectExample Usageresult=shipments_controller.shipment_get_shipping_carrier()Shipment Get Pingdefshipment_get_ping(self)Response TypeobjectExample Usageresult=shipments_controller.shipment_get_ping()Shipment Get ListGet a list of all shipments optionally filtered by date. All parameters are optional.defshipment_get_list(self,page=None,page_size=None,created_at_min=None,created_at_max=None,order_id=None,minimum_shipment_id=None,shipping_provider_id=None)ParametersParameterTypeTagsDescriptionpageintQuery, OptionalSpecifies the page to request.page_sizeintQuery, OptionalSpecifies the pagesize. Defaults to 50, max value is 250created_at_mindatetimeQuery, OptionalSpecifies the oldest shipment date to include in the responsecreated_at_maxdatetimeQuery, OptionalSpecifies the newest shipment date to include in the responseorder_idlong|intQuery, OptionalGet shipments for this order only.minimum_shipment_idlong|intQuery, OptionalGet Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments.shipping_provider_idlong|intQuery, OptionalGet Shippings for the specified shipping provider only.Response TypeRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelShipmentExample Usageresult=shipments_controller.shipment_get_list()WebhooksOverviewGet instanceAn instance of theWebhooksControllerclass can be accessed from the API Client.webhooks_controller = client.webhooksWeb Hook Management GetGets all registered WebHooks for a given user.defweb_hook_management_get(self)Response TypeList of MicrosoftAspNetWebHooksWebHookExample Usageresult=webhooks_controller.web_hook_management_get()Web Hook Management PostRegisters a new WebHook for a given user.defweb_hook_management_post(self,web_hook)ParametersParameterTypeTagsDescriptionweb_hookMicrosoftAspNetWebHooksWebHookBody, RequiredThe webhook to create. Attach ?noecho to the uri to prevent echo test.Response TypeMicrosoftAspNetWebHooksWebHookExample Usageweb_hook=MicrosoftAspNetWebHooksWebHook()web_hook.web_hook_uri='WebHookUri2'result=webhooks_controller.web_hook_management_post(web_hook)Web Hook Management Delete AllDeletes all existing WebHook registrations.defweb_hook_management_delete_all(self)Response TypeobjectExample Usageresult=webhooks_controller.web_hook_management_delete_all()Web Hook Management LookupLooks up a registered WebHook with the given {id} for a given user.defweb_hook_management_lookup(self,id)ParametersParameterTypeTagsDescriptionidstringTemplate, Required-Response TypeMicrosoftAspNetWebHooksWebHookExample Usageid='id0'result=webhooks_controller.web_hook_management_lookup(id)Web Hook Management PutUpdates an existing WebHook registration.defweb_hook_management_put(self,id,web_hook)ParametersParameterTypeTagsDescriptionidstringTemplate, RequiredThe WebHook ID.web_hookMicrosoftAspNetWebHooksWebHookBody, RequiredThe new webhook to use.Response TypeobjectExample Usageid='id0'web_hook=MicrosoftAspNetWebHooksWebHook()web_hook.web_hook_uri='WebHookUri2'result=webhooks_controller.web_hook_management_put(id,web_hook)Web Hook Management DeleteDeletes an existing WebHook registration.defweb_hook_management_delete(self,id)ParametersParameterTypeTagsDescriptionidstringTemplate, RequiredThe WebHook ID.Response TypeobjectExample Usageid='id0'result=webhooks_controller.web_hook_management_delete(id)Web Hook Management Get FiltersReturns a list of all known filters you can use to register webhooksdefweb_hook_management_get_filters(self)Response TypeobjectExample Usageresult=webhooks_controller.web_hook_management_get_filters()Model ReferenceStructuresBillbee Interfaces Billbee API Model Update Stock Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Update Stock Response DataBillbee Interfaces Billbee API Model Update Stock Response DataRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Get Reserved Amount Response DataBillbee Interfaces Billbee API Model Get Reserved Amount Response DataBillbee Interfaces Billbee API Model Update Stock Code Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Update Stock Code Response DataRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Api ModelBillbee Interfaces Billbee API Model Article Api ModelBillbee Interfaces Order Multi Language StringBillbee Interfaces Billbee API Model Article Image Relation Api ModelBillbee Interfaces Billbee API Model Article Source Api ModelBillbee Interfaces Billbee API Model Stock Article Api ModelBillbee Interfaces Billbee API Model Article Category Api ModelBillbee Interfaces Billbee API Model Bom Sub Article Api ModelBillbee Interfaces Billbee API Model Article Api Custom Field Value ModelBillbee Interfaces Billbee API Model Article Api Custom Field Definition ModelRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Article Api ModelRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Article Api ModelRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelRechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Model Article Image Relation Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Image Relation Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Deleted Images ModelBillbee Interfaces Billbee API Model Deleted Images ModelRechnungsdruck Web App Controllers Api Automatic Provisioning Controller Create Account ContainerRechnungsdruck Web App Controllers Api Automatic Provisioning Controller Create Account Container User AddressRechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Model Cloud Storage Api ModelBillbee Interfaces Billbee API Model Cloud Storage Api ModelRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Customer Api ModelRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Customer Api ModelBillbee Interfaces Billbee API Model Customer Api ModelBillbee Interfaces Billbee API Model Create Customer Api ModelBillbee Interfaces Billbee API Model Customer Address Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Customer Api ModelRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Rechnungsdruck Web App Controllers Api OrderRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Rechnungsdruck Web App Controllers Api OrderRechnungsdruck Web App Controllers Api OrderRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Customer Address Api ModelRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Customer Address Api ModelRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Customer Address Api ModelRechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Models Layout TemplateBillbee Interfaces Billbee API Models Layout TemplateBillbee Interfaces Billbee API Model OrderBillbee Interfaces Billbee API Model ShipmentBillbee Interfaces Billbee API Model Comment Api ModelBillbee Interfaces Billbee API Model Order Address Api ModelBillbee Interfaces Billbee API Model Order ItemBillbee Interfaces Billbee API Model Order UserBillbee Interfaces Shipping Product ServiceBillbee Interfaces Order History EntryBillbee Interfaces Billbee API Models Order PaymentBillbee Interfaces Billbee API Model Sold ProductBillbee Interfaces Billbee API Model Order Item AttributeSystem Collections Generic Key Value Pair System String System Collections Generic List System Collections Generic Key Value Pair System Int 32 System StringBillbee Interfaces Billbee API Model Product ImageSystem Collections Generic Key Value Pair System Int 32 System StringRechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model OrderRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model OrderRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model OrderRechnungsdruck Web App Controllers Api Order Tag CreateRechnungsdruck Web App Controllers Api Order State UpdateRechnungsdruck Web App Controllers Api Api Add Shipment to Order ModelRechnungsdruck Web App Controllers Api Order Api Controller Send Message ModelRechnungsdruck Web App Controllers Api Order Api Controller Trigger Event ContainerRechnungsdruck Web App Controllers Api Order Api Controller Parse Text ContainerRechnungsdruck Web App Controllers Api Search Controller Search ModelRechnungsdruck Web App Controllers Api Api Result Rechnungsdruck Web App Controllers Api Search Controller Search Results ModelRechnungsdruck Web App Controllers Api Search Controller Search Results ModelRechnungsdruck Web App Controllers Api Search Controller Product ResultRechnungsdruck Web App Controllers Api Search Controller Order ResultRechnungsdruck Web App Controllers Api Search Controller Customer ResultBillbee Interfaces Billbee API Model Create Shipment Api ModelBillbee Interfaces Billbee API Model Shipment Address Api ModelBillbee Interfaces Shipping Shipment Data DimensionsRechnungsdruck Web App Controllers Api Shipment With LabelRechnungsdruck Web App Controllers Api Api Result Rechnungsdruck Web App Controllers Api Shipment With Label ResultRechnungsdruck Web App Controllers Api Shipment With Label ResultRechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model ShipmentRechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model ShipmentMicrosoft Asp Net Web Hooks Web HookBillbee Interfaces Billbee API Model Update Stock Api ModelClass NameBillbeeInterfacesBillbeeAPIModelUpdateStockApiModelFieldsNameTypeTagsDescriptionbillbee_idlong|intOptionalOptional the ID of the Billbee product to updateskustringOptionalThe SKU of the product to updatestock_idlong|intOptionalOptional the stock id if the feature multi stock is activatedreasonstringOptionalOptional a reason text for the stock updateold_quantityfloatOptionalThis parameter is currently ignorednew_quantityfloatOptionalThe new absolute stock quantity for the product you want to setdelta_quantityfloatOptionalThis parameter is currently ignoredforce_send_stock_to_shopsboolOptionalIf true, every sent stockchange is stored and transmitted to the connected shop, even if the value has not changedautosubtract_reserved_amountboolOptionalAutomatically reduce the NewQuantity by the currently not fulfilled amountExample (as JSON){"BillbeeId":null,"Sku":null,"StockId":null,"Reason":null,"OldQuantity":null,"NewQuantity":null,"DeltaQuantity":null,"ForceSendStockToShops":null,"AutosubtractReservedAmount":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Update Stock Response DataClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelUpdateStockResponseDataFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelUpdateStockResponseDataOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Model Update Stock Response DataClass NameBillbeeInterfacesBillbeeAPIModelUpdateStockResponseDataFieldsNameTypeTagsDescriptionskustringOptionalThe SKU of the article to update the current stockcurrent_stockfloatOptionalThe new value for current stock after the updateunfulfilled_amountfloatOptionalThe value of the unfulfilled amount (reserved) of the articlemessagestringOptionalA human readable message that explains the result of the operationExample (as JSON){"SKU":null,"CurrentStock":null,"UnfulfilledAmount":null,"Message":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Get Reserved Amount Response DataClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelGetReservedAmountResponseDataFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelGetReservedAmountResponseDataOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Model Get Reserved Amount Response DataClass NameBillbeeInterfacesBillbeeAPIModelGetReservedAmountResponseDataFieldsNameTypeTagsDescriptionreserved_amountfloatOptionalThe reserve (not fulfilled) qty of the articleExample (as JSON){"ReservedAmount":null}Billbee Interfaces Billbee API Model Update Stock Code Api ModelClass NameBillbeeInterfacesBillbeeAPIModelUpdateStockCodeApiModelFieldsNameTypeTagsDescriptionbillbee_idlong|intOptional-skustringOptional-stock_idlong|intOptional-stock_codestringOptional-Example (as JSON){"BillbeeId":null,"Sku":null,"StockId":null,"StockCode":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Update Stock Code Response DataClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelUpdateStockCodeResponseDataFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataobjectOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelArticleApiModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Model Article Api ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleApiModelFieldsNameTypeTagsDescriptioninvoice_textList of BillbeeInterfacesOrderMultiLanguageStringOptional-manufacturerstringOptional-idlong|intOptional-titleList of BillbeeInterfacesOrderMultiLanguageStringOptional-descriptionList of BillbeeInterfacesOrderMultiLanguageStringOptional-short_descriptionList of BillbeeInterfacesOrderMultiLanguageStringOptional-basic_attributesList of BillbeeInterfacesOrderMultiLanguageStringOptional-imagesList of BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelOptional-vat_indexintRequired-pricefloatRequired-cost_pricefloatOptional-vat_1_ratefloatRequired-vat_2_ratefloatRequired-stock_desiredfloatOptional-stock_currentfloatOptional-stock_warningfloatOptional-skustringOptional-eanstringOptional-materialsList of BillbeeInterfacesOrderMultiLanguageStringOptional-tagsList of BillbeeInterfacesOrderMultiLanguageStringOptional-sourcesList of BillbeeInterfacesBillbeeAPIModelArticleSourceApiModelOptional-weightintOptional-weight_netintOptional-low_stockboolOptional-stock_codestringOptional-stock_reduce_items_per_salefloatOptional-stocksList of BillbeeInterfacesBillbeeAPIModelStockArticleApiModelOptional-category_1BillbeeInterfacesBillbeeAPIModelArticleCategoryApiModelOptional-category_2BillbeeInterfacesBillbeeAPIModelArticleCategoryApiModelOptional-category_3BillbeeInterfacesBillbeeAPIModelArticleCategoryApiModelOptional-mtypeintRequired-unitintOptional-units_per_itemfloatOptional-sold_amountfloatOptional-sold_sum_grossfloatOptional-sold_sum_netfloatOptional-sold_sum_net_last_30_daysfloatOptional-sold_sum_gross_last_30_daysfloatOptional-sold_amount_last_30_daysfloatOptional-shipping_product_idintOptional-is_digitalboolRequired-is_customizableboolRequired-delivery_timeintOptional-recipientintOptional-occasionintOptional-country_of_originstringOptional-export_descriptionstringOptional-taric_numberstringOptional-conditionintOptional-width_cmfloatOptional-length_cmfloatOptional-height_cmfloatOptional-bill_of_materialList of BillbeeInterfacesBillbeeAPIModelBomSubArticleApiModelOptional-custom_fieldsList of BillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldValueModelOptional-Example (as JSON){"InvoiceText":null,"Manufacturer":null,"Id":null,"Title":null,"Description":null,"ShortDescription":null,"BasicAttributes":null,"Images":null,"VatIndex":40,"Price":6.2,"CostPrice":null,"Vat1Rate":232.14,"Vat2Rate":233.2,"StockDesired":null,"StockCurrent":null,"StockWarning":null,"SKU":null,"EAN":null,"Materials":null,"Tags":null,"Sources":null,"Weight":null,"WeightNet":null,"LowStock":null,"StockCode":null,"StockReduceItemsPerSale":null,"Stocks":null,"Category1":null,"Category2":null,"Category3":null,"Type":190,"Unit":null,"UnitsPerItem":null,"SoldAmount":null,"SoldSumGross":null,"SoldSumNet":null,"SoldSumNetLast30Days":null,"SoldSumGrossLast30Days":null,"SoldAmountLast30Days":null,"ShippingProductId":null,"IsDigital":false,"IsCustomizable":false,"DeliveryTime":null,"Recipient":null,"Occasion":null,"CountryOfOrigin":null,"ExportDescription":null,"TaricNumber":null,"Condition":null,"WidthCm":null,"LengthCm":null,"HeightCm":null,"BillOfMaterial":null,"CustomFields":null}Billbee Interfaces Order Multi Language StringClass NameBillbeeInterfacesOrderMultiLanguageStringFieldsNameTypeTagsDescriptiontextstringOptional-language_codestringOptional-Example (as JSON){"Text":null,"LanguageCode":null}Billbee Interfaces Billbee API Model Article Image Relation Api ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelFieldsNameTypeTagsDescriptionurlstringOptional-idlong|intOptional-thumb_path_extstringOptional-thumb_urlstringOptional-positionintOptional-is_defaultboolOptional-article_idlong|intOptional-Example (as JSON){"Url":null,"Id":null,"ThumbPathExt":null,"ThumbUrl":null,"Position":null,"IsDefault":null,"ArticleId":null}Billbee Interfaces Billbee API Model Article Source Api ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleSourceApiModelFieldsNameTypeTagsDescriptionidintOptional-sourcestringRequired-source_idstringRequired-api_account_namestringOptional-api_account_idlong|intOptional-export_factorfloatOptional-stock_sync_inactiveboolOptional-stock_sync_minfloatOptional-stock_sync_maxfloatOptional-units_per_itemfloatOptional-customobjectOptional-Example (as JSON){"Id":null,"Source":"Source0","SourceId":"SourceId2","ApiAccountName":null,"ApiAccountId":null,"ExportFactor":null,"StockSyncInactive":null,"StockSyncMin":null,"StockSyncMax":null,"UnitsPerItem":null,"Custom":null}Billbee Interfaces Billbee API Model Stock Article Api ModelClass NameBillbeeInterfacesBillbeeAPIModelStockArticleApiModelFieldsNameTypeTagsDescriptionnamestringOptional-stock_idintOptional-stock_currentfloatOptional-stock_warningfloatOptional-stock_codestringOptional-unfulfilled_amountfloatOptional-stock_desiredfloatOptional-Example (as JSON){"Name":null,"StockId":null,"StockCurrent":null,"StockWarning":null,"StockCode":null,"UnfulfilledAmount":null,"StockDesired":null}Billbee Interfaces Billbee API Model Article Category Api ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleCategoryApiModelFieldsNameTypeTagsDescriptionnamestringOptional-idlong|intOptional-Example (as JSON){"Name":null,"Id":null}Billbee Interfaces Billbee API Model Bom Sub Article Api ModelClass NameBillbeeInterfacesBillbeeAPIModelBomSubArticleApiModelFieldsNameTypeTagsDescriptionamountfloatOptional-article_idlong|intOptional-skustringOptional-Example (as JSON){"Amount":null,"ArticleId":null,"SKU":null}Billbee Interfaces Billbee API Model Article Api Custom Field Value ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldValueModelFieldsNameTypeTagsDescriptionidlong|intOptional-definition_idlong|intOptional-definitionBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelOptional-article_idlong|intOptional-valueobjectOptional-Example (as JSON){"Id":null,"DefinitionId":null,"Definition":null,"ArticleId":null,"Value":null}Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelClass NameBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelFieldsNameTypeTagsDescriptionidlong|intOptional-namestringOptional-configurationobjectOptional-mtypeTypeEnumOptional-is_nullableboolOptional-Example (as JSON){"Id":null,"Name":null,"Configuration":null,"Type":null,"IsNullable":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Article Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiModelFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiModelOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelArticleApiModelOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Article Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiModelFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Api Custom Field Definition ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelArticleApiCustomFieldDefinitionModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Model Article Image Relation Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Article Image Relation Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelArticleImageRelationApiModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Deleted Images ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelDeletedImagesModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelDeletedImagesModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Model Deleted Images ModelClass NameBillbeeInterfacesBillbeeAPIModelDeletedImagesModelFieldsNameTypeTagsDescriptiondeletedList of long|intOptional-not_foundList of long|intOptional-Example (as JSON){"Deleted":null,"NotFound":null}Rechnungsdruck Web App Controllers Api Automatic Provisioning Controller Create Account ContainerData used to create a new Billbee user accountClass NameRechnungsdruckWebAppControllersApiAutomaticProvisioningControllerCreateAccountContainerFieldsNameTypeTagsDescriptione_mailstringRequiredThe Email address of the user to createpasswordstringOptional-accept_termsboolOptionalSet to true, if the user has accepted the Billbee terms & conditionsaddressRechnungsdruckWebAppControllersApiAutomaticProvisioningControllerCreateAccountContainerUserAddressOptionalRepresents the invoice address of a Billbee usernewsletterboolOptionalGets or sets if the user is interested in the Billbee newsletteraffiliate_coupon_codestringOptionalSpecifies an billbee affiliate code to attach to the uservat_1_ratefloatOptionalOptionally specify the vat1 (normal) rate of the uservat_2_ratefloatOptionalOptionally specify the vat2 (reduced) rate of the userdefault_vat_modeDefaultVatModeEnumOptionalOptionally specify the default vat mode of the userdefault_currrencystringOptionalOptionally specify the default currency of the userdefault_vat_indexintOptionalOptionally specify the default vat index of the userExample (as JSON){"EMail":"EMail0","Password":null,"AcceptTerms":null,"Address":null,"Newsletter":null,"AffiliateCouponCode":null,"Vat1Rate":null,"Vat2Rate":null,"DefaultVatMode":null,"DefaultCurrrency":null,"DefaultVatIndex":null}Rechnungsdruck Web App Controllers Api Automatic Provisioning Controller Create Account Container User AddressRepresents the invoice address of a Billbee userClass NameRechnungsdruckWebAppControllersApiAutomaticProvisioningControllerCreateAccountContainerUserAddressFieldsNameTypeTagsDescriptioncompanystringOptional-namestringOptional-address_1stringOptional-address_2stringOptional-zipstringOptional-citystringOptional-countrystringOptionalThe ISO2 country code of the users countryvat_idstringOptional-Example (as JSON){"Company":null,"Name":null,"Address1":null,"Address2":null,"Zip":null,"City":null,"Country":null,"VatId":null}Rechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Model Cloud Storage Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCloudStorageApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelCloudStorageApiModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Model Cloud Storage Api ModelClass NameBillbeeInterfacesBillbeeAPIModelCloudStorageApiModelFieldsNameTypeTagsDescriptionidlong|intOptional-namestringOptional-mtypestringOptional-used_as_printerboolOptional-Example (as JSON){"Id":null,"Name":null,"Type":null,"UsedAsPrinter":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Customer Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerApiModelFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerApiModelOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelCustomerApiModelOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Customer Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerApiModelFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Billbee Interfaces Billbee API Model Customer Api ModelClass NameBillbeeInterfacesBillbeeAPIModelCustomerApiModelFieldsNameTypeTagsDescriptionidlong|intOptionalThe Billbee Id of the customernamestringOptional-emailstringOptional-tel_1stringOptional-tel_2stringOptional-numberintOptional-price_group_idlong|intOptional-language_idintOptional-vat_idstringOptional-mtypeintOptionalCustomer TypeExample (as JSON){"Id":null,"Name":null,"Email":null,"Tel1":null,"Tel2":null,"Number":null,"PriceGroupId":null,"LanguageId":null,"VatId":null,"Type":null}Billbee Interfaces Billbee API Model Create Customer Api ModelClass NameBillbeeInterfacesBillbeeAPIModelCreateCustomerApiModelFieldsNameTypeTagsDescriptionaddressBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelOptionalContainer for passing address dataidlong|intOptionalThe Billbee Id of the customernamestringOptional-emailstringOptional-tel_1stringOptional-tel_2stringOptional-numberintOptional-price_group_idlong|intOptional-language_idintOptional-vat_idstringOptional-mtypeintOptionalCustomer TypeExample (as JSON){"Address":null,"Id":null,"Name":null,"Email":null,"Tel1":null,"Tel2":null,"Number":null,"PriceGroupId":null,"LanguageId":null,"VatId":null,"Type":null}Billbee Interfaces Billbee API Model Customer Address Api ModelContainer for passing address dataClass NameBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelFieldsNameTypeTagsDescriptionidlong|intOptionalThe internal Billbee ID of the address record. Can be null if a new address is createdaddress_typeAddressTypeEnumOptionalThe type of the addresscustomer_idlong|intOptionalThe internal Billbee id of the customer the address belongs tocompanystringOptionalThe name of the companyfirst_namestringOptional-last_namestringOptional-name_2stringOptionalOptionally an additional name fieldstreetstringOptional-housenumberstringOptional-zipstringOptional-citystringOptional-statestringOptional-country_codestringOptionalThe ISO2 code of the countryemailstringOptional-tel_1stringOptional-tel_2stringOptional-faxstringOptional-address_additionstringOptional-Example (as JSON){"Id":null,"AddressType":null,"CustomerId":null,"Company":null,"FirstName":null,"LastName":null,"Name2":null,"Street":null,"Housenumber":null,"Zip":null,"City":null,"State":null,"CountryCode":null,"Email":null,"Tel1":null,"Tel2":null,"Fax":null,"AddressAddition":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Customer Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelCustomerApiModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Rechnungsdruck Web App Controllers Api OrderClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListRechnungsdruckWebAppControllersApiOrderFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListRechnungsdruckWebAppControllersApiOrderOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of RechnungsdruckWebAppControllersApiOrderOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Rechnungsdruck Web App Controllers Api OrderClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListRechnungsdruckWebAppControllersApiOrderFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Rechnungsdruck Web App Controllers Api OrderClass NameRechnungsdruckWebAppControllersApiOrderFieldsNameTypeTagsDescriptionidintOptional-external_idstringOptional-invoice_numberstringOptional-invoice_created_atdatetimeOptional-invoice_datedatetimeOptional-created_atdatetimeOptional-paid_atdatetimeOptional-shipped_atdatetimeOptional-has_invoiceboolOptional-order_state_idintOptional-order_state_textstringOptional-total_grossfloatOptional-shop_namestringOptional-can_create_auto_invoiceboolOptional-Example (as JSON){"Id":null,"ExternalId":null,"InvoiceNumber":null,"InvoiceCreatedAt":null,"InvoiceDate":null,"CreatedAt":null,"PaidAt":null,"ShippedAt":null,"HasInvoice":null,"OrderStateId":null,"OrderStateText":null,"TotalGross":null,"ShopName":null,"CanCreateAutoInvoice":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model Customer Address Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model Customer Address Api ModelClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model Customer Address Api ModelClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModelOptionalContainer for passing address dataExample (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Result System Collections Generic List Billbee Interfaces Billbee API Models Layout TemplateClass NameRechnungsdruckWebAppControllersApiApiResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelsLayoutTemplateFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelsLayoutTemplateOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Billbee Interfaces Billbee API Models Layout TemplateClass NameBillbeeInterfacesBillbeeAPIModelsLayoutTemplateFieldsNameTypeTagsDescriptionidlong|intOptional-namestringOptional-mtypeType1EnumOptional-Example (as JSON){"Id":null,"Name":null,"Type":null}Billbee Interfaces Billbee API Model OrderA class that represents the Billbee data model of a single orderClass NameBillbeeInterfacesBillbeeAPIModelOrderFieldsNameTypeTagsDescriptionrebate_differencefloatOptional-shipping_idsList of BillbeeInterfacesBillbeeAPIModelShipmentOptionalThe shipments of the orderaccept_loss_of_return_rightboolOptionalCustomer accepts loss due to withdrawalidstringOptionalId of the order in the external system (marketplace)order_numberstringOptionalOrder number of the order in the external system (marketplace)stateStateEnumOptionalThe current state of the ordervat_modeVatModeEnumOptionalThe vat mode of the ordercreated_atdatetimeOptionalThe date on which the order was createdshipped_atdatetimeOptionalThe date on which the order was shippedconfirmed_atdatetimeOptionalThe date on which the order was confirmedpayed_atdatetimeOptionalThe date on which the order was paidseller_commentstringOptionalAn internal seller commentcommentsList of BillbeeInterfacesBillbeeAPIModelCommentApiModelOptionalAll messages / comments of the orderinvoice_number_prefixstringOptionalThe prefix of the invoice numberinvoice_number_postfixstringOptionalThe postfix of the invoice numberinvoice_numberintOptionalThe invoice numberinvoice_datedatetimeOptionalThe date on which the invoice was createdinvoice_addressBillbeeInterfacesBillbeeAPIModelOrderAddressApiModelOptional-shipping_addressBillbeeInterfacesBillbeeAPIModelOrderAddressApiModelOptional-payment_methodPaymentMethodEnumOptionalThe payment methodshipping_costfloatOptionalThe shipping costtotal_costfloatOptionalThe total cost excluding shipping costadjustment_costfloatOptional-adjustment_reasonstringOptional-order_itemsList of BillbeeInterfacesBillbeeAPIModelOrderItemOptionalThe list of items purchased like shirt, pant, toys etccurrencystringOptionalThe three letter currency code.sellerBillbeeInterfacesBillbeeAPIModelOrderUserOptional-buyerBillbeeInterfacesBillbeeAPIModelOrderUserOptional-updated_atdatetimeOptionalThe date on which the order was last updatedtax_rate_1floatOptionalThe regular tax ratetax_rate_2floatOptionalThe reduced tax ratebill_bee_order_idlong|intOptionalThe Order.Id from the Billbee databasebill_bee_parent_order_idlong|intOptionalThe Id of the parent order in the Billbee databasevat_idstringOptionalThe customers vat idtagsList of stringOptionalThe Tags of the ordership_weight_kgfloatOptionalThe total weight of the shipment(s)language_codestringOptionalThe two-letter language code of the customerpaid_amountfloatOptional-shipping_profile_idstringOptionalInternal Id for the shipping profile for that ordershipping_provider_idlong|intOptionalInternal Id for the used shipping providershipping_provider_product_idlong|intOptionalInternal Id for the used shipping productshipping_provider_namestringOptionalThe Name for of used shipping providershipping_provider_product_namestringOptionalThe Name of the used shipping productshipping_profile_namestringOptionalDisplay Name of Shipping profile, if availablepayment_instructionstringOptionalA textfield optionaly filled with a payment instruction text for printout on the invoice (z.B. Ebay Kauf auf Rechnung)is_cancelation_forstringOptionalAn optional Order Id (externalid) for an order if this is a cancel order (shopify only at the moment)payment_transaction_idstringOptionalThe id of the payment transaction. For example the transaction id of PayPal payment. Should not be used any more. Please use 'Payments' instead.distribution_centerstringOptionalAn optional code for the distribution center delivering this orderdelivery_source_country_codestringOptionalAn optional Country ISO2 Code of the country where order is shipped from (FBA)custom_invoice_notestringOptionalAn optional multiline text which is printed on the invoicecustomer_numberstringOptionalThe customer number (not to be confused with the id of the customer)payment_referencestringOptionalA payment reference. Should not be used any more. Please use 'Payments' instead.shipping_servicesList of BillbeeInterfacesShippingProductServiceOptionalAdditional services for the shipmentcustomerBillbeeInterfacesBillbeeAPIModelCustomerApiModelOptional-historyList of BillbeeInterfacesOrderHistoryEntryOptional-paymentsList of BillbeeInterfacesBillbeeAPIModelsOrderPaymentOptional-last_modified_atdatetimeOptionalDate of the last update, the order gotExample (as JSON){"RebateDifference":null,"ShippingIds":null,"AcceptLossOfReturnRight":null,"Id":null,"OrderNumber":null,"State":null,"VatMode":null,"CreatedAt":null,"ShippedAt":null,"ConfirmedAt":null,"PayedAt":null,"SellerComment":null,"Comments":null,"InvoiceNumberPrefix":null,"InvoiceNumberPostfix":null,"InvoiceNumber":null,"InvoiceDate":null,"InvoiceAddress":null,"ShippingAddress":null,"PaymentMethod":null,"ShippingCost":null,"TotalCost":null,"AdjustmentCost":null,"AdjustmentReason":null,"OrderItems":null,"Currency":null,"Seller":null,"Buyer":null,"UpdatedAt":null,"TaxRate1":null,"TaxRate2":null,"BillBeeOrderId":null,"BillBeeParentOrderId":null,"VatId":null,"Tags":null,"ShipWeightKg":null,"LanguageCode":null,"PaidAmount":null,"ShippingProfileId":null,"ShippingProviderId":null,"ShippingProviderProductId":null,"ShippingProviderName":null,"ShippingProviderProductName":null,"ShippingProfileName":null,"PaymentInstruction":null,"IsCancelationFor":null,"PaymentTransactionId":null,"DistributionCenter":null,"DeliverySourceCountryCode":null,"CustomInvoiceNote":null,"CustomerNumber":null,"PaymentReference":null,"ShippingServices":null,"Customer":null,"History":null,"Payments":null,"LastModifiedAt":null}Billbee Interfaces Billbee API Model ShipmentRepresents a single shipment.Class NameBillbeeInterfacesBillbeeAPIModelShipmentFieldsNameTypeTagsDescriptionbillbee_idlong|intOptionalThe billbee internal id of the shipmentshipping_idstringOptionalThe id of this shipmentshipperstringOptionalThe name of the shipping providercreateddatetimeOptionalThe creation datetracking_urlstringOptionalThe url to track this shipmentshipping_provider_idlong|intOptionalThe id of the used shipping providershipping_provider_product_idlong|intOptionalThe id of the used shipping provider productshipping_carrierintOptionalThe carrier used to ship the parcel withExample (as JSON){"BillbeeId":null,"ShippingId":null,"Shipper":null,"Created":null,"TrackingUrl":null,"ShippingProviderId":null,"ShippingProviderProductId":null,"ShippingCarrier":null}Billbee Interfaces Billbee API Model Comment Api ModelClass NameBillbeeInterfacesBillbeeAPIModelCommentApiModelFieldsNameTypeTagsDescriptionidlong|intOptional-from_customerboolOptional-textstringOptional-namestringOptional-createddatetimeOptional-Example (as JSON){"Id":null,"FromCustomer":null,"Text":null,"Name":null,"Created":null}Billbee Interfaces Billbee API Model Order Address Api ModelClass NameBillbeeInterfacesBillbeeAPIModelOrderAddressApiModelFieldsNameTypeTagsDescriptionbillbee_idlong|intOptional-first_namestringOptional-last_namestringOptional-companystringOptional-name_additionstringOptional-streetstringOptional-house_numberstringOptional-zipstringOptional-citystringOptional-country_iso_2stringOptional-countrystringOptional-line_2stringOptional-emailstringOptional-statestringOptional-phonestringOptional-Example (as JSON){"BillbeeId":null,"FirstName":null,"LastName":null,"Company":null,"NameAddition":null,"Street":null,"HouseNumber":null,"Zip":null,"City":null,"CountryISO2":null,"Country":null,"Line2":null,"Email":null,"State":null,"Phone":null}Billbee Interfaces Billbee API Model Order ItemClass NameBillbeeInterfacesBillbeeAPIModelOrderItemFieldsNameTypeTagsDescriptionbillbee_idlong|intOptionalThe billbee id of this itemtransaction_idstringOptionalId of the individual transaction. Only required by Ebay to detect aggregated ordersproductBillbeeInterfacesBillbeeAPIModelSoldProductOptional-quantityfloatOptionalThe sold quantitytotal_pricefloatOptionalThe total price (unit price * quantity)tax_amountfloatOptionalThe tax amount in the total pricetax_indexintOptionalThe tax index.discountfloatOptionalSets the discount in percentattributesList of BillbeeInterfacesBillbeeAPIModelOrderItemAttributeOptionalA list of product attributes for this positionget_price_from_article_if_anyboolOptionalIf true, the price will be overwritten by the known article price in billbee if availableis_couponboolOptionalDetermines if it is a coupon, which is interpreted as tax-free paymentshipping_profile_idstringOptionalDetermines if it is a coupon, which is interpreted as tax-free paymentdont_adjust_stockboolOptionalIf true, the import of this order won't adjust the stock level at billbee.unrebated_total_pricefloatOptionalIs just used for the billbee apiserial_numberstringOptionalContains the used serial numberExample (as JSON){"BillbeeId":null,"TransactionId":null,"Product":null,"Quantity":null,"TotalPrice":null,"TaxAmount":null,"TaxIndex":null,"Discount":null,"Attributes":null,"GetPriceFromArticleIfAny":null,"IsCoupon":null,"ShippingProfileId":null,"DontAdjustStock":null,"UnrebatedTotalPrice":null,"SerialNumber":null}Billbee Interfaces Billbee API Model Order UserClass NameBillbeeInterfacesBillbeeAPIModelOrderUserFieldsNameTypeTagsDescriptionplatformstringOptionalThe name of the platform from which this customer originatedbillbee_shop_namestringOptionalThe name of shop connection in Billbeebillbee_shop_idlong|intOptionalThe Billbee internal id of the shop connectionidstringOptionalThe Billbee internal id of this customernickstringOptionalThe nick name (if available) from the original systemfirst_namestringOptionalThe first name of this customerlast_namestringOptionalThe last name of this customerfull_namestringOptionalThe full name ("firstname lastname") of this customeremailstringOptionalThe email address of this customerExample (as JSON){"Platform":null,"BillbeeShopName":null,"BillbeeShopId":null,"Id":null,"Nick":null,"FirstName":null,"LastName":null,"FullName":null,"Email":null}Billbee Interfaces Shipping Product ServiceClass NameBillbeeInterfacesShippingProductServiceFieldsNameTypeTagsDescriptiondisplay_namestringOptional-display_valuestringOptional-requires_user_inputboolOptional-service_namestringOptional-type_namestringOptional-possible_value_listsList of SystemCollectionsGenericKeyValuePairSystemStringSystemCollectionsGenericListSystemCollectionsGenericKeyValuePairSystemInt32SystemStringOptional-can_be_configuredboolOptional-Example (as JSON){"DisplayName":null,"DisplayValue":null,"RequiresUserInput":null,"ServiceName":null,"typeName":null,"PossibleValueLists":null,"CanBeConfigured":null}Billbee Interfaces Order History EntryClass NameBillbeeInterfacesOrderHistoryEntryFieldsNameTypeTagsDescriptioncreateddatetimeOptional-event_type_namestringOptional-textstringOptional-employee_namestringOptional-type_idintOptional-Example (as JSON){"Created":null,"EventTypeName":null,"Text":null,"EmployeeName":null,"TypeId":null}Billbee Interfaces Billbee API Models Order PaymentClass NameBillbeeInterfacesBillbeeAPIModelsOrderPaymentFieldsNameTypeTagsDescriptionbillbee_idlong|intOptional-transaction_idstringOptional-pay_datedatetimeOptional-payment_typeintOptional-source_technologystringOptional-source_textstringOptional-pay_valuefloatOptional-purposestringOptional-namestringOptional-Example (as JSON){"BillbeeId":null,"TransactionId":null,"PayDate":null,"PaymentType":null,"SourceTechnology":null,"SourceText":null,"PayValue":null,"Purpose":null,"Name":null}Billbee Interfaces Billbee API Model Sold ProductClass NameBillbeeInterfacesBillbeeAPIModelSoldProductFieldsNameTypeTagsDescriptionold_idstringOptionalThis is for migration scenarios when the internal id of a product changesI.E. Etsy when switching to the new inventory management, the ids for variants will change.idstringOptionalThe id of this product in the external systemtitlestringOptionalThe name of this productweightintOptionalWeight of one item in gramskustringOptionalThe SKU of this productsku_or_idstringOptionalThe SKU of this product or the id if the SKU is emptyis_digitalboolOptionalTrue if the product is a digital good (download etc.), false if notimagesList of BillbeeInterfacesBillbeeAPIModelProductImageOptionalThe images of this producteanstringOptionalThe EAN / GTIN of this productplatform_datastringOptionalOptional platform specific Data as serialized JSON Object for the producttaric_codestringOptionalThe TARIC codecountry_of_originstringOptionalThe country where this article was madebillbee_idlong|intOptionalThe Billbee internal id of the linked productExample (as JSON){"OldId":null,"Id":null,"Title":null,"Weight":null,"SKU":null,"SkuOrId":null,"IsDigital":null,"Images":null,"EAN":null,"PlatformData":null,"TARICCode":null,"CountryOfOrigin":null,"BillbeeId":null}Billbee Interfaces Billbee API Model Order Item AttributeClass NameBillbeeInterfacesBillbeeAPIModelOrderItemAttributeFieldsNameTypeTagsDescriptionidstringOptionalThe internal id of this attributenamestringOptionalThe attribute name. E.g. colorvaluestringOptionalThe attribute value. E.g. redpricefloatOptional-Example (as JSON){"Id":null,"Name":null,"Value":null,"Price":null}System Collections Generic Key Value Pair System String System Collections Generic List System Collections Generic Key Value Pair System Int 32 System StringClass NameSystemCollectionsGenericKeyValuePairSystemStringSystemCollectionsGenericListSystemCollectionsGenericKeyValuePairSystemInt32SystemStringFieldsNameTypeTagsDescriptionkeystringOptional-valueList of SystemCollectionsGenericKeyValuePairSystemInt32SystemStringOptional-Example (as JSON){"key":null,"value":null}Billbee Interfaces Billbee API Model Product ImageClass NameBillbeeInterfacesBillbeeAPIModelProductImageFieldsNameTypeTagsDescriptionurlstringOptionalThe url to the imageis_default_imageboolOptionalTrue if the image is / should be the default imagepositionintOptionalThe order of this imageexternal_idstringOptionalThe id of this image from the original systemExample (as JSON){"Url":null,"IsDefaultImage":null,"Position":null,"ExternalId":null}System Collections Generic Key Value Pair System Int 32 System StringClass NameSystemCollectionsGenericKeyValuePairSystemInt32SystemStringFieldsNameTypeTagsDescriptionkeyintOptional-valuestringOptional-Example (as JSON){"key":null,"value":null}Rechnungsdruck Web App Controllers Api Api Result Billbee Interfaces Billbee API Model OrderClass NameRechnungsdruckWebAppControllersApiApiResultBillbeeInterfacesBillbeeAPIModelOrderFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataBillbeeInterfacesBillbeeAPIModelOrderOptionalA class that represents the Billbee data model of a single orderExample (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model OrderClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelOrderFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelOrderOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelOrderOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model OrderClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelOrderFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Rechnungsdruck Web App Controllers Api Order Tag CreateClass NameRechnungsdruckWebAppControllersApiOrderTagCreateFieldsNameTypeTagsDescriptiontagsList of stringOptional-Example (as JSON){"Tags":null}Rechnungsdruck Web App Controllers Api Order State UpdateSpecifies the parameters used to set the new state of an orderClass NameRechnungsdruckWebAppControllersApiOrderStateUpdateFieldsNameTypeTagsDescriptionnew_state_idNewStateIdEnumOptionalThe new state to setExample (as JSON){"NewStateId":null}Rechnungsdruck Web App Controllers Api Api Add Shipment to Order ModelData of the shipment to be createdClass NameRechnungsdruckWebAppControllersApiApiAddShipmentToOrderModelFieldsNameTypeTagsDescriptionshipping_idstringOptionalThe id of the shipment (Sendungsnummer/trackingid)order_idstringOptionalOptional a differing order number of the shipment if availablecommentstringOptionalOptional a text stored with the shipmentshipping_provider_idlong|intOptionalOptional the id of a shipping provider existing in the billbee account that should be assigned to the shipmentshipping_provider_product_idlong|intOptionalOptional the id of a shipping provider product that should be assigend to the shipmentcarrier_idintOptionalOptional the id of a shipping carrier that should be assigend to the shipmentWill override the carrier from the shipment product.Please use the integer value from this Enumeration:{Billbee.Interfaces.Shipping.Enums.ShippingCarrier}Example (as JSON){"ShippingId":null,"OrderId":null,"Comment":null,"ShippingProviderId":null,"ShippingProviderProductId":null,"CarrierId":null}Rechnungsdruck Web App Controllers Api Order Api Controller Send Message ModelClass NameRechnungsdruckWebAppControllersApiOrderApiControllerSendMessageModelFieldsNameTypeTagsDescriptionsend_modeSendModeEnumOptional-subjectList of BillbeeInterfacesOrderMultiLanguageStringOptional-bodyList of BillbeeInterfacesOrderMultiLanguageStringOptional-alternative_mailstringOptional-Example (as JSON){"SendMode":null,"Subject":null,"Body":null,"AlternativeMail":null}Rechnungsdruck Web App Controllers Api Order Api Controller Trigger Event ContainerClass NameRechnungsdruckWebAppControllersApiOrderApiControllerTriggerEventContainerFieldsNameTypeTagsDescriptionnamestringOptionalName of the eventdelay_in_minutesintOptionalThe delay in minutes until the rule is executedExample (as JSON){"Name":null,"DelayInMinutes":null}Rechnungsdruck Web App Controllers Api Order Api Controller Parse Text ContainerClass NameRechnungsdruckWebAppControllersApiOrderApiControllerParseTextContainerFieldsNameTypeTagsDescriptiontext_to_parsestringOptionalThe text to parse and replace the placeholders in.is_htmlboolOptionalIf true, the string will be handled as html.languagestringOptionalThe ISO 639-1 code of the target language. Using default if not set.trimboolOptionalIf true, then the placeholder values are trimmed after usage.Example (as JSON){"TextToParse":null,"IsHtml":null,"Language":null,"Trim":null}Rechnungsdruck Web App Controllers Api Search Controller Search ModelClass NameRechnungsdruckWebAppControllersApiSearchControllerSearchModelFieldsNameTypeTagsDescriptionmtypeList of stringOptional-termstringOptional-search_modeSearchModeEnumOptional-Example (as JSON){"Type":null,"Term":null,"SearchMode":null}Rechnungsdruck Web App Controllers Api Api Result Rechnungsdruck Web App Controllers Api Search Controller Search Results ModelClass NameRechnungsdruckWebAppControllersApiApiResultRechnungsdruckWebAppControllersApiSearchControllerSearchResultsModelFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataRechnungsdruckWebAppControllersApiSearchControllerSearchResultsModelOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Search Controller Search Results ModelClass NameRechnungsdruckWebAppControllersApiSearchControllerSearchResultsModelFieldsNameTypeTagsDescriptionproductsList of RechnungsdruckWebAppControllersApiSearchControllerProductResultOptional-ordersList of RechnungsdruckWebAppControllersApiSearchControllerOrderResultOptional-customersList of RechnungsdruckWebAppControllersApiSearchControllerCustomerResultOptional-Example (as JSON){"Products":null,"Orders":null,"Customers":null}Rechnungsdruck Web App Controllers Api Search Controller Product ResultClass NameRechnungsdruckWebAppControllersApiSearchControllerProductResultFieldsNameTypeTagsDescriptionidlong|intOptional-short_textstringOptional-skustringOptional-tagsstringOptional-Example (as JSON){"Id":null,"ShortText":null,"SKU":null,"Tags":null}Rechnungsdruck Web App Controllers Api Search Controller Order ResultClass NameRechnungsdruckWebAppControllersApiSearchControllerOrderResultFieldsNameTypeTagsDescriptionidlong|intOptional-external_referencestringOptional-buyer_namestringOptional-invoice_numberstringOptional-customer_namestringOptional-article_textsstringOptional-Example (as JSON){"Id":null,"ExternalReference":null,"BuyerName":null,"InvoiceNumber":null,"CustomerName":null,"ArticleTexts":null}Rechnungsdruck Web App Controllers Api Search Controller Customer ResultClass NameRechnungsdruckWebAppControllersApiSearchControllerCustomerResultFieldsNameTypeTagsDescriptionidlong|intOptional-namestringOptional-addressesstringOptional-numberstringOptional-Example (as JSON){"Id":null,"Name":null,"Addresses":null,"Number":null}Billbee Interfaces Billbee API Model Create Shipment Api ModelClass NameBillbeeInterfacesBillbeeAPIModelCreateShipmentApiModelFieldsNameTypeTagsDescriptionprovider_namestringOptionalThe name of the provider as specified in the billbee accountproduct_codestringOptionalThe productcode to be used when creating the shipment. Values depends on the carrier usedprinter_namestringOptionalThe name of a connected Cloudprinter to sent the label toprinter_id_for_export_docslong|intOptionalThe id of a connected Cloudprinter to sent the export docs toservicesList of BillbeeInterfacesShippingProductServiceOptionalA list of services to be used when creating the shipmentreceiver_addressBillbeeInterfacesBillbeeAPIModelShipmentAddressApiModelOptional-client_referencestringOptionalOptional specify a text to be included on the label. Not possible with all carrierscustomer_numberstringOptionalNot used anymoreweight_in_gramfloatOptionalOptional specify the weight in gram of the shipmentorder_sumfloatOptionalThe value of the shipments contentorder_currency_codestringOptionalThe Currency if the ordersumcontentstringOptionalOptional specify a text describing the content of the shipment. Used for export shipmentsship_datedatetimeOptionalOptional overwrite the shipdate to be transferred to the carriershipping_carrierShippingCarrierEnumOptional-dimensionBillbeeInterfacesShippingShipmentDataDimensionsOptional-Example (as JSON){"ProviderName":null,"ProductCode":null,"PrinterName":null,"PrinterIdForExportDocs":null,"Services":null,"ReceiverAddress":null,"ClientReference":null,"CustomerNumber":null,"WeightInGram":null,"OrderSum":null,"OrderCurrencyCode":null,"Content":null,"ShipDate":null,"shippingCarrier":null,"Dimension":null}Billbee Interfaces Billbee API Model Shipment Address Api ModelClass NameBillbeeInterfacesBillbeeAPIModelShipmentAddressApiModelFieldsNameTypeTagsDescriptioncompanystringOptional-first_namestringOptional-last_namestringOptional-name_2stringOptional-streetstringOptional-housenumberstringOptional-zipstringOptional-citystringOptional-country_codestringOptional-country_code_iso_3stringOptional-emailstringOptional-telephonestringOptional-address_additionstringOptional-is_export_countryboolOptional-statestringOptional-full_namestringOptional-full_streetstringOptional-Example (as JSON){"Company":null,"FirstName":null,"LastName":null,"Name2":null,"Street":null,"Housenumber":null,"Zip":null,"City":null,"CountryCode":null,"CountryCodeISO3":null,"Email":null,"Telephone":null,"AddressAddition":null,"IsExportCountry":null,"State":null,"FullName":null,"FullStreet":null}Billbee Interfaces Shipping Shipment Data DimensionsClass NameBillbeeInterfacesShippingShipmentDataDimensionsFieldsNameTypeTagsDescriptionlengthfloatOptional-widthfloatOptional-heightfloatOptional-Example (as JSON){"length":null,"width":null,"height":null}Rechnungsdruck Web App Controllers Api Shipment With LabelClass NameRechnungsdruckWebAppControllersApiShipmentWithLabelFieldsNameTypeTagsDescriptionorder_idlong|intOptionalThe Billbee internal id of the order to shipprovider_idlong|intOptionalThe id of the provider. You can query all providers with the shippingproviders endpointproduct_idlong|intOptionalthe id of the shipping provider product to be usedchange_state_to_sendboolOptionalOptional parameter to automatically change the orderstate to sent after creating the shipmentprinter_namestringOptionalOptional the name of a connected cloudprinter to send the label toweight_in_gramintOptionalOptional the shipments weight in gram to override the calculated weightship_datedatetimeOptionalOptional specify the shipdate to be transmitted to the carrierclient_referencestringOptionalOptional specify a reference text to be included on the label. Works not with all carriersdimensionBillbeeInterfacesShippingShipmentDataDimensionsOptional-Example (as JSON){"OrderId":null,"ProviderId":null,"ProductId":null,"ChangeStateToSend":null,"PrinterName":null,"WeightInGram":null,"ShipDate":null,"ClientReference":null,"Dimension":null}Rechnungsdruck Web App Controllers Api Api Result Rechnungsdruck Web App Controllers Api Shipment With Label ResultClass NameRechnungsdruckWebAppControllersApiApiResultRechnungsdruckWebAppControllersApiShipmentWithLabelResultFieldsNameTypeTagsDescriptionerror_messagestringOptional-error_codeErrorCodeEnumOptional-dataRechnungsdruckWebAppControllersApiShipmentWithLabelResultOptional-Example (as JSON){"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Shipment With Label ResultClass NameRechnungsdruckWebAppControllersApiShipmentWithLabelResultFieldsNameTypeTagsDescriptionorder_idlong|intOptional-order_referencestringOptional-shipping_idstringOptional-tracking_urlstringOptional-label_data_pdfstringOptional-export_docs_pdfstringOptional-carrierstringOptional-shipping_datedatetimeOptional-Example (as JSON){"OrderId":null,"OrderReference":null,"ShippingId":null,"TrackingUrl":null,"LabelDataPdf":null,"ExportDocsPdf":null,"Carrier":null,"ShippingDate":null}Rechnungsdruck Web App Controllers Api Api Paged Result System Collections Generic List Billbee Interfaces Billbee API Model ShipmentClass NameRechnungsdruckWebAppControllersApiApiPagedResultSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelShipmentFieldsNameTypeTagsDescriptionpagingRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelShipmentOptional-error_messagestringOptional-error_codeErrorCodeEnumOptional-dataList of BillbeeInterfacesBillbeeAPIModelShipmentOptional-Example (as JSON){"Paging":null,"ErrorMessage":null,"ErrorCode":null,"Data":null}Rechnungsdruck Web App Controllers Api Api Paged Result Paging Information System Collections Generic List Billbee Interfaces Billbee API Model ShipmentClass NameRechnungsdruckWebAppControllersApiApiPagedResultPagingInformationSystemCollectionsGenericListBillbeeInterfacesBillbeeAPIModelShipmentFieldsNameTypeTagsDescriptionpageintOptional-total_pagesintOptional-total_rowsintOptional-page_sizeintOptional-Example (as JSON){"Page":null,"TotalPages":null,"TotalRows":null,"PageSize":null}Microsoft Asp Net Web Hooks Web HookClass NameMicrosoftAspNetWebHooksWebHookFieldsNameTypeTagsDescriptionidstringOptional-web_hook_uristringRequired-secretstringOptional-descriptionstringOptional-is_pausedboolOptional-filtersList of stringOptional-headersdictOptional-propertiesdictOptional-Example (as JSON){"Id":null,"WebHookUri":"WebHookUri0","Secret":null,"Description":null,"IsPaused":null,"Filters":null,"Headers":null,"Properties":null}EnumerationsAddress TypeArticle Title SourceDefault Vat ModeError CodeNew State IdPayment MethodSearch ModeSend ModeShipping CarrierStateTypeType 1Vat ModeAddress TypeThe type of the addressClass NameAddressTypeEnumFieldsNameENUM_1ENUM_2Article Title SourceClass NameArticleTitleSourceEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3Default Vat ModeOptionally specify the default vat mode of the userClass NameDefaultVatModeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4ENUM_5Error CodeClass NameErrorCodeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4ENUM_5ENUM_6ENUM_7ENUM_8ENUM_9ENUM_10ENUM_11ENUM_12ENUM_13ENUM_14ENUM_15ENUM_16ENUM_17ENUM_18ENUM_19ENUM_20ENUM_21ENUM_22ENUM_23ENUM_24ENUM_25ENUM_26ENUM_27New State IdThe new state to setClass NameNewStateIdEnumFieldsNameENUM_1ENUM_2ENUM_3ENUM_4ENUM_5ENUM_6ENUM_7ENUM_8ENUM_9ENUM_10ENUM_11ENUM_12ENUM_13ENUM_14ENUM_15ENUM_16Payment MethodThe payment methodClass NamePaymentMethodEnumFieldsNameENUM_1ENUM_2ENUM_3ENUM_4ENUM_6ENUM_19ENUM_20ENUM_21ENUM_22ENUM_23ENUM_24ENUM_25ENUM_26ENUM_27ENUM_28ENUM_29ENUM_30ENUM_31ENUM_32ENUM_33ENUM_34ENUM_35ENUM_36ENUM_37ENUM_38ENUM_39ENUM_40ENUM_41ENUM_42ENUM_43ENUM_44ENUM_45ENUM_46ENUM_47ENUM_48ENUM_49ENUM_50ENUM_51ENUM_52ENUM_53ENUM_54ENUM_55ENUM_56ENUM_57ENUM_58ENUM_59ENUM_60ENUM_61ENUM_62ENUM_63ENUM_64ENUM_65ENUM_66ENUM_67ENUM_68ENUM_69ENUM_70ENUM_71ENUM_72ENUM_73ENUM_74ENUM_75ENUM_76ENUM_77ENUM_78ENUM_79ENUM_80ENUM_81ENUM_82ENUM_83ENUM_84ENUM_85ENUM_86ENUM_87ENUM_88ENUM_89ENUM_90ENUM_91ENUM_92ENUM_93ENUM_94ENUM_95ENUM_96ENUM_97ENUM_98ENUM_99ENUM_100ENUM_101ENUM_102ENUM_103ENUM_104ENUM_105ENUM_106ENUM_107ENUM_108ENUM_109ENUM_110ENUM_111ENUM_112Search ModeClass NameSearchModeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4Send ModeClass NameSendModeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4Shipping CarrierClass NameShippingCarrierEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4ENUM_5ENUM_6ENUM_7ENUM_8ENUM_9ENUM_10ENUM_11ENUM_12ENUM_13ENUM_14ENUM_15ENUM_16ENUM_17StateThe current state of the orderClass NameStateEnumFieldsNameENUM_1ENUM_2ENUM_3ENUM_4ENUM_5ENUM_6ENUM_7ENUM_8ENUM_9ENUM_10ENUM_11ENUM_12ENUM_13ENUM_14ENUM_15ENUM_16TypeClass NameTypeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3Type 1Class NameType1EnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4ENUM_5Vat ModeThe vat mode of the orderClass NameVatModeEnumFieldsNameENUM_0ENUM_1ENUM_2ENUM_3ENUM_4ENUM_5Utility Classes DocumentationApiHelperA utility class for processing API Calls. Also contains classes for supporting standard datetime formats.MethodsNameDescriptionjson_deserializeDeserializes a JSON string to a Python dictionary.ClassesNameDescriptionHttpDateTimeA wrapper for datetime to support HTTP date format.UnixDateTimeA wrapper for datetime to support Unix date format.RFC3339DateTimeA wrapper for datetime to support RFC3339 format.Common Code DocumentationHttpResponseHttp response received.ParametersNameTypeDescriptionstatus_codeintThe status code returned by the server.reason_phrasestrThe reason phrase returned by the server.headersdictResponse headers.textstrResponse body.requestHttpRequestThe request that resulted in this response.HttpRequestRepresents a single Http Request.ParametersNameTypeTagDescriptionhttp_methodHttpMethodEnumThe HTTP method of the request.query_urlstrThe endpoint URL for the API request.headersdictoptionalRequest headers.query_parametersdictoptionalQuery parameters to add in the URL.parametersdict | stroptionalRequest body, either as a serialized string or else a list of parameters to form encode.filesdictoptionalFiles to be sent with the request.