| PRODUCT_MANAGE | PRODUCT Endpoint | |
| /rpc/product/?method=PRODUCT_MANAGE | ||
| Object: 16. Click here for more information. | ||
|
Manage a product, includes optional integration with stock and financials. For more details, see the getting started guide for stock management |
| PARAMETERS | TYPE | ||
| DataReturn | Text | A comma delimited list of advanced search fields to be returned after a successful save | |
| Id | Numeric | ||
| Remove | Numeric | Pass '1' to remove the item | |
| Area | Numeric | ||
| Barcode | Text (50) | ||
| BrochureDocument | Numeric | ||
| Category | Numeric | You define your own, eg. 123=Demo Product, 124=Administration. If you are only going to link your products to one category, use this property. Otherwise, use PRODUCT_CATEGORY_LINK_MANAGE | |
| ContactBusiness | Numeric | ||
| ContactPerson | Numeric | ||
| CustomerOrderTaxType | Numeric | 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 | |
| Description | Text (8000) | Full description of product. Intended for internal use | |
| DisplayOrder | Numeric | ||
| FinancialAccountIncome | Numeric | If you use the financials component, this field is mandatory | |
| FinancialAccountInventory | Numeric | ||
| FinancialAccountPurchases | Numeric | If you use the financials component, this field is mandatory | |
| ImageAttachment | Numeric | As returned from CORE_ATTACHMENT_SEARCH | |
| MinimumStockLevel | Numeric | You could design a report to show products under this level | |
| Notes | Text (2000) | ||
| PreferredSupplierBusiness | Numeric | Contact Business | |
| Reference | Text (25) | Should be unique for each of your products. If left blank will default to PRDnnnnnn. When updating, you can pass this field to identify the record (ie instead of passing the id). Uses Profile Setting 64 to determine the default | |
| ReferenceMask | Text (50) | Alternatively, you can pass a mask to generate the Reference. It should have question mark(s) where the number is meant to go. For example with the next number of 123, "REF_??????" would generate "REF_000123". "REF?" would generate "REF123", "REF??????abc" would generate "REF000123abc". Note: The reference has to be blank for this to take effect | |
| 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 | |
| ShortDescription | Text (50) | Shorter description of product. Intended for external use | |
| Status | Numeric | 1=Available Now,2=Coming Soon...,6=Discontinued,7=Internal. Don't ask what happened to 3..5! | |
| SupplierOrderTaxType | Numeric | 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 | |
| SupplierReference | Text (50) | ||
| Title | Text (150) | Is mandatory | |
| TrackInventory | Text (1) | Y/N. If tracking inventory, you also need to set inventoryfinancialaccount | |
| Type | Numeric | 1=Standard [default],2=Grouped | |
| UnitType | Numeric | 1=Each,2=Packet,3=Metre,4=Box,5=kg,6=Thousand,7=Unit,8=Hour,9=Pair | |
| URL | Text (250) | For websites, you can use this field in conjuction with document urls to build id-less urls. The first charcter should be /. eg "http://mywebsite.com.au/{document url]/[product url]" |
|
| StockInitialUnits | Numeric | It is recommended that you only use this field when adding in new products. Once they are added, use the PRODUCT_STOCK_MANAGE method instead. If you modify this field via PRODUCT_MANAGE, a new stock record will be created | |
| StockUnitPrice | Numeric | Stock cost price per unit. |
| RETURN | ||
| id |