# Documentation Starter Kit

## Docs

- [Bulk Update Campaign](https://developer.lulacommerce.com/api-reference/campaigns/bulk-update-campaign.md): Update multiple campaigns simultaneously with the same changes, ideal for bulk campaign management and maintenance operations.
- [Campaigns Overview](https://developer.lulacommerce.com/api-reference/campaigns/campaigns-overview.md): Comprehensive campaign management system for creating, managing, and tracking marketing campaigns and promotions across your stores.
- [Create Campaign](https://developer.lulacommerce.com/api-reference/campaigns/create-campaign.md): Create a new marketing campaign for a company with detailed configuration including scheduling, targeting, and media assets.
- [Delete Campaign](https://developer.lulacommerce.com/api-reference/campaigns/delete-campaign.md): Delete a campaign and all associated data including promotions, store associations, and historical records.
- [Get Campaign Details](https://developer.lulacommerce.com/api-reference/campaigns/get-campaign-details.md): Retrieve comprehensive details for a specific campaign including full configuration, associated stores, and performance metrics.
- [Get Campaigns](https://developer.lulacommerce.com/api-reference/campaigns/get-campaigns.md): Retrieve a list of all campaigns for a company with pagination, filtering, and sorting capabilities.
- [Link Campaign to Stores](https://developer.lulacommerce.com/api-reference/campaigns/link-campaign-to-stores.md): Retrieve and manage the association between campaigns and store locations, including store-specific campaign configurations.
- [Create Promotion](https://developer.lulacommerce.com/api-reference/campaigns/promotions/create-promotion.md): Create a new promotion within a specific campaign, including discount rules, eligibility criteria, and promotional mechanics.
- [Delete Promotion](https://developer.lulacommerce.com/api-reference/campaigns/promotions/delete-promotion.md): Delete a promotion with comprehensive safety checks, data archival options, and impact assessment to protect business operations.
- [Get All Promotions](https://developer.lulacommerce.com/api-reference/campaigns/promotions/get-all-promotions.md): Retrieve a comprehensive list of all promotions within a campaign, with advanced filtering, sorting, and analytics capabilities.
- [Get Promotion Details](https://developer.lulacommerce.com/api-reference/campaigns/promotions/get-promotion.md): Retrieve comprehensive details for a specific promotion, including performance metrics, usage statistics, and configuration settings.
- [Update Promotion](https://developer.lulacommerce.com/api-reference/campaigns/promotions/update-promotion.md): Update an existing promotion's configuration, including discount rules, eligibility criteria, scheduling, and display settings.
- [Update Campaign](https://developer.lulacommerce.com/api-reference/campaigns/update-campaign.md): Update an existing campaign's configuration including name, description, schedule, and targeting parameters.
- [Get Job Status Of Ingestion](https://developer.lulacommerce.com/api-reference/catalog/get-job-status.md): This endpoint allows you to check the status of a background job, typically used to monitor the progress of bulk product uploads and inventory ingestion processes.
- [Get Store Inventory](https://developer.lulacommerce.com/api-reference/catalog/get-store-inventory.md): This endpoint retrieves the complete inventory for a specific store, including product details, pricing, quantities, and category information.
- [Modifiers Overview](https://developer.lulacommerce.com/api-reference/catalog/modifiers.md): Create and manage product customization options with modifier groups, enabling customers to personalize their orders with sizes, add-ons, and variations.
- [Create Modifier Group](https://developer.lulacommerce.com/api-reference/catalog/modifiers/create-modifier-group.md): This endpoint creates a new modifier group for a store. Modifier groups allow you to organize customization options that can be applied to menu items.
- [Create Modifier Group Linked Items](https://developer.lulacommerce.com/api-reference/catalog/modifiers/create-modifier-group-linked-items.md): This endpoint links store items to a modifier group, allowing those items to use the customization options defined in the modifier group.
- [Create Modifier Group Options](https://developer.lulacommerce.com/api-reference/catalog/modifiers/create-modifier-group-options.md): This endpoint adds new options to an existing modifier group. These options represent the individual choices customers can select within a modifier group.
- [Delete Linked Items From Modifier Group](https://developer.lulacommerce.com/api-reference/catalog/modifiers/delete-linked-items-from-modifier-group.md): This endpoint removes the association between store items and a modifier group, preventing those items from using the modifier group's customization options.
- [Delete Modifier Group](https://developer.lulacommerce.com/api-reference/catalog/modifiers/delete-modifier-group.md): This endpoint permanently deletes a modifier group and all its associated options and mappings. Use with caution as this action cannot be undone.
- [Delete Modifier Group Option From Modifier Group](https://developer.lulacommerce.com/api-reference/catalog/modifiers/delete-modifier-group-option.md): This endpoint removes specific options from a modifier group. Use this to eliminate unwanted customization choices or clean up outdated options.
- [Get List Of Modifier Groups](https://developer.lulacommerce.com/api-reference/catalog/modifiers/get-list-of-modifier-groups.md): This endpoint retrieves a list of all modifier groups for a specific store, with options for filtering, searching, and pagination.
- [Get Modifier Group Details](https://developer.lulacommerce.com/api-reference/catalog/modifiers/get-modifier-group-details.md): This endpoint retrieves comprehensive details about a specific modifier group, including all its options, linked items, and complete configuration.
- [Update Modifier Group](https://developer.lulacommerce.com/api-reference/catalog/modifiers/update-modifier-group.md): This endpoint updates the properties of existing modifier groups. You can modify settings like name, description, quantity limits, and other configuration options.
- [Get Recommended Products](https://developer.lulacommerce.com/api-reference/catalog/recommended-products.md): This endpoint retrieves a list of recommended products for a specific item in your store. These recommendations can be used to suggest complementary or related products to customers.
- [Catalog Updates](https://developer.lulacommerce.com/api-reference/catalog/updates.md): Manage and update your store's product catalog with bulk operations, inventory management, and product recommendations.
- [Upsert Inventory](https://developer.lulacommerce.com/api-reference/catalog/upsert-inventory.md): This endpoint allows you to update inventory information for specific products in a store. You can modify quantity, status, price, and location for existing products using their external_id.
- [Upsert Products using CSV](https://developer.lulacommerce.com/api-reference/catalog/upsert-products-csv.md): This endpoint allows you to upload and upsert products in bulk using a CSV file. The CSV file should contain product information that will be processed and updated in your inventory.
- [Upsert Products using JSON](https://developer.lulacommerce.com/api-reference/catalog/upsert-products-json.md): This endpoint allows you to create or update products in bulk using a JSON array. Send an array of product objects to add new products or update existing ones in your inventory.
- [Create Company](https://developer.lulacommerce.com/api-reference/companies/create-company.md): This endpoint creates a new company in the system. Companies serve as the parent entity for stores and manage business-level information including contact details, addresses, and operational status.
- [Delete Company](https://developer.lulacommerce.com/api-reference/companies/delete-company.md): This endpoint permanently deletes a company from the system. This is a destructive operation that will remove the company and potentially affect all associated stores, orders, and data. Use with extreme caution.
- [Get Company Details](https://developer.lulacommerce.com/api-reference/companies/get-company-details.md): This endpoint retrieves company information from the system. You can fetch either all companies or specific company details by providing a company ID. The response includes company details, address information, and associated store counts.
- [Offboard Company](https://developer.lulacommerce.com/api-reference/companies/offboard-company.md): This endpoint initiates the offboarding process for a company. Offboarding is a controlled process that safely transitions a company out of active service while preserving important data and ensuring proper closure of operations.
- [Update Company](https://developer.lulacommerce.com/api-reference/companies/update-company.md): This endpoint updates an existing company's information in the system. You can modify any company details including business information, contact details, address, and operational status. All fields are optional - only provide the fields you want to update.
- [CSV Item Ingestion](https://developer.lulacommerce.com/api-reference/csvItemsIngestion.md): CSV support for item ingestion
- [Get Job](https://developer.lulacommerce.com/api-reference/endpoint/get-job.md): Get information about an ingestion job.
- [Post items for ingestion](https://developer.lulacommerce.com/api-reference/endpoint/post-items-for-ingestion.md): This endpoint takes a JSON body and updates your inventory for the store. We post the JSON body containing the inventory items and the store gets updated with the items.
- [Upload CSV file for item ingestion](https://developer.lulacommerce.com/api-reference/endpoint/upload-csv.md): This endpoint takes a CSV file and updates your inventory for the store. We upload the CSV file contanining the inventory items and the store gets updated with the items.
- [Upload JSON file for item ingestion](https://developer.lulacommerce.com/api-reference/endpoint/upload-json.md): This endpoint takes a JSON file and updates your inventory for the store. We upload the JSON file containing the inventory items and the store gets updated with the items.
- [JSON Item Ingestion](https://developer.lulacommerce.com/api-reference/jsonItemsIngestion.md): The json items are ingested into the system by uploading through an API.
- [Create Store Menu](https://developer.lulacommerce.com/api-reference/menus/create-store-menu.md): Create a new menu for a specific store with customizable operating hours and configuration settings.
- [Delete Store Menu](https://developer.lulacommerce.com/api-reference/menus/delete-store-menu.md): Delete a specific menu from a store, removing all associated menu hours and configurations.
- [Get All Active Menu of Store](https://developer.lulacommerce.com/api-reference/menus/get-all-active-menu-of-store.md): Retrieve all active menus for a specific store, providing essential menu information for operational and customer-facing applications.
- [Get Menu List](https://developer.lulacommerce.com/api-reference/menus/get-menu-list.md): Retrieve a list of all menus for a specific store with filtering, sorting, and detailed menu information including operating hours and item counts.
- [Get Store Menu Timings](https://developer.lulacommerce.com/api-reference/menus/get-store-menu-timings.md): Retrieve specific timing information for selected menus, providing detailed operating hours and availability schedules.
- [Create Menu Item](https://developer.lulacommerce.com/api-reference/menus/menu-items/create-menu-item.md): Add items to specific menus within a store, controlling which products appear in different menu configurations through category and item-level management.
- [Delete Menu Item](https://developer.lulacommerce.com/api-reference/menus/menu-items/delete-menu.md): Remove specific items from store menus, providing precise control over product visibility and menu composition for optimal customer experience.
- [Update Menu Item](https://developer.lulacommerce.com/api-reference/menus/menu-items/update-menu-item.md): Modify menu item properties, availability, and configuration within specific menus to maintain accurate and optimized menu offerings.
- [Get Menu Rules](https://developer.lulacommerce.com/api-reference/menus/menu-rules/get-menu-rules.md): Retrieve comprehensive menu rules and business logic configurations that govern menu behavior, item availability, and operational constraints for a specific store.
- [Get Menu Rules by ID](https://developer.lulacommerce.com/api-reference/menus/menu-rules/get-menu-rules-by-id.md): Retrieve detailed configuration and status information for a specific menu rule, including its conditions, actions, execution history, and performance metrics.
- [Upsert Menu Rules](https://developer.lulacommerce.com/api-reference/menus/menu-rules/upsert-menu-rules.md): Create or update menu rules that control menu behavior, item availability, pricing logic, and operational constraints to automate menu management and ensure consistent business policy application.
- [Menus Service Overview](https://developer.lulacommerce.com/api-reference/menus/menus-overview.md): Comprehensive guide to the Menus service for managing store menus, menu items, operating hours, and menu rules within the Lula Commerce platform.
- [Sync Menu For All Stores](https://developer.lulacommerce.com/api-reference/menus/sync-menu-for-all-stores.md): Synchronize menu configurations across multiple stores, allowing for bulk menu updates and coordination with external partners.
- [Upsert Store Menu](https://developer.lulacommerce.com/api-reference/menus/upsert-store-menu.md): Update or insert (upsert) a store menu with new configuration, operating hours, and settings.
- [Accept Incoming Order](https://developer.lulacommerce.com/api-reference/orders/accept-incoming-order.md): Accept an incoming order from a delivery service platform and initiate the fulfillment process.
- [Cancel Order](https://developer.lulacommerce.com/api-reference/orders/cancel-order.md): Cancel an order and handle refunds, inventory adjustments, and platform notifications automatically.
- [Create New Order](https://developer.lulacommerce.com/api-reference/orders/create-new-order.md): Create a new order manually through the system, typically for in-store purchases, phone orders, or direct customer orders.
- [Get Incoming Orders](https://developer.lulacommerce.com/api-reference/orders/get-incoming-orders.md): Retrieve incoming orders for a specific store that are waiting for processing. This endpoint returns orders with their complete details including customer information, items, and fulfillment status.
- [Get Order Details](https://developer.lulacommerce.com/api-reference/orders/get-order-details.md): Retrieve comprehensive details for a specific order including all items, customer information, fulfillment history, and complete order tracking.
- [Get Orders Count](https://developer.lulacommerce.com/api-reference/orders/get-orders-count.md): Retrieve the count of orders by status for a specific store, providing a quick overview of active and completed order volumes.
- [Get Orders History](https://developer.lulacommerce.com/api-reference/orders/get-orders-history.md): Retrieve comprehensive historical order data with advanced analytics, reporting capabilities, and detailed performance metrics.
- [Get Store Orders](https://developer.lulacommerce.com/api-reference/orders/get-store-orders.md): Retrieve all orders for a specific store with flexible filtering options including date ranges, status, and pagination.
- [List All Orders](https://developer.lulacommerce.com/api-reference/orders/list-all-orders.md): Retrieve a comprehensive list of all orders for a specific store with filtering capabilities by status and other criteria.
- [Create Order Issue](https://developer.lulacommerce.com/api-reference/orders/order-issues/create-order-issue.md): Create a new issue report for an order, documenting problems, complaints, or special situations that require attention.
- [Update Order Issue](https://developer.lulacommerce.com/api-reference/orders/order-issues/update-order-issue.md): Update an existing order issue with resolution notes, status changes, refund information, and other progress updates.
- [Get All Order Items](https://developer.lulacommerce.com/api-reference/orders/order-items/get-all-order-items.md): Retrieve all items within a specific order with complete details, modifications, and fulfillment status for each item.
- [Get Order Items](https://developer.lulacommerce.com/api-reference/orders/order-items/get-order-items.md): Retrieve detailed information for a specific item within an order including pricing, modifications, and special instructions.
- [Update Order Items](https://developer.lulacommerce.com/api-reference/orders/order-items/update-order-items.md): Update specific details of an order item including special instructions, product information, and item specifications.
- [Orders Management](https://developer.lulacommerce.com/api-reference/orders/orders-overview.md): Comprehensive order management system for handling incoming orders, order processing, item management, and issue resolution across all delivery platforms.
- [Patch Order Cart](https://developer.lulacommerce.com/api-reference/orders/patch-order-cart.md): Modify order items by adding, removing, or updating quantities after order creation but before completion.
- [Change Store Status](https://developer.lulacommerce.com/api-reference/stores/change-store-status.md): This endpoint controls the operational status of a store across delivery service partners. You can open or close the store on all platforms simultaneously, or manage individual platforms (UberEats, DoorDash, GrubHub) separately. This is essential for managing store hours, temporary closures, and pla…
- [Create Store](https://developer.lulacommerce.com/api-reference/stores/create-store.md): This endpoint creates a new store under a specific company. Stores are the operational units that handle orders, inventory, and customer interactions. Each store can have multiple addresses for different purposes and automatically gets configured with delivery service partners.
- [Get Store Status](https://developer.lulacommerce.com/api-reference/stores/get-store-status.md): This endpoint retrieves the current operational status of a store across all delivery service partners (UberEats, DoorDash, GrubHub). It provides real-time information about whether the store is accepting orders, any active pauses, and detailed status descriptions for each platform.
- [Get Store Tax Rate](https://developer.lulacommerce.com/api-reference/stores/get-store-tax-rate.md): This endpoint retrieves the tax rate configuration for a specific store. Tax rates are essential for accurate order calculations and compliance with local tax regulations. The response includes applicable tax percentages and tax jurisdiction information.
- [Get Onboarding by Company ID](https://developer.lulacommerce.com/api-reference/stores/onboarding/get-onboarding-by-company-id.md): This endpoint retrieves onboarding status information for all stores belonging to a specific company. This provides a company-wide view of store onboarding progress and operational status across all delivery platforms.
- [Get Onboarding by ID](https://developer.lulacommerce.com/api-reference/stores/onboarding/get-onboarding-by-id.md): This endpoint retrieves onboarding information for a specific onboarding record using its unique identifier. This is useful for tracking onboarding progress and status when you have the onboarding ID from previous operations.
- [Get Onboarding by Store ID](https://developer.lulacommerce.com/api-reference/stores/onboarding/get-onboarding-by-store-id.md): This endpoint retrieves the current onboarding and operational status of a store by its store ID. It provides comprehensive information about the store's availability across all delivery platforms and any onboarding-related status information.
- [Start Onboarding](https://developer.lulacommerce.com/api-reference/stores/onboarding/start-onboarding.md): This endpoint initiates the store onboarding process by opening the store on all delivery service platforms. This is a critical step that makes the store live and ready to accept orders from customers across UberEats, DoorDash, and GrubHub.
- [Link Store to Employee](https://developer.lulacommerce.com/api-reference/stores/store-employees/link-store-to-employee.md): This endpoint links multiple stores to a new employee, creating employee relationships across multiple store locations simultaneously. This is useful for employees who work across multiple stores or for managers overseeing multiple locations.
- [Link User to Store](https://developer.lulacommerce.com/api-reference/stores/store-employees/link-user-to-store.md): This endpoint links an existing user to a specific store, establishing their employee relationship and access permissions. This is used to assign employees to stores and grant them appropriate access levels for store operations.
- [Update Store](https://developer.lulacommerce.com/api-reference/stores/update-store.md): This endpoint updates an existing store's information including basic details, contact information, and addresses. You can modify store properties while maintaining operational continuity and preserving existing integrations.
- [Get Started](https://developer.lulacommerce.com/documentation/get-started.md): This guide walks you through the fastest path to value: loading your products, creating a menu, and syncing to your sales channels with Lula Commerce.
- [High-Level Architecture](https://developer.lulacommerce.com/documentation/high-level-architecture.md): Understanding Lula Commerce's architecture, core components, data flow, and how we connect your stores to every delivery channel.
- [Integrations](https://developer.lulacommerce.com/documentation/integrations.md): Connect your stores to major delivery channels and third-party platforms with Lula Commerce's comprehensive integration ecosystem.
- [Lula Direct SDK](https://developer.lulacommerce.com/documentation/lula-direct-sdk.md): Integrate Lula Direct's first-party eCommerce delivery platform into your React Native, iOS, and Android applications with our comprehensive SDK.
- [Welcome to Lula Commerce](https://developer.lulacommerce.com/documentation/welcome-intro.md): Your comprehensive guide to growing delivery sales and simplifying operations with Lula Commerce's unified platform for convenience retailers.
- [Get Started](https://developer.lulacommerce.com/introduction.md): Lula Commerce API documentation.
- [Migrating from Item Ingest v1 to Item Ingest v2](https://developer.lulacommerce.com/migrating_v1_v2.md): Highlighting the main changes between our v1 and v2 APIs