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 ide
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://app.billbee.io
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/v1/automaticprovision/createaccount | Creates a new Billbee user account with the data passed Provisioning |
GET | /api/v1/automaticprovision/termsinfo | Returns infos about Billbee terms and conditions Provisioning |
GET | /api/v1/cloudstorages | Gets a list of all connected cloud storage devices CloudStorage |
GET | /api/v1/customer-addresses | Get a list of all customer addresses CustomerAddresses |
POST | /api/v1/customer-addresses | Creates a new customer address CustomerAddresses |
GET | /api/v1/customer-addresses/{id} | Queries a single customer address by id CustomerAddresses |
PUT | /api/v1/customer-addresses/{id} | Updates a customer address by id CustomerAddresses |
GET | /api/v1/customers | Get a list of all customers Customers |
POST | /api/v1/customers | Creates a new customer Customers |
GET | /api/v1/customers/addresses/{id} | Queries a single address from a customer Customers |
PUT | /api/v1/customers/addresses/{id} | Updates all fields of an address Id and CustomerId cannot be changed. Fields you do not send will become empty |
PATCH | /api/v1/customers/addresses/{id} | Updates one or more fields of an address Id and CustomerId cannot be changed Customers |
GET | /api/v1/customers/{id} | Queries a single customer by id Customers |
PUT | /api/v1/customers/{id} | Updates a customer by id Customers |
GET | /api/v1/customers/{id}/addresses | Queries a list of addresses from a customer Customers |
POST | /api/v1/customers/{id}/addresses | Adds a new address to a customer Id and CustomerId will be ignored in model. If Id is set, the addition will |
GET | /api/v1/customers/{id}/orders | Queries a list of orders from a customer Customers |
GET | /api/v1/enums/orderstates | Returns a list with all defined orderstates EnumApi |
GET | /api/v1/enums/paymenttypes | Returns a list with all defined paymenttypes EnumApi |
GET | /api/v1/enums/shipmenttypes | Returns a list with all defined shipmenttypes EnumApi |
GET | /api/v1/enums/shippingcarriers | Returns a list with all defined shippingcarriers EnumApi |
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 |
GET | /api/v1/orders | Get a list of all orders optionally filtered by date Orders |
POST | /api/v1/orders | Creates a new order in the Billbee account To create an order POST an JSON object to the orders endpoint with |
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 maxim |
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 |
GET | /api/v1/orders/PatchableFields | Returns a list of fields which can be updated with the orders/{id} patch call Orders |
GET | /api/v1/orders/find/{id}/{partner} | Find a single order by its external id (order number) Orders |
GET | /api/v1/orders/findbyextref/{extRef} | Get a single order by its external order number Orders |
GET | /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 |
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 Or |
PATCH | /api/v1/orders/{id} | Updates one or more fields of an order Orders |
PUT | /api/v1/orders/{id}/orderstate | Changes the main state of a single order ### REMARKS ### Use this call to change the state of an order to i.e |
POST | /api/v1/orders/{id}/parse-placeholders | Parses a text and replaces all placeholders Orders |
POST | /api/v1/orders/{id}/send-message | Sends a message to the buyer Orders |
POST | /api/v1/orders/{id}/shipment | Add a shipment to a given order Orders |
POST | /api/v1/orders/{id}/tags | Attach one or more tags to an order When a tag is already attached, it is ignored. Tags are not case sensitive |
PUT | /api/v1/orders/{id}/tags | Sets the tags attached to an order All existing tags will be replaced by the given list of new tags. To just a |
POST | /api/v1/orders/{id}/trigger-event | Triggers a rule event Orders |
GET | /api/v1/products | Get a list of all products Products |
and 34 more operation(s) in this specification, all searchable.
specification origin: https://app.billbee.io/swagger/docs/v1
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.