> 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/third-party-logistics-3pl/list-items.md).

# List Items

Retrieves a list of items from the data source based on the provided 3PL account token

```json
{"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Third-Party Logistics (3PL)","description":"Use 3PL APIs when a warehouse or logistics provider needs account-specific access to customer orders, inventory, purchase orders, RMAs, bills, item receipts, packing slips, and related documents. 3PL requests use the 3PL account token generated in Xorosoft ERP so data access can be limited to the connected client account."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/account3pl/getitem":{"get":{"parameters":[{"description":"A comma-separated list of item ids.","in":"query","name":"id","required":false,"schema":{"type":"number"}},{"description":"A comma-separated list of item numbers.","in":"query","name":"item_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 items 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 items 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 items 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 items updated at or before date (format: 2014-04-25T16:15:47-04:00.","in":"query","name":"updated_at_max","required":false,"schema":{"type":"string"}},{"description":"A unique authentication token assigned to each 3PL account within the system.","in":"query","name":"account_token","required":true,"schema":{"type":"string"}},{"description":"Page number for the query result set. Default = 1","in":"query","name":"page","required":true,"schema":{"type":"number"}},{"name":"upc","in":"query","required":false,"description":"Universal product code assigned to the item.","schema":{"type":"string"}},{"name":"base_part_number","in":"query","required":false,"description":"Base part number used to identify a product family or variant group.","schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"description":"Comma-separated tags used to filter matching records.","schema":{"type":"string"}},{"name":"option1_value","in":"query","required":false,"description":"Variant option 1 value, such as size, color, or another configured product option.","schema":{"type":"string"}},{"name":"option2_value","in":"query","required":false,"description":"Variant option 2 value, such as size, color, or another configured product option.","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"items":{"properties":{"Account3PLCode":{"type":"string","nullable":true},"Account3PLId":{"type":"number","nullable":true},"Account3PLName":{"type":"string","nullable":true},"ActiveFlag":{"type":"boolean"},"ActiveFlagStr":{"type":"string","nullable":true},"AdjAccntId":{"type":"string"},"AdjAccountName":{"type":"string"},"AlertNote":{"type":"string"},"AllowBackorderFlag":{"type":"boolean"},"AllowedPurchaseUomIdList":{"type":"boolean","nullable":true},"AllowedPurchaseUomNameList":{"type":"boolean","nullable":true},"AllowedSellUomIdList":{"type":"boolean","nullable":true},"AllowedSellUomNameList":{"type":"boolean","nullable":true},"AlternativeItemNumber1":{"type":"string"},"AlternativeItemNumber2":{"type":"string"},"AlternativeItemNumber3":{"type":"string"},"AssetAccntId":{"type":"string"},"AssetAccountName":{"type":"string"},"AverageUnitCost":{"type":"number","nullable":true},"BasePartNumber":{"type":"string"},"BaseUomCode":{"type":"string","nullable":true},"BaseUomId":{"type":"number"},"BaseUomName":{"type":"string"},"BrandId":{"type":"number"},"BrandName":{"type":"string"},"CARB":{"type":"string"},"CBM":{"type":"string","nullable":true},"CategoryId":{"type":"number"},"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"},"CustomDescription":{"type":"string","nullable":true},"CustomFieldH1":{"type":"string"},"CustomFieldH10":{"type":"string"},"CustomFieldH11":{"type":"string"},"CustomFieldH12":{"type":"string"},"CustomFieldH13":{"type":"string"},"CustomFieldH14":{"type":"string"},"CustomFieldH15":{"type":"string"},"CustomFieldH16":{"type":"string"},"CustomFieldH17":{"type":"string"},"CustomFieldH18":{"type":"string"},"CustomFieldH19":{"type":"string"},"CustomFieldH2":{"type":"string"},"CustomFieldH20":{"type":"string"},"CustomFieldH21":{"type":"string"},"CustomFieldH22":{"type":"string"},"CustomFieldH23":{"type":"string"},"CustomFieldH24":{"type":"string"},"CustomFieldH25":{"type":"string"},"CustomFieldH26":{"type":"string"},"CustomFieldH27":{"type":"string"},"CustomFieldH28":{"type":"string"},"CustomFieldH29":{"type":"string"},"CustomFieldH3":{"type":"string"},"CustomFieldH30":{"type":"string"},"CustomFieldH31":{"type":"string"},"CustomFieldH32":{"type":"string"},"CustomFieldH33":{"type":"string"},"CustomFieldH34":{"type":"string"},"CustomFieldH35":{"type":"string"},"CustomFieldH36":{"type":"string"},"CustomFieldH37":{"type":"string"},"CustomFieldH38":{"type":"string"},"CustomFieldH39":{"type":"string"},"CustomFieldH4":{"type":"string"},"CustomFieldH40":{"type":"string"},"CustomFieldH41":{"type":"string"},"CustomFieldH42":{"type":"string"},"CustomFieldH43":{"type":"string"},"CustomFieldH44":{"type":"string"},"CustomFieldH45":{"type":"string"},"CustomFieldH46":{"type":"string"},"CustomFieldH47":{"type":"string"},"CustomFieldH48":{"type":"string"},"CustomFieldH49":{"type":"string"},"CustomFieldH5":{"type":"string"},"CustomFieldH50":{"type":"string"},"CustomFieldH6":{"type":"string"},"CustomFieldH7":{"type":"string"},"CustomFieldH8":{"type":"string"},"CustomFieldH9":{"type":"string"},"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},"CustomPriceFormula":{"type":"string","nullable":true},"CustomPriceFormulaProfile":{"type":"object","additionalProperties":true,"nullable":true},"CustomPriceFormulaProfileId":{"type":"number","nullable":true},"CustomPriceLabels":{"type":"string","nullable":true},"DefaultLocationClassName":{"type":"string"},"DefaultLocationId":{"type":"number","nullable":true},"DefaultLocationName":{"type":"string"},"DefaultProductImagePath":{"type":"string","nullable":true},"DefaultSkuImagePath":{"type":"string","nullable":true},"DefaultStoreId":{"type":"number","nullable":true},"DefaultStoreName":{"type":"string"},"DefaultVendorId":{"type":"number","nullable":true},"DefaultVendorName":{"type":"string"},"Description":{"type":"string"},"DiscontinuedDate":{"type":"string","nullable":true},"DiscountedPrice":{"type":"number","nullable":true},"DoNotUpdateAccounts":{"type":"boolean"},"DoNotUseCheckDBValidation":{"type":"boolean"},"DropShipItemFlag":{"type":"boolean"},"DropShipItemFlagStr":{"type":"string","nullable":true},"DropShipVendors":{"type":"string","nullable":true},"DropShipVendorsList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"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"},"HSCodeId":{"type":"number","nullable":true},"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"},"ImageUrls":{"type":"string","nullable":true},"ImportError":{"type":"string","nullable":true},"IncomeAccntId":{"type":"string"},"IncomeAccountName":{"type":"string"},"IncomeReturnAccntId":{"type":"string"},"IncomeReturnAccountName":{"type":"string"},"InnerCaseQty":{"type":"number","nullable":true},"InnerCaseUPC":{"type":"string","nullable":true},"InventoryTabAccessPortalSubForm":{"type":"boolean"},"Is3AItemFlag":{"type":"boolean"},"IsBomItemFlag":{"type":"boolean"},"IsPreSellFlag":{"type":"boolean"},"IsPreSellFlagStr":{"type":"string"},"IsProducibleFlag":{"type":"boolean"},"IsProducibleFlagStr":{"type":"boolean","nullable":true},"IsPurchasableFlag":{"type":"boolean"},"IsPurchasableFlagStr":{"type":"boolean","nullable":true},"IsRawMaterialFlag":{"type":"boolean"},"IsRawMaterialFlagStr":{"type":"boolean","nullable":true},"IsRestrictToPurchaseFlag":{"type":"boolean"},"IsRestrictToPurchaseFlagStr":{"type":"string"},"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"},"ItemBomJson":{"type":"object","additionalProperties":true,"nullable":true},"ItemGtin":{"type":"string","nullable":true},"ItemImageList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"ItemLpnAttributeMappingObj":{"type":"object","additionalProperties":true,"nullable":true},"ItemNumber":{"type":"string"},"ItemProductCategoryName":{"type":"string","nullable":true},"ItemSalesForecastList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"ItemSalesTaxProvinceMapList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"ItemTrackingTypeId":{"type":"number","nullable":true},"ItemTrackingTypeName":{"type":"string","nullable":true},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"ItemUpc":{"type":"string"},"LastLandedUnitCost":{"type":"number","nullable":true},"LastLandedUnitHomeCurrency":{"type":"string","nullable":true},"LastPurchasedQty":{"type":"number","nullable":true},"LastReceiptCurrencyCode":{"type":"string","nullable":true},"LastReceiptDate":{"type":"string","nullable":true},"LastReceiptReconcileFlag":{"type":"boolean","nullable":true},"LastUnitCost":{"type":"number","nullable":true},"Length":{"type":"string","nullable":true},"MID":{"type":"number","nullable":true},"ManufactureItemFlag":{"type":"boolean"},"ManufactureItemFlagStr":{"type":"string","nullable":true},"Manufacturer":{"type":"string","nullable":true},"ManufacturerId":{"type":"number","nullable":true},"Margin":{"type":"string"},"MasterCaseQty":{"type":"number","nullable":true},"MasterCaseUPC":{"type":"string","nullable":true},"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","nullable":true},"Option1Value":{"type":"string"},"Option1ValueCode":{"type":"string"},"Option1ValueId":{"type":"number"},"Option2Name":{"type":"string"},"Option2Seq":{"type":"number","nullable":true},"Option2Value":{"type":"string"},"Option2ValueCode":{"type":"string"},"Option2ValueId":{"type":"number"},"Option3Name":{"type":"string"},"Option3Seq":{"type":"number","nullable":true},"Option3Value":{"type":"string"},"Option3ValueCode":{"type":"string"},"Option3ValueId":{"type":"number","nullable":true},"OptionArray":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"PriceNotAvailable":{"type":"boolean"},"ProductCategoryId":{"type":"number","nullable":true},"ProductHeaderId":{"type":"number"},"ProductImageId":{"type":"number"},"ProductImages":{"type":"string","nullable":true},"ProductTags":{"type":"string","nullable":true},"ProjectClassId":{"type":"number","nullable":true},"ProjectClassName":{"type":"string","nullable":true},"PurchaseNotes":{"type":"string"},"PurchaseTaxCode":{"type":"string"},"PurchaseTaxCodeId":{"type":"number"},"PurchaseTaxCodeName":{"type":"string"},"PurchaseUomCode":{"type":"string","nullable":true},"PurchaseUomId":{"type":"number"},"PurchaseUomName":{"type":"string"},"QtyDecimalFlag":{"type":"boolean"},"ReCalculateCustomPrices":{"type":"boolean"},"ReCalculateCustomPricesStr":{"type":"string","nullable":true},"ReOrderPointQty":{"type":"number","nullable":true},"ReOrderQty":{"type":"number","nullable":true},"ReadonlyFlag":{"type":"boolean"},"RefId":{"type":"number","nullable":true},"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"},"ScrapAccntId":{"type":"string"},"ScrapAccountName":{"type":"string"},"SearchKeywords":{"type":"string","nullable":true},"SeasonIdList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"SeasonValues":{"type":"string"},"SellPkgQty":{"type":"number","nullable":true},"SellUomCode":{"type":"string","nullable":true},"SellUomId":{"type":"number"},"SellUomName":{"type":"string"},"ShelfLife":{"type":"string"},"ShowItemPreviewSubForm":{"type":"boolean"},"SizeUomCode":{"type":"string","nullable":true},"SizeUomId":{"type":"number"},"SizeUomName":{"type":"string"},"StandardUnitCost":{"type":"number"},"StandardUnitPrice":{"type":"number"},"SubCategoryId":{"type":"number","nullable":true},"SubCategoryName":{"type":"string","nullable":true},"Tags":{"type":"string"},"TaxCategoryCode":{"type":"string"},"TaxStateMappingProfile":{"type":"object","additionalProperties":true,"nullable":true},"TaxStateMappingProfileId":{"type":"number"},"ThirdPartyDisplayName":{"type":"string","nullable":true},"ThirdPartyIconUrl":{"type":"string","nullable":true},"ThirdPartyImageRefNo":{"type":"string","nullable":true},"ThirdPartyRefNo":{"type":"string","nullable":true},"ThirdPartySource":{"type":"string","nullable":true},"Title":{"type":"string"},"TrackingBySerialNumberFlag":{"type":"boolean"},"TrackingBySerialNumberFlagStr":{"type":"string","nullable":true},"TxnTypeId":{"type":"number","nullable":true},"UniqueId":{"type":"string"},"UomFactor":{"type":"string","nullable":true},"UpdateDefaultItemImage":{"type":"boolean"},"UpdatePastTransactionsFlag":{"type":"boolean"},"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"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Page":{"type":"number"},"Result":{"type":"boolean"},"TotalPages":{"type":"number"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Third-Party Logistics (3PL)"],"description":"Retrieves a list of items from the data source based on the provided 3PL account token","operationId":"get_account3pl_getitem","summary":"List Items"}}}}
```


---

# 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/third-party-logistics-3pl/list-items.md?ask=<question>&goal=<endgoal>
```

`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.