Summary
Trends
  • Orders
  • Store Groups
  • Settings
Product Management
Bulk Product Updates
Status Scheduled Start Time Actual Start Time Processing Time Type UPC/PLUs In Update
Product Option Group Management
Manage product option groups and their linked choices. Changes will affect all products using this option group.
  • Transactions
  • Payouts
Store Amount Transaction ID Payout ID Type Date Time Source Details Payout Date Status
Gross Total:   Net Total:
Payout ID Account Amount Payout Date Status
Net Total:
  • Pricebook Deals
  • Promo Codes
  • Subscriptions
  • Upsells
  • Retention
  • Referral Programs
   A pricebook deal includes mix-and-match and combo offers. If you have an automated pricebook integration, these will populate automatically
   A promo code is a digital coupon that customers can apply during checkout. They can be store-wide or customer-specific

Promo Codes

Code Details Start Time End Time Actions
   A subscription is a monthly and/or annual program that customers can enroll in to receive deals such as free delivery or discounted products

Subscription Services

Service Name Monthly Rate Yearly Rate
   Upsells allow you to promote products during checkout based on the products or categories already in cart

Upsells

Description Type Product to Upsell Stores
   Auto-retention allows you to define a promo code template that gets automatically sent to customers after they drop-off from your online service

Retention Rules

Days After Last Order Maximum Attempts Details Actions
   Referral programs allow you to define a promo code template that customers share with friends. The customer receives a promo code for the same deal whenever a friend uses their referral code and completes an order.

Referral Programs

Details Applicable Stores Actions
  • Data Exports
  • Developers
Customer and Order Segmentation
Total Customer Count Has Email & Phone Has Just Email Has Just Phone Unsubscribed Invalidated Average Orders Per Customer
  • AND In Group
  • OR In Group
  • NOT In Group
  • Ordered Within Dates
  • Not Ordered Within Dates
  • Ordered Number of Times
Other Exports

Getting Started

About The API

The Vroom reporting API allows you to programmatically retrieve various data points from your digital commerce program such as customer contacts, order histories, transaction data, customer search terms, and audit logs. All requests and responses will be in JSON format via HTTPS with a base URL of https://www.vroomdelivery.com/api/retailer/v1.

If you have any questions, please don't hesitate to reach out to your Vroom representative or email us at help@vroomdelivery.com.

Authentication

All API endpoints use Basic Authentication using your management portal email and password credentials. If you want to create a standalone set of credentials for API usage, click the "Users" tab, select "Management", and add a new user. A temporary password will be automatically emailed to you which you can use to login and reset your password.

Retrieve Customer Contacts

POST /analytics/customer_contacts

This endpoint returns a list of customer contacts as well as the stores that the customers have ordered from. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the customer first ordered. If this parameter is not provided, the start time will be the start of your online program. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the customer first ordered. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body — Array of Customer Contacts:

Parameter Type Description
name String The name of the customer provided on their first order.
email String The unique email of the customer.
phone String The unique 10-digit phone number of the customer. This may be blank if the same phone number is used on another customer contact. For example, if a customer ordered with two different emails but one phone number, we only report the phone number once.
created_at Datetime The datetime (ISO-8601) when the customer was created.
last_order_id String The Order ID of the customer's most recent order.
last_order_time Datetime The datetime (ISO-8601) when the customer's last order was placed.
unsubscribed Boolean True only if the customer has unsubscribed from marketing emails via Vroom-managed campaigns.
site_ids Array<String> The Site IDs of the stores where the customer has placed an order. This will be restricted to the site_ids that you requested, so we recommend requesting all stores (or leaving the site_ids parameter out) if you want a comprehensive list of stores that customers have ordered from.

Response Body Example:

Retrieve Live Order Statuses

POST /analytics/order_statuses

This endpoint returns an aggregated list of operational order statuses by store. This provides similar data to the interface in the "Stores" > "Orders" tab of your management portal. For example, you can track the number of unconfirmed or canceled orders by site. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the order was placed. If this parameter is not provided, the start time will be 24 hours before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the order was placed. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Order Group Object Schema

