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.io76 endpoints available
/api/v1/eventsGet a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.
/api/v1/ordersGet a list of all orders optionally filtered by date
/api/v1/ordersCreates a new order in the Billbee account
/api/v1/searchSearch for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax
/api/v1/layoutsLayoutApi_GetList
/api/v1/productsGet a list of all products
/api/v1/productsCreates a new product
/api/v1/webhooksGets all registered WebHooks for a given user.
/api/v1/webhooksRegisters a new WebHook for a given user.
/api/v1/webhooksDeletes all existing WebHook registrations.
/api/v1/customersGet a list of all customers
/api/v1/customersCreates a new customer
/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/cloudstoragesGets a list of all connected cloud storage devices
/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/{id}Deletes a product
/api/v1/shipment/pingShipment_GetPing
/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.
/api/v1/webhooks/{id}Deletes an existing WebHook registration.
/api/v1/customers/{id}Queries a single customer by id
/api/v1/customers/{id}Updates a customer by id
/api/v1/orders/invoicesGet 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/products/stocksQuery all defined stock locations
/api/v1/orders/{id}/tagsSets the tags attached to an order
/api/v1/orders/{id}/tagsAttach one or more tags to an order
/api/v1/webhooks/filtersReturns a list of all known filters you can use to register webhooks
/api/v1/enums/orderstatesReturns a list with all defined orderstates
/api/v1/products/categoryGEts a list of all defined categories
/api/v1/shipment/shipmentCreates a new shipment with the selected Shippingprovider
/api/v1/customer-addressesGet a list of all customer addresses
/api/v1/customer-addressesCreates a new customer address
/api/v1/enums/paymenttypesReturns a list with all defined paymenttypes
/api/v1/shipment/shipmentsGet a list of all shipments optionally filtered by date. All parameters are optional.
/api/v1/enums/shipmenttypesReturns a list with all defined shipmenttypes
/api/v1/orders/{id}/shipmentAdd a shipment to a given order
/api/v1/products/updatestockUpdate the stock qty of an article
/api/v1/customers/{id}/ordersQueries a list of orders from a customer
/api/v1/enums/shippingcarriersReturns a list with all defined shippingcarriers
/api/v1/orders/PatchableFieldsReturns a list of fields which can be updated with the orders/{id} patch call
/api/v1/orders/{id}/orderstateChanges the main state of a single order
/api/v1/products/custom-fieldsQueries a list of all custom fields
/api/v1/products/images/deleteDelete multiple images by id
/api/v1/shipment/shipwithlabelCreates a shipment for an order in billbee
/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/products/reservedamountQueries the reserved amount for a single article by id or by sku
/api/v1/customers/addresses/{id}Queries a single address from a customer
/api/v1/customers/addresses/{id}Updates all fields of an address
/api/v1/customers/addresses/{id}Updates one or more fields of an address
/api/v1/customers/{id}/addressesQueries a list of addresses from a customer
/api/v1/customers/{id}/addressesAdds a new address to a customer
/api/v1/orders/{id}/send-messageSends a message to the buyer
/api/v1/products/PatchableFieldsReturns a list of fields which can be updated with the patch call
/api/v1/products/updatestockcodeUpdate the stock code of an article
/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/{id}/trigger-eventTriggers a rule event
/api/v1/products/images/{imageId}Returns a single image by id
/api/v1/products/images/{imageId}Deletes a single image by id
/api/v1/shipment/shippingcarriersQueries the currently available shipping carriers.
/api/v1/orders/find/{id}/{partner}Find a single order by its external id (order number)
/api/v1/shipment/shippingprovidersQuery all defined shipping providers
/api/v1/products/custom-fields/{id}Queries a single custom field
/api/v1/products/{productId}/imagesReturns a list of all images of the product
/api/v1/products/{productId}/imagesAdd multiple images to a product or replace the product images by the given images
/api/v1/automaticprovision/termsinfoReturns infos about Billbee terms and conditions
/api/v1/orders/findbyextref/{extRef}Get a single order by its external order number
/api/v1/products/updatestockmultipleUpdate the stock qty for multiple articles at once
/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/{id}/parse-placeholdersParses a text and replaces all placeholders
/api/v1/automaticprovision/createaccountCreates a new Billbee user account with the data passed
/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/products/{productId}/images/{imageId}Deletes a single image from a product
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.io76 endpoints available
/api/v1/eventsGet a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.
/api/v1/ordersGet a list of all orders optionally filtered by date
/api/v1/ordersCreates a new order in the Billbee account
/api/v1/searchSearch for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax
/api/v1/layoutsLayoutApi_GetList
/api/v1/productsGet a list of all products
/api/v1/productsCreates a new product
/api/v1/webhooksGets all registered WebHooks for a given user.
/api/v1/webhooksRegisters a new WebHook for a given user.
/api/v1/webhooksDeletes all existing WebHook registrations.
/api/v1/customersGet a list of all customers
/api/v1/customersCreates a new customer
/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/cloudstoragesGets a list of all connected cloud storage devices
/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/{id}Deletes a product
/api/v1/shipment/pingShipment_GetPing
/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.
/api/v1/webhooks/{id}Deletes an existing WebHook registration.
/api/v1/customers/{id}Queries a single customer by id
/api/v1/customers/{id}Updates a customer by id
/api/v1/orders/invoicesGet 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/products/stocksQuery all defined stock locations
/api/v1/orders/{id}/tagsSets the tags attached to an order
/api/v1/orders/{id}/tagsAttach one or more tags to an order
/api/v1/webhooks/filtersReturns a list of all known filters you can use to register webhooks
/api/v1/enums/orderstatesReturns a list with all defined orderstates
/api/v1/products/categoryGEts a list of all defined categories
/api/v1/shipment/shipmentCreates a new shipment with the selected Shippingprovider
/api/v1/customer-addressesGet a list of all customer addresses
/api/v1/customer-addressesCreates a new customer address
/api/v1/enums/paymenttypesReturns a list with all defined paymenttypes
/api/v1/shipment/shipmentsGet a list of all shipments optionally filtered by date. All parameters are optional.
/api/v1/enums/shipmenttypesReturns a list with all defined shipmenttypes
/api/v1/orders/{id}/shipmentAdd a shipment to a given order
/api/v1/products/updatestockUpdate the stock qty of an article
/api/v1/customers/{id}/ordersQueries a list of orders from a customer
/api/v1/enums/shippingcarriersReturns a list with all defined shippingcarriers
/api/v1/orders/PatchableFieldsReturns a list of fields which can be updated with the orders/{id} patch call
/api/v1/orders/{id}/orderstateChanges the main state of a single order
/api/v1/products/custom-fieldsQueries a list of all custom fields
/api/v1/products/images/deleteDelete multiple images by id
/api/v1/shipment/shipwithlabelCreates a shipment for an order in billbee
/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/products/reservedamountQueries the reserved amount for a single article by id or by sku
/api/v1/customers/addresses/{id}Queries a single address from a customer
/api/v1/customers/addresses/{id}Updates all fields of an address
/api/v1/customers/addresses/{id}Updates one or more fields of an address
/api/v1/customers/{id}/addressesQueries a list of addresses from a customer
/api/v1/customers/{id}/addressesAdds a new address to a customer
/api/v1/orders/{id}/send-messageSends a message to the buyer
/api/v1/products/PatchableFieldsReturns a list of fields which can be updated with the patch call
/api/v1/products/updatestockcodeUpdate the stock code of an article
/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/{id}/trigger-eventTriggers a rule event
/api/v1/products/images/{imageId}Returns a single image by id
/api/v1/products/images/{imageId}Deletes a single image by id
/api/v1/shipment/shippingcarriersQueries the currently available shipping carriers.
/api/v1/orders/find/{id}/{partner}Find a single order by its external id (order number)
/api/v1/shipment/shippingprovidersQuery all defined shipping providers
/api/v1/products/custom-fields/{id}Queries a single custom field
/api/v1/products/{productId}/imagesReturns a list of all images of the product
/api/v1/products/{productId}/imagesAdd multiple images to a product or replace the product images by the given images
/api/v1/automaticprovision/termsinfoReturns infos about Billbee terms and conditions
/api/v1/orders/findbyextref/{extRef}Get a single order by its external order number
/api/v1/products/updatestockmultipleUpdate the stock qty for multiple articles at once
/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/{id}/parse-placeholdersParses a text and replaces all placeholders
/api/v1/automaticprovision/createaccountCreates a new Billbee user account with the data passed
/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/products/{productId}/images/{imageId}Deletes a single image from a product