GET /api/v1/orders

Get a list of all orders optionally filtered by date

Servers

Query parameters

Name Type Required Description
page Integer No

Specifies the page to request

modifiedAtMin String No

If given, the last modification has to be newer than the given date

modifiedAtMax String No

If given, the last modification has to be older or equal than the given date.

maxOrderDate String No

Specifies the newest order date to include in the response

articleTitleSource Integer No

The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text

Valid values:

  • 0
  • 1
  • 2
  • 3
minimumBillBeeOrderId Integer No

If given, all delivered orders have an Id greater than or equal to the given minimumOrderId

excludeTags Boolean No

If true the list of tags passed to the call are used to filter orders to not include these tags

orderStateId[] Array No

Specifies a list of state ids to include in the response

minOrderDate String No

Specifies the oldest order date to include in the response

pageSize Integer No

Specifies the pagesize. Defaults to 50, max value is 250

shopId[] Array No

Specifies a list of shop ids for which invoices should be included

tag[] Array No

Specifies a list of tags the order must have attached to be included in the response

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.