Skip to content

Billbee API API

by billbee.io

API keyHTTPSShopping
Open documentation ↗

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 [email protected] 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

Billbee API is a shopping API from billbee.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 76 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Shopping
Base URL
https://app.billbee.io
Version
v1
Endpoints
76
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://app.billbee.io/api/v1/automaticprovision/termsinfo" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://app.billbee.io/api/v1/automaticprovision/termsinfo", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://app.billbee.io/api/v1/automaticprovision/termsinfo",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

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

Questions

Does the Billbee API API need an API key?

Yes. The Billbee API API uses API key authentication; the documentation explains how to get credentials.

Does the Billbee API API support HTTPS?

Yes, the Billbee API API is served over HTTPS.

How many endpoints does the Billbee API API have?

Its OpenAPI description lists 76 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Billbee API API?

Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.

Compare alternatives →

Listed from APIs.guru (CC0).