Kimelo will publish orders submitted by Customers to the seller in regular intervals. Each row will represent one order line - a single item ordered by the Customer and quantity of it. Kimelo will also repeat order-level information (listed below under ‘Repeat per order line:’) in every row representing order lines of a given order. This file reflects the latest status of the Orders as submitted by the Customers. This file will contain a snapshot of latest details, not only new or changed orders. Sample file:
exported_orders_2025-03-28_21-59-06 - exported_orders_2025-03-28_21-59-06.csv
| Filename pattern | orders[datetime].csv | |
|---|---|---|
| ERP to Kimelo | Y | Internal manual orders from the ERP, for route planning or payment in Kimelo |
| Kimelo to ERP | Y | Ecommerce orders placed in Kimelo for fulfillment through the ERP |
| System of record | Kimelo | |
| Status | Available | |
| Frequency | 1-4 times per day |
These are the attributes for one or more orders from the vendor’s customers, as they progress through status of the order lifecycle. Each line has details for a purchase item. Each line of an order repeats order header information as shown.
| Column Name | Data Type | Description |
|---|---|---|
| Repeat per order line: | ||
| kimelo_order_id | Integer | Kimelo-generated unique order number. |
| erp_customer_id | Integer | Unique identifier for the customer location in the partner’s system |
| status | String | Current status of the order. |
| in_progress: user has items in the cart (not sent outside Kimelo) | ||
| checkout: customer customer completed cart check out | ||
| processing: edits locked after order cutoff time | ||
| delivered: marked as delivered with final quantities | ||
| canceled: a user has cancelled the order | ||
| error: a payment or processing error | ||
| billed: Kimelo has created an invoice for the completed order | ||
| delivery_date | Date | Committed delivery date in the Kimelo app. |
| delivery_time_start | Integer (hours) | Start of the delivery window in Pacific time (hours). |
| delivery_time_end | Timestamp | End of the delivery window in Pacific time. |
| delivery_address | String | The delivery address provided by the user at checkout. |
| order_checkedout_at | Timestamp | Timestamp when the order was checked out. |
| created_at | Timestamp | Timestamp when the order was initially created. |
| updated_at | Timestamp | Timestamp of the last update made to the order. |
| edit_up_to | Timestamp | Cutoff time for editing this order. |
| total | Currency | Final total amount of the order, including all items. |
| note | String | Note for the delivery driver, if provided. |
| source | String | The source of the order: |
| ios_app: The Kimelo app | ||
| android_app: The Kimelo app | ||
| recurring_order: A scheduled repeating order | ||
| web_app: The Kimelo web app | ||
| erp: Sent from the distributor ERP for route planning or billing in Kimelo | ||
| promo_code_discount | Currency | Discount applied from a promotional code. |
| volume | Float | Total volume of the order in cubic inches. |
| weight | Float | Total weight of the order in pounds. |
| deleted_at | Timestamp | Timestamp when the order was deleted, if applicable. |
| delivery_fee | Currency | Kimelo-calculated delivery fee based on delivery zone settings |
| payment_processing_fee | Currency | Payment processing fees levied on the end customers - depending on the payment method chosen by the customer. Note, this can change if during charging payment method fails and customer provides a backup one for which the fee is different (e.g. backup credit card charged after ACH fail). |
| One row per order line: | ||
| erp_product_id | String | Distributor's identifier for a specific product |
| pack_type | String | A product variant defining how the SKU is sold (e.g., Case or Each). SKU + Variant form a unique identifier. |
| quantity_units | Integer (unsigned) | Number of units ordered, in terms of the pack type of the SKU. If the pack_type for this order line is “case” this is the number of cases the customer requested. May be positive or zero but not negative. |
| unit_price | Currency | Price per unit. For catchweight items, this is the price per unit of measure (Kimelo uses imperial pound for all UOM) |
| line_subtotal | Currency | Total price for the line item, excluding taxes. |
03/17/2025
Each order (and order line) is associated with a status. Status is set on the order-level and is the same across all order lines within a given order. Kimelo will export orders with the following statuses:
checkout - these orders are still editable but the customers have already clicked the checkout button. These orders can be freely cancelled or modified by the end Customer until the edit_up_to timestamp.processing - these orders are not editable or cancellable by the end customers anymore. They can be edited by the seller in DMC but will not change otherwise. These are the orders that should be fulfilled by the seller.delivered - these orders have been marked as delivered by the seller. It can be done in multiple ways:
order_items_accepted.csvcanceled - these orders have been cancelled either by the seller or the Customererror - these orders have been subject to an error - either processing or payment. Kimelo recommends to check the invoice status if the payment has failed. Otherwise Kimelo recommend contacting the Customer to submit an order again.billed - these orders have had their invoice successfully issued. For payment status refer to invoices.csv file