Billbee API
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
https://app.billbee.ioAuth: unknown
Endpoints: 35
Reachable: unknown
CORS: unknown
Links
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/api/v1/automaticprovision/termsinfo | Returns infos about Billbee terms and conditions | — | — | — |
GET |
/api/v1/cloudstorages | Gets a list of all connected cloud storage devices | — | — | — |
GET |
/api/v1/customer-addresses | Get a list of all customer addresses | — | — | — |
GET |
/api/v1/customer-addresses/{id} | Queries a single customer address by id | — | — | — |
GET |
/api/v1/customers | Get a list of all customers | — | — | — |
GET |
/api/v1/customers/addresses/{id} | Queries a single address from a customer | — | — | — |
GET |
/api/v1/customers/{id} | Queries a single customer by id | — | — | — |
GET |
/api/v1/customers/{id}/addresses | Queries a list of addresses from a customer | — | — | — |
GET |
/api/v1/customers/{id}/orders | Queries a list of orders from a customer | — | — | — |
GET |
/api/v1/enums/orderstates | Returns a list with all defined orderstates | — | — | — |
GET |
/api/v1/enums/paymenttypes | Returns a list with all defined paymenttypes | — | — | — |
GET |
/api/v1/enums/shipmenttypes | Returns a list with all defined shipmenttypes | — | — | — |
GET |
/api/v1/enums/shippingcarriers | Returns a list with all defined shippingcarriers | — | — | — |
GET |
/api/v1/events | Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour. | — | — | — |
GET |
/api/v1/layouts | — | — | — | — |
GET |
/api/v1/orders | Get a list of all orders optionally filtered by date | — | — | — |
GET |
/api/v1/orders/PatchableFields | Returns a list of fields which can be updated with the orders/{id} patch call | — | — | — |
GET |
/api/v1/orders/find/{id}/{partner} | Find a single order by its external id (order number) | — | — | — |
GET |
/api/v1/orders/findbyextref/{extRef} | Get a single order by its external order number | — | — | — |
GET |
/api/v1/orders/{id} | Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute | — | — | — |
GET |
/api/v1/products | Get a list of all products | — | — | — |
GET |
/api/v1/products/PatchableFields | Returns a list of fields which can be updated with the patch call | — | — | — |
GET |
/api/v1/products/category | GEts a list of all defined categories | — | — | — |
GET |
/api/v1/products/custom-fields | Queries a list of all custom fields | — | — | — |
GET |
/api/v1/products/custom-fields/{id} | Queries a single custom field | — | — | — |
GET |
/api/v1/products/images/{imageId} | Returns a single image by id | — | — | — |
GET |
/api/v1/products/reservedamount | Queries the reserved amount for a single article by id or by sku | — | — | — |
GET |
/api/v1/products/stocks | Query all defined stock locations | — | — | — |
GET |
/api/v1/products/{id} | Queries a single article by id or by sku | — | — | — |
GET |
/api/v1/products/{productId}/images | Returns a list of all images of the product | — | — | — |
GET |
/api/v1/products/{productId}/images/{imageId} | Returns a single image by id | — | — | — |
POST |
/api/v1/search | Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax | — | — | — |
GET |
/api/v1/shipment/ping | — | — | — | — |
GET |
/api/v1/shipment/shipments | Get a list of all shipments optionally filtered by date. All parameters are optional. | — | — | — |
GET |
/api/v1/shipment/shippingcarriers | Queries the currently available shipping carriers. | — | — | — |
GET |
/api/v1/shipment/shippingproviders | Query all defined shipping providers | — | — | — |