Billbee
Documentation of the Billbee REST API to connect a Billbee account to external aplications.
Endpoint
The Billbee API endpoint base url is https://api.billbee.io/api/v1
Activation
You 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 to support@billbee.io and send us a short note about what you are building.
Authorization & security
Because you can access private data with the Billbee API, every request has to be sent over https and must
- Contain a valid API Key identifying the application/developer. It has to be sent as the HTTP header X-Billbee-Api-Key
- Contain a valid user login with billbee username and api password in form of a basic auth HTTP header
Throttling
Each 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 code
Operations
Creates a new Billbee user account with the data passed
Returns infos about Billbee terms and conditions
Gets a list of all connected cloud storage devices
Get a list of all customer addresses
Queries a single customer address by id
Updates a customer address by id
Creates a new customer address
Queries a single address from a customer
Updates one or more fields of an address
Updates all fields of an address
Get a list of all customers
Queries a list of addresses from a customer
Adds a new address to a customer
Queries a single customer by id
Queries a list of orders from a customer
Updates a customer by id
Creates a new customer
Returns a list with all defined orderstates
Returns a list with all defined paymenttypes
Returns a list with all defined shipmenttypes
Returns a list with all defined shippingcarriers
Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.
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.
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 a single order by its external order number
Get a list of all orders optionally filtered by date
Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute
Changes the main state of a single order
Parses a text and replaces all placeholders
Updates one or more fields of an order
Sends a message to the buyer
Add a shipment to a given order
Attach one or more tags to an order
Sets the tags attached to an order
Triggers a rule event
Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate
Returns a list of fields which can be updated with the orders/{id} patch call
Creates a new order in the Billbee account
GEts a list of all defined categories
Queries a list of all custom fields
Queries a single custom field
Get a list of all products
Deletes a product
Queries a single article by id or by sku
Updates one or more fields of a product
Delete multiple images by id
Deletes a single image by id
Returns a single image by id
Returns a list of fields which can be updated with the patch call
Creates a new product
Returns a list of all images of the product
Deletes a single image from a product
Returns a single image by id
Add or update an existing image of a product
Add multiple images to a product or replace the product images by the given images
Queries the reserved amount for a single article by id or by sku
Query all defined stock locations
Update the stock qty of an article
Update the stock code of an article
Update the stock qty for multiple articles at once
Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax
Creates a new shipment with the selected Shippingprovider
Get a list of all shipments optionally filtered by date. All parameters are optional.
Queries the currently available shipping carriers.
Query all defined shipping providers
Creates a shipment for an order in billbee
Deletes all existing WebHook registrations.
Returns a list of all known filters you can use to register webhooks
Gets all registered WebHooks for a given user.
Deletes an existing WebHook registration.
Looks up a registered WebHook with the given {id} for a given user.
Updates an existing WebHook registration.
Registers a new WebHook for a given user.