ecellar_get_reference_data
Get reference data
Lookup lists of the winery's eCellar account: brands = brands (brand_key + name); locations = locations (location_id, name, timezone); customer_types = customer types; customer_sources = customer sources; customer_tags = customer tags; order_tags = order tags (tag groups and tags); reservation_types = reservation types; terminals = POS terminals; billing_statuses = billing statuses (enum values for the orders filter billing_statuses); purchase_statuses = order statuses (enum values for the orders filter purchase_statuses); purchase_sources = order sources (Web, POS, club, phone...); carriers = carriers (enum values for ecellar_add_order_tracking carrier_enum); payment_types = payment types; card_types = card types; note_types = customer note types; product_availabilities = product availabilities; product_statuses = product statuses; reservation_statuses = reservation statuses; fulfillment_companies = fulfillment companies; state_codes = state codes; country_codes = country codes. Use brands first: the brand_key values filter orders, club tiers, events and reservations. GET /client/* or /types/*.
Parameterskindrequired
ecellar_search_customers
Search customers
Customers (club members and buyers) with contact details, type, source, tags, email consent and default addresses. Personal data: use only what the task needs. POST /customers.
Parameterspagepage_sizecustomer_idssignup_date_endcustomer_type_idsmodified_date_endsignup_date_startmodified_date_start
ecellar_search_addresses
Search customer addresses
Customer billing and shipping addresses. POST /addresses.
Parameterspagepage_sizeaddress_idscustomer_idscreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_notes
Search customer notes
Notes on customer records (type, text, dates). POST /notes.
Parameterspagepage_sizecustomer_idscreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_orders
Search orders
Orders (web, POS, club and phone) with totals, status, billing and shipping details, and their lines, payments, tracking records and tags. Statuses are the enum values from ecellar_get_reference_data purchase_statuses / billing_statuses. Contains customer personal data. POST /orders.
Parameterspagepage_sizebrand_keyscustomer_idspurchase_idsclose_date_endcreate_date_endbilling_statusesclose_date_startcreate_date_startmodified_date_endpurchase_statuses+3 more
ecellar_search_order_lines
Search order lines
Order lines (product, SKU, quantity, price, discount, tax) across orders. POST /orders/lines.
Parameterspagepage_sizepurchase_idscreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_order_payments
Search order payments
Order payments (amount, type, billing status, dates, card brand, last digits and expiry; no card numbers). POST /orders/payments.
Parameterspagepage_sizepurchase_idscreate_date_endbilling_statusescreate_date_startmodified_date_endmodified_date_startfunds_captured_date_endfunds_captured_date_start
ecellar_search_order_trackings
Search order tracking records
Carrier tracking records of orders (carrier, tracking number, shipped and delivered dates). POST /orders/trackings.
Parameterspagepage_sizepurchase_idscreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_products
Search products
Products (wines and merchandise): name, SKU, price, vintage-related fields, categories and inventory SKUs. POST /products.
Parameterspagepage_sizecreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_product_categories
Search product categories
Product categories (tree: parent_category_id, category_id, name). POST /products/categories.
Parameterspagepage_sizecreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_get_inventory_counts
Get inventory counts
Current inventory per SKU and location: on_hand, on_hold, invoiced and available. Filter by SKUs and/or locations (ids or names from ecellar_get_reference_data locations); with no filter every SKU and location is returned. POST /inventory/counts.
Parametersskuslocation_idslocation_names
ecellar_search_club_subscriptions
Search club subscriptions
Wine club subscriptions of customers: tier, signup/cancel/hold dates, billing and shipping address, card brand, last digits and expiry (no card numbers). POST /subscriptions.
Parameterspagepage_sizecustomer_idsclub_tier_idscancel_date_endsignup_date_endcancel_date_startmodified_date_endsignup_date_startmodified_date_startcc_expiration_date_endcc_expiration_date_start
ecellar_search_club_tiers
Search club tiers
Wine club tiers (id, name, description, brand). POST /club/tiers.
Parameterspagepage_sizebrand_keyscreate_date_endcreate_date_startmodified_date_endmodified_date_start
ecellar_search_club_events
Search club events
Club events / shipments (name, date, ship group, tier, pickup location, product totals, remix window). POST /club/events.
Parameterspagepage_sizebrand_keyscreate_date_endcreate_date_startmodified_date_endclub_event_date_endmodified_date_startclub_event_date_start
ecellar_search_reservations
Search reservations
Tasting-room and experience reservations (party, times, status, host, notes, contact phone and email). POST /reservations.
Parameterspagepage_sizecreate_date_endreservation_idscreate_date_startmodified_date_endmodified_date_start
ecellar_mark_order_shipped
Mark order shipped
WRITE: set the shipped date and status of ONE order, to be used when ALL its packages have shipped. eCellar refuses it unless the order status is EXPORTED, HOLD_SHIP, SHIPPED, TO_PICKUP or UNSHIPPED, the date is not before the order date, and the date matches the latest tracking ship date. Check the order and its tracking records first. PATCH /order/{order_id}/shipped.
Parametersorder_idrequireddate_shippedrequired
ecellar_mark_order_delivered
Mark order delivered
WRITE: set the delivered date and status of ONE order, to be used when ALL its packages were delivered. eCellar refuses it unless the order status is DELIVERED or SHIPPED and the date matches the latest tracking delivered date. PATCH /order/{order_id}/delivered.
Parametersorder_idrequireddate_deliveredrequired
ecellar_add_order_tracking
Add order tracking record
WRITE: add a carrier tracking record (carrier + tracking number, optional shipped/delivered dates) to ONE order. Adds a record each call; a duplicate tracking number on the same order is refused by eCellar. Get carrier_enum from ecellar_get_reference_data carriers. POST /order/{order_id}/tracking.
Parametersorder_idrequiredcarrier_enumrequireddate_shippeddate_deliveredcarrier_tracking_numberrequired
ecellar_adjust_inventory_count
Adjust inventory count
WRITE: change the on-hand count of ONE SKU at ONE location by a signed amount (+12 adds, -3 removes; it is a delta, not a new total, so repeating it repeats the change). Pass location_id or location_name; eCellar refuses an unknown or ambiguous location, a SKU that is not at that location, or a result below zero. Check ecellar_get_inventory_counts first. PATCH /inventory/counts/{SKU}.
Parametersskurequiredlocation_idlocation_nameon_hand_adjustmentrequired