{ "opencollection": "1.0.0", "info": { "name": "TableCheck API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "apikey": { "key": "Authorization", "value": "{{secret_key}}", "in": "header" } } }, "items": [ { "info": { "name": "Availability", "type": "folder" }, "items": [ { "info": { "name": "Search for availability across all shops", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/availability/v1/shops" }, "docs": "Search for availability across all shops" }, { "info": { "name": "Fetch info of a specific shop. Does not include availability.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/availability/v1/shops/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch info of a specific shop. Does not include availability." }, { "info": { "name": "Fetch availability timetable of a specific shop.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/availability/v1/timetable/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch availability timetable of a specific shop." }, { "info": { "name": "Fetch availability calendar of a specific shop.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/availability/v1/calendar/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch availability calendar of a specific shop." }, { "info": { "name": "Fetch availability tables of a specific shop.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/availability/v1/availability_tables/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch availability tables of a specific shop." } ] }, { "info": { "name": "Web Booking", "type": "folder" }, "items": [ { "info": { "name": "List all Reservations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/web_booking/v1/reservations" }, "docs": "List all Reservations" }, { "info": { "name": "Fetch a specific Reservation", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/web_booking/v1/reservations/:reservation_id_or_ref", "params": [ { "name": "reservation_id_or_ref", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Reservation" } ] }, { "info": { "name": "Booking", "type": "folder" }, "items": [ { "info": { "name": "Create Blockage", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/booking/v1/blockages", "body": { "type": "json", "data": "{}" } }, "docs": "Create Blockage" }, { "info": { "name": "Fetch a specific Blockage", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id", "params": [ { "name": "blockage_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Blockage" }, { "info": { "name": "Update Blockage", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id", "params": [ { "name": "blockage_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Blockage" }, { "info": { "name": "Delete Blockage", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id", "params": [ { "name": "blockage_id", "value": "", "type": "path" } ] }, "docs": "Delete Blockage" }, { "info": { "name": "List all Reservations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/reservations" }, "docs": "List all Reservations" }, { "info": { "name": "Create Reservation", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/booking/v1/reservations", "body": { "type": "json", "data": "{}" } }, "docs": "Create Reservation" }, { "info": { "name": "Fetch a specific Reservation", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref", "params": [ { "name": "reservation_id_or_ref", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Reservation" }, { "info": { "name": "Update Reservation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref", "params": [ { "name": "reservation_id_or_ref", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Reservation" }, { "info": { "name": "Cancel Reservation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref/cancel", "params": [ { "name": "reservation_id_or_ref", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel Reservation" }, { "info": { "name": "List all Reservation Flags", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/reservation_flags" }, "docs": "List all Reservation Flags" }, { "info": { "name": "Fetch a specific Reservation Flag", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/reservation_flags/:reservation_flag_id", "params": [ { "name": "reservation_flag_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Reservation Flag" }, { "info": { "name": "List all shops", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/shops" }, "docs": "List all shops" }, { "info": { "name": "Fetch a specific shop", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/booking/v1/shops/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific shop" } ] }, { "info": { "name": "CRM", "type": "folder" }, "items": [ { "info": { "name": "List all Reservations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/reservations" }, "docs": "List all Reservations" }, { "info": { "name": "Create Reservation", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/crm/v1/reservations", "body": { "type": "json", "data": "{}" } }, "docs": "Create Reservation" }, { "info": { "name": "Fetch a specific Reservation", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/reservations/:reservation_id", "params": [ { "name": "reservation_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Reservation" }, { "info": { "name": "Update Reservation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/crm/v1/reservations/:reservation_id", "params": [ { "name": "reservation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Reservation" }, { "info": { "name": "List all Reservation Flags", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/reservation_flags" }, "docs": "List all Reservation Flags" }, { "info": { "name": "Fetch a specific Reservation Flag", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/reservation_flags/:reservation_flag_id", "params": [ { "name": "reservation_flag_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Reservation Flag" }, { "info": { "name": "List all Memberships", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/memberships" }, "docs": "List all Memberships" }, { "info": { "name": "Create Membership", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/crm/v1/memberships", "body": { "type": "json", "data": "{}" } }, "docs": "Create Membership" }, { "info": { "name": "Fetch a specific Membership", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/memberships/:membership_id", "params": [ { "name": "membership_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Membership" }, { "info": { "name": "Update Membership", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/crm/v1/memberships/:membership_id", "params": [ { "name": "membership_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Membership" }, { "info": { "name": "Destroy the membership", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tablecheck.com/api/crm/v1/memberships/:membership_id", "params": [ { "name": "membership_id", "value": "", "type": "path" } ] }, "docs": "Destroy the membership" }, { "info": { "name": "List all Membership Programs", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/membership_programs" }, "docs": "List all Membership Programs" }, { "info": { "name": "Fetch a specific Membership Program", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/membership_programs/:membership_program_id", "params": [ { "name": "membership_program_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Membership Program" }, { "info": { "name": "List all Customers", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/customers" }, "docs": "List all Customers" }, { "info": { "name": "Create a new customer", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/crm/v1/customers", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new customer" }, { "info": { "name": "Fetch a specific Customer", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Customer" }, { "info": { "name": "Amend the Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/crm/v1/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Amend the Customer" }, { "info": { "name": "Destroy the customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tablecheck.com/api/crm/v1/customers/:customer_id", "params": [ { "name": "customer_id", "value": "", "type": "path" } ] }, "docs": "Destroy the customer" }, { "info": { "name": "Search and bulk export customers", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/crm/v1/customer_search", "body": { "type": "json", "data": "{}" } }, "docs": "Search and bulk export customers" }, { "info": { "name": "List all Shops", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/shops" }, "docs": "List all Shops" }, { "info": { "name": "Fetch a specific Shop", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/shops/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Shop" }, { "info": { "name": "List all Franchises", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/franchises" }, "docs": "List all Franchises" }, { "info": { "name": "Fetch a specific Franchise", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/crm/v1/franchises/:franchise_id", "params": [ { "name": "franchise_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific Franchise" } ] }, { "info": { "name": "POS", "type": "folder" }, "items": [ { "info": { "name": "List of all available shops", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops" }, "docs": "List of all available shops" }, { "info": { "name": "Get Shop information", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get Shop information" }, { "info": { "name": "List all PosJournals", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "List all PosJournals" }, { "info": { "name": "Create PosJournal", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals", "params": [ { "name": "shop_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create PosJournal" }, { "info": { "name": "Get PosJournal information", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id", "params": [ { "name": "shop_id", "value": "", "type": "path" }, { "name": "pos_journal_id", "value": "", "type": "path" } ] }, "docs": "Get PosJournal information" }, { "info": { "name": "Update PosJournal", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id", "params": [ { "name": "shop_id", "value": "", "type": "path" }, { "name": "pos_journal_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update PosJournal" }, { "info": { "name": "Delete PosJournal", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id", "params": [ { "name": "shop_id", "value": "", "type": "path" }, { "name": "pos_journal_id", "value": "", "type": "path" } ] }, "docs": "Delete PosJournal" }, { "info": { "name": "Void PosJournal (Check Void)", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/void", "params": [ { "name": "shop_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Void PosJournal (Check Void)" }, { "info": { "name": "List all Reservations", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "List all Reservations" }, { "info": { "name": "Get Reservation information", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations/:reservation_id", "params": [ { "name": "shop_id", "value": "", "type": "path" }, { "name": "reservation_id", "value": "", "type": "path" } ] }, "docs": "Get Reservation information" }, { "info": { "name": "Update Reservation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations/:reservation_id", "params": [ { "name": "shop_id", "value": "", "type": "path" }, { "name": "reservation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Reservation" }, { "info": { "name": "List all Tables", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/tables", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "List all Tables" }, { "info": { "name": "Get Table Status", "type": "http" }, "http": { "method": "POST", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/table_status/show", "params": [ { "name": "shop_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Table Status" }, { "info": { "name": "Update Table Status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tablecheck.com/api/pos/v1/shops/:shop_id/table_status/update", "params": [ { "name": "shop_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Table Status" } ] }, { "info": { "name": "Site Controller", "type": "folder" }, "items": [ { "info": { "name": "List all Shops", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/site/v1/shops" }, "docs": "List all Shops" }, { "info": { "name": "Fetch a specific shop", "type": "http" }, "http": { "method": "GET", "url": "https://api.tablecheck.com/api/site/v1/shops/:shop_id", "params": [ { "name": "shop_id", "value": "", "type": "path" } ] }, "docs": "Fetch a specific shop" } ] } ] }