brightpearl_get_account_configuration
Get account configuration
The Brightpearl account's configuration as key/value pairs: base currency, tax scheme, time zone, default and new-order status ids, nominal codes, weight unit, whether multiple warehouses are enabled. GET /integration-service/account-configuration.
无需输入参数。
brightpearl_search_orders
Search orders
Search sales orders, sales credits, purchase orders and purchase credits. Every filter is optional and they combine (AND); each result row has orderId, orderTypeId, contactId, orderStatusId, orderStockStatusId, createdOn, updatedOn, customerRef, externalRef, warehouseId and more. Use brightpearl_get_orders for the full order. Order type ids: brightpearl_list_order_types; status ids: brightpearl_list_order_statuses. GET /order-service/order-search.
输入参数is_closedorder_idspage_sizeplaced_tocontact_idcreated_toupdated_toplaced_fromcreated_fromcustomer_refexternal_reffirst_result另有 8 个
brightpearl_get_orders
Get orders
Full details of one or more orders by id: type, status, payment/stock/shipping status, dates, currency, totals, assignment, customer/supplier, billing and delivery parties, and the order rows (product, quantity, price, tax). Up to 50 ids. GET /order-service/order/{ids}.
输入参数order_ids必填include_custom_fields
brightpearl_get_order_notes
Get order notes
All notes on one order (text, author contact id, date, whether it is public on the customer portal, the order status at the time). GET /order-service/order/{id}/note.
输入参数order_id必填
brightpearl_list_order_statuses
List order statuses
The account's order statuses (id, name, order type code SO/PO/SC/PC, sort order, disabled, visible to the customer, state such as draft). Use the ids to filter orders or to change an order's status. GET /order-service/order-status.
无需输入参数。
brightpearl_list_order_types
List order types
The four order types with their ids and codes (1 SO sales order, 2 PO purchase order, 3 SC sales credit, 4 PC purchase credit), for the order search. GET /order-service/order-type.
无需输入参数。
brightpearl_add_order_note
Add order note
WRITE: add a note to an existing order. The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server. POST /order-service/order/{id}/note.
输入参数text必填order_id必填is_public
brightpearl_update_order_status
Update order status
WRITE: move an existing order to another status (ids from brightpearl_list_order_statuses; the new status must exist, be visible and belong to this order's type). Brightpearl adds an order note on success, and status changes can trigger the account's alerts and automations. Moving a sales order to the account's 'cancelled' status removes its reservations and coupons and is refused while goods-out notes or payments exist. PUT /order-service/order/{id}/status.
输入参数noteorder_id必填note_is_publicorder_status_id必填
brightpearl_search_products
Search products
Search the product catalogue. Every filter is optional and they combine (AND); each result row has productId, productName, SKU, barcode, EAN, UPC, ISBN, MPN, stockTracked, createdOn, updatedOn, brightpearlCategoryCode, productGroupId, brandId, productTypeId, productStatus, primarySupplierId. Use brightpearl_get_products for full details. GET /product-service/product-search.
输入参数eanmpnskuupcisbnnamebarcodebrand_idpage_sizecreated_toupdated_tocategory_id另有 10 个
brightpearl_get_products
Get products
Full details of one or more products by id: identity (SKU, barcodes), brand, type, stock-tracking, weight and dimensions, tax code, sales-channel names/descriptions/categories, bundle composition, variations, per-warehouse reorder levels, supplier and status. Up to 50 ids. GET /product-service/product/{ids}.
输入参数product_ids必填include_custom_fields
brightpearl_get_product_prices
Get product prices
Prices of products per price list: for each product and price list the currency, SKU and the quantity-break price map (e.g. {"1":"12","100":"11"}). Up to 50 product ids; optionally only some price lists (ids from brightpearl_list_price_lists). GET /product-service/product-price/{product ids}/price-list/{price list ids}.
输入参数product_ids必填price_list_ids
brightpearl_get_product_availability
Get product stock availability
Stock availability of stock-tracked products: for each product the totals across all warehouses (inStock, onHand, allocated, inTransit) and the same per warehouse; optionally per location, with on-order quantities. Up to 50 product ids. GET /warehouse-service/product-availability/{ids}.
输入参数on_orderby_locationproduct_ids必填
brightpearl_list_price_lists
List price lists
The price lists (id, name, code, currency, SELL or BUY, gross or net). Id 0 is the cost price list. GET /product-service/price-list.
无需输入参数。
brightpearl_search_brands
Search brands
Search product brands by name; each row has brandId, brandName, createdOn, updatedOn. GET /product-service/brand-search.
输入参数namepage_sizefirst_result
brightpearl_search_categories
Search product categories
Search Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. GET /product-service/brightpearl-category-search.
输入参数nameactivepage_sizeparent_idfirst_result
brightpearl_list_warehouses
List warehouses
The warehouses (id, name, type, address id, click-and-collect settings, weekly operating hours). Use the ids for stock and order filters. GET /warehouse-service/warehouse.
无需输入参数。
brightpearl_list_shipping_methods
List shipping methods
The shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.
无需输入参数。
brightpearl_search_goods_out_notes
Search goods-out notes (shipments)
Search goods-out notes, the pick/pack/ship records of sales orders; each row has goodsOutNoteId, printed, picked, packed, shipped, shippedOn, orderId, shippingMethodId, warehouseId, createdOn, releaseDate, transfer. GET /warehouse-service/goods-note/goods-out-search.
输入参数packedpickedshippedorder_idpage_sizecreated_toshipped_tocreated_fromfirst_resultnewest_firstshipped_fromwarehouse_id另有 1 个
brightpearl_search_goods_in_notes
Search goods-in notes (stock received)
Search goods-in records (stock received against purchase orders, by batch and location); each row has purchaseOrderId, batchId, productId, locationId, price, currCode, receivedQuantity, onHand, createdDate, receivedDate, warehouseId. GET /warehouse-service/goods-in-search.
输入参数batch_idpage_sizeproduct_idreceived_tofirst_resultnewest_firstwarehouse_idreceived_frompurchase_order_id
brightpearl_search_contacts
Search contacts
Search contacts (customers, suppliers and staff). Every filter is optional and they combine (AND); each result row has contactId, primaryEmail, firstName, lastName, companyName, isSupplier, isStaff, isCustomer, createdOn, updatedOn, lastOrderedOn and more. Use brightpearl_get_contacts for the full record. GET /contact-service/contact-search.
输入参数emailphonetag_idsis_stafflast_namepage_sizecreated_tofirst_nameupdated_tocompany_idscontact_idsis_customer另有 9 个
brightpearl_get_contacts
Get contacts
Full records of one or more contacts by id: name, emails, phones, status, supplier/staff flags, financial details (price list, tax code, credit limit and terms), assignment, organisation, tags, dates; optionally custom fields and the full postal addresses. Up to 50 ids. GET /contact-service/contact/{ids}.
输入参数contact_ids必填include_addressesinclude_custom_fields
brightpearl_add_contact_note
Add contact note
WRITE: add a note to a contact's timeline (for example a record of correspondence). The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server. POST /contact-service/contact/{id}/note.
输入参数text必填is_publiccontact_id必填
brightpearl_search_customer_payments
Search customer payments
Search payments received against sales orders; each row has paymentId, transactionRef, paymentMethodCode, paymentType, orderId, currencyCode, amountAuthorized, amountPaid, paymentDate, createdOn, journalId. GET /accounting-service/customer-payment-search.
输入参数order_idspage_sizecreated_topayment_topayment_idscreated_fromfirst_resultnewest_firstpayment_frompayment_typetransaction_refpayment_method_code
brightpearl_list_payment_methods
List payment methods
The payment methods (name, code, active, bank accounts with currency and nominal code). GET /accounting-service/payment-method.
无需输入参数。
brightpearl_list_tax_codes
List tax codes
The tax codes (id, code, description, rate). GET /accounting-service/tax-code.
无需输入参数。