> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/developers-api/product-information-management/list-products.md). # List Products Retrieves List of products from the database. Retrieve product data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions. ```json {"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Product Information Management","description":"Use Product Information Management APIs to manage catalog data for products and items, including base part numbers, item numbers, variants, tags, prices, vendor maps, currency prices, and product-level attributes. These APIs are commonly used by ecommerce channels, PIM tools, marketplace connectors, and internal catalog maintenance jobs that need product and SKU data from Xorosoft ERP."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/product/getproduct":{"get":{"parameters":[{"description":"A comma-separated list of product ids.","in":"query","name":"id","required":false,"schema":{"type":"number"}},{"description":"A comma-separated list of base part numbers.","in":"query","name":"base_part_number","required":false,"schema":{"type":"string"}},{"description":"Restrict results to after the specified ID.","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"Show products created at or after date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"created_at_min","required":false,"schema":{"type":"string"}},{"description":"Show products updated at or after date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"updated_at_min","required":false,"schema":{"type":"string"}},{"description":"Show products created at or before date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"created_at_max","required":false,"schema":{"type":"string"}},{"description":"Show products updated at or before date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"updated_at_max","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"description":"Comma-separated tags used to filter matching records.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for paginated responses.","schema":{"type":"string","default":"1"}},{"name":"query","in":"query","required":false,"description":"Search text used by the endpoint where supported.","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"items":{"properties":{"ActiveFlag":{"type":"boolean"},"BasePartNumber":{"type":"string"},"BodyHtml":{"type":"string"},"CategoryId":{"type":"number","nullable":true},"CategoryName":{"type":"string"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"Handle":{"type":"string","nullable":true},"Id":{"type":"number"},"ModifyDttm":{"type":"string"},"ModifySource":{"type":"string"},"Options":{"items":{},"type":"array"},"ProductImages":{"items":{"properties":{"EntityRefHeaderId":{"type":"number"},"EntityRefId":{"type":"number"},"EntityTypeId":{"type":"number"},"Height":{"type":"string","nullable":true},"Id":{"type":"number"},"ImageSrc":{"type":"string"},"ImageSrcList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"Position":{"type":"number"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"Width":{"type":"string","nullable":true}},"required":["EntityRefHeaderId","EntityRefId","EntityTypeId","Height","Id","ImageSrc","ImageSrcList","Position","ThirdPartyRefNo","ThirdPartySource","Width"],"type":"object"},"type":"array"},"Title":{"type":"string"},"Variants":{"items":{"properties":{"ActiveFlag":{"type":"boolean"},"ActiveFlagStr":{"type":"string","nullable":true},"AdjAccntId":{"type":"string"},"AdjAccountName":{"type":"string"},"AlertNote":{"type":"string"},"AllowBackorderFlag":{"type":"boolean"},"AssetAccntId":{"type":"string"},"AssetAccountName":{"type":"string"},"BasePartNumber":{"type":"string"},"BrandId":{"type":"number","nullable":true},"BrandName":{"type":"string"},"CARB":{"type":"string"},"CategoryId":{"type":"number","nullable":true},"CategoryName":{"type":"string"},"CogsAccntId":{"type":"string"},"CogsAccountName":{"type":"string"},"CooCodeIso2":{"type":"string"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CurrencyCode":{"type":"string","nullable":true},"CurrencyPriceList":{"items":{},"type":"array"},"CustomPrice1":{"type":"string","nullable":true},"CustomPrice10":{"type":"string","nullable":true},"CustomPrice11":{"type":"string","nullable":true},"CustomPrice12":{"type":"string","nullable":true},"CustomPrice13":{"type":"string","nullable":true},"CustomPrice14":{"type":"string","nullable":true},"CustomPrice2":{"type":"string","nullable":true},"CustomPrice3":{"type":"string","nullable":true},"CustomPrice4":{"type":"string","nullable":true},"CustomPrice5":{"type":"string","nullable":true},"CustomPrice6":{"type":"string","nullable":true},"CustomPrice7":{"type":"string","nullable":true},"CustomPrice8":{"type":"string","nullable":true},"CustomPrice9":{"type":"string","nullable":true},"CustomPriceLabels":{"type":"string","nullable":true},"DefaultLocationClassName":{"type":"string"},"DefaultLocationId":{"type":"number","nullable":true},"DefaultLocationName":{"type":"string"},"DefaultStoreId":{"type":"number","nullable":true},"DefaultStoreName":{"type":"string"},"DefaultVendorId":{"type":"number","nullable":true},"DefaultVendorName":{"type":"string"},"Description":{"type":"string"},"DiscountedPrice":{"type":"number","nullable":true},"DoNotUpdateAccounts":{"type":"boolean"},"DropShipItemFlag":{"type":"boolean"},"ExpenseAccntId":{"type":"string"},"ExpenseAccountName":{"type":"string"},"ExpirationDate":{"type":"string","nullable":true},"ForceSalesTaxCode":{"type":"boolean"},"ForceSalesTaxCodeStr":{"type":"string"},"GenderCode":{"type":"string"},"GroupId":{"type":"number","nullable":true},"GroupName":{"type":"string"},"HSCode":{"type":"string"},"HasMultiCurPrice":{"type":"boolean"},"HazmatCode":{"type":"string"},"HazmatId":{"type":"number","nullable":true},"HazmatName":{"type":"string"},"Height":{"type":"string","nullable":true},"HomeCurrencyCode":{"type":"string","nullable":true},"Id":{"type":"number"},"ImagePath":{"type":"string"},"IncomeAccntId":{"type":"string"},"IncomeAccountName":{"type":"string"},"IsBomItemFlag":{"type":"boolean"},"IsPurchasableFlag":{"type":"boolean"},"IsPurchasableFlagStr":{"type":"boolean","nullable":true},"IsRawMaterialFlag":{"type":"boolean"},"IsRawMaterialFlagStr":{"type":"boolean","nullable":true},"IsSelected":{"type":"boolean"},"IsSellableFlag":{"type":"boolean"},"IsSellableFlagStr":{"type":"boolean","nullable":true},"IsStockingItemFlag":{"type":"boolean"},"IsTaxableOnPurchase":{"type":"boolean"},"IsTaxableOnPurchaseStr":{"type":"boolean","nullable":true},"IsTaxableOnSale":{"type":"boolean"},"IsTaxableOnSaleStr":{"type":"boolean","nullable":true},"IsTransferableFlag":{"type":"boolean"},"IsTransferableFlagStr":{"type":"string"},"ItemBarcode":{"type":"string"},"ItemNumber":{"type":"string"},"ItemProductCategoryName":{"type":"string","nullable":true},"ItemTrackingTypeId":{"type":"number","nullable":true},"ItemTrackingTypeName":{"type":"string","nullable":true},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"ItemUpc":{"type":"string"},"Length":{"type":"string","nullable":true},"ManufactureItemFlag":{"type":"boolean"},"ManufactureItemFlagStr":{"type":"string","nullable":true},"Margin":{"type":"string"},"MaterialId":{"type":"number","nullable":true},"MaterialName":{"type":"string"},"ModifyDttm":{"type":"string"},"ModifySource":{"type":"string"},"MultipleUomFlag":{"type":"boolean"},"Name":{"type":"string","nullable":true},"NeedsTrackingFlag":{"type":"boolean"},"OldItemNumber":{"type":"string"},"Option1Name":{"type":"string"},"Option1Seq":{"type":"number"},"Option1Value":{"type":"string"},"Option1ValueCode":{"type":"string"},"Option1ValueId":{"type":"number","nullable":true},"Option2Name":{"type":"string"},"Option2Seq":{"type":"number"},"Option2Value":{"type":"string"},"Option2ValueCode":{"type":"string"},"Option2ValueId":{"type":"number","nullable":true},"Option3Name":{"type":"string"},"Option3Seq":{"type":"number"},"Option3Value":{"type":"string"},"Option3ValueCode":{"type":"string"},"Option3ValueId":{"type":"number","nullable":true},"OptionArray":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"ProductHeaderId":{"type":"number"},"ProductImageId":{"type":"number","nullable":true},"ProductImages":{"type":"string","nullable":true},"ProjectClassId":{"type":"number","nullable":true},"ProjectClassName":{"type":"string","nullable":true},"PurchaseNotes":{"type":"string"},"PurchaseTaxCode":{"type":"string"},"PurchaseTaxCodeId":{"type":"number","nullable":true},"PurchaseTaxCodeName":{"type":"string"},"QtyDecimalFlag":{"type":"boolean"},"ReOrderPointQty":{"type":"number","nullable":true},"ReOrderQty":{"type":"number","nullable":true},"ReadonlyFlag":{"type":"boolean"},"RemoveImageFlag":{"type":"boolean"},"ReorderPointQtyList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"RestockingFeePer":{"type":"number","nullable":true},"ReturnableFlag":{"type":"boolean"},"ReturnableFlagStr":{"type":"string"},"SaleTaxCode":{"type":"string"},"SaleTaxCodeName":{"type":"string"},"SalesNotes":{"type":"string"},"SalesTaxCodeId":{"type":"number","nullable":true},"ScrapAccntId":{"type":"string"},"ScrapAccountName":{"type":"string"},"SeasonIdList":{"items":{},"type":"array"},"SeasonValues":{"type":"string"},"SellPkgQty":{"type":"number"},"SellUomCode":{"type":"string","nullable":true},"SellUomId":{"type":"number"},"SellUomName":{"type":"string"},"ShelfLife":{"type":"string"},"SizeUomCode":{"type":"string","nullable":true},"SizeUomId":{"type":"number"},"SizeUomName":{"type":"string"},"StandardUnitCost":{"type":"number"},"StandardUnitPrice":{"type":"number"},"Tags":{"type":"string"},"ThirdPartyImageRefNo":{"type":"string","nullable":true},"Title":{"type":"string"},"UseImageForProductPreviewFlag":{"type":"boolean"},"UseImageForProductPreviewFlagStr":{"type":"boolean","nullable":true},"VariantInfo":{"type":"string"},"VariantInfoColored":{"type":"string"},"VelocityCodeId":{"type":"number","nullable":true},"WarrantyTime":{"type":"string"},"WarrantyUOM":{"type":"string"},"WebUrl":{"type":"string"},"Weight":{"type":"string","nullable":true},"WeightUomCode":{"type":"string","nullable":true},"WeightUomId":{"type":"number"},"WeightUomName":{"type":"string"},"Width":{"type":"string","nullable":true},"WipAccntId":{"type":"string"},"WipAccountName":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Result":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Product Information Management"],"description":"Retrieves List of products from the database.\n\nRetrieve product data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.","operationId":"get_product_getproduct","summary":"List Products"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xorosoft.com/developers-api/product-information-management/list-products.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.