What is Internal Data?
The Reporting API leverages a set of APIs that retrieve essential data points related to orders, operations, and quality indicators. These APIs provide a structured foundation for retrieving order details, and error logs, enabling efficient monitoring and analysis of restaurant operations and customer interactions.
Overview of Internal Data APIs
The following APIs contains internally stored data to support your reporting needs:
| API Name | Description |
|---|---|
| Tickets | Contains information on tickets/orders received. |
| Order Details | Captures details of each order, including status and errors. |
| Order Promotions | Logs promotional codes or discounts applied to orders. |
| Sold Items Details | Summarizes items sold across orders, including quantities and totals. |
| Item Sold Out Events | Logs sold-out events, including timestamps and restock information. |
| Sold Out Items Details | Tracks items marked as sold out, with timestamps and restock times. |
| Error Rates | Monitors and categorizes error events encountered during order processing. |
Tickets API
This API returns information about individual tickets and orders received. The following fields are included in the response for this API:
| Field Name | Description |
|---|---|
| ticket_id | Unique identifier for the ticket. |
| location_id | Identifier for the restaurant location. |
| order_number | Unique identifier for the order. |
| order_source | Platform from which the order was received (e.g., Uber). |
| alt_order_number | Alternative order number, if available. |
| customer_name | Name of the customer placing the order. |
| quantity | Total quantity of items in the order. |
| discount | Discount applied to the order, if any. |
| tax | Tax amount applied to the order. |
| web_tax | Tax amount applied specifically to web orders. |
| subtotal | Subtotal amount of the order, excluding tax. |
| web_subtotal | Subtotal amount for web orders, excluding tax. |
| created_at | Timestamp when the ticket was created. |
| updated_at | Timestamp when the ticket was last updated. |
| closed_at | Timestamp when the ticket was closed. |
| order_payload_id | Identifier for the order payload. |
| pos_id | Identifier for the point-of-sale (POS) system. |
| pos_check_id | Identifier for the POS check. |
| external_store_id | Identifier for the external store location. |
Order Details API
The Order Details API provides detailed information about individual orders, including their status, source, and associated errors. This API is useful for tracking order lifecycles, monitoring issues, and analyzing customer data to optimize operations.
| Field Name | Description |
| order_id | Unique identifier for the order. |
| order_number | Unique order number assigned by the platform. |
| location_id | Identifier for the restaurant location where the order was placed. |
| ordering_source_name | Name of the platform or source where the order originated. |
| customer_name | Name of the customer who placed the order. |
| status | Current status of the order (e.g., PROCESSED, RECEIVED). |
| reason | Reason for the current order status (if applicable). |
| subtotal | Subtotal amount of the order, excluding taxes and fees. |
| tax | Tax amount applied to the order. |
| ticket_id | Identifier for the associated ticket (if any). |
| is_err | Indicates whether the order contains errors (Y or N). |
| is_resolved | Indicates whether any errors have been resolved. |
| assigned_to | ID of the person assigned to resolve issues (if applicable). |
| resolved_by | ID of the person who resolved the issues. |
| asker_id | ID of the user who reported the issue. |
| assignee_id | ID of the person assigned to address the issue. |
| reviewer_id | ID of the reviewer who verified the resolution. |
| event_time | Timestamp of the related event (e.g., error occurrence). |
| reported_on | Timestamp when the issue was reported. |
| updated_on | Timestamp when the order details were last updated. |
| order_payload_id | Identifier for the order payload. |
| error_instruction_id | Identifier for the error resolution instruction. |
| error_category_id | Identifier for the error category. |
| error_category | Description of the error category. |
| is_live | Indicates whether the order is live (Y or N). |
| submitter_id | ID of the person who submitted the order. |
| external_store_id | Identifier for the external store, if applicable. |
| rating_tags | Tags associated with the ratings, providing additional context; null if not applicable. |
| canceled_by | Indicates who was responsible for initiating the cancellation of the order. |
Order Promotions API
The Order Promotions API tracks promotional codes or discounts applied to specific orders. It provides insights into promotional campaigns, including the discount amounts, associated orders, and performance metrics. This API is essential for evaluating the effectiveness of promotions and improving marketing strategies.
| Field Name | Description |
|---|---|
| ticket_id | Identifier for the associated ticket. |
| location_id | Identifier for the restaurant location where the promotion was applied. |
| order_source | Name of the platform or source where the order originated. |
| order_number | Unique identifier for the order. |
| subtotal | Subtotal amount of the order, excluding taxes and fees. |
| web_subtotal | Subtotal amount for web orders. |
| closed_at | Timestamp when the order was closed. |
| created_at | Timestamp when the promotion was applied. |
| promo_name | Name of the promotion applied to the order. |
| promo_amount | Discount amount provided by the promotion. |
| promo_code | Promotional code applied to the order (e.g., BOGO). |
| order_payload_id | Identifier for the order payload associated with the promotion. |
| external_store_id | Identifier for the external store, if applicable. |
Sold Items Details API
The Sold Items Details API provides detailed information about items sold across orders. It tracks item names, types, quantities, and subtotal amounts, offering insights into product performance and customer preferences. This API is valuable for inventory management and sales trend analysis.
| Field Name | Description |
|---|---|
| created_date | The date when the item was added to the menu. |
| location_id | Identifier for the restaurant location. |
| order_source | Name of the platform or source where the order originated. |
| item_name | Name of the sold item. |
| item_type | Type of the item (e.g., modifier_item). |
| quantity | Total quantity of the item sold. |
| subtotal | Subtotal amount for the sold item, excluding taxes. |
| external_store_id | Identifier for the external store, if applicable. |
Sold Out Items Details API
The Sold Out Items Details API tracks items marked as sold out, with timestamps and restock times. This API provides crucial information for inventory management and operational analysis.
| Field Name | Description |
| location_id | Unique identifier for the location where the item is sold out. |
| element_name | Name and details of the sold-out item (e.g., Large Fries). |
| menu_element_type | Type of menu element that is sold out (e.g., Item). |
| log_push_event_id | Identifier for the event that triggered the sold-out status. |
| next_pushed_event_id | Identifier for the next event related to the item; null if not applicable. |
| suspended_until | Timestamp indicating when the item is expected to be restocked. |
| created_at | Timestamp when the sold-out record was created. |
| sold_out_action_started_at | Timestamp when the item was marked as sold out. |
| sold_out_action_started_by | Email or identifier of the person who marked the item as sold out. |
| sold_out_action_ended_at | Timestamp when the sold-out action ended; null if still ongoing. |
| sold_out_action_ended_by | Person who ended the sold-out status; null if still ongoing. |
| reason | Reason for the item being marked as sold out. |
| offline_hours | Total hours the item has been marked as offline. |
| times_went_offline | Number of times the item has been marked as offline. |
| external_store_id | Identifier for the external store, if applicable; null if not applicable. |
Item Sold Out Events API
The Item Sold Out Events API tracks instances where items are marked as sold out at specific locations. It provides detailed information about the reasons for sold-out events, timestamps, and the actions taken to resolve them. This API is valuable for inventory management and operational analysis.
| Field Name | Description |
|---|---|
| reason | Reason for the item being marked as sold out (e.g., bulk update request). |
| item_id | Unique identifier for the item. |
| log_push_event_id | Identifier for the related log push event. |
| created_at | Timestamp when the item was marked as sold out. |
| item_name | Name of the sold-out item. |
| location_id | Identifier for the location where the item was marked sold out. |
| updated_at | Timestamp when the record was last updated. |
| user_id | Identifier of the user who updated the record. |
| offline_hours | Number of hours the item was offline. |
| suspended_until | Timestamp indicating when the item is expected to be restocked (if applicable). |
| id | Unique identifier for the sold-out event record. |
| superseded | Indicates whether the record has been superseded (true or false). |
| next_pushed_event_id | Identifier for the next pushed event in the log (if any). |
| status | Current status of the item (e.g., online, offline). |
| external_store_id | Identifier for the external store associated with the item. |
Error Rates API
The Error Rates API provides detailed insights into errors encountered during order processing. This includes error resolution times, associated ticket information, and discrepancies between POS and operational subtotals. The API is valuable for monitoring operational accuracy, identifying recurring issues, and optimizing error management processes.
| Field Name | Description |
|---|---|
| month | Month associated with the error. |
| week | Week associated with the error. |
| created_at | Timestamp when the error record was created. |
| recon_created_at | Timestamp when the error reconciliation was created. |
| order_number | Unique identifier for the order associated with the error. |
| location_id | Identifier for the restaurant location where the error occurred. |
| order_source | Name of the platform or source where the order originated. |
| ticket_id | Identifier for the associated ticket (if applicable). |
| order_id | Unique identifier for the order (if applicable). |
| pos_subtotal | Subtotal amount from the POS system. |
| op_subtotal | Subtotal amount from the operational system. |
| is_resolved | Indicates whether the error has been resolved. |
| closed_at | Timestamp when the error was resolved. |
| recon_closed_at | Timestamp when the error reconciliation was completed. |
| last_activity_type | Type of the last activity related to the error (if applicable). |
| last_activity_at | Timestamp of the last activity related to the error. |
| notification_message | Message associated with the error notification (if any). |
| agent_name | Name of the agent handling the error resolution. |
| assignee_id | Identifier of the person assigned to resolve the error. |
| alt_order_number | Alternative order number, if available. |
| supports_menu_api | Indicates whether the menu API is supported (true or false). |
| error_category | Category of the error (if applicable). |
| external_store_id | Identifier for the external store, if applicable. |
Comments
0 comments
Please sign in to leave a comment.