Skip to content

Integration · E-commerce

joinluminous.com

Connect Claude & ChatGPT to Luminous

Ask your AI how much stock you have, where a sales order stands or which purchase orders are still open in Luminous. It can create sales orders, purchase orders, work orders and inventory adjustments, and look up products, suppliers, customer companies, invoices and shipments. You get answers about inventory and orders without clicking through each screen.

Connect Luminous free

Free plan, no credit card. Takes about a minute.

Try asking

  • “How many units of SKU TEE-BLK-M do we have on hand and incoming?”

    The AI lists stock levels for that SKU per warehouse: on hand, available, incoming and backordered.

  • “Which purchase orders from our main supplier are still open?”

    It searches for the supplier, then lists its purchase orders filtered by order status.

  • “Create a purchase order for 200 units of SKU MUG-01 at 3.50 each.”

    It finds the supplier and creates the purchase order with the order date and one item line.

What your AI can do

Inventory and warehouses

List stock by product and warehouse, see incoming and backordered quantities, and adjust on-hand stock with remarks.

Sales and purchasing

Create, read and update sales and purchase orders, list fulfillment orders and shipments, and read customer invoices.

Products, suppliers and manufacturing

Search and update products, create suppliers and customer companies, and create and search work orders.

  • “Start a work order to produce 50 gift boxes in the main warehouse.”

    It looks up the product and warehouse and creates a work order for 50 units, optionally with a BOM and expected completion date.

  • “Has sales order 10482 shipped yet?”

    It reads the sales order with its status and lists the shipments recorded for it.

  • “Which customer invoices are unpaid?”

    It lists customer invoices filtered by payment status, with company and due date.

563 tools for Luminous

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

  • add_alternate_skuChanges dataCreate a new product. Required: sku or alternate sku. Search products first to avoid duplicates. API summary: Add alternate SKU.
  • approve_invoiceVisible to othersApprove a invoice (invoice id). Has effects visible outside this system. API summary: Approve invoice.
  • attach_bom_to_productChanges dataAttach a bom (product id). API summary: Attach BOMs to a product.
  • attach_invoice_to_dealChanges dataAttach a invoice (invoice id). API summary: Link a bill to a deal.
  • attach_order_to_dealChanges dataAttach a order (order id). API summary: Link a supplier PO to a deal.
  • attach_order_to_deal_link_work_order_to_dealChanges dataAttach a order (order id). API summary: Link a work order to a deal.
  • attach_payment_obligation_billChanges dataLink a payment obligation (payment obligation id). API summary: Link a bill to a payment obligation.
  • attach_tagChanges dataAttach a tag (record id). API summary: Attach tags to a record.
  • attach_tag_to_orderChanges dataAttach a tag (fulfillment order id). API summary: Attach tag(s) to a fulfillment order.
  • cancel_a_work_orderDeletesCancel a order (work order id). Destructive action; may require approval. API summary: Cancel a work order.
  • cancel_cycle_countDeletesCancel a cycle count (session id). Destructive action; may require approval. API summary: Cancel a cycle count session.
  • cancel_orderDeletesCancel a order (fulfillment order id). Destructive action; may require approval. API summary: Cancel fulfillment order.
  • cancel_paymentDeletesVoid a payment (payment id). Destructive action; may require approval. API summary: Void a bill payment.
  • cancel_vendor_creditDeletesCancel a vendor credit (vendor credit id). Destructive action; may require approval.
  • cancel_vendor_returnDeletesCancel a vendor return (vendor return id). Destructive action; may require approval.
  • close_the_books_zero_cost_line_items_in_rangeList products. Optional filters: from date or end date. API summary: Close the Books — zero-cost line items in range.
  • close_the_books_zero_valuation_inventoryList inventories. API summary: Close the Books — zero valuation inventory.
  • create_a_billChanges dataCreate a new invoice. API summary: Create a bill.
  • create_a_cycle_count_batchVisible to othersCreate a new cycle count. Has effects visible outside this system. API summary: Create a cycle count batch.
  • create_a_new_shipment_for_a_sales_orderChanges dataCreate a new shipment for a order. Required: ship date, tracking number, carrier code, warehouse id, ship to or items. API summary: Create a new shipment for a sales order.
  • create_a_supplier_skuChanges dataCreate a new product. Required: product id, supplier id or sku. Search products first to avoid duplicates. API summary: Create a supplier SKU.
  • create_a_transfer_orderMoves moneyTransfer a order. Financial or irreversible action; may require approval. API summary: Create a transfer order.
  • create_a_work_order_shipmentChanges dataCreate a new shipment for a order. Required: quantity shipped. API summary: Create a work order shipment.
  • create_addressChanges dataCreate a new address. Required: name or parent id. Search addresses first to avoid duplicates. API summary: Create location.
  • create_an_export_templateChanges dataExport templates. API summary: Create an export template.
  • create_ask_aiChanges dataCreate a new ask ai. Required: subject type, subject id or question. API summary: Ask an AI about a record's history.
  • create_auto_carrier_mappingChanges dataCreate a new auto carrier mapping. Required: app integration account id or enabled. API summary: Toggle auto carrier mapping.
  • create_auto_mapChanges dataCreate a new auto map. API summary: Dispatch auto-mapping job.
  • create_auto_map_ai_auto_map_integration_mappingChanges dataCreate a new auto map. API summary: AI auto-map a mapping.
  • create_batch_start_allVisible to othersCreate a new start all for a batch. Has effects visible outside this system. API summary: Start every draft session in the batch.
  • create_bill_item_ai_suggestionChanges dataCreate a new ai suggestion for a bill item. API summary: Get AI suggestions for a bill item.
  • create_bill_item_prorate_allocateChanges dataCreate a new prorate allocate for a bill item. API summary: Prorate allocation for a bill item.
  • create_bomChanges dataCreate a new bom. Required: name or items. Search boms first to avoid duplicates. API summary: Create a BOM.
  • create_bulkVisible to othersCreate a new bulk. Required: supplier id or items. Has effects visible outside this system. API summary: Bulk upsert supplier SKUs.
  • create_bulk_attach_bomVisible to othersCreate a new bulk attach bom. Required: items. Has effects visible outside this system. API summary: Bulk attach BOMs to products.
  • create_bulk_bulk_create_integration_field_mappingsVisible to othersCreate a new bulk. Required: mappings. Has effects visible outside this system. API summary: Bulk create integration field mappings.
  • create_bulk_bulk_create_work_ordersVisible to othersCreate a new bulk. Required: work orders. Has effects visible outside this system. API summary: Bulk create work orders.
  • create_bulk_deleteVisible to othersCreate a new bulk delete. Required: lot ids. Has effects visible outside this system. API summary: Bulk delete lots.
  • create_bulk_delete_bulk_delete_integration_field_mappingsVisible to othersCreate a new bulk delete. Required: ids. Has effects visible outside this system. API summary: Bulk delete integration field mappings.
  • create_bulk_refreshVisible to othersCreate a new bulk refresh. Required: sales order ids. Has effects visible outside this system. API summary: Bulk refresh sales orders.
  • create_carton_templateChanges dataCreate a new carton template. Required: name. Search carton templates first to avoid duplicates. API summary: Create a carton template.
  • create_channelChanges dataCreate a new channel. Required: channel type or label. API summary: Create channel.
  • create_channel_productChanges dataCreate a new product for a channel. Required: items. Search products first to avoid duplicates. API summary: Sync channel integration products.
  • create_channel_test_restrictionChanges dataCreate a new test restriction for a channel. API summary: Test channel restrictions against a sample order.
  • create_companyChanges dataCreate a customer company with a `name`, optionally address, phone, payment term, price level and tax exemption.
  • create_company_addressChanges dataCreate a new address for a company. Required: address 1, city, state, country or zip. Search addresses first to avoid duplicates. API summary: Create shipping address.
  • create_contactChanges dataCreate a new contact. Required: first name. Search contacts first to avoid duplicates. API summary: Create a contact.
  • create_contact_b2b_portal_passwordDeletesCreate a new b2b portal password for a contact. Required: password. Destructive action; may require approval. API summary: Set or rotate B2B portal password.
  • create_cost_ruleChanges dataCreate a new cost rule. Required: name. Search cost rules first to avoid duplicates. API summary: Create a cost rule.
  • create_custom_fieldChanges dataCreate a new custom field. Required: label or type. API summary: Create a custom field definition.
  • create_cycle_countVisible to othersCreate a new cycle count. Has effects visible outside this system. API summary: Create a cycle count batch.
  • create_cycle_count_postChanges dataCreate a new cycle count. Required: confirm. API summary: Post a cycle count session.
  • create_cycle_count_reset_countChanges dataCreate a new reset count for a cycle count. API summary: Reset all counted quantities.
  • create_cycle_count_scanChanges dataCreate a new scan for a cycle count. API summary: Scan a barcode and record a count.
  • create_cycle_count_startChanges dataCreate a new start for a cycle count. API summary: Start counting.
  • create_editChanges dataCreate a new edit. Required: instruction. API summary: AI edit a mapping.
  • create_field_mappingChanges dataCreate a new field mapping. Required: field name, luminous value or external value. API summary: Create an integration field mapping.
  • create_field_mapping_and_retryChanges dataCreate a new field mapping. Required: app integration account id, field name, luminous value or external value. API summary: Create mapping and retry fulfillment.
  • create_fulfillment_priority_listChanges dataCreate a new fulfillment priority list. Required: name or lines. Search fulfillment priority lists first to avoid duplicates. API summary: Create a fulfillment priority list.
  • create_generateChanges dataCreate a new generate. API summary: Generate payment obligations for a purchase order.
  • create_importChanges dataCreate a new import. Required: type or rows. API summary: Submit a bulk import.
  • create_import_resumeChanges dataCreate a new resume for a import. API summary: Resume an incomplete import.
  • create_import_retry_errorChanges dataCreate a new retry error for a import. API summary: Retry errored rows.
  • create_integration_mappingChanges dataCreate a new integration mapping. Required: name or action. API summary: Create an integration mapping.
  • create_inventory_adjustmentChanges dataAdjust stock: each entry in `adjustment_entries` has warehouse_id, location_id, product (sku or product_id) and a qty_onhand change; add `remarks`.
  • create_invoiceChanges dataCreate a new invoice. Required: company id, order date, payment terms or items. API summary: Create invoice.
  • create_invoice_allocationChanges dataCreate a new allocation for a invoice. Required: body. API summary: Create a bill allocation.
  • create_invoice_auto_allocateChanges dataCreate a new auto allocate for a invoice. API summary: Auto-allocate bill.
  • create_invoice_holdChanges dataCreate a new hold for a invoice. Required: hold status or hold reason. API summary: Hold a bill.
  • create_invoice_paymentChanges dataCreate a new payment for a invoice. API summary: Record a bill payment.
  • create_invoice_postChanges dataCreate a new invoice. API summary: Post a bill.
  • create_invoice_resolve_varianceChanges dataCreate a new resolve variance for a invoice. API summary: Resolve bill variance.
  • create_invoice_unholdChanges dataCreate a new unhold for a invoice. API summary: Unhold a bill.
  • create_lotChanges dataCreate a new lot. Search lots first to avoid duplicates. API summary: Create a lot.
  • create_order_allocateChanges dataCreate a new allocate for a order. Required: sales order id or lines. API summary: Allocate a sales order onto a purchase order.
  • create_order_assembly_orderChanges dataCreate a new order. Search orders first to avoid duplicates. API summary: Create a draft assembly order for a work order.
  • create_order_assembly_order_from_bom_itemChanges dataCreate a new order. Required: rfq id or quantity. Search orders first to avoid duplicates. API summary: Create a draft assembly order from a work order BOM item.
  • create_order_assembly_orders_from_bom_itemsChanges dataCreate a new order. Search orders first to avoid duplicates. API summary: Create draft assembly orders from work order BOM items.
  • create_order_auto_generate_fulfillment_ordersChanges dataCreate a new order for a order. Search orders first to avoid duplicates. API summary: Auto-generate fulfillment orders (synchronous).
  • create_order_generate_purchase_orders_from_bomChanges dataCreate a new generate purchase orders from bom for a order. API summary: Generate purchase orders from a work order BOM.
  • create_order_generate_stepChanges dataCreate a new generate step for a order. API summary: Generate work order steps.
  • create_order_generate_transfer_orders_from_bomMoves moneyCreate a new generate transfer orders from bom for a order. Financial or irreversible action; may require approval. API summary: Generate transfer orders from a work order BOM.
  • create_order_generate_work_order_finished_goods_transfer_orderMoves moneyCreate a new order for a order. Search orders first to avoid duplicates. Financial or irreversible action; may require approval. API summary: Generate a finished goods transfer order for a work order.
  • create_order_generate_work_order_purchase_ordersChanges dataCreate a new order for a order. Search orders first to avoid duplicates. API summary: Generate purchase orders for a work order.
  • create_order_holdChanges dataCreate a new hold for a order. API summary: Hold fulfillment order.
  • create_order_hold_hold_work_orderChanges dataCreate a new hold for a order. API summary: Hold a work order.
  • create_order_inventoryChanges dataCreate a new inventory for a order. Required: rfq id or quantity. API summary: Adjust committed stock.
  • create_order_inventory_allocate_work_order_incoming_stockChanges dataCreate a new inventory for a order. Required: rfq id or allocations. API summary: Allocate incoming stock to a work order.
  • create_order_labelChanges dataCreate a new label for a order. Required: carrier code, service code or weight. API summary: Buy a shipping label for a fulfillment order.
  • create_order_material_scrapChanges dataCreate a new material scrap for a order. Required: component sku id or quantity scrapped. API summary: Record work order material scrap.
  • create_order_messageChanges dataCreate a new message for a order. Required: comment. API summary: Create a work order comment.
  • create_order_pageChanges dataCreate a new page for a order. Required: quantity produced. API summary: Create a production entry.
  • create_order_paymentChanges dataCreate a new payment for a order. Required: payment date, payment type or paid amount. API summary: Create a payment for a purchase order.
  • create_order_payment_obligationChanges dataCreate a new payment obligation for a order. Required: body. API summary: Create a payment obligation for a purchase order.
  • create_order_planChanges dataCreate a new plan for a order. API summary: Plan a work order.
  • create_order_po_linkChanges dataCreate a new po link for a order. Required: purchase order id. API summary: Add a purchase order link to a work order.
  • create_order_productChanges dataCreate a new product for a order. Required: items. Search products first to avoid duplicates. API summary: Append line items to a purchase order.
  • create_order_pushChanges dataCreate a new push for a order. API summary: Push fulfillment order to OMS.
  • create_order_push_previewChanges dataCreate a new push preview for a order. API summary: Preview fulfillment-order push mapping.
  • create_order_quick_completeChanges dataCreate a new quick complete for a order. API summary: Quick complete a work order.
  • create_order_receiveChanges dataCreate a new receive for a order. Required: completed qty. API summary: Receive finished goods.
  • create_order_reconcile_source_referenceChanges dataCreate a new reconcile source reference for a order.
  • create_order_regenerate_stepChanges dataCreate a new regenerate step for a order. API summary: Regenerate work order steps.
  • create_order_releaseChanges dataCreate a new release for a order. API summary: Release fulfillment order from hold.
  • create_order_repair_and_pushChanges dataCreate a new repair and push for a order. API summary: Repair address and push fulfillment order.
  • create_order_shipmentChanges dataCreate a new shipment for a order. API summary: Push purchase order as inbound shipment to WMS.
  • create_order_shipment_create_fulfillment_order_shipmentChanges dataCreate a new shipment for a order. Required: ship date, tracking number, carrier code, ship to or items. API summary: Create Shipment.
  • create_order_shipment_push_sales_order_fulfillmentChanges dataCreate a new shipment for a order. API summary: Push fulfillment to order source.
  • create_order_shipment_receiptChanges dataCreate a new shipment receipt for a order. Required: quantity received. API summary: Create a work order shipment receipt.
  • create_order_shipment_simulate_sales_order_fulfillmentChanges dataCreate a new shipment for a order. API summary: Simulate fulfillment for a sales order.
  • create_order_startChanges dataCreate a new start for a order. API summary: Start a work order.
  • create_order_unholdChanges dataCreate a new unhold for a order. API summary: Release a work order from hold.
  • create_order_unpushChanges dataCreate a new unpush for a order. API summary: Unpush fulfillment order from OMS.
  • create_pairing_codeChanges dataCreate a new pairing code. API summary: Mint a print station pairing code (PickFlow).
  • create_parseChanges dataCreate a new parse. Required: body. API summary: Parse bill import.
  • create_prepaymentChanges dataCreate a new prepayment. Required: body. API summary: Create a prepayment.
  • create_prepayment_applyChanges dataCreate a new apply for a prepayment. Required: body. API summary: Apply a prepayment.
  • create_print_station_projectChanges dataCreate a new project for a print station. Required: format. API summary: Enqueue a print job.
  • create_print_station_revokeChanges dataCreate a new revoke for a print station. API summary: Revoke a print station (PickFlow).
  • create_print_station_test_printChanges dataCreate a new test print for a print station. API summary: Send a test print (PickFlow).
  • create_productChanges dataCreate a product: pass fields in `body` such as name, sku, upc, type, category, supplier, unit_cost and retail_price.
  • create_product_correct_quantityChanges dataCreate a new correct quantity for a product. Required: correct qty. API summary: Correct a posted receiving-report line quantity.
  • create_product_profileChanges dataCreate a new product profile. Required: name. API summary: Create a product builder profile.
  • create_product_pushChanges dataCreate a new push for a product. Required: destination integration account id. API summary: Push a product to an OMS/WMS integration.
  • create_product_substitutionChanges dataCreate a new substitution for a product. Required: substitute product id. API summary: Add product substitution.
  • create_production_batchVisible to othersCreate a new production batch. Search production batches first to avoid duplicates. Has effects visible outside this system. API summary: Create a production batch.
  • create_production_batch_orderVisible to othersCreate a new order for a production batch. Required: work order ids. Search orders first to avoid duplicates. Has effects visible outside this system. API summary: Add work orders to a production batch.
  • create_production_batch_order_generate_production_batch_transferMoves moneyCreate a new order for a production batch. Search orders first to avoid duplicates. Financial or irreversible action; may require approval. API summary: Generate transfer orders for a production batch.
  • create_purchase_orderChanges dataCreate a purchase order: `supplier_id`, `order_date` and `items` (each sku or product_id, quantity, unit_price), plus warehouse, dates and notes.
  • create_quick_addChanges dataCreate a new quick add. API summary: Quick-add field mappings from recent orders.
  • create_quick_completeVisible to othersCreate a new quick complete. Required: work order ids. Has effects visible outside this system. API summary: Bulk quick-complete work orders.
  • create_rateChanges dataCreate a new rate. Required: body. API summary: Create a currency rate.
  • create_receiving_reportChanges dataCreate a new receiving report. Required: received date or items. API summary: Create a receiving report.
  • create_recountChanges dataCreate a new recount. Required: rfq stock location id or quantity. API summary: Recount a bin/lot row (PickFlow).
  • create_reprocessChanges dataCreate a new reprocess. API summary: Dispatch reprocess-purgatory job.
  • create_returnChanges dataCreate a new return. Required: sales order id or items. API summary: Create customer return.
  • create_saleChanges dataCreate a new sale. Required: label or warehouse group id. API summary: Create sales channel (legacy).
  • create_sales_orderChanges dataCreate a sales order: `channel_id`, `order_number`, `order_date`, `order_status` and `items` (each sku or product_id, quantity, unit_price), plus ship_to, bill_to and notes.
  • create_scriptChanges dataCreate a new script. Required: instruction. API summary: AI draft a custom-function script.
  • create_shipmentChanges dataCreate a new shipment for a shipment. Required: sales order item ids. API summary: Force-push shipment fulfillment to order source.
  • create_shipment_packageChanges dataCreate a new package for a shipment. Required: packages. API summary: Create shipment packages.
  • create_shipment_receiveChanges dataCreate a new receive for a shipment. Required: quantity received. API summary: Receive a work order shipment.
  • create_simulateChanges dataCreate a new simulate. Required: sales order ids. API summary: Simulate fulfillment-order generation (bulk).
  • create_step_skipChanges dataCreate a new skip for a step. API summary: Skip a work order step.
  • create_sub_assembly_assembly_ordersVisible to othersCreate a new sub assembly. Required: items. Has effects visible outside this system. API summary: Bulk create assembly orders for sub-assemblies.
  • create_suggest_carrierChanges dataCreate a new suggest carrier. Required: app integration account id or carrier value. API summary: Suggest carrier mapping.
  • create_supplierChanges dataCreate a supplier with a `name`, optionally address, contacts, default payment term and default warehouse.
  • create_supplier_contactChanges dataCreate a new contact for a supplier. Required: contact name or contact email. Search contacts first to avoid duplicates. API summary: Add a supplier contact.
  • create_transferMoves moneyCreate a new transfer. Required: source location id, destination location id or items. Financial or irreversible action; may require approval. API summary: Transfer inventory between locations (PickFlow).
  • create_unit_classChanges dataCreate a new unit class. Required: name. API summary: Create unit class.
  • create_unit_conversion_ruleChanges dataCreate a new unit conversion rule. Required: type, base unit of measure id, converted unit of measure id or conversion factor. API summary: Create unit conversion rule.
  • create_unit_of_measureChanges dataCreate a new unit of measure. Required: unit class id, name or description. API summary: Create unit of measure.
  • create_vendor_creditChanges dataCreate a new vendor credit. Required: body. API summary: Create a vendor credit.
  • create_vendor_credit_applyChanges dataCreate a new apply for a vendor credit. Required: body. API summary: Apply a vendor credit.
  • create_vendor_returnChanges dataCreate a new vendor return. Required: body. API summary: Create a vendor return.
  • create_vendor_return_generate_creditChanges dataCreate a new generate credit for a vendor return.
  • create_vendor_return_processChanges dataCreate a new process for a vendor return. API summary: Process a vendor return.
  • create_warehouseChanges dataCreate a new warehouse. Required: name. Search warehouses first to avoid duplicates. API summary: Create warehouse.
  • create_warehouse_groupChanges dataCreate a new warehouse group. Required: name. Search warehouse groups first to avoid duplicates. API summary: Create warehouse group.
  • create_work_orderChanges dataCreate a work order to produce `planned_qty` of a product (`produced_sku_id`) into `destination_warehouse_id`, optionally with a BOM, vendor and expected completion date.
  • delete_a_supplier_skuDeletesPermanently delete a product by supplier product sku id. Destructive action; may require approval. API summary: Delete a supplier SKU.
  • delete_a_work_orderDeletesPermanently delete a order by order id. Destructive action; may require approval. API summary: Delete a work order.
  • delete_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: Delete location.
  • delete_batchMoves moneyPermanently delete a batch by batch id. Financial or irreversible action; may require approval. API summary: Delete a batch and all its sessions.
  • delete_bomDeletesPermanently delete a bom by bom id. Destructive action; may require approval. API summary: Delete BOM.
  • delete_bulksMoves moneyPermanently delete a bulk. Financial or irreversible action; may require approval. API summary: Bulk delete work orders.
  • delete_carton_templateDeletesPermanently delete a carton template by carton template id. Destructive action; may require approval.
  • delete_channelDeletesPermanently delete a channel by channel id. Destructive action; may require approval. API summary: Delete channel.
  • delete_comment_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete a work order comment attachment.
  • delete_companyDeletesPermanently delete a company by company id. Destructive action; may require approval.
  • delete_company_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: Delete shipping address.
  • delete_contactDeletesPermanently delete a contact by contact id. Destructive action; may require approval.
  • delete_cost_ruleDeletesPermanently delete a cost rule by cost rule id. Destructive action; may require approval.
  • delete_custom_fieldDeletesPermanently delete a custom field by custom field id. Destructive action; may require approval. API summary: Delete a custom field definition.
  • delete_cycle_countDeletesPermanently delete a cycle count by session id. Destructive action; may require approval. API summary: Delete a cycle count session.
  • delete_export_templateDeletesPermanently delete a export template by export template id. Destructive action; may require approval. API summary: Delete an export template.
  • delete_field_mappingDeletesPermanently delete a field mapping by field mapping id. Destructive action; may require approval. API summary: Delete an integration field mapping.
  • delete_fulfillment_priority_listDeletesPermanently delete a fulfillment priority list by fulfillment priority list id. Destructive action; may require approval.
  • delete_integration_mappingDeletesPermanently delete a integration mapping by integration mapping id. Destructive action; may require approval. API summary: Delete an integration mapping.
  • delete_invoice_allocationDeletesPermanently delete a allocation by allocation id. Destructive action; may require approval. API summary: Delete a bill allocation.
  • delete_invoice_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete a bill attachment.
  • delete_invoice_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Delete a bill payment.
  • delete_lotDeletesPermanently delete a lot by lot id. Destructive action; may require approval.
  • delete_orderDeletesPermanently delete a order by order id. Destructive action; may require approval. API summary: Delete a purchase order.
  • delete_order_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Delete a sales order attachment.
  • delete_order_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a work order comment.
  • delete_order_pageDeletesPermanently delete a page by entry id. Destructive action; may require approval. API summary: Delete a production entry.
  • delete_order_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Delete a purchase order payment.
  • delete_order_po_linkDeletesPermanently delete a po link by link id. Destructive action; may require approval. API summary: Remove a purchase order link from a work order.
  • delete_order_shipment_receiptDeletesPermanently delete a shipment receipt by receipt id. Destructive action; may require approval. API summary: Delete a work order shipment receipt.
  • delete_order_so_itemDeletesPermanently delete a order by fulfillment order id. Destructive action; may require approval. API summary: Remove sales order line from fulfillment order.
  • delete_order_supplier_portal_accessesMoves moneyPermanently delete a supplier portal access by purchase order id. Financial or irreversible action; may require approval. API summary: Revoke a supplier's portal access.
  • delete_ordersMoves moneyPermanently delete a order. Financial or irreversible action; may require approval. API summary: Bulk remove work orders from batches.
  • delete_print_stationDeletesPermanently delete a print station by print station id. Destructive action; may require approval. API summary: Delete a print station (PickFlow).
  • delete_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: Delete product.
  • delete_product_categoriesMoves moneyPermanently delete a category by product id. Financial or irreversible action; may require approval. API summary: Clear a product's size-curve category.
  • delete_product_distribution_templatesMoves moneyPermanently delete a distribution template by product id. Financial or irreversible action; may require approval. API summary: Clear a product's distribution template assignment.
  • delete_product_profileDeletesPermanently delete a product profile by product profile id. Destructive action; may require approval. API summary: Delete a product builder profile.
  • delete_product_substitutionDeletesPermanently delete a substitution by substitution id. Destructive action; may require approval. API summary: Remove product substitution.
  • delete_production_batchMoves moneyPermanently delete a production batch by batch id. Financial or irreversible action; may require approval.
  • delete_production_batch_orderMoves moneyPermanently delete a order by order id. Financial or irreversible action; may require approval. API summary: Remove a work order from a production batch.
  • delete_productsMoves moneyPermanently delete a product. Financial or irreversible action; may require approval. API summary: Delete alternate SKU.
  • delete_returnDeletesPermanently delete a return by return id. Destructive action; may require approval. API summary: Delete customer return.
  • delete_supplierDeletesPermanently delete a supplier by supplier id. Destructive action; may require approval.
  • delete_unit_classDeletesPermanently delete a unit class by unit class id. Destructive action; may require approval. API summary: Delete unit class.
  • delete_unit_conversion_ruleDeletesPermanently delete a unit conversion rule by unit conversion rule id. Destructive action; may require approval. API summary: Delete unit conversion rule.
  • delete_unit_of_measureDeletesPermanently delete a unit of measure by unit of measure id. Destructive action; may require approval. API summary: Delete unit of measure.
  • delete_vendor_credit_applicationDeletesPermanently delete a application by application id. Destructive action; may require approval. API summary: Delete a vendor credit application.
  • delete_warehouseDeletesPermanently delete a warehouse by warehouse id. Destructive action; may require approval. API summary: Delete warehouse.
  • delete_warehouse_groupDeletesPermanently delete a warehouse group by warehouse group id. Destructive action; may require approval. API summary: Delete warehouse group.
  • detach_bom_to_productMoves moneyDetach a bom (product id). Financial or irreversible action; may require approval. API summary: Detach BOMs from a product.
  • detach_invoice_to_dealDeletesDetach a invoice (invoice id). Destructive action; may require approval. API summary: Unlink a bill from a deal.
  • detach_invoice_to_payment_obligationDeletesDetach a invoice (invoice id). Destructive action; may require approval. API summary: Unlink a bill from a payment obligation.
  • detach_order_to_dealDeletesDetach a order (order id). Destructive action; may require approval. API summary: Unlink a supplier PO from a deal.
  • detach_order_to_deal_unlink_work_order_from_dealDeletesDetach a order (order id). Destructive action; may require approval. API summary: Unlink a work order from a deal.
  • detach_tagDeletesDetach a tag (tag id). Destructive action; may require approval. API summary: Detach a tag from a record.
  • detach_tag_to_orderDeletesDetach a tag (tag). Destructive action; may require approval. API summary: Detach a tag from a fulfillment order.
  • download_a_bill_attachmentDownload the document for a document. API summary: Download a bill attachment.
  • download_a_work_order_comment_attachmentDownload the document for a document. API summary: Download a work order comment attachment.
  • download_documentDownload the document for a document. API summary: Download a sales order attachment.
  • download_importDownload the document for a import. API summary: Download the original import file.
  • export_agingsExport agings. API summary: Inventory aging export.
  • export_batchesExport batches. API summary: Export the batch-level variance report as CSV.
  • export_consumptionsExport consumptions. API summary: Consumption report export.
  • export_cycle_countsExport cycle counts. API summary: Export the session-level variance report as CSV.
  • export_edisExport edis. API summary: EDI report CSV export.
  • export_forecast_dataExport forecast data. API summary: Materialized forecast export.
  • export_forecast_warehouse_dataExport forecast warehouse data. API summary: Warehouse forecast export.
  • export_inventoriesExport inventories. Results are paginated. API summary: Export inventory stock (cursor pagination).
  • export_inventory_costsExport inventory costs. Results are paginated. API summary: Export Core inventory costs.
  • export_ordersExport orders. Results are paginated. API summary: Export sales orders (incremental).
  • export_paymentsExport payments. Results are paginated. API summary: Export Core inventory transactions.
  • export_production_batchesExport production batches. API summary: Export a production batch.
  • export_productsExport products. Results are paginated. API summary: Export products (cursor pagination).
  • export_sub_assembliesChanges dataExport sub assemblies. API summary: Export production batch sub-assemblies.
  • export_templatesExport templates. Results are paginated. API summary: List export templates.
  • get_a_single_non_posted_orderGet one order by sales order id. API summary: Get a single non-posted order.
  • get_a_supplier_skuGet one product by supplier product sku id. API summary: Get a supplier SKU.
  • get_accountGet one account by account id. API summary: Get integration account.
  • get_addressGet one address by address id. API summary: Get location by ID.
  • get_adjustmentGet one adjustment by adjustment id. API summary: Inventory adjustment.
  • get_batchGet one batch by batch id. API summary: Get a cycle count batch.
  • get_billable_lines_for_a_work_orderList billable lines for a order. API summary: Get billable lines for a work order.
  • get_bomGet one bom by bom id. API summary: Single BOM.
  • get_bulk_statusChanges dataGet the current status of a bulk. API summary: Bulk update work order status.
  • get_bulk_status_statusChanges dataGet the current status of a bulk. API summary: Bulk update production batch status.
  • get_carton_templateGet one carton template by carton template id. API summary: Single carton template.
  • get_channelGet one channel by channel id. API summary: Get channel.
  • get_companyGet one customer company by `company_id`.
  • get_contactGet one contact by contact id. API summary: Single contact.
  • get_cost_layerGet one cost layer by cost layer id. API summary: Get cost layer by ID.
  • get_cost_ruleGet one cost rule by cost rule id. API summary: Single cost rule.
  • get_custom_fieldGet one custom field by custom field id. API summary: Get a custom field definition.
  • get_custom_field_valuesList custom fields. API summary: Get custom field values.
  • get_cycle_countGet one cycle count by session id. API summary: Get a cycle count session.
  • get_dealGet one deal by deal id. API summary: Single deal.
  • get_export_templateGet one export template by export template id. API summary: Get an export template.
  • get_field_mappingGet one field mapping by field mapping id. API summary: Get an integration field mapping.
  • get_forecast_dataGet one forecast data by forecast data id. API summary: Forecast row by materialized row ID.
  • get_forecast_data_statusGet one forecast data. API summary: Forecast table refresh metadata.
  • get_forecast_warehouse_dataGet one forecast warehouse data by forecast warehouse data id. API summary: Warehouse forecast row by ID.
  • get_forecast_warehouse_data_statusGet one forecast warehouse data. API summary: Warehouse forecast refresh metadata.
  • get_fulfillment_orderGet one order by order id. API summary: Get fulfillment order.
  • get_fulfillment_priority_listGet one fulfillment priority list by fulfillment priority list id. API summary: Get a fulfillment priority list.
  • get_importGet one import by import id. API summary: Preview the import file rows.
  • get_import_by_idGet one import by import id. API summary: Get import by ID.
  • get_inbound_shipmentGet one shipment by shipment id. API summary: Get inbound shipment.
  • get_integration_mappingGet one integration mapping by integration mapping id. API summary: Get an integration mapping.
  • get_integration_mapping_versionGet one version for a integration mapping by version id. API summary: Get a single mapping version.
  • get_inventory_costGet one inventory cost by cost id. API summary: Get a Core inventory cost.
  • get_invoiceGet one customer invoice by `invoice_id`.
  • get_invoice_get_bill_by_idGet one invoice by invoice id. API summary: Single bill.
  • get_invoice_statusChanges dataGet the current status of a invoice by bill id. API summary: Update bill status.
  • get_lotGet one lot by lot id. API summary: Get a lot.
  • get_order_get_bills_by_purchase_orderGet one order by order id. API summary: Bills by purchase order.
  • get_order_get_transfer_orderGet one order by order id. API summary: Single transfer order.
  • get_order_shipmentGet one shipment for a order by shipment id. API summary: Get shipment by purchase order.
  • get_order_status_historyGet the current status of a order by work order id. API summary: Get status history.
  • get_paymentGet one payment by transaction id. API summary: Get a Core inventory transaction.
  • get_payment_obligationGet one payment obligation by payment obligation id. API summary: Get a payment obligation.
  • get_payment_obligation_statusChanges dataGet the current status of a payment obligation by payment obligation id. API summary: Update payment obligation status.
  • get_payment_obligations_dashboardList dashboards. API summary: Get payment obligations dashboard.
  • get_picklistGet one picklist by picklist id. API summary: Get a picklist.
  • get_price_levelGet one price level by level id.
  • get_price_scheduleGet one price schedule by schedule id.
  • get_productGet one product by `product_id`, with SKU, prices, dimensions and supplier.
  • get_product_get_forecast_data_by_productGet one product by rfq id. API summary: Forecast row by product (RFQ) ID.
  • get_product_get_forecast_warehouse_data_by_productGet one product by rfq id. API summary: All warehouse-group forecast rows for a product.
  • get_product_profileGet one product profile by product profile id. API summary: Get a product builder profile.
  • get_production_batchGet one production batch by batch id. API summary: Get a production batch.
  • get_production_batch_statusChanges dataGet the current status of a production batch by batch id. API summary: Update production batch status.
  • get_production_batch_status_historyGet the current status of a production batch by batch id. API summary: List status history for a production batch.
  • get_purchase_orderGet one purchase order by `order_id`, with items and receiving status.
  • get_receiving_reportGet one receiving report by receiving report id. API summary: Single receiving report.
  • get_returnGet one return by return id. API summary: Single customer return.
  • get_sales_orderGet one sales order by `order_id`, with items, addresses and status.
  • get_shipmentGet one shipment by shipment id. API summary: Get purchase order shipment.
  • get_supplierGet one supplier by `supplier_id`.
  • get_supplier_get_bills_by_vendorGet one supplier by supplier id. API summary: Bills by vendor.
  • get_unit_classGet one unit class by unit class id. API summary: Single unit class.
  • get_unit_conversion_ruleGet one unit conversion rule by unit conversion rule id. API summary: Single unit conversion rule.
  • get_unit_of_measureGet one unit of measure by unit of measure id. API summary: Single unit of measure.
  • get_vendor_creditGet one vendor credit by vendor credit id. API summary: Get a vendor credit.
  • get_vendor_returnGet one vendor return by vendor return id. API summary: Get a vendor return.
  • get_warehouseGet one warehouse by warehouse id. API summary: Get warehouse by ID.
  • get_warehouse_groupGet one warehouse group by warehouse group id. API summary: Get warehouse group by ID.
  • get_work_orderGet one work order by `order_id`.
  • list_account_productsList products for a account. Optional filters: sku or lum sku id. Results are paginated. API summary: List OMS product links.
  • list_account_shipping_methodsList shipping methods for a account. API summary: List OMS shipping methods.
  • list_account_warehousesList warehouses for a account. API summary: List OMS warehouses.
  • list_account_write_schemasList write schemas for a account. Optional filters: action or refresh. API summary: Get the write schema for a push action.
  • list_accountsList accounts. Optional filters: app. Results are paginated. API summary: List integration accounts.
  • list_activity_logsList activity logs. Optional filters: subject type, subject id, user type, date sort, include log name or exclude log names. Results are paginated. API summary: List activity log entries for a subject.
  • list_address_inventoriesList inventories for a address. API summary: Get bin contents.
  • list_adjustmentsList adjustments. Optional filters: sort, created at, updated at, effective date, is correction or remarks. Results are paginated. API summary: Inventory adjustments.
  • list_agingsList agings. Optional filters: as of date, sort field or sort direction. Results are paginated. API summary: Inventory aging (paginated).
  • list_agings_get_bills_agingList agings. Optional filters: as of date or vendor id. API summary: AP bills aging by vendor.
  • list_allocation_inboxesList allocation inboxes. Results are paginated. API summary: Bills allocation inbox.
  • list_assembly_order_billable_linesList billable lines for a assembly order. API summary: Get billable lines for an assembly order.
  • list_authoring_guidesList authoring guides. API summary: Get the export template authoring guide.
  • list_available_for_linkingsList available for linkings. API summary: List production batches available for linking.
  • list_availablesList availables. API summary: Get available currencies.
  • list_basesList bases. API summary: Get base currency.
  • list_batchesList batches. Optional filters: statuses, warehouse id, created at from or created at to. Results are paginated. API summary: List cycle count batches.
  • list_bill_item_eligible_linesList eligible lines for a bill item. API summary: Get eligible lines for a bill item.
  • list_billsList invoices. Results are paginated. API summary: List bills.
  • list_candidatesList candidates. API summary: List distribution template candidates for a product.
  • list_carriersList carriers. API summary: List shipping carriers.
  • list_channelsList sales channels with their IDs. A channel_id is needed to create a sales order.
  • list_check_duplicatesList check duplicates. Optional filters: vendor id or bill number. API summary: Check for duplicate bill.
  • list_companiesList companies. Optional filters: order date gte, order date lte, group by, company id eq or company id in. Results are paginated. API summary: Sales by company report.
  • list_company_addressesList addresses for a company. API summary: List shipping addresses.
  • list_company_invoicesList invoices for a company. Results are paginated.
  • list_company_ordersList orders for a company. Results are paginated. API summary: List sales orders for a company.
  • list_company_product_price_overridesList product price overrides for a company. Results are paginated. API summary: Company Product Price Overrides.
  • list_consumptionsList consumptions. Optional filters: group. Results are paginated. API summary: Consumption report (paginated).
  • list_convertsList converts. Optional filters: from, to or amount. API summary: Convert currency.
  • list_cost_layersList cost layers. Optional filters: product id, sku, warehouse id, remaining quantity, initial quantity or cost per unit. Results are paginated.
  • list_custom_fieldsList custom fields. Optional filters: object type. API summary: Get custom field definitions.
  • list_customer_topologiesList customer topologies. API summary: Customer operational topology snapshot.
  • list_cycle_count_productsList products for a cycle count. Optional filters: warehouse id. API summary: List session items.
  • list_cycle_count_progressList progress for a cycle count. Optional filters: warehouse id. API summary: Session counting-progress summary.
  • list_cycle_count_templatesList templates for a cycle count. API summary: Download the CSV count-sheet template.
  • list_cycle_countsList cycle counts. Optional filters: warehouse id. API summary: List active sessions for a warehouse.
  • list_dashboardsList dashboards. Optional filters: warehouse id. API summary: Discrepancy dashboard summary.
  • list_deal_invoicesList invoices for a deal. API summary: List bills linked to a deal.
  • list_deal_ordersList orders for a deal. API summary: List supplier POs linked to a deal.
  • list_dealsList deals. Optional filters: pipeline id, stage id, status or business account id. Results are paginated.
  • list_edisList edis. Optional filters: edi type, transaction status, direction, order id, control number or has received 997. Results are paginated. API summary: EDI documents (paginated).
  • list_field_mappingsList field mappings. Optional filters: app integration account id, field name, mapping group or global only. API summary: List integration field mappings.
  • list_fieldsList fields. Optional filters: app integration account id. API summary: List mapping field names.
  • list_forecast_dataList forecast data. Results are paginated. API summary: Materialized forecast rows (paginated).
  • list_forecast_warehouse_dataList forecast warehouse data. Results are paginated. API summary: Materialized forecast by warehouse group (paginated).
  • list_fulfillment_ordersList fulfillment orders, filtered by `order_status`, `sales_order_id`, `ship_by_date` and more.
  • list_groupsList groups. Optional filters: app integration account id. API summary: List mapping groups.
  • list_import_errorsList errors for a import. API summary: Download import errors.
  • list_import_typesList types. API summary: List import types.
  • list_importsList imports. Optional filters: type. Results are paginated.
  • list_integration_mapping_versionsList versions for a integration mapping. API summary: List a mapping's version history.
  • list_integration_mappingsList integration mappings. Results are paginated.
  • list_inventoryList stock levels (on hand, available, incoming, backordered) by product, filtered by `sku`, `product_id`, `warehouse_ids` and more.
  • list_inventory_discrepanciesList inventory discrepancies. Optional filters: warehouse id. API summary: Stock / cost-layer discrepancy rows.
  • list_invoice_allocationsList allocations for a invoice. API summary: List bill allocations.
  • list_invoice_billable_linesList billable lines for a invoice. API summary: Get bill billable lines.
  • list_invoice_candidate_linesList candidate lines for a invoice. API summary: Get bill candidate lines.
  • list_invoice_sync_errorsList invoice sync errors. Optional filters: from date or end date. API summary: Close the Books — invoice sync errors.
  • list_invoice_variancesList variances for a invoice. API summary: Get bill variance.
  • list_invoicesList customer invoices, filtered by `status`, `payment_status`, `company_id`, `due_date` and more.
  • list_non_posted_purgatory_sales_ordersList orders. Optional filters: order number, order status, channel name, tag, created at or updated at. Results are paginated. API summary: List non-posted (purgatory) sales orders.
  • list_options_schemasList options schemas. Optional filters: type. API summary: Get the options-mode form schema.
  • list_order_activity_logsList activity logs for a order. Optional filters: user type or date sort. Results are paginated. API summary: List fulfillment-order activity logs.
  • list_order_allocation_availabilitiesList allocation availabilities for a order. API summary: Get purchase-to-order allocation availability.
  • list_order_ao_linksList ao links for a order. API summary: List work order assembly order links.
  • list_order_billable_linesList billable lines for a order. API summary: Get billable lines for a purchase order.
  • list_order_completionsList completions for a order. API summary: List work order step completions.
  • list_order_documentsList documents for a order. API summary: List sales order attachments.
  • list_order_eventsList events for a order. API summary: Get work order events.
  • list_order_inventoriesList inventories for a order. Optional filters: rfq ids. API summary: Get work order sub-assembly stock.
  • list_order_material_scrapsList material scraps for a order. API summary: List work order material scrap.
  • list_order_messagesList messages for a order. API summary: List work order comments.
  • list_order_pagesList pages for a order. API summary: List production entries.
  • list_order_payment_obligationsList payment obligations for a order. API summary: List payment obligations for a purchase order.
  • list_order_po_linksList po links for a order. API summary: List work order purchase order links.
  • list_order_productsList products for a order. API summary: List work order BOM items.
  • list_order_push_readinessesList push readinesses for a order. API summary: Check fulfillment-order push readiness.
  • list_order_quality_inspectionsList quality inspections for a order. Results are paginated. API summary: List quality inspections for a purchase order.
  • list_order_raw_materialsList raw materials for a order. API summary: List work order raw materials.
  • list_order_receiving_reportsList receiving reports for a order. API summary: List work order receiving reports.
  • list_order_shipment_receiptsList shipment receipts for a order. API summary: List work order shipment receipts.
  • list_order_shipmentsList shipments for a order. Optional filters: updated at or reference number. Results are paginated. API summary: List shipments for a purchase order.
  • list_order_stepsList steps for a order. API summary: List work order steps.
  • list_order_supplier_acceptancesList supplier acceptances for a order. Results are paginated. API summary: List supplier acceptance responses.
  • list_order_supplier_extra_cost_requestsList supplier extra cost requests for a order. Results are paginated. API summary: List supplier extra-cost requests.
  • list_order_tagsList tags for a order. API summary: Get tags on a fulfillment order.
  • list_packagesList packages. Optional filters: carrier code. API summary: List package types for a carrier.
  • list_payment_obligationsList payment obligations. Results are paginated.
  • list_paymentsList payments. Optional filters: date gte, date lte, warehouse id in, transaction type in, linked type or item id. Results are paginated. API summary: List Core inventory transactions.
  • list_picklist_wip_lotsList wip lots for a picklist. API summary: List lots staged in a picklist's WIP bin.
  • list_picklistsList picklists. Optional filters: id, status, order number, requested shipping service, channel name or channel id. Results are paginated.
  • list_placeholdersList placeholders. Optional filters: type. API summary: List placeholders for a template type.
  • list_prefillsList prefills. Optional filters: shipment ids. API summary: Prefill bill from shipments.
  • list_prepaymentsList prepayments. Results are paginated.
  • list_print_stationsList print stations. API summary: List print stations (PickFlow alias).
  • list_print_stations_list_print_stationsList print stations.
  • list_product_company_pricingsList company pricings for a product. Optional filters: company id. API summary: Single product with company pricing.
  • list_product_inventoriesList inventories for a product. Optional filters: warehouse id. API summary: Get product stock by bin.
  • list_product_lotsList lots for a product. API summary: List a product's lots.
  • list_product_pricingsList pricings for a product. API summary: Single product pricing.
  • list_product_profile_resolvedsList resolveds for a product profile. API summary: Get a product profile with builder metadata.
  • list_product_profilesList product profiles. API summary: List product builder profiles.
  • list_product_remap_previewsList remap previews for a product. Optional filters: product id or force. API summary: Preview a sales-order item remap.
  • list_production_batch_ao_linksList ao links for a production batch. API summary: List assembly order links for a production batch.
  • list_production_batch_billable_linesList billable lines for a production batch. API summary: Get billable lines for a production batch.
  • list_production_batch_eventsList events for a production batch.
  • list_production_batch_po_linksList po links for a production batch. API summary: List purchase order links for a production batch.
  • list_production_batch_receiving_reportsList receiving reports for a production batch.
  • list_production_batch_sub_assembliesList sub assemblies for a production batch. API summary: List sub-assemblies for a production batch.
  • list_production_batch_summariesList summaries for a production batch. API summary: Get production batch summary.
  • list_productsList products. Optional filters: purchase order id, source sku, quantity, quantity received, quantity shipped or quantity billed. Results are paginated. API summary: Purchase order items.
  • list_purchase_ordersList purchase orders, filtered by `supplier_id`, `order_status`, `warehouse_id`, `order_date` and more.
  • list_quotesList quotes. Optional filters: warehouse ids, scope type, product ids or lot ids. API summary: SKU-mode item-count estimate per warehouse.
  • list_quotes_get_pickflow_cycle_count_bin_location_estimateList quotes. Optional filters: warehouse ids, scope type, product ids, lot ids or location ids. API summary: Bin-location-mode item-count estimate per warehouse.
  • list_ratesList rates. API summary: List currency rates.
  • list_receivablesList receivables. Optional filters: product id or warehouse id. API summary: List open PO lines to receive a product against.
  • list_receiving_report_billable_linesList billable lines for a receiving report. Optional filters: include extra costs. API summary: Get billable lines for a receiving report.
  • list_receiving_reportsList receiving reports. Optional filters: tracking number, received by, shipped via, received date, created at or updated at. Results are paginated.
  • list_recentsList recents. Results are paginated. API summary: List recent print jobs (PickFlow).
  • list_resolvesList resolves. Optional filters: product id, base unit of measure id or converted unit of measure id. API summary: Resolve effective conversion rule.
  • list_resolves_resolve_pickflow_scanList resolves. Optional filters: code, product codes or warehouse id. API summary: Resolve a scanned barcode.
  • list_restriction_fieldsList restriction fields. API summary: List channel restriction fields.
  • list_returnsList returns. Results are paginated. API summary: List customer returns.
  • list_sales_order_shipmentsList shipments for a sales order by `sales_order_id`.
  • list_sales_ordersList sales orders, filtered by `order_number`, `order_status`, `customer_id`, `company_id`, `channel_id`, `order_date` and more.
  • list_sales_summariesList sales summaries. Optional filters: from date or end date. API summary: Close the Books — sales summary by channel.
  • list_schemasList schemas. API summary: Get purgatory settings schema.
  • list_servicesList services. Optional filters: carrier code. API summary: List shipping services for a carrier.
  • list_settingsList settings. API summary: Get purgatory automation settings.
  • list_shipment_billable_linesList billable lines for a shipment. API summary: Get billable lines for a shipment.
  • list_shipmentsList shipments. Optional filters: updated at, created at, shipping date, last synced at, id or purchase order id. Results are paginated. API summary: Purchase order shipments.
  • list_shipments_get_inbound_shipmentsList shipments. Optional filters: updated at, created at, arrival date, external status, external shipment id or purchase order id. Results are paginated. API summary: Inbound shipments.
  • list_specsList specs. Optional filters: type. API summary: Field schema for an import type.
  • list_summariesList summaries. Optional filters: date from, date to or edi type. API summary: EDI aggregate summary.
  • list_summaries_get_bills_summaryList summaries. API summary: Bills summary.
  • list_supplier_contactsList contacts for a supplier. API summary: Supplier contacts.
  • list_supplier_skusList products. Optional filters: product id, supplier id, sku, unit cost, created at or updated at. Results are paginated. API summary: List supplier SKUs.
  • list_tagsList tags. API summary: Get tags for a record.
  • list_transaction_cogsList transaction cogs. Optional filters: from date, to date, product name, sku, channel or order number. Results are paginated. API summary: Transaction COGS (paginated, read-only).
  • list_transformationsList transformations. API summary: List available transformations.
  • list_typesList types. API summary: List export template types.
  • list_unit_classesList unit classes. Results are paginated.
  • list_unit_conversion_rulesList unit conversion rules. Results are paginated.
  • list_unit_of_measuresList unit of measures. Results are paginated. API summary: List units of measure.
  • list_vendor_creditsList vendor credits. Results are paginated.
  • list_vendor_returnsList vendor returns. Results are paginated.
  • list_vendor_statementsList statements for a vendor. API summary: Get vendor statement.
  • list_warehousesList warehouses by `name`, with paging.
  • list_work_order_shipmentsList shipments for a order. API summary: List work order shipments.
  • list_work_orders_linked_to_a_dealList orders for a deal. API summary: List work orders linked to a deal.
  • pay_orderMoves moneyTransfer a order. Financial or irreversible action; may require approval. Results are paginated. API summary: Transfer orders.
  • refund_applicationMoves moneyReverse a application (application id). Financial or irreversible action; may require approval. API summary: Reverse a prepayment application.
  • refund_application_reverseMoves moneyReverse a application (application id). Financial or irreversible action; may require approval. API summary: Reverse a vendor credit application.
  • refund_order_allocationMoves moneyReverse a order. Financial or irreversible action; may require approval. API summary: Reverse (unallocate) an allocation peg.
  • reject_invoiceVisible to othersReject a invoice (invoice id). Has effects visible outside this system. API summary: Reject invoice.
  • search_addressesSearch addresses by name or is pick location. Use this to find existing addresses before creating a new address. Results are paginated. API summary: Locations.
  • search_bomsSearch boms by name, created at, updated at, item product id, item product sku or item product name. Use this to find existing boms before creating a new bom. Results are paginated.
  • search_carton_templatesSearch carton templates by active only or search. Use this to find existing carton templates before creating a new carton template. API summary: List carton templates.
  • search_companiesSearch customer companies by `name`, city, status, type or phone, with paging.
  • search_company_contactsSearch contacts for a company by first name, last name, email, phone, status or company name. Use this to find existing contacts before creating a new contact. Results are paginated. API summary: Company Contacts.
  • search_company_pricingsSearch company pricings by company id, q, name, description, sku or upc. Use this to find existing company pricings before creating a new company pricing. Results are paginated. API summary: All products with company pricing.
  • search_company_productsSearch products for a company by q, name, description, sku, upc or sellable. Use this to find existing products before creating a new product. Results are paginated. API summary: Company Products.
  • search_contactsSearch contacts by name, `email`, `phone` or `company_name`.
  • search_cost_rulesSearch cost rules by vendor id, status, document type, name, search or description. Use this to find existing cost rules before creating a new cost rule. Results are paginated. API summary: List cost rules.
  • search_fulfillment_priority_listsSearch fulfillment priority lists by id or name. Use this to find existing fulfillment priority lists before creating a new fulfillment priority list. Results are paginated. API summary: List fulfillment priority lists.
  • search_inventory_costsSearch inventory costs by date gte, date lte, linked type, cost id, item id or cost basis. Use this to find existing inventory costs before creating a new inventory cost. Results are paginated. API summary: List Core inventory costs.
  • search_locations_bins_within_a_warehouseSearch addresses by search. Use this to find existing addresses before creating a new address. Results are paginated. API summary: Search locations (bins) within a warehouse.
  • search_lotsSearch lots by search. Use this to find existing lots before creating a new lot. Results are paginated.
  • search_price_levelsSearch price levels by sort, name, type or percent increase. Use this to find existing price levels before creating a new price level. Results are paginated.
  • search_price_schedulesSearch price schedules by name, counting algorithm or modification type. Use this to find existing price schedules before creating a new price schedule. Results are paginated.
  • search_pricingsSearch pricings by q, name, description, sku, upc or sellable. Use this to find existing pricings before creating a new pricing. Results are paginated. API summary: All products pricing.
  • search_production_batchesSearch production batches by sort by, sort direction, search, status or vendor id. Use this to find existing production batches before creating a new production batch. Results are paginated. API summary: List production batches.
  • search_productsSearch products with `q` (name, UPC or SKU) or filters such as `sku`, `category_id`, `supplier_id`, `discontinued`, with paging.
  • search_products_searchSearch products by search. Use this to find existing products before creating a new product. Results are paginated.
  • search_stock_snapshotsSearch stock snapshots by start date, end date, warehouse id, sku, sku prefix or id. Use this to find existing stock snapshots before creating a new stock snapshot. Results are paginated. API summary: Stock snapshot (JSON, CSV, or Excel).
  • search_suppliersSearch suppliers by `name`, city, state or country, with paging.
  • search_warehouse_binsSearch bins for a warehouse by name or search. Use this to find existing bins before creating a new bin. Results are paginated. API summary: Search bins in a warehouse.
  • search_warehouse_groupsSearch warehouse groups by name. Use this to find existing warehouse groups before creating a new warehouse group. Results are paginated.
  • search_work_ordersSearch work orders (manufacturing) by `search`, `status`, `work_order_number` or vendor.
  • send_invoice_emailVisible to othersSend a invoice (invoice id). Has effects visible outside this system. API summary: Email a Draft invoice.
  • send_supplier_portal_linkVisible to othersSend a supplier portal link (purchase order id). Has effects visible outside this system. API summary: Mint and email a supplier portal link.
  • submit_channelVisible to othersLock a channel (channel id). Has effects visible outside this system. API summary: Lock channel.
  • submit_cycle_countVisible to othersReopen a cycle count (session id). Has effects visible outside this system. API summary: Reopen for counting.
  • submit_cycle_count_reviewVisible to othersSubmit a cycle count (session id). Has effects visible outside this system. API summary: Submit for review.
  • submit_export_templateVisible to othersValidate a export template. Has effects visible outside this system. API summary: Validate an export template draft.
  • submit_export_template_previewVisible to othersPreview a export template. Has effects visible outside this system. API summary: Preview an unsaved export template draft.
  • submit_export_template_preview_saved_export_templateVisible to othersPreview a export template (export template id). Has effects visible outside this system. API summary: Preview a saved export template.
  • submit_importVisible to othersCopy a import (import id). Has effects visible outside this system. API summary: Copy an import.
  • submit_integration_mappingVisible to othersPreview a integration mapping (integration mapping id). Has effects visible outside this system. API summary: Preview a mapping (dry run).
  • submit_invoiceVisible to othersReopen a invoice (bill id). Has effects visible outside this system. API summary: Reopen a bill.
  • submit_invoice_due_dateVisible to othersCalculate a invoice. Has effects visible outside this system. API summary: Calculate bill due date.
  • submit_labelVisible to othersRender a label. Has effects visible outside this system. API summary: Render ZPL label.
  • submit_orderVisible to othersRefresh a order (sales order id). Has effects visible outside this system. API summary: Refresh a sales order.
  • submit_order_completeVisible to othersComplete a order (work order id). Has effects visible outside this system. API summary: Complete a work order.
  • submit_order_mark_shippedVisible to othersMark shipped a order (fulfillment order id). Has effects visible outside this system. API summary: Mark fulfillment order as shipped.
  • submit_order_refreshVisible to othersRefresh a order (work order id). Has effects visible outside this system. API summary: Refresh a work order.
  • submit_picklistVisible to othersComplete a picklist (picklist id). Has effects visible outside this system. API summary: Complete picking for a picklist.
  • submit_productVisible to othersCount a product (item id). Has effects visible outside this system. API summary: Record a count for one item.
  • submit_production_batchDeletesRefresh a production batch (batch id). Destructive action; may require approval.
  • submit_production_batch_statusDeletesSync a production batch (batch id). Destructive action; may require approval. API summary: Sync production batch status.
  • submit_stepVisible to othersComplete a step (step id). Has effects visible outside this system. API summary: Complete a work order step.
  • update_a_billChanges dataUpdate an existing invoice identified by invoice id. API summary: Update a bill.
  • update_a_supplier_skuChanges dataUpdate an existing product identified by supplier product sku id. API summary: Update a supplier SKU.
  • update_a_work_orderChanges dataUpdate an existing order identified by order id. API summary: Update a work order.
  • update_addressChanges dataUpdate an existing address identified by address id. Only the fields you pass are changed. API summary: Update location.
  • update_basesVisible to othersUpdate an existing base. Has effects visible outside this system. API summary: Set base currency.
  • update_bomChanges dataUpdate an existing bom identified by bom id. API summary: Update a BOM.
  • update_carton_templateChanges dataUpdate an existing carton template identified by carton template id. Only the fields you pass are changed. API summary: Update a carton template (PATCH).
  • update_channelChanges dataUpdate an existing channel identified by channel id. API summary: Update channel.
  • update_companyChanges dataUpdate an existing company identified by company id. API summary: Update a company.
  • update_company_addressChanges dataUpdate an existing address identified by address id. API summary: Update shipping address.
  • update_contactChanges dataUpdate an existing contact identified by contact id. API summary: Update a contact.
  • update_cost_ruleChanges dataUpdate an existing cost rule identified by cost rule id. API summary: Update a cost rule.
  • update_custom_fieldChanges dataUpdate an existing custom field identified by custom field id. Only the fields you pass are changed. API summary: Partially update a custom field definition.
  • update_custom_field_choicesVisible to othersUpdate an existing choice identified by custom field id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Add or remove dropdown choices.
  • update_custom_fieldsVisible to othersUpdate an existing custom field identified by record id. Has effects visible outside this system. API summary: Update custom field values.
  • update_export_templateChanges dataUpdate an existing export template identified by export template id. Only the fields you pass are changed. API summary: Update an export template (PATCH).
  • update_export_template_defaultChanges dataUpdate an existing export template identified by export template id. API summary: Set an export template as default.
  • update_field_mappingChanges dataUpdate an existing field mapping identified by field mapping id. API summary: Update an integration field mapping.
  • update_fulfillment_priority_listChanges dataUpdate an existing fulfillment priority list identified by fulfillment priority list id. API summary: Update a fulfillment priority list.
  • update_integration_mappingChanges dataUpdate an existing integration mapping identified by integration mapping id. API summary: Update an integration mapping.
  • update_invoiceChanges dataUpdate an existing invoice identified by invoice id. Only the fields you pass are changed. API summary: Update invoice.
  • update_lotChanges dataUpdate an existing lot identified by lot id. Only the fields you pass are changed. API summary: Update a lot.
  • update_notesVisible to othersUpdate an existing message identified by work order id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update notes.
  • update_order_custom_fieldsVisible to othersUpdate an existing custom field identified by fulfillment order id. Has effects visible outside this system. API summary: Set custom field values on a fulfillment order.
  • update_order_custom_fields_update_work_order_custom_fieldsVisible to othersUpdate an existing custom field identified by work order id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update custom fields.
  • update_order_lineChanges dataUpdate an existing order line identified by sales order item id. Only the fields you pass are changed. API summary: Map a line item to a product / toggle flags.
  • update_order_messagesVisible to othersUpdate an existing message identified by fulfillment order id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update fulfillment order notes.
  • update_order_paymentChanges dataUpdate an existing payment identified by payment id. API summary: Update a purchase order payment.
  • update_order_shipmentChanges dataUpdate an existing shipment identified by shipment id. API summary: Update a work order shipment.
  • update_order_tagsVisible to othersUpdate an existing tag identified by fulfillment order id. Has effects visible outside this system. API summary: Replace all tags on a fulfillment order.
  • update_payment_obligationChanges dataUpdate an existing payment obligation identified by payment obligation id. API summary: Update a payment obligation.
  • update_productChanges dataUpdate a product by `product_id`: fields in `body` such as name, sku, prices, supplier, category or low-stock alert.
  • update_product_categoriesVisible to othersUpdate an existing category identified by product id. Has effects visible outside this system. API summary: Assign a size-curve category to a product.
  • update_product_distribution_templatesVisible to othersUpdate an existing distribution template identified by product id. Has effects visible outside this system. API summary: Assign a distribution template to a product.
  • update_product_lotsVisible to othersUpdate an existing lot identified by line item id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Set or clear a purchase-order line's lot.
  • update_product_profileChanges dataUpdate an existing product profile identified by product profile id. API summary: Update a product builder profile.
  • update_product_remapsVisible to othersUpdate an existing remap identified by sales order item id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Remap a sales-order item.
  • update_production_batchVisible to othersUpdate an existing production batch identified by batch id. Has effects visible outside this system. API summary: Update a production batch.
  • update_productsVisible to othersUpdate an existing product. Only the fields you pass are changed. Has effects visible outside this system. API summary: Create or update product.
  • update_purchase_orderChanges dataUpdate a purchase order by `order_id`; `supplier_id`, `order_date` and the full `items` list must be sent again.
  • update_return_receivesVisible to othersUpdate an existing receive identified by return id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Mark return received.
  • update_return_restocksVisible to othersUpdate an existing restock identified by return id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update return restock flag.
  • update_sales_orderChanges dataUpdate a sales order by `order_id`: status, ship dates, addresses, tracking number or notes.
  • update_settingsVisible to othersUpdate an existing setting. Has effects visible outside this system. API summary: Partially update purgatory settings.
  • update_supplierChanges dataUpdate an existing supplier identified by supplier id. API summary: Update a supplier.
  • update_tagsVisible to othersUpdate an existing tag identified by record id. Has effects visible outside this system. API summary: Replace all tags on a record.
  • update_transaction_cogs_costsChanges dataUpdate an existing transaction cog. API summary: Update per-line COGS from unit cost.
  • update_unit_classChanges dataUpdate an existing unit class identified by unit class id. API summary: Update unit class.
  • update_unit_class_default_unit_of_measureChanges dataUpdate an existing default unit of measure identified by unit of measure id. API summary: Set base UOM for a unit class.
  • update_unit_conversion_ruleChanges dataUpdate an existing unit conversion rule identified by unit conversion rule id. API summary: Update unit conversion rule.
  • update_unit_of_measureChanges dataUpdate an existing unit of measure identified by unit of measure id. API summary: Update unit of measure.
  • update_warehouseChanges dataUpdate an existing warehouse identified by warehouse id. API summary: Update warehouse.
  • update_warehouse_groupChanges dataUpdate an existing warehouse group identified by warehouse group id. API summary: Update warehouse group.
  • upload_cycle_count_countsChanges dataImport a cycle count (session id). API summary: Apply a validated import.

Set up in three steps

  1. 1

    Pick the app

    Create a free HeyMyApps account and choose Luminous from the app list.

  2. 2

    Paste your key

    Paste your Luminous company name (the subdomain in companyName.api.joinluminous.com) and an API token. In Luminous go to Settings > API Tokens and click Create API Token, then copy the token.

  3. 3

    Add the link to your AI

    You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:

    1. Click your name, then Settings › Connectors › Add custom connector.
    2. Paste your link as the Remote MCP server URL.
    3. Switch it on from the + menu in a chat.

Questions

What can the AI do in Luminous?

The AI can read and search products, stock levels, warehouses, sales orders, purchase orders, fulfillment orders, shipments, invoices, suppliers, customer companies, contacts, sales channels and work orders. It can create sales orders, purchase orders, work orders, inventory adjustments, products, suppliers and customer companies, and update sales orders, purchase orders and products.

Does the AI see my Luminous credentials?

No. Your Luminous company name and API token are encrypted at rest and never shown to the AI. After you save them, they are not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start read-only. Inventory adjustments change your on-hand stock, and new sales and purchase orders enter your real order flow, so those tools can require your approval before they run. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT, open Settings › Apps & Connectors › Advanced, turn on Developer mode and add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own Luminous account.

Why does Luminous need my company name?

Each Luminous account has its own API address, companyName.api.joinluminous.com. HeyMyApps uses the company name you paste to send calls to your account. The API token then decides which data the calls can reach.

Let your AI work in Luminous today.

Start free. Your key stays encrypted, and you decide what the AI may do.

Connect Luminous free

HeyMyApps is not affiliated with Luminous. Product names are trademarks of their owners.