developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core API

Checks

View .md

Endpoints

getGet check details V2/api/v2/Outlets/{outletId}/Checks/{checkId}deleteDelete check V2/api/v2/Outlets/{outletId}/Checks/{checkId}getGet outlet check list V2/api/v2/Outlets/{outletId}/CheckspostCreate check V2/api/v2/Outlets/{outletId}/ChecksgetGet sales location check list V2/api/v2/Outlets/{outletId}/Checks/SalesLocations/{salesLocationId}postAdd item V2/api/v2/Outlets/{outletId}/Checks/AddItempostAdd items V2/api/v2/Outlets/{outletId}/Checks/{checkId}/ItemsputMove check V2/api/v2/Outlets/{outletId}/Checks/{checkId}/MoveputUpdate check custom name V2/api/v2/Outlets/{outletId}/Checks/{checkId}/CustomNameputUpdate check custom ticket number V2/api/v2/Outlets/{outletId}/Checks/{checkId}/CustomTicketputDiscount check V2/api/v2/Outlets/{outletId}/Checks/{checkId}/DiscountputSplit check V2/api/v2/Outlets/{outletId}/Checks/{checkId}/SplitputSplit check items V2/api/v2/Outlets/{outletId}/Checks/{checkId}/Items/SplitputDiscount check items V2/api/v2/Outlets/{outletId}/Checks/{checkId}/Items/DiscountputSet check table reservation metadata V2/api/v2/Outlets/{outletId}/Checks/{checkId}/TableReservationMetaDataputCreate integration check payment V2/api/v2/Outlets/{outletId}/Checks/{checkId}/IntegrationPayment

Deprecated

These endpoints will be removed. Each page names its replacement; see deprecation.

getGet check detailsdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}deleteDelete checkdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}postCreate checkdeprecated/api/v1/Outlets/{outletId}/ChecksputMove checkdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/MoveputUpdate check custom namedeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomNameputUpdate check custom ticket numberdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomTicketgetGet check list for sales locationdeprecated/api/v1/Outlets/{outletid}/Checks/SalesLocations/{salesLocationId}getGet check list for outletdeprecated/api/v1/Outlets/{outletid}/ChecksputDiscount checkdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/DiscountputCheck item splitdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/Items/SplitputSplit checkdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/SplitputCheck item discountdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/Items/DiscountpostAdd itemdeprecated/api/v1/Outlets/{outletId}/Checks/AddItemputSet TableReservation check metadatadeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/TableReservationMetaDataputCreate integration check paymentdeprecated/api/v1/Outlets/{outletId}/Checks/{checkId}/IntegrationPayment