Products Resource

The Products Resource allows read access to the Sage 100 Products table.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/products?itemCode=<itemCode>		Retrieve product data for one product
list	GET	/products /products?offset=<offset>&limit=<limit> /products?itemType=<1\|2\|3\|4\|5>	Only	Retrieve a list of products

Resource Table List
Click on the table to view detail.

CI Item

Element Name	Description	Type	Length
ItemCode	Item Code	String	30
ItemType	Item Type	String	1
ItemCodeDesc	Item Code Description	String	30
ExtendedDescriptionKey	Extended Description Key	String	10
UseInAR	Use In AR	String	1
UseInSO	Use In SO	String	1
UseInPO	Use In PO	String	1
UseInBM	Use In BM	String	1
CalculateCommission	Calculate Commission	String	1
DropShip	Drop Ship	String	1
EBMEnabled	eBusiness Manager Enabled	String	1
AllowBackOrders	Allow Back Orders	String	1
AllowReturns	Allow Returns	String	1
PriceCode	Price Code	String	4
AllowTradeDiscount	Allow Trade Discount	String	1
PrintReceiptLabels	Print Receipt Labels	String	1
AllocateLandedCost	Allocate Landed Cost	String	1
InactiveItem	Inactive Item	String	1
ConfirmCostIncrInRcptOfGoods	Confirm Cost Increase in Receipt Of Goods	String	1
WarrantyCode	Warranty Code	String	10
SalesUnitOfMeasure	Sales Unit of Measure	String	4
PurchaseUnitOfMeasure	Purchase Unit of Measure	String	4
StandardUnitOfMeasure	Standard Unit of Measure	String	4
PostToGLByDivision	Post to G/L By Division	String	1
SalesAcctKey	Sales Account Key	String	9
CostOfGoodsSoldAcctKey	Cost Of Goods Sold Account Key	String	9
InventoryAcctKey	Inventory Account Key	String	9
PurchaseAcctKey	Purchase Account Key	String	9
ManufacturingCostAcctKey	Manufacturing Cost Account Key	String	9
TaxClass	Tax Class	String	2
PurchasesTaxClass	Purchases Tax Class	String	2
ProductLine	Product Line	String	4
ProductType	Product Type	String	1
Valuation	Valuation	String	1
DefaultWarehouseCode	Default Warehouse Code	String	3
PrimaryAPDivisionNo	Primary AP Division Number	String	2
PrimaryVendorNo	Primary Vendor Number	String	7
ImageFile	Image File	String	30
LastSoldDate	Last Sold Date	String	8
LastReceiptDate	Last Receipt Date	String	8
Category1	Category 1	String	10
Category2	Category 2	String	10
Category3	Category 3	String	10
Category4	Category 4	String	10
SalesPromotionCode	Sales Promotion Code	String	10
SaleStartingDate	Sale Starting Date	String	8
SaleEndingDate	Sale Ending Date	String	8
SaleMethod	Sale Method	String	1
ExplodeKitItems	Explode Kit Items	String	1
ShipWeight	Ship Weight	String	10
CommentText	Comment Text	String	2048
RestockingMethod	Restocking Method	String	1
NextLotSerialNo	Next Lot/Serial Number	String	15
InventoryCycle	Inventory Cycle	String	1
RoutingNo	Routing Number	String	20
ProcurementType	Procurement Type	String	1
PlannerCode	Planner Code	String	3
BuyerCode	Buyer Code	String	3
LowLevelCode	Low Level Code	String	2
PlannedByMRP	Planned By Mrp	String	1
VendorItemCode	Vendor Item Code	String	30
SetupCharge	Setup Charge	String	1
AttachmentFileName	Attachment File Name	String	30
ItemImageWidthInPixels	Item Image Width In Pixels	Numeric	4
ItemImageHeightInPixels	Item Image Height In Pixels	Numeric	4
StandardUnitCost	Standard Unit Cost	Numeric	16.6
StandardUnitPrice	Standard Unit Price	Numeric	16.6
LastTotalUnitCost	Last Total Unit Cost	Numeric	16.6
AverageUnitCost	Average Unit Cost	Numeric	16.6
SalesPromotionPrice	Sales Promotion Price	Numeric	16.6
SuggestedRetailPrice	Suggested Retail Price	Numeric	16.6
SalesPromotionDiscountPercent	Sales Promotion Discount Percentage	Numeric	12.3
TotalQuantityOnHand	Total Quantity On Hand	Numeric	16.6
AverageBackOrderFillDays	Average Back Order Fill Days	Numeric	5
LastAllocatedUnitCost	Last Allocated Unit Cost	Numeric	16.6
CommissionRate	Commission Rate	Numeric	9.3
BaseCommAmt	Base Commission Amount	Numeric	12.2
PurchaseUMConvFctr	Purchase Unit of Measure Conversion Factor	Numeric	12.4
SalesUMConvFctr	Sales Unit of Measure Conversion Factor	Numeric	12.4
Volume	Volume	Numeric	11.4
RestockingCharge	Restocking Charge	Numeric	11.3
TotalInventoryValue	Total Inventory Value	Numeric	15.2
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

