v2

latestSwagger 2.02026-08-0187117271.9 KB
Orders

Get a list of all orders optionally filtered by date

get/api/v1/orders

Query parameters

minOrderDatestring date-time

Specifies the oldest order date to include in the response

maxOrderDatestring date-time

Specifies the newest order date to include in the response

pageinteger

Specifies the page to request

pageSizeinteger

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

shopIdinteger[]

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

orderStateIdinteger[]

Specifies a list of state ids to include in the response

tagstring[]

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

minimumBillBeeOrderIdinteger

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

modifiedAtMinstring date-time

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

modifiedAtMaxstring date-time

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

articleTitleSource0 | 1 | 2 | 3

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

excludeTagsboolean

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

Response

OK

ErrorMessagestring
ErrorCode0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31
ErrorDescription0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31