Billbee API

Tools (78)

Extracted live via the executor SDK.

• cloudStorage.cloudStorageApiGetList

  Gets a list of all connected cloud storage devices

• customerAddresses.customerAddressesCreate

  Creates a new customer address

• customerAddresses.customerAddressesGetAll

  Get a list of all customer addresses

• customerAddresses.customerAddressesGetOne

  Queries a single customer address by id

• customerAddresses.customerAddressesUpdate

  Updates a customer address by id

• customers.customerAddCustomerAddress

  Id and CustomerId will be ignored in model. If Id is set, the addition will be stopped.

• customers.customerCreate

  Creates a new customer

• customers.customerGetAll

  Get a list of all customers

• customers.customerGetCustomerAddress

  Queries a single address from a customer

• customers.customerGetCustomerAddresses

  Queries a list of addresses from a customer

• customers.customerGetCustomerOrders

  Queries a list of orders from a customer

• customers.customerGetOne

  Queries a single customer by id

• customers.customerPatchAddress

  Id and CustomerId cannot be changed

• customers.customerUpdate

  Updates a customer by id

• customers.customerUpdateAddress

  Id and CustomerId cannot be changed. Fields you do not send will become empty.

• enumApi.enumApiGetOrderStates

  Returns a list with all defined orderstates

• enumApi.enumApiGetPaymentTypes

  Returns a list with all defined paymenttypes

• enumApi.enumApiGetShipmentTypes

  Returns a list with all defined shipmenttypes

• enumApi.enumApiGetShippingCarriers

  Returns a list with all defined shippingcarriers

• events.eventApiGetList

  Get a list of all events optionally filtered by date. This request is extra throttled to 2 calls per page per hour.

• orders.layoutApiGetList

  GET /api/v1/layouts

• orders.orderApiAddShipment

  Add a shipment to a given order

• orders.orderApiCreateDeliveryNote

  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.

• orders.orderApiCreateInvoice

  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.

• orders.orderApiFind

  Find a single order by its external id (order number)

• orders.orderApiGet

  Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute

• orders.orderApiGetByExtRef

  Get a single order by its external order number

• orders.orderApiGetInvoiceList

  Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate

• orders.orderApiGetList

  Get a list of all orders optionally filtered by date

• orders.orderApiGetPatchableFields

  Returns a list of fields which can be updated with the orders/{id} patch call

• orders.orderApiParsePlaceholders

  Parses a text and replaces all placeholders

• orders.orderApiPatchOrder

  Updates one or more fields of an order

• orders.orderApiPostNewOrder

  To create an order POST an JSON object to the orders endpoint with the shown properties. Not all properties are required.

• orders.orderApiSendMessage

  Sends a message to the buyer

• orders.orderApiTagsCreate

  When a tag is already attached, it is ignored. Tags are not case sensitive. All given tags are added to the existing tags.

• orders.orderApiTagsUpdate

  All existing tags will be replaced by the given list of new tags. To just add tags, use POST method.

• orders.orderApiTriggerEvent

  Triggers a rule event

• orders.orderApiUpdateState

  REMARKS

  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 is the list of known states:

  • 1: ordered
  • 2: confirmed
  • 3: paid
  • 4: shipped
  • 5: reclamation
  • 6: deleted
  • 7: closed
  • 8: canceled
  • 9: archived
  • 10: not used
  • 11: demand note 1
  • 12: demand note 2
  • 13: packed
  • 14: offered
  • 15: payment reminder
  • 16: fulfilling
• products.articleCreateArticle

  Creates a new product

• products.articleDeleteArticle

  Deletes a product

• products.articleDeleteImage

  Deletes a single image by id

• products.articleDeleteImageFromProduct

  Deletes a single image from a product

• products.articleDeleteImages

  Delete multiple images by id

• products.articleGetArticle

  Queries a single article by id or by sku

• products.articleGetCategory

  GEts a list of all defined categories

• products.articleGetCustomField

  Queries a single custom field

• products.articleGetCustomFields

  Queries a list of all custom fields

• products.articleGetImage

  Returns a single image by id

• products.articleGetImageFromProduct

  Returns a single image by id

• products.articleGetImages

  Returns a list of all images of the product

• products.articleGetList

  Get a list of all products

• products.articleGetPatchableFields

  Returns a list of fields which can be updated with the patch call

• products.articleGetReservedAmount

  Queries the reserved amount for a single article by id or by sku

• products.articleGetStocks

  Query all defined stock locations

• products.articlePatchArticle

  Updates one or more fields of a product

• products.articlePutImage

  Add or update an existing image of a product

• products.articlePutImages

  Add multiple images to a product or replace the product images by the given images

• products.articleUpdateStock

  The article is specified by sku. You have to send the absolute value for the current stock

• products.articleUpdateStockCode

  Update the stock code of an article

• products.articleUpdateStockMultiple

  Update the stock qty for multiple articles at once

• products.searchSearch

  Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contains lucene query syntax

• provisioning.automaticProvisioningCreateAccount

  Creates a new Billbee user account with the data passed

• provisioning.automaticProvisioningTermsInfo

  Returns infos about Billbee terms and conditions

• shipments.shipmentGetList

  Get a list of all shipments optionally filtered by date. All parameters are optional.

• shipments.shipmentGetPing

  GET /api/v1/shipment/ping

• shipments.shipmentGetShippingCarrier

  Queries the currently available shipping carriers.

• shipments.shipmentGetShippingproviders

  Query all defined shipping providers

• shipments.shipmentPostShipment

  Creates a new shipment with the selected Shippingprovider

• shipments.shipmentShipWithLabel

  Creates a shipment for an order in billbee

• webhooks.webHookManagementDelete

  Deletes an existing WebHook registration.

• webhooks.webHookManagementDeleteAll

  Deletes all existing WebHook registrations.

• webhooks.webHookManagementGet

  Gets all registered WebHooks for a given user.

• webhooks.webHookManagementGetFilters

  Returns a list of all known filters you can use to register webhooks

• webhooks.webHookManagementLookup

  Looks up a registered WebHook with the given {id} for a given user.

• webhooks.webHookManagementPost

  Registers a new WebHook for a given user.

• webhooks.webHookManagementPut

  Updates an existing WebHook registration.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools