/
BI
billbee
/
Billbee API
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v2
latest
Swagger 2.0
2026-08-01
87
117
271.9 KB
ApiUsage
Get summarised api usage statistics
get
/api/v1/apiusage
Query parameters
request.date
string
date-time
Only year and month of this is relevant
Response
OK
RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIDtoApiUsageApiUsageSummaryReport
required
ErrorMessage
string
ErrorCode
0
|
1
|
2
|
3
|
4
|
5
|
6
|
7
|
8
|
9
|
10
|
11
|
12
|
13
|
14
|
15
|
16
|
17
|
18
|
19
|
20
|
21
|
22
|
23
|
24
|
25
|
26
|
27
|
28
|
29
|
30
|
31
ErrorDescription
0
|
1
|
2
|
3
|
4
|
5
|
6
|
7
|
8
|
9
|
10
|
11
|
12
|
13
|
14
|
15
|
16
|
17
|
18
|
19
|
20
|
21
|
22
|
23
|
24
|
25
|
26
|
27
|
28
|
29
|
30
|
31
Data
BillbeeInterfacesBillbeeAPIDtoApiUsageApiUsageSummaryReport
All 87 operations
get
Get summarised api usage statistics
get
Get detailed api usage statistics
get
Gets a list of all connected cloud storage devices
get
Get a list of all customer addresses
post
Creates a new customer address
get
Queries a single customer address by id
put
Updates a customer address by id
get
Get a list of all customers
post
Creates a new customer
get
Queries a single customer by id
put
Updates a customer by id
get
Queries a list of orders from a customer
get
Queries a list of addresses from a customer
post
Adds a new address to a customer
get
Queries a single address from a customer
put
Updates all fields of an address
patch
Updates one or more fields of an address
get
Returns a list with all defined paymenttypes
get
Returns a list with all defined shippingcarriers
get
Returns a list with all defined account sync states
get
Returns a list with all defined account types
get
Returns a list with all defined shipmenttypes
get
Returns a list with all defined orderstates
get
Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.
post
/api/v1/orders/createmultiple
get
Get a list of all orders optionally filtered by date
post
/api/v1/orders
put
Sets the tags attached to an order
post
Attach one or more tags to an order
post
Add one or more tags to multiple orders
get
Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute
patch
Updates one or more fields of an order
get
Get a single order by its external order number
put
Changes the main state of a single order
post
Add a shipment to a given order
get
Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate
get
Find a single order by its external id (order number)
post
Create an delivery note for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.
post
Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.
get
Returns a list of fields which can be updated with the orders/{id} patch call
post
Sends a message to the buyer
post
Triggers a rule event
post
Parses a text and replaces all placeholders
post
Adds a message to the order
get
/api/v1/layouts
post
Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contain lucene query syntax
get
Get a list of all products
post
Creates a new product
get
Queries a single article by id or by sku
delete
Deletes a product
patch
Updates one or more fields of a product
get
Query all defined stock locations
get
Returns a list of fields which can be updated with the patch call
get
GEts a list of all defined categories
post
Update the stock qty of an article
post
Retrieve the stock qty for multiple articles at once
post
Update the stock qty for multiple articles at once
get
Queries the reserved amount for a single article by id or by sku
post
Update the stock code of an article
get
Queries a list of all custom fields
get
Queries a single custom field
get
Returns a list of all images of the product
put
Add multiple images to a product or replace the product images by the given images
get
Returns a single image by id
put
Add or update an existing image of a product
delete
Deletes a single image from a product
get
Returns a single image by id
delete
Deletes a single image by id
post
/api/v1/products/images/delete
post
Creates a new Billbee user account with the data passed
get
Returns infos about Billbee terms and conditions
post
Creates multiple shipments
post
Creates a new shipment with the selected Shippingprovider
get
Query all defined shipping providers
post
Creates a shipment for an order in billbee
post
Creates shipments for a list of orders in billbee
get
Queries the currently available shipping carriers.
get
/api/v1/shipment/ping
get
Get a list of all shipments optionally filtered by date. All parameters are optional.
get
Queries a list of avaible shop accounts
get
Gets all registered WebHooks for a given user.
post
Registers a new WebHook for a given user.
delete
Deletes all existing WebHook registrations.
get
Looks up a registered WebHook with the given {id} for a given user.
put
Updates an existing WebHook registration.
delete
Deletes an existing WebHook registration.
get
Returns a list of all known filters you can use to register webhooks