sosinventory_list_items
List items
List or search inventory items (products, assemblies, services...) with SKU, type, quantities (onhand, available, on sales/purchase orders) and prices. Filter by free text, SKU, category, type, tags, ids or update time; pass location to see quantities at one location. GET /api/v2/item.
輸入參數idsskutagstypequerystartsummarycategorylocationmax_resultsupdated_since
sosinventory_get_item
Get item
One item by id with all fields: quantities, prices, accounts, vendor, category, units of measure, price tiers, custom fields. GET /api/v2/item/{id}.
輸入參數id必填location
sosinventory_get_item_bom
Get item bill of materials
The bill of materials of an assembly item: component items, quantities and costs. GET /api/v2/item/{id}/bom.
輸入參數id必填
sosinventory_list_customers
List customers
List or search customers with contact details, billing/shipping addresses, terms, sales rep and credit-hold flag. Filter by name/notes text, name, email or update time. GET /api/v2/customer.
輸入參數nameemailquerystartsummarymax_resultsupdated_since
sosinventory_get_customer
Get customer
One customer by id with all fields (addresses, contact, terms, price tier, custom fields). GET /api/v2/customer/{id}.
輸入參數id必填
sosinventory_list_vendors
List vendors
List or search vendors (suppliers) by name or notes, with contact details, address, terms and account number. GET /api/v2/vendor.
輸入參數querystartsummarymax_resultsupdated_since
sosinventory_get_vendor
Get vendor
One vendor by id with all fields. GET /api/v2/vendor/{id}.
輸入參數id必填
sosinventory_list_sales_orders
List sales orders
List or search sales orders with customer, dates, totals, order stage, channel and (with summary=false) line items with shipped/invoiced quantities. GET /api/v2/salesorder.
輸入參數tofromquerystartstatuschannelsummarylocationmax_resultsorder_stageupdated_since
sosinventory_get_sales_order
Get sales order
One sales order by id with all fields and line items. GET /api/v2/salesorder/{id}.
輸入參數id必填
sosinventory_list_purchase_orders
List purchase orders
List or search purchase orders with vendor, dates, expected receipt date, totals and (with summary=false) line items with received quantities. GET /api/v2/purchaseorder.
輸入參數tofromquerystartstatussummarymax_resultsupdated_since
sosinventory_get_purchase_order
Get purchase order
One purchase order by id with all fields and line items. GET /api/v2/purchaseorder/{id}.
輸入參數id必填
sosinventory_list_transactions
List other transactions
List any SOS transaction type: invoices, estimates, sales receipts, item receipts, shipments, pick tickets, work orders, builds, adjustments, transfers, RMAs, returns, returns to vendor, rentals, rental returns and processes. Filters: query, date range, updated_since; status (open/closed; invoices voided/notvoided; estimates accepted/pending/closed/rejected; not available for transfers, shipments, builds, returns, item receipts, processes); location (transfers, rentals and rental returns take from_location/to_location instead). GET /api/v2/{type}.
輸入參數tofromtype必填querystartstatussummarylocationmax_resultsto_locationfrom_locationupdated_since
sosinventory_get_transaction
Get transaction
One transaction of any type by id, with all fields and line items. GET /api/v2/{type}/{id}.
輸入參數id必填type必填
sosinventory_list_reference_data
List reference data
List a configuration or reference table: locations, channels, classes, departments, payment terms, tax codes, sales reps, ship methods, payment methods, priorities, order stages, price tiers, units of measure, users (id, name, email), accounts, custom fields, warranties, bins, workers, work centers, jobs, lots or serial numbers. Use it to find the ids and names that the create tools reference. GET /api/v2/{type}.
輸入參數type必填querystartmax_results
sosinventory_create_customer
Create customer
WRITE: creates a new customer record in SOS Inventory. Only name is required. Check sosinventory_list_customers first so you do not create a duplicate. POST /api/v2/customer.
輸入參數name必填emailnotesphonetermsbillingsales_repcompany_name
sosinventory_create_vendor
Create vendor
WRITE: creates a new vendor (supplier) record in SOS Inventory. Only name is required. Check sosinventory_list_vendors first to avoid a duplicate. POST /api/v2/vendor.
輸入參數name必填emailnotesphonetermsaddresscompany_nameaccount_number
sosinventory_create_item
Create item
WRITE: creates a new inventory item. Optionally books initial stock: SOS then creates an inventory adjustment for the quantity at the given location. Item names must be unique within their category: check sosinventory_list_items first. POST /api/v2/item.
輸入參數skuname必填typevendorbarcodetaxablecategorydescriptioninitial_valuepurchase_costreorder_pointbase_sales_price另有 3 個
sosinventory_create_sales_order
Create sales order
WRITE: creates a new sales order for an EXISTING customer with line items for existing items (a customer or item cannot be created inside an order: use the create tools first). The order number is assigned automatically (SOS auto-numbering) unless you pass one. Confirm the customer, items, quantities and prices with the user before calling. POST /api/v2/salesorder.
輸入參數datelines必填numbercommentcustomer必填locationcustomer_pocustomer_message
sosinventory_create_purchase_order
Create purchase order
WRITE: creates a new purchase order to an EXISTING vendor with line items for existing items. The PO number is assigned automatically unless you pass one. Confirm the vendor, items, quantities and costs with the user before calling. POST /api/v2/purchaseorder.
輸入參數datelines必填numbervendor必填commentlocationexpected_datevendor_message