Tickets

Get a list of tickets

Returns tickets of the authenticated store, ordered by sortField and sortOrder and paginated with paginationStart and paginationPageLength. Drafts and deleted tickets are excluded unless requested.

get/tickets

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/tickets
  • Auth
    HTTP bearer

Query parameters

cursorstring

Cursor for pagination. If parameter is set, paginationStart will be ignored. Only allowed for default sorting or based on id.

filterstring

Filter expression. See https://restdocs.e-conomic.com/#filtering. In and Not In are not supported.

sortOrder-1 | 1

Sorting order. If 1, items are retrieved in ascending order, otherwise in descending order. Ties are broken by ticket id in the same direction.

type'repair' | 'sale'

Only return tickets of this type.

statusstring

Only return tickets with this status. Supported values are new, ready, done, awaiting and quote.

excludedonetasksboolean

If true, tickets with status done are excluded.

isPaidboolean

Only return tickets that are paid (true) or not paid (false).

assigneeinteger

Id of the employee assigned to the ticket.

idinteger

Id of a single ticket to restrict the search to.

serienostring

Only return tickets with a customer article having this serial number.

customerarticleidsstring

Comma separated ids of customer articles. Only applied when it contains at least two ids; use customerarticleid for one.

sortFieldstring

Field to sort by. Supported values are id, cardno, status, payingcustomerid, type, description, created, startTime, updated_at, pickup, draft, assignee, customerid, createByUserId and customer_name. Other values are ignored (sorted by id).

paginationStartinteger

Deprecated, use cursor instead. Determine the offset (in number of items) to fetch. This is usually a multiple of the pageLength.

paginationPageLengthinteger

Determine the number of items to fetch in one page. If 0, no items are returned.

withPartnerStoresboolean

Not used by the server.

tagidsstring[]

List of tag ids to restrict the search to.

idsstring[]

List of ids to restrict the search to.

excludetagidsstring[]

List of tag ids that should not be in the task.

updated_afterstring

Get all tasks updated after the given date

startDatestring nullable

Get tasks where pickup (and startTime if set) is after the given date

endDatestring nullable

Get tasks where pickup (and startTime if set) is before the given date

created_afterstring nullable

Get tasks created on or after the given date

created_beforestring nullable

Get tasks created on or before the given date

customeridinteger nullable

Id of customer assigned to the ticket

customerarticleidinteger nullable

Id of customer article assigned to the ticket

cardnostring nullable

Card number of the ticket

allowDeletedboolean

Allow deleted tickets in response

Response

Ok

countinteger nullable

Number of available tickets, if ignoring pagination. Only set when the count query parameter is true, otherwise null.

hasMoreboolean

True if there are more tasks than the given page length

nextCursorstring nullable

Cursor for next page when using cursor based pagination.

Changes

No recorded changes to this operation across all 1 revision of this API.