
Loading API details…
Billbee API
The Billbee API is a REST interface that lets external applications read and modify core e‑commerce data in a Billbee account—including orders, customers, products, shipments, tags, messages, and related enums—as well as manage cloud storage connections, webhooks, and perform searches.
Latency p95
1396 ms
last successful checks
Uptime 30d
100.0%
monitored sample
Playground
Verified
live · allowlisted
Endpoints & operations
api
(76)
/api/v1/enums/orderstates
Returns a list with all defined orderstates
/api/v1/enums/paymenttypes
Returns a list with all defined paymenttypes
/api/v1/enums/shipmenttypes
Returns a list with all defined shipmenttypes
/api/v1/enums/shippingcarriers
Returns a list with all defined shippingcarriers
/api/v1/orders/{id}/send-message
Sends a message to the buyer
/api/v1/orders/{id}/shipment
Add a shipment to a given order
/api/v1/orders/{id}/tags
Attach one or more tags to an order
/api/v1/orders/{id}/tags
Sets the tags attached to an order
/api/v1/orders/{id}/trigger-event
Triggers a rule event
/api/v1/automaticprovision/createaccount
Creates a new Billbee user account with the data passed
/api/v1/automaticprovision/termsinfo
Returns infos about Billbee terms and conditions
/api/v1/cloudstorages
Gets a list of all connected cloud storage devices
/api/v1/customer-addresses
Get a list of all customer addresses
/api/v1/customer-addresses
Creates a new customer address
/api/v1/customer-addresses/{id}
Queries a single customer address by id
/api/v1/customer-addresses/{id}
Updates a customer address by id
/api/v1/customers
Get a list of all customers
/api/v1/customers
Creates a new customer
/api/v1/customers/addresses/{id}
Queries a single address from a customer
/api/v1/customers/addresses/{id}
Updates one or more fields of an address
/api/v1/customers/addresses/{id}
Updates all fields of an address
/api/v1/customers/{id}
Queries a single customer by id
/api/v1/customers/{id}
Updates a customer by id
/api/v1/customers/{id}/addresses
Queries a list of addresses from a customer
/api/v1/customers/{id}/addresses
Adds a new address to a customer
/api/v1/customers/{id}/orders
Queries a list of orders from a customer
/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.
/api/v1/layouts
/api/v1/orders
Get a list of all orders optionally filtered by date
/api/v1/orders
Creates a new order in the Billbee account
/api/v1/orders/CreateDeliveryNote/{id}
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.
/api/v1/orders/CreateInvoice/{id}
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.
/api/v1/orders/PatchableFields
Returns a list of fields which can be updated with the orders/{id} patch call
/api/v1/orders/find/{id}/{partner}
Find a single order by its external id (order number)
/api/v1/orders/findbyextref/{extRef}
Get a single order by its external order number
/api/v1/orders/invoices
Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate
/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
/api/v1/orders/{id}
Updates one or more fields of an order
/api/v1/orders/{id}/orderstate
Changes the main state of a single order
/api/v1/orders/{id}/parse-placeholders
Parses a text and replaces all placeholders
/api/v1/products
Get a list of all products
/api/v1/products
Creates a new product
/api/v1/products/PatchableFields
Returns a list of fields which can be updated with the patch call
/api/v1/products/category
GEts a list of all defined categories
/api/v1/products/custom-fields
Queries a list of all custom fields
/api/v1/products/custom-fields/{id}
Queries a single custom field
/api/v1/products/images/delete
Delete multiple images by id
/api/v1/products/images/{imageId}
Deletes a single image by id
/api/v1/products/images/{imageId}
Returns a single image by id
/api/v1/products/reservedamount
Queries the reserved amount for a single article by id or by sku
/api/v1/products/stocks
Query all defined stock locations
/api/v1/products/updatestock
Update the stock qty of an article
/api/v1/products/updatestockcode
Update the stock code of an article
/api/v1/products/updatestockmultiple
Update the stock qty for multiple articles at once
/api/v1/products/{id}
Deletes a product
/api/v1/products/{id}
Queries a single article by id or by sku
/api/v1/products/{id}
Updates one or more fields of a product
/api/v1/products/{productId}/images
Returns a list of all images of the product
/api/v1/products/{productId}/images
Add multiple images to a product or replace the product images by the given images
/api/v1/products/{productId}/images/{imageId}
Deletes a single image from a product
/api/v1/products/{productId}/images/{imageId}
Returns a single image by id
/api/v1/products/{productId}/images/{imageId}
Add or update an existing image of a product
/api/v1/search
Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax
/api/v1/shipment/ping
/api/v1/shipment/shipment
Creates a new shipment with the selected Shippingprovider
/api/v1/shipment/shipments
Get a list of all shipments optionally filtered by date. All parameters are optional.
/api/v1/shipment/shippingcarriers
Queries the currently available shipping carriers.
/api/v1/shipment/shippingproviders
Query all defined shipping providers
/api/v1/shipment/shipwithlabel
Creates a shipment for an order in billbee
/api/v1/webhooks
Deletes all existing WebHook registrations.
/api/v1/webhooks
Gets all registered WebHooks for a given user.
/api/v1/webhooks
Registers a new WebHook for a given user.
/api/v1/webhooks/filters
Returns a list of all known filters you can use to register webhooks
/api/v1/webhooks/{id}
Deletes an existing WebHook registration.
/api/v1/webhooks/{id}
Looks up a registered WebHook with the given {id} for a given user.
/api/v1/webhooks/{id}
Updates an existing WebHook registration.
curl -X GET \ "https://app.billbee.io/api/v1/enums/orderstates" \ -H "X-Billbee-Api-Key: YOUR_API_KEY"
app.billbee.io · HTTPS only · apiKeyHeader auth