Parameter Type Description
count Integer The number of orders in the respective order state.
order_ids Array<String> The Order IDs of the orders in the respective order state.

Response Body — Array of Store Order Statuses:

Parameter Type Description
site_id String The Site ID of the store provided.
orders_pending_less_than_ten_mins Order Group The number of orders and their Order IDs for those created in the date range that have been pending for less than 10 minutes and are waiting for confirmation.
orders_pending_more_than_ten_mins Order Group The number of orders and their Order IDs for those created in the date range that have been pending for more than 10 minutes and are waiting for confirmation and may need operational assistance.
orders_preparing_less_than_one_hour Order Group The number of orders and their Order IDs for those created in the date range that have been confirmed and in preparation for less than 1 hour.
orders_preparing_more_than_one_hour Order Group The number of orders and their Order IDs for those created in the date range that have been confirmed and in preparation for more than 1 hour and may need operational assistance.
orders_ready_less_than_one_hour Order Group The number of orders and their Order IDs for those created in the date range that have been ready for pickup or in delivery for less than 1 hour.
orders_ready_more_than_one_hour Order Group The number of orders and their Order IDs for those created in the date range that have been ready for pickup or in delivery for more than 1 hour and may need operational assistance.
orders_completed Order Group The number of orders and their Order IDs for those created in the date range that have been completed.
orders_canceled Order Group The number of orders and their Order IDs for those created in the date range that have been canceled and refunded.

Response Body Example:

Retrieve Search Terms

POST /analytics/search_terms

This endpoint returns the search terms used by customers looking for products on your online menus. It also provides information on whether customers clicked a result so you can see if there are certain items that customers want to buy but may not be available online. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the search was made. If this parameter is not provided, the start time will be one week before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the search was made. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body — Array of Search Terms:

Parameter Type Description
site_id String The Site ID of the store provided.
created_at Datetime The datetime (ISO-8601) when the search was made.
ip_hash String A secure hash of the IP used to make the request. You can use this to identify when individual users are making multiple searches.
term String The search term used by the customer.
num_search_results Integer The number of search results returned for the search term. This will be between 0 and 10 depending on how many matches were found.
selected_product_upc_or_plu String The UPC or PLU of the product that was selected by the customer. If the customer did not select a product, this will be null.
selected_product_title String The title of the product that was selected by the customer. If the customer did not select a product, this will be null.
selection_position Integer The position of the selected product in the search results. For example, 0 is the first slot, 1 is the second slot, etc. If the customer did not select a product, this will be null.

Response Body Example:

Retrieve Audit Logs

POST /analytics/audit_logs

This endpoint returns a chronological audit of important actions that both store and management users perform in the Vroom portals. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the action was made. If this parameter is not provided, the start time will be one week before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the action was made. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body — Array of Audit Logs:

Parameter Type Description
site_id String The Site ID of the store provided. This will be Management if the action was cross-site.
created_at Datetime The datetime (ISO-8601) when the action was made.
action String The event type performed by the user. Options include Store Closed, Store Info Updated, Product Shown, Product Hidden, Product Created, Product Updated, Product Deleted, Driver Added, Driver Removed, Driver Updated, Bulk Product Update Run, Bulk Promotion Update Run, Order Unconfirmed After 15 Minutes, Order Canceled, Order Not Completed, Upcharge Failed, Long Service Estimate, Store Opened, Password Reset, and Management Refund.
additional_details String Additional context about the action that took place.
user String Either the email of the user that performed the action or Automated if it was done by an automated job.

Response Body Example:

Retrieve Line Items

POST /analytics/line_items

This endpoint returns a list of transaction line items. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the action was made. If this parameter is not provided, the start time will be one week before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the action was made. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body — Array of Line Items:

