Dining partner tools

The onboarding status of a restaurant.

Read only.

Resourceresources/read aikonic://partner/dining_partner_get_onboarding_status/{restaurantId}

Arguments

• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid), as text.

Your partner locations.

Read only.

Resourceresources/read aikonic://partner/dining_partner_list_locations

Arguments

A resource takes no arguments: the agent reads it by its address.

A restaurant's guest tags.

Read only.

Resourceresources/read aikonic://partner/dining_partner_list_tags/{restaurantId}

Arguments

• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid), as text.

The restaurants available to you as a partner.

Read only.

Tool signaturedining_partner_directory(
  limit?: integer,
  offset?: integer,
  privateDining?: boolean
)
// * required   ? optional

Arguments

• limitoptional
  integer Page size (1-1000); absent = 100.
• offsetoptional
  integer Rows to skip; absent = 0.
• privateDiningoptional
  boolean Only restaurants that take private-dining leads.

Pull reservations.

Read only.

Tool signaturedining_partner_sync_reservations(
  limit?: integer,
  offset?: integer,
  restaurantId*: string,
  scheduledFrom?: string,
  scheduledTo?: string,
  updatedAfter?: string (date-time)
)
// * required   ? optional

Arguments

• limitoptional
  integer Page size (1-1000); absent = 100.
• offsetoptional
  integer Rows to skip; absent = 0.
• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid).
• scheduledFromoptional
  string Restaurant-local lower bound (yyyy-MM-ddTHH:mm).
• scheduledTooptional
  string Restaurant-local upper bound.
• updatedAfteroptional
  string (date-time) Only rows updated after this instant (UTC).

The restaurants linked to your point-of-sale system.

Read only.

Resourceresources/read aikonic://partner/dining_partner_list_pos_restaurants

Arguments

A resource takes no arguments: the agent reads it by its address.

Pull point-of-sale data matched to reservations.

Read only.

Tool signaturedining_partner_sync_pos_data(
  limit?: integer,
  offset?: integer,
  restaurantId*: string,
  scheduledFrom*: string,
  scheduledTo*: string
)
// * required   ? optional

Arguments

• limitoptional
  integer Page size (1-1000); absent = 100.
• offsetoptional
  integer Rows to skip; absent = 0.
• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid).
• scheduledFromrequired
  string Restaurant-local lower bound.
• scheduledTorequired
  string Restaurant-local upper bound.

Point-of-sale checks in a time window.

Read only.

Tool signaturedining_partner_list_pos_tickets(
  limit?: integer,
  offset?: integer,
  restaurantId*: string,
  updatedFrom*: string (date-time),
  updatedTo*: string (date-time)
)
// * required   ? optional

Arguments

• limitoptional
  integer Page size (1-1000); absent = 100.
• offsetoptional
  integer Rows to skip; absent = 0.
• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid), as text.
• updatedFromrequired
  string (date-time) Inclusive lower bound (UTC).
• updatedTorequired
  string (date-time) Exclusive upper bound (UTC).

A restaurant's reviews.

Read only.

Tool signaturedining_partner_list_reviews(
  limit?: integer,
  restaurantId*: string
)
// * required   ? optional

Arguments

• limitoptional
  integer How many of the newest reviews (1-100); absent = 20.
• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid).

Rating summaries for one or more restaurants.

Read only.

Tool signaturedining_partner_get_review_summary(
  restaurantIds*: string
)
// * required   ? optional

Arguments

• restaurantIdsrequired
  string Comma-separated rids (at most 50).

The status of a guest's photo.

Read only.

Resourceresources/read aikonic://partner/dining_partner_get_guest_photo_status/{restaurantId}/{guestId}

Arguments

• guestIdrequired
  string The guest id Example Dining assigned.
• restaurantIdrequired
  string The restaurant's supplier id (Example Dining rid), as text.