CI Extended Description

Element Name	Description	Type	Length
ExtendedDescriptionKey	Extended Description Key	String	10
ExtendedDescriptionText	Extended Description Text	String	4096
CreationModuleCode	Creation Module Code	String	3
UpdatedModuleCode	Updated Module Code	String	3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Warehouse

Element Name	Description	Type	Length
WarehouseCode	Warehouse Code	String	3
WarehouseDesc	Warehouse Description	String	30
WarehouseName	Warehouse Name	String	30
WarehouseAddress1	Warehouse Address Line 1	String	30
WarehouseAddress2	Warehouse Address Line 2	String	30
WarehouseAddress3	Warehouse Address Line 3	String	30
WarehouseCity	Warehouse City	String	20
WarehouseState	Warehouse State	String	2
WarehouseZipCode	Warehouse Zip Code	String	10
WarehouseCountryCode	Warehouse Country Code	String	3
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
EmailAddress	Email Address	String	50
ContactName	Contact Name	String	30
PostToGLSubAcct	Post To G/L Sub Account	String	15
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Vendor Contact

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Warranty Code

Element Name	Description	Type	Length
WarrantyCode	Warranty Code	String	10
WarrantyCodeDesc	Warranty Code Description	String	30
WarrantyDays	Warranty Days	Numeric	4
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Product Line

Element Name	Description	Type	Length
ProductLine	Product Line	String	4
ProductLineDesc	Product Line Description	String	25
ProductType	Product Type	String	1
Valuation	Valuation	String	1
PriceCode	Price Code	String	4
AllowBackOrders	Allow Back Orders	String	1
ExplodeKitItems	Explode Kit Items	String	1
CalculateCommission	Calculate Commission	String	1
StandardUnitOfMeasure	Standard Unit Of Measure	String	4
PurchaseUnitOfMeasure	Purchase Unit Of Measure	String	4
SalesUnitOfMeasure	Sales Unit Of Measure	String	4
ProcurementType	Procurement Type	String	1
InventoryCycle	Inventory Cycle	String	1
AllowTradeDiscount	Allow Trade Discount	String	1
InactiveItem	Inactive Item	String	1
AllocateLandedCost	Allocate Landed Cost	String	1
TaxClass	Tax Class	String	2
PurchasesTaxClass	PurchasesTax Class	String	2
PrintReceiptLabels	Print Receipt Labels	String	1
ConfirmCostIncrInRcptOfGoods	Confirm Cost Increase In Receipt Of Goods	String	1
PostInventoryByWhse	Post Inventory By Warehouse	String	1
PostCostOfGoodsSoldByWhse	Post Cost Of Goods Sold By Warehouse	String	1
PostSalesIncomeByWhse	Post Sales/Income By Warehouse	String	1
PostReturnsByWhse	Post Returns By Warehouse	String	1
PostAdjustmentByWhse	Post Adjustment By Warehouse	String	1
PostPurchaseByWhse	Post Purchases By Warehouse	String	1
PostPOVarianceByWhse	Post Po Variance By Warehouse	String	1
PostMFGVarianceByWhse	Post Manufacturing Variance By Warehouse	String	1
InventoryAcctKey	Inventory Account Key	String	9
CostOfGoodsSoldAcctKey	Cost Of Goods Sold Account Key	String	9
SalesIncomeAcctKey	Sales Income Account Key	String	9
ReturnsAcctKey	Returns Account Key	String	9
AdjustmentAcctKey	Adjustment Account Key	String	9
PurchaseAcctKey	Purchase Account Key	String	9
PurchaseOrderVarianceAcctKey	Purchase Order Variance Account Key	String	9
ManufacturingVarianceAcctKey	Manufacturing Variance Account Key	String	9
WarrantyCode	Warranty Code	String	10
AllowReturns	Allow Returns	String	1
RestockingMethod	Restocking Method	String	1
ScrapAcctKey	Scrap Account Key	String	9
RepairsInProcessAcctKey	Repairs In Process Account Key	String	9
RepairsClearingAcctKey	Repairs Clearing Account Key	String	9
PostScrapByWhse	Post Scrap by Warehouse	String	1
PostRepairsInProcessByWhse	Post Repairs In Process by Warehouse	String	1
PostRepairsClearingByWhse	Post Repairs Clearing by Warehouse	String	1
CommissionRate	Commission Rate	Numeric	9.3
BaseCommAmt	Base Commission Amount	Numeric	12.2
PurchaseUMConvFctr	Purchase Unit Of Measure Conversion Factor	Numeric	12.4
SalesUMConvFctr	Sales Unit Of Measure Conversion Factor	Numeric	12.4
RestockingCharge	Restocking Charge	Numeric	11.3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Price Code

Element Name	Description	Type	Length
PriceCodeRecord	Price Code Record	String	1
PriceCode	Price Code	String	4
ItemCode	Item Code	String	30
CustomerPriceLevel	Customer Price Level	String	1
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
PriceCodeDesc	Price Code Description	String	25
PricingMethod	Pricing Method	String	1
BreakQuantity1	Break Quantity 1	Numeric	8
BreakQuantity2	Break Quantity 2	Numeric	8
BreakQuantity3	Break Quantity 3	Numeric	8
BreakQuantity4	Break Quantity 4	Numeric	8
BreakQuantity5	Break Quantity 5	Numeric	8
DiscountMarkup1	Discount Markup 1	Numeric	16.6
DiscountMarkup2	Discount Markup 2	Numeric	16.6
DiscountMarkup3	Discount Markup 3	Numeric	16.6
DiscountMarkup4	Discount Markup 4	Numeric	16.6
DiscountMarkup5	Discount Markup 5	Numeric	16.6
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Buyer Planner Code

Element Name	Description	Type	Length
BuyerPlannerCode	Buyer Planner Code	String	3
LastName	Last Name	String	30
FirstName	First Name	String	20
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Sales Promotion

Element Name	Description	Type	Length
SalesPromotionCode	Sales Promotion Code	String	10
SaleStartingDate	Sale Starting Date	String	8
SaleEndingDate	Sale Ending Date	String	8
SaleMethod	Sale Method	String	1
SalePrice	Sale Price	Numeric	16.6
DiscountPercentage	Discount Percentage	Numeric	11.3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Item Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor Name	String	30
AddressLine1	Address Line 1	String	30
AddressLine2	Address Line 2	String	30
AddressLine3	Address Line 3	String	30
City	City	String	20
State	State	String	2
ZipCode	Zip Code	String	10
CountryCode	Country Code	String	3
PrimaryContact	Primary Contact Code	String	10
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
EmailAddress	Email Address	String	250
URLAddress	URL Address	String	50
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

GL Account

Element Name	Description	Type	Length
AccountKey	Account Number	String	9
AccountDesc	Account Description	String	50
Account	Fully Formatted Account Number	String	41
RawAccount	Unformatted Account Number	String	32
MainAccountCode	Main Account	String	15
DateStart	Start Date	String	8
DateEnd	End Date	String	8
Status	Status	String	1
ClearBalance	Clear Balance	String	1
AccountType	Account Type	String	2
CashFlowsType	Cash Flows Type	String	1
RollupCode1	Rollup Code 1	String	20
RollupCode2	Rollup Code 2	String	20
RollupCode3	Rollup Code 3	String	20
RollupCode4	Rollup Code 4	String	20
AccountGroup	Account Group	String	15
AccountCategory	Account Category	String	1
CompanyCode	Company Code	String	3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor Name	String	30
AddressLine1	Address Line 1	String	30
AddressLine2	Address Line 2	String	30
AddressLine3	Address Line 3	String	30
City	City	String	20
State	State	String	2
ZipCode	Zip Code	String	10
CountryCode	Country Code	String	3
PrimaryContact	Primary Contact Code	String	10
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
EmailAddress	Email Address	String	250
URLAddress	URL Address	String	50
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8

SY Sales Tax Class

Element Name	Description	Type	Length
TaxClass	Tax Class	String	2
TaxClassDesc	Tax Class Description	String	30
TaxClassType	Tax Class Type	String	1

Users and Administrators can retrieve data for a single Product. This can include data from any of the tables associated with the resource.

Users and Administrators can retrieve all product data from the Products Resource. The return can be limited to a number of products by specifying the Limit and Offset. The return can also be limited by passing any non-key column to the resource.

Element Name	Description	Type	Length
category	Category	String	64
categoryRID	Category Reference ID	String	8
categoryDescription	Category Description	String	64
categoryImage	Category Image	String	64
categoryShortDescription	Category Short Description	String	2048
categoryLongDescription	Category Long Description	String	4096
mainNavigation	Main Navigation	Numeric	1
categoryEnabled	Category Enabled	Numeric	1
parentCategory	Parent Category	String	64

Products Resource

Category

CI Item

CI Extended Description

IM Warehouse

AP Vendor Contact

AP Division

IM Warranty Code

IM Product Line

IM Price Code

IM Buyer Planner Code

IM Sales Promotion

IM Item Vendor

GL Account

AP Division

AP Vendor

SY Sales Tax Class

Resource Methods

Get

List