Parameter Type Description
site_id String The Site ID of the store provided.
order_id String The Order ID of the order the line item is associated with.
sales_channel String The sales channel of the order the line item is associated with, such as "Vroom", "Uber Eats", or "DoorDash".
external_order_id String The external order ID of the order the line item is associated with if the order is through an external sales channel such as Uber or DoorDash.
created_at Datetime The datetime (ISO-8601) when the order was created.
customer_name String The name of the customer associated with the order.
customer_email String The email of the customer associated with the order.
customer_phone String The phone number of the customer associated with the order.
product_upc_or_plu String The UPC or PLU of the product associated with the line item.
product_title String The description of the product associated with the line item.
product_price Decimal The unit price of the line item.
product_container_deposit Decimal The unit container or bottle deposit of the line item.
original_quantity Integer The original quantity ordered of the line item.
final_quantity Integer The final quantity of the line item after in-store adjustments.
upsell Boolean Whether or not the line item is an upsell. An upsell occurs when a customer adds an item to cart from the "Customers Also Bought" section of checkout.
cart_position Integer The 0-based index of which position the item was in the customer's cart. For example, if there are 5 items in cart, item 0 is first and item 4 is last.
added_by_store Boolean Whether or not the line item was added by the store. This is typically due to a line item swap.
product_merchandise_code String The merchandise code of the product associated with the line item. This will get auto-populated from your backoffice integration if enabled.

Response Body Example:

Retrieve Orders

POST /analytics/orders

This endpoint returns a list of orders. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the action was made. If this parameter is not provided, the start time will be one week before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the action was made. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
include_line_items Boolean Optional
Whether or not to include full transaction line items in the response. This provides similar information to the separate Line Items API, but nests them within their respective Order. By default, line items are not included in the response.

Request Body Example:

Response Body — Array of Orders:

Parameter Type Description
site_id String The Site ID of the store provided.
order_id String The Order ID of the order.
sales_channel String The sales channel of the order the line item is associated with, such as "Vroom", "Uber Eats", or "DoorDash".
external_order_id String The external order ID of the order the line item is associated with if the order is through an external sales channel such as Uber or DoorDash.
created_at Datetime The datetime (ISO-8601) when the order was created.
customer_name String The name of the customer associated with the order.
customer_email String The email of the customer associated with the order.
customer_phone String The phone number of the customer associated with the order.
total Decimal The total amount paid by the customer.
merchandise Decimal The total amount of merchandise and taxes paid by the customer.
delivery_fee Decimal The total amount of delivery fees paid by the customer.
tip Decimal The total amount of tips paid by the customer.
tip_refund Decimal The amount of tips refunded to the customer. This is typically only present if the order is canceled.
net_tip Decimal The net amount of tips paid by the customer. This is the tip minus the tip_refund.
refund_amount Decimal The amount refunded to the customer based on adjustments made to the order.
upcharge_amount Decimal The amount of additional charges added to the transaction based on adjustments made to the order.
adjusted_total Decimal The net total amount paid by the customer after adjustments were made to the order.
adjusted_total_less_tips Decimal The net total amount paid by the customer after adjustments were made to the order, excluding tips.
processing_fee Decimal The total amount of processing fees charged to the retailer on the backend.
processing_fee_refund Decimal The amount of processing fees refunded to the retailer.
processing_fee_on_upcharge Decimal The total amount of processing fees charged to the retailer for upcharges to the transaction.
net_processing_fee Decimal The total amount of net processing fees charged to the retailer after adjustments to the order.
third_party_fulfillment_fee Decimal The total amount of third party fulfillment fees charged to the retailer on the backend. Note that this includes net tips (tips after processing fees) paid by the customer.
third_party_fulfillment_fee_refund Decimal Refunds for third party fulfillment fees.
net_third_party_fulfillment_fee Decimal The total amount of net third party fulfillment fees charged to the retailer.
ebt_fees Decimal The total amount of EBT processing fees charged to the retailer.
net_remit Decimal The total amount of funds that will be paid out to the retailer after all fees and adjustments.
promotion_code String The promotion code used for the order if present.
promotion_code_original_discount Decimal The amount of the promotion code discount on the original order.
promotion_code_final_discount Decimal The amount of the promotion code discount after adjustments were made to the order.
mix_match_combo_original_count Integer The number of mix-and-match or combo offers on the original order.
mix_match_combo_final_count Integer The number of mix-and-match or combo offers on the after adjustments.
mix_match_combo_original_discount Decimal The total dollar value of all mix-and-match or combo offers on the original order.
mix_match_combo_final_discount Decimal The total dollar value of all mix-and-match or combo offers after adjustments were made to the order.
loyalty_code String The loyalty code (card number or Alt ID) used for the order if present.
loyalty_original_discount Decimal The discount applied to the order from the loyalty host based on the customer's loyalty code.
loyalty_final_discount Decimal The discount applied to the order from the loyalty host after adjustments were made to the order.
canceled Boolean Whether or not the order was canceled.
driver String The name of the driver or fulfiller who delivered the order if it was a delivery order.
delivery_address String The delivery address of the order if it was a delivery order.
delivery_latitude Decimal The latitude of the delivery address if it was a delivery order.
delivery_longitude Decimal The longitude of the delivery address if it was a delivery order.
delivery_distance Decimal The distance (miles) of the delivery if it was a delivery order.
order_type String The type of order: Delivery, Scheduled Delivery, Pickup, Scheduled Pickup, Curbside, Scheduled Curbside, or Shipping.
scheduled_time Datetime The time the order was scheduled for if it was a scheduled order.
placed_time Datetime The time the order was placed.
confirm_time Datetime The time the order was confirmed by the store.
ready_time Datetime The time the order was ready for pickup or delivery.
driver_start_time Datetime The time the driver picked up the order from the store if it was a delivery order.
driver_end_time Datetime The time the driver dropped off the order at the customer if it was a delivery order.
complete_time Datetime The time the order was completed by the store or auto-completed by Vroom.
cancelation_reason String The reason the order was canceled if it was canceled. This is typically self-reported by the store so often should be reviewed by operations.
subscribed Boolean Whether the customer is part of a retailer subscription service.
subscription_discount Decimal The discount the customer received if they are part of a retailer subscription service.
auto_retention_conversion Boolean Whether this customer reconverted from a Retention Rule.
is_new_customer Boolean Whether or not the customer is a new online customer.
line_items Array<Line Item> The line items of the order if include_line_items was set to true in the request body. See the Line Items API for the schema of this object.

Response Body Example:

Create Promo Code

POST /marketing/create_promo_code

This endpoint creates a promo code for customers to use when ordering. This provides similar capabilities to the interface in the "Promotions" tab under "Promo Codes". The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs that the promo code will be valid for. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, the promo code will be valid for all of your stores.
active_time Datetime Optional
A Datetime representing when the promo code should start being available for use. If this parameter is not provided, the promo code will be immediately active. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
expiry_time Datetime Optional
A Datetime representing when the promo code should expire. If this parameter is not provided, the promo code will expire in one month. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
code String Optional
A String representing the code that the customer will use to apply the promo code to their order. This code must be unique across all of your promo codes. If this is not provided, we will generate a random code for you. Alternatively, you can provide the customer_name parameter and we will generate a code for you based on the customer's name.
customer_name String Optional
If the code parameter is empty but this parameter is provided, we will generate a code for you based on the customer's name. For example, if the name is Jack Johnson, we will generate a code such as JACK12. This is recommend for customer specific promo codes as we will guarentee that the code is unique.
promo_code_type String Required
This can be percent_off, dollar_off, or free_delivery.
value Decimal Conditional
The value of the promo code. If the promo_code_type is percent_off, this should be a percentage between 0 and 100. If the promo_code_type is dollar_off, this should be a dollar amount. If the promo_code_type is free_delivery, this can be excluded or set to 0.
maximum_discount Decimal Optional
The maximum discount that the promo code can provide if the promo_code_type is percent_off.
minimum_order_amount Decimal Optional
The minimum basket subtotal that the customer must have in order to use the promo code.
customer_email String Optional
If present, the promo code can only be used by the customer with the provided email address. If neither customer_email nor customer_phone are provided, the promo code can be used by any customer.
customer_phone String Optional
If present, the promo code can only be used by the customer with the provided 10-digit phone number. If neither customer_email nor customer_phone are provided, the promo code can be used by any customer.
first_order_only Boolean Optional
If true, the promo code can only be used on the customer's first online order. By default, this is false.
is_one_time_use Boolean Optional
If true, the promo code can only be used once per customer. By default, this is false.

Request Body Example:

Response Body:

Parameter Type Description
code String The code that the customer will use to apply the promo code to their order.
active_time Datetime The time that the promo code will start being available for use.
expiry_time Datetime The time that the promo code will expire.
promo_code_type String The type of promo code. This will be one of percent_off, dollar_off, or free_delivery.
value Decimal The value of the promo code. This will be a percentage if the promo_code_type is percent_off, a dollar amount if the promo_code_type is dollar_off, or 0 if the promo_code_type is free_delivery.
minimum_order_amount Decimal The minimum basket subtotal that the customer must have in order to use the promo code.
maximum_discount Decimal The maximum discount that the promo code can provide if the promo_code_type is percent_off.
first_order_only Boolean If true, the promo code can only be used on the customer's first online order.
is_one_time_use Boolean If true, the promo code can only be used once per customer.
customer_email String If present, the promo code can only be used by the customer with the provided email address. If neither customer_email nor customer_phone are present, the promo code can be used by any customer.
customer_phone String If present, the promo code can only be used by the customer with the provided phone number. If neither customer_email nor customer_phone are present, the promo code can be used by any customer.
site_ids Array An array of site IDs that the promo code is available on.

Response Body Example:

Get Transactions

POST /analytics/transactions

This endpoint returns a list of transactions and associated settlement data within the specified time range. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
from_time Datetime Required
A Datetime representing the start of the time range. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Required
A Datetime representing the end of the time range. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body:

Parameter Type Description
site_id String The Site ID of the store provided.
amount Decimal The dollar amount of the transaction.
transaction_id String The unique identifier of the transaction.
payout_id String The identifier of the bank disbursement associated with the transaction.
type String The type of transaction such as Card, Fee, or Refund.
time Datetime The time of the transaction.
source String The Order ID that the transaction is associated with if applicable.
deposit_status String Status of the deposit. This will be pending, in_transit, or paid.
estimated_deposit String Estimated date of bank settlement in format MM/DD/YYYY.
additional_details String Additional transaction details.

Response Body Example:

Get Sales By Product

POST /analytics/sales_by_product

This endpoint returns a list of sales by product sorted by sales descending. The endpoint is a POST request with Content-Type: application/json, and it requires an Authentication header per the instructions in the "Getting Started" section above.

Request Body:

Parameter Type Description
site_ids Array<String> Optional
An Array of Strings representing your physical store Site IDs. These will typically match the Site IDs you're providing us for backoffice or inventory integrations. If this parameter is not provided, all stores will be returned in the response.
from_time Datetime Optional
A Datetime representing the earliest time to include in the results based on when the action was made. If this parameter is not provided, the start time will be one week before the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).
to_time Datetime Optional
A Datetime representing the latest time to include in the results based on when the action was made. If this parameter is not provided, the end time will be the time of the API call. The exact format of the datetime string is flexible, but we recommend using standard formats such as ISO-8601 (YYYY-MM-DDTHH:MM:SSZ).

Request Body Example:

Response Body:

Parameter Type Description
upc_or_plu String The UPC or PLU of the product.
title String The title of the product.
total_sales Decimal The total dollar sales of the product in the specified time range.
units_sold Integer The total number of units sold of the product in the specified time range.
category String The fully qualified category name that the product is contained in.
image_url String The URL of the product image if available.

Response Body Example:

   More APIs Coming Soon!
  • Reviews
  • Custom Questions

Internal Alerts

Email Address Event Type Store
  • Stores
  • Management
  • Drivers

Store User Permissions

User Name User Email Stores Managed Actions

Management User Permissions

Name User Email Stores
Add New User

Create Product

Is this image correct?
If you would like to create an image on the products, please do so here:
  

Create Bulk Product Update

ID Item Type Store Value

View & Edit Product Option Groups

Uploading product option choice images

Add Products

Update Mix-Match Metadata

ID Start Time End Time Qty Value

Create Promo Code

Create Subscription Service