| PRODUCT_SEARCH | PRODUCT Endpoint | |
| /rpc/product/?method=PRODUCT_SEARCH | ||
| For information on how to use Advanced Searches, click here |
| DETAILS | |||
| Prefix | Product |
| SUB SEARCHES | |||
| Attachment | CORE_ATTACHMENT_SEARCH | This returns all attachments linked to the product | |
| BrochureDocument | DOCUMENT_SEARCH | ||
| Category | SETUP_PRODUCT_CATEGORY_SEARCH | ||
| CategoryLink | PRODUCT_CATEGORY_LINK_SEARCH | ||
| ChildLink | SETUP_PRODUCT_LINK_SEARCH | ||
| Code | PRODUCT_CODE_SEARCH | ||
| ContactBusiness | CONTACT_BUSINESS_SEARCH | ||
| ContactPerson | CONTACT_PERSON_SEARCH | ||
| ImageAttachment | CORE_ATTACHMENT_SEARCH | This returns the attachment selected in the ImageAttachment field | |
| ParentLink | SETUP_PRODUCT_LINK_SEARCH | ||
| PreferredSupplierBusiness | CONTACT_BUSINESS_SEARCH | ||
| Variant | SETUP_PRODUCT_VARIANT_SEARCH |
| AVAILABLE FIELDS | TYPE | ||
| Area | Numeric | Linked area | |
| AreaText | Text (50) | See above | |
| Barcode | Text (50) | ||
| BrochureDocument | Numeric | Id of document | |
| BrochureDocumentText | Text (50) | See above | |
| Category | Numeric | Define your own, eg Office Products | |
| CategoryText | Text (50) | See above | |
| ContactBusiness | Numeric | Linked Contact Business | |
| ContactBusinessText | Text | ||
| ContactPerson | Numeric | Linked Contact Person | |
| ContactPersonText | Text | ||
| CurrentRetailPrice | Numeric | Retail Price for the All Group for today. If you want more control / other prices use PRODUCT_PRICE_SEARCH | |
| CustomerOrderTaxType | Numeric | Customer Order GST Type. Depending on your country the values change. Eg for Australia, 1=GST Applies,2=GST Free - Export,3=GST Free - Other,4=GST Free - Input Taxed,5=GST Free - Exclude | |
| CustomerOrderTaxTypeText | Text (50) | See above | |
| Description | Text (8000) | ||
| DisplayOrder | Numeric | ||
| FinancialAccountIncome | Numeric | Linked financial account | |
| FinancialAccountIncomeText | Text (50) | See above | |
| FinancialAccountInventory | Numeric | Linked financial account | |
| FinancialAccountInventoryText | Text (50) | See above | |
| FinancialAccountPurchases | Numeric | Linked financial account | |
| FinancialAccountPurchasesText | Text (50) | See above | |
| Id | Numeric | ||
| ImageAttachment | Numeric | ||
| ImageAttachmentText | Text (300) | ||
| MinimumStockLevel | Numeric | ||
| PreferredSupplierBusiness | Numeric | Link to Preferred Supplier contact business | |
| PreferredSupplierBusinessText | Text (50) | ||
| Notes | Text (2000) | ||
| Reference | Text (25) | ||
| ShortDescription | Text (50) | ||
| ShopStatus | Numeric | 1=Show In Shop,2=Do Not Show In Shop,3=Show In Shop As Special,4=Show In Shop As New Product,5=Coming Soon | |
| ShopStatusText | Text (50) | See above | |
| Status | Numeric | 1=Available Now,2=Coming Soon...,6=Discontinued,7=Internal | |
| StatusText | Text (50) | See above | |
| SupplierOrderTaxType | Numeric | Supplier Order GST Type. Depending on your country the values change. Eg for Australia, 1=GST Applies,2=GST Free - Input Taxed,3=GST Free - Other,4=GST Free - Entertainment/Private,5=GST Free - Exclude | |
| SupplierOrderTaxTypeText | Text (50) | See above | |
| SupplierReference | Text (50) | ||
| Title | Text (150) | ||
| TrackInventory | Text (1) | Y/N | |
| Type | Numeric | 1=Standard Product,2=Product Group | |
| TypeText | Numeric | See above | |
| UnitPrice | Numeric | Average Unit Cost Price. This is the average unit price based on Supplier Order Receivals, Stock Adjustments etc. To get the selling price use PRODUCT_PRICE_SEARCH | |
| Units | Numeric | Quantity in stock. Use PRODUCT_STOCK_SEARCH for more details | |
| UnitType | Numeric | 1=Each,2=Packet,3=Metre,4=Box,5=kg,6=Thousand,7=Unit,8=Hour,9=Pair | |
| UnitTypeText | Text (50) | See above | |
| URL | Text (250) | ||
| Structure Fields | Click here for more information | ||
| Audit Fields | Click here for more information |
| RETURN | ||
| Selected Fields |
| EXAMPLE | |
| 1. Return a number of fields for a specific id | |
| var oAdvancedSearch = new AdvancedSearch(); oAdvancedSearch.endPoint = 'product'; oAdvancedSearch.method = 'PRODUCT_SEARCH'; oAdvancedSearch.addField('title,quantity'); oAdvancedSearch.addFilter('id', 'EQUAL_TO', '1'); oAdvancedSearch.rf = 'XML'; oAdvancedSearch.getResults(function(asData) { GetResultsComplete(asData);}); |
