Billbee

Billbee API

Documentation of the Billbee REST API to connect a Billbee account to external aplications. Endpoint The Billbee API endpoint base url is…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 76

Provisioning

  • POSTCreates a new Billbee user account with the data passed/api/v1/automaticprovision/createaccount
  • GETReturns infos about Billbee terms and conditions/api/v1/automaticprovision/termsinfo

CloudStorage

  • GETGets a list of all connected cloud storage devices/api/v1/cloudstorages

CustomerAddresses

  • GETGet a list of all customer addresses/api/v1/customer-addresses?page=0&pageSize=0
  • POSTCreates a new customer address/api/v1/customer-addresses
  • GETQueries a single customer address by id/api/v1/customer-addresses/:id
  • PUTUpdates a customer address by id/api/v1/customer-addresses/:id

Customers

  • GETGet a list of all customers/api/v1/customers?page=0&pageSize=0
  • POSTCreates a new customer/api/v1/customers
  • GETQueries a single address from a customer/api/v1/customers/addresses/:id
  • PUTUpdates all fields of an address/api/v1/customers/addresses/:idId and CustomerId cannot be changed. Fields you do not send will become empty.
  • PATCHUpdates one or more fields of an address/api/v1/customers/addresses/:idId and CustomerId cannot be changed
  • GETQueries a single customer by id/api/v1/customers/:id
  • PUTUpdates a customer by id/api/v1/customers/:id
  • GETQueries a list of addresses from a customer/api/v1/customers/:id/addresses?page=0&pageSize=0
  • POSTAdds a new address to a customer/api/v1/customers/:id/addressesId and CustomerId will be ignored in model. If Id is set, the addition will be stopped.
  • GETQueries a list of orders from a customer/api/v1/customers/:id/orders?page=0&pageSize=0

EnumApi

  • GETReturns a list with all defined orderstates/api/v1/enums/orderstates
  • GETReturns a list with all defined paymenttypes/api/v1/enums/paymenttypes
  • GETReturns a list with all defined shipmenttypes/api/v1/enums/shipmenttypes
  • GETReturns a list with all defined shippingcarriers/api/v1/enums/shippingcarriers

Events

  • GETGet a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour./api/v1/events?minDate=2024-01-01T00:00:00Z&maxDate=2024-01-01T00:00:00Z&page=0&pageSize=0&typeId=0&orderId=0

Orders

  • GETLayoutApi_GetList/api/v1/layouts
  • GETGet a list of all orders optionally filtered by date/api/v1/orders?minOrderDate=2024-01-01T00:00:00Z&maxOrderDate=2024-01-01T00:00:00Z&page=0&pageSize=0&shopId=0&orderStateId=0&tag=string&minimumBillBeeOrderId=0&modifiedAtMin=2024-01-01T00:00:00Z&modifiedAtMax=2024-01-01T00:00:00Z&articleTitleSource=0&excludeTags=true
  • POSTCreates a new order in the Billbee account/api/v1/orders?shopId=0To create an order POST an JSON object to the orders endpoint with the shown properties. Not all properties are required.
  • POSTCreate 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/CreateDeliveryNote/:id?includePdf=true&sendToCloudId=0
  • POSTCreate 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/CreateInvoice/:id?includeInvoicePdf=true&templateId=0&sendToCloudId=0
  • GETReturns a list of fields which can be updated with the orders/{id} patch call/api/v1/orders/PatchableFields
  • GETFind a single order by its external id (order number)/api/v1/orders/find/:id/:partnerDeprecated.
  • GETGet a single order by its external order number/api/v1/orders/findbyextref/:extRef
  • GETGet 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/invoices?minInvoiceDate=2024-01-01T00:00:00Z&maxInvoiceDate=2024-01-01T00:00:00Z&page=0&pageSize=0&shopId=0&orderStateId=0&tag=string&minPayDate=2024-01-01T00:00:00Z&maxPayDate=2024-01-01T00:00:00Z&includePositions=true&excludeTags=true
  • GETGet a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute/api/v1/orders/:id?articleTitleSource=0
  • PATCHUpdates one or more fields of an order/api/v1/orders/:id
  • PUTChanges the main state of a single order/api/v1/orders/:id/orderstateREMARKS ### Use this call to change the state of an order to i.e. paid or sent. The state is transfered to the external shop/marketplace if configured. This…
  • POSTParses a text and replaces all placeholders/api/v1/orders/:id/parse-placeholders
  • POSTSends a message to the buyer/api/v1/orders/:id/send-message
  • POSTAdd a shipment to a given order/api/v1/orders/:id/shipment
  • PUTSets the tags attached to an order/api/v1/orders/:id/tagsAll existing tags will be replaced by the given list of new tags. To just add tags, use POST method.
  • POSTAttach one or more tags to an order/api/v1/orders/:id/tagsWhen a tag is already attached, it is ignored. Tags are not case sensitive. All given tags are added to the existing tags.
  • POSTTriggers a rule event/api/v1/orders/:id/trigger-event

Products

  • GETGet a list of all products/api/v1/products?page=0&pageSize=0&minCreatedAt=2024-01-01T00:00:00Z&minimumBillBeeArticleId=0&maximumBillBeeArticleId=0
  • POSTCreates a new product/api/v1/products
  • GETReturns a list of fields which can be updated with the patch call/api/v1/products/PatchableFields
  • GETGEts a list of all defined categories/api/v1/products/category
  • GETQueries a list of all custom fields/api/v1/products/custom-fields?page=0&pageSize=0
  • GETQueries a single custom field/api/v1/products/custom-fields/:id
  • POSTDelete multiple images by id/api/v1/products/images/delete
  • GETReturns a single image by id/api/v1/products/images/:imageId
  • DELETEDeletes a single image by id/api/v1/products/images/:imageId
  • GETQueries the reserved amount for a single article by id or by sku/api/v1/products/reservedamount?id=string&lookupBy=string&stockId=0
  • GETQuery all defined stock locations/api/v1/products/stocks
  • POSTUpdate the stock qty of an article/api/v1/products/updatestockThe article is specified by sku. You have to send the absolute value for the current stock
  • POSTUpdate the stock code of an article/api/v1/products/updatestockcode
  • POSTUpdate the stock qty for multiple articles at once/api/v1/products/updatestockmultiple
  • GETQueries a single article by id or by sku/api/v1/products/:id?lookupBy=string
  • DELETEDeletes a product/api/v1/products/:id
  • PATCHUpdates one or more fields of a product/api/v1/products/:id
  • GETReturns a list of all images of the product/api/v1/products/:productId/images
  • PUTAdd multiple images to a product or replace the product images by the given images/api/v1/products/:productId/images?replace=true
  • GETReturns a single image by id/api/v1/products/:productId/images/:imageId
  • PUTAdd or update an existing image of a product/api/v1/products/:productId/images/:imageId
  • DELETEDeletes a single image from a product/api/v1/products/:productId/images/:imageId
  • POSTSearch for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax/api/v1/search

Shipments

  • GETShipment_GetPing/api/v1/shipment/ping
  • POSTCreates a new shipment with the selected Shippingprovider/api/v1/shipment/shipment
  • GETGet a list of all shipments optionally filtered by date. All parameters are optional./api/v1/shipment/shipments?page=0&pageSize=0&createdAtMin=2024-01-01T00:00:00Z&createdAtMax=2024-01-01T00:00:00Z&orderId=0&minimumShipmentId=0&shippingProviderId=0
  • GETQueries the currently available shipping carriers./api/v1/shipment/shippingcarriers
  • GETQuery all defined shipping providers/api/v1/shipment/shippingproviders
  • POSTCreates a shipment for an order in billbee/api/v1/shipment/shipwithlabel

Webhooks

  • GETGets all registered WebHooks for a given user./api/v1/webhooks
  • POSTRegisters a new WebHook for a given user./api/v1/webhooks
  • DELETEDeletes all existing WebHook registrations./api/v1/webhooks
  • GETReturns a list of all known filters you can use to register webhooks/api/v1/webhooks/filters
  • GETLooks up a registered WebHook with the given {id} for a given user./api/v1/webhooks/:id
  • PUTUpdates an existing WebHook registration./api/v1/webhooks/:id
  • DELETEDeletes an existing WebHook registration./api/v1/webhooks/:id

API details

Base URL
https://app.billbee.io
Authentication
An API key in the X-Billbee-Api-Key header
HTTP Basic authentication (username and password)
Operations
76 operations on 55 pathsGET 39POST 21PUT 8DELETE 5PATCH 3
1 marked deprecated
Main resources
Products 23Orders 19Customers 11Webhooks 7Shipments 6CustomerAddresses 4EnumApi 4Invoice 2Provisioning 2CloudStorage 1
Response formats
application/json text/json application/xml
Description format
OpenAPI 3.0.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Billbee API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Billbee API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Billbee-Api-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Creates a new Billbee user account with the data passed” (POST /api/v1/automaticprovision/createaccount), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Billbee API?

Documentation of the Billbee REST API to connect a Billbee account to external aplications. Endpoint The Billbee API endpoint base url is… It is listed under E-commerce and has 76 endpoints.

Who publishes the Billbee API?

It is listed from Billbee's public API description (an OpenAPI document), not published by Billbee on Swastik Codes. Anyone who controls billbee.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Billbee API?

Requests go to https://app.billbee.io. Endpoint paths are added to this base URL.

How do I authenticate with the Billbee API?

It accepts 2 methods: an API key in the X-Billbee-Api-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Billbee API have?

76 operations on 55 paths (39 GET, 21 POST, 8 PUT, 5 DELETE, 3 PATCH). The largest groups are Products, Orders, Customers, Webhooks.

Is forking the Billbee API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.