Order Report
The order report contains detailed information regarding the orders received by organization or selected stores.
Report fields:
| Name | Details |
|---|---|
| storeId | The ID of the store. The id used here is the same as the one used for authenticating the store in Public API. If the particular store is not integrated this field will be empty |
| dateTime | The date and time the order was created (format: yyyy-MM-dd hh:mm:ss.SSSSSSSSS UTC) |
| brand | The brand name of the store where the order was processed |
| location | The name of the location where the order was processed |
| channel | The ordering channel - e.g. ubereats, doordash, toast etc. |
| orderDisplayId | The display id of the order as provided by the online food delivery channel as appears on the receipt ticket and screens |
| orderId | The ID of the order as provided by online food delivery channel |
| orderStatus | Status of the order. It will be set to the following depending on the status: - OFO_STATUS_FULFILLED - the order has been fulfilled - OFO_STATUS_CANCELED - the order has been canceled - OFO_STATUS_NEW - the order is new |
| isAccepted | If the order has been accepted |
| fulfillmentMode | How the order was fulfilled. Available options include: - FULFILLMENT_MODE_OFO_DELIVERY - If the fulfillment mode is through the online food delivery partner - FULFILLMENT_MODE_PICKUP - If the fulfillment mode was pickup - FULFILLMENT_MODE_RESTAURANT_DELIVERY - If the fulfillment mode was restaurant delivery - FULFILLMENT_MODE_NOT_SET- If there was no fulfillment mode set - FULFILLMENT_MODE_DINE_IN - If the fulfillment mode was dine in. |
| schedulingType | How the delivery was scheduled. One of: - SCHEDULING_ASAP - If the food was scheduled as fast as possible - SCHEDULING_FIXED_TIME - Schedule delivery for a pre agreed time - SCHEDULING_UNKNOWN - If the scheduling method is unknown |
| currencyCode | ISO 3-letter currency code representing the currency used for the order: USD, etc. |
| subtotal | The subtotal of the order |
| tax | The additional tax on the order |
| discounts | Any discounts taken on the order |
| errorCharges | Amount was erroneously charged to an eater. Deductions from your payouts as the result of order issues (e.g. missing items) |
| adjustments | An eater was undercharged, amount of the adjustment |
| locationDeliveryFee | Delivery fee charged to location |
| eaterDeliveryFee | Delivery fee charged to eater |
| tips | The tips on the order |
| marketingFees | The marketing fees taken by the online food delivery partner |
| otherFees | The other fees taken by the online food delivery partner |
| total | The total of the order |
| estimatedCommission | Estimated commissions for the order |
| estimatedNetPayout | Estimated payout for the order |
| payoutId | Transaction id for the payout |
| payoutDate | Date when payout happened for this order if already known (format: yyyy-MM-dd) |
| isReconciled | Payout data is reconciled with ofo transactions |
| paymentType | The payment method for the order. Available options include: - CASH - Outstanding payment is paid in cash - CARD - Outstanding payment is paid by card - CHEQUE - Outstanding payment is paid by cheque - OTHER - paid fully to OFO or unknown |
| itemsQuantity | Quantity of the different items in the order |
| orderIssues | Number of reported order issues |
| issueTypes | Space separated issue types for the order. Possible values include: - ISSUE_TYPE_MISSING_ITEM - item was missing from the order - ISSUE_TYPE_INCOMPLETE - order was incomplete - ISSUE_TYPE_WRONG_INGREDIENTS - some of the ingredients were wrong in the order - ISSUE_TYPE_UNDETERMINED - order issue type is not known - ISSUE_TYPE_WRONG_ORDER - completely wrong order was delivered - ISSUE_TYPE_POOR_QUALITY - order was of a poor quality - ISSUE_TYPE_WRONG_ITEM - some of the items in the order were wrong - ISSUE_TYPE_LATE_TO_COURIER - courier received order late - ISSUE_TYPE_HANDLED_POORLY - order was handled poorly - ISSUE_TYPE_TEMPERATURE_COLD - order was delivered cold - ISSUE_TYPE_WRONG_INSTRUCTIONS - instructions were not followed |
| issueDetails | Details on issues that happened with order if applicable |
| orderRating | Rating of the order from 0 to 5 |
| customerNote | Customer note on the order |
| orderReview | Full text of order review |
| preparationTime | How much time it took to prepare the order, milliseconds |
| deliveryTime | How much time it took to deliver the order, milliseconds |