List Items
Retrieves a list of items from the data source based on the provided 3PL account token
get
Authorizations
AuthorizationstringRequired
Query parameters
idnumberOptional
A comma-separated list of item ids.
item_numberstringOptional
A comma-separated list of item numbers.
since_idstringOptional
Restrict results to after the specified ID.
created_at_minstringOptional
Show items created at or after date (format: 2014-04-25T16:15:47-04:00).
updated_at_minstringOptional
Show items updated at or after date (format: 2014-04-25T16:15:47-04:00).
created_at_maxstringOptional
Show items created at or before date (format: 2014-04-25T16:15:47-04:00).
updated_at_maxstringOptional
Show items updated at or before date (format: 2014-04-25T16:15:47-04:00.
account_tokenstringRequired
A unique authentication token assigned to each 3PL account within the system.
pagenumberRequired
Page number for the query result set. Default = 1
upcstringOptional
Universal product code assigned to the item.
base_part_numberstringOptional
Base part number used to identify a product family or variant group.
tagsstringOptional
Comma-separated tags used to filter matching records.
option1_valuestringOptional
Variant option 1 value, such as size, color, or another configured product option.
option2_valuestringOptional
Variant option 2 value, such as size, color, or another configured product option.
Responses
200
OK
application/json
IsForwardRequestbooleanOptional
MessagestringOptional
MessageTitlestring · nullableOptional
PagenumberOptional
ResultbooleanOptional
TotalPagesnumberOptional
get/api/xerp/account3pl/getitem
GET /api/xerp/account3pl/getitem?account_token=text&page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*
200
OK
{
"Data": [
{
"Account3PLCode": null,
"Account3PLId": null,
"Account3PLName": null,
"ActiveFlag": true,
"ActiveFlagStr": null,
"AdjAccntId": "B7D03F338DD5065FD4441C9F48A7",
"AdjAccountName": "COGS Inventory - Not Owned",
"AlertNote": "",
"AllowBackorderFlag": false,
"AllowedPurchaseUomIdList": null,
"AllowedPurchaseUomNameList": null,
"AllowedSellUomIdList": null,
"AllowedSellUomNameList": null,
"AlternativeItemNumber1": "0004109-SHMBLAQUA-S",
"AlternativeItemNumber2": "D.000.4109.823.SL",
"AlternativeItemNumber3": "",
"AssetAccntId": "B7D03F338C6171DB72D9E48A4749",
"AssetAccountName": "Inventory - Not Owned",
"AverageUnitCost": null,
"BasePartNumber": 4109,
"BaseUomCode": null,
"BaseUomId": 4,
"BaseUomName": "Each",
"BrandId": 10,
"BrandName": "Test",
"CARB": "",
"CBM": null,
"CategoryId": 42,
"CategoryName": "Accessories 1 - Small",
"CogsAccntId": "B7D03F338DD5065FD4441C9F48A7",
"CogsAccountName": "COGS Inventory - Not Owned",
"CooCodeIso2": "",
"CreateDttm": "04/06/2022 05:22:05 PM",
"CreateSource": "Schedule Agent",
"CurrencyCode": null,
"CurrencyPriceList": [],
"CustomDescription": null,
"CustomFieldH1": "Custom Field 1(Text)",
"CustomFieldH10": "",
"CustomFieldH11": "",
"CustomFieldH12": "",
"CustomFieldH13": "",
"CustomFieldH14": "",
"CustomFieldH15": "",
"CustomFieldH16": "",
"CustomFieldH17": "",
"CustomFieldH18": "",
"CustomFieldH19": "",
"CustomFieldH2": "",
"CustomFieldH20": "",
"CustomFieldH21": "",
"CustomFieldH22": "",
"CustomFieldH23": "",
"CustomFieldH24": "",
"CustomFieldH25": "",
"CustomFieldH26": "",
"CustomFieldH27": "",
"CustomFieldH28": "",
"CustomFieldH29": "",
"CustomFieldH3": "",
"CustomFieldH30": "",
"CustomFieldH31": "",
"CustomFieldH32": "",
"CustomFieldH33": "",
"CustomFieldH34": "",
"CustomFieldH35": "",
"CustomFieldH36": "",
"CustomFieldH37": "",
"CustomFieldH38": "",
"CustomFieldH39": "",
"CustomFieldH4": "Test11",
"CustomFieldH40": "",
"CustomFieldH41": "",
"CustomFieldH42": "",
"CustomFieldH43": "",
"CustomFieldH44": "",
"CustomFieldH45": "",
"CustomFieldH46": "",
"CustomFieldH47": "",
"CustomFieldH48": "",
"CustomFieldH49": "",
"CustomFieldH5": "",
"CustomFieldH50": "",
"CustomFieldH6": "",
"CustomFieldH7": "",
"CustomFieldH8": "",
"CustomFieldH9": "",
"CustomPrice1": null,
"CustomPrice10": null,
"CustomPrice11": null,
"CustomPrice12": null,
"CustomPrice13": null,
"CustomPrice14": null,
"CustomPrice2": null,
"CustomPrice3": null,
"CustomPrice4": null,
"CustomPrice5": null,
"CustomPrice6": null,
"CustomPrice7": null,
"CustomPrice8": null,
"CustomPrice9": null,
"CustomPriceFormula": null,
"CustomPriceFormulaProfile": null,
"CustomPriceFormulaProfileId": null,
"CustomPriceLabels": null,
"DefaultLocationClassName": "",
"DefaultLocationId": null,
"DefaultLocationName": "",
"DefaultProductImagePath": null,
"DefaultSkuImagePath": null,
"DefaultStoreId": null,
"DefaultStoreName": "",
"DefaultVendorId": null,
"DefaultVendorName": "",
"Description": "KAHONI SUPER CHEEK SHAMBHALA AQUA S",
"DiscontinuedDate": null,
"DiscountedPrice": null,
"DoNotUpdateAccounts": false,
"DoNotUseCheckDBValidation": false,
"DropShipItemFlag": false,
"DropShipItemFlagStr": null,
"DropShipVendors": null,
"DropShipVendorsList": null,
"ExpenseAccntId": "",
"ExpenseAccountName": "",
"ExpirationDate": null,
"ForceSalesTaxCode": false,
"ForceSalesTaxCodeStr": "N",
"GenderCode": "",
"GroupId": null,
"GroupName": "",
"HSCode": "",
"HSCodeId": null,
"HasMultiCurPrice": false,
"HazmatCode": "",
"HazmatId": null,
"HazmatName": "",
"Height": null,
"HomeCurrencyCode": null,
"Id": 123866,
"ImagePath": "/Images/resources/no-image.gif",
"ImageUrls": null,
"ImportError": null,
"IncomeAccntId": "B7D03F338E3501DA06B9A46242A0",
"IncomeAccountName": "Sales Inventory - Not Owned",
"IncomeReturnAccntId": "B7D03F338E3501DA06B9A46242A0",
"IncomeReturnAccountName": "Sales Inventory - Not Owned",
"InnerCaseQty": null,
"InnerCaseUPC": null,
"InventoryTabAccessPortalSubForm": false,
"Is3AItemFlag": false,
"IsBomItemFlag": false,
"IsPreSellFlag": false,
"IsPreSellFlagStr": "N",
"IsProducibleFlag": false,
"IsProducibleFlagStr": null,
"IsPurchasableFlag": true,
"IsPurchasableFlagStr": null,
"IsRawMaterialFlag": false,
"IsRawMaterialFlagStr": null,
"IsRestrictToPurchaseFlag": false,
"IsRestrictToPurchaseFlagStr": "N",
"IsSelected": false,
"IsSellableFlag": true,
"IsSellableFlagStr": null,
"IsStockingItemFlag": false,
"IsTaxableOnPurchase": false,
"IsTaxableOnPurchaseStr": null,
"IsTaxableOnSale": false,
"IsTaxableOnSaleStr": null,
"IsTransferableFlag": false,
"IsTransferableFlagStr": "N",
"ItemBarcode": "",
"ItemBomJson": null,
"ItemGtin": null,
"ItemImageList": null,
"ItemLpnAttributeMappingObj": null,
"ItemNumber": "610934002539",
"ItemProductCategoryName": null,
"ItemSalesForecastList": null,
"ItemSalesTaxProvinceMapList": null,
"ItemTrackingTypeId": null,
"ItemTrackingTypeName": null,
"ItemTypeId": 10,
"ItemTypeName": "Inventory",
"ItemUpc": "610934002539",
"LastLandedUnitCost": null,
"LastLandedUnitHomeCurrency": null,
"LastPurchasedQty": null,
"LastReceiptCurrencyCode": null,
"LastReceiptDate": null,
"LastReceiptReconcileFlag": null,
"LastUnitCost": null,
"Length": null,
"MID": null,
"ManufactureItemFlag": false,
"ManufactureItemFlagStr": null,
"Manufacturer": null,
"ManufacturerId": null,
"Margin": "50%",
"MasterCaseQty": null,
"MasterCaseUPC": null,
"MaterialId": null,
"MaterialName": "",
"ModifyDttm": "07/23/2024 01:54:35 AM",
"ModifySource": "test",
"MultipleUomFlag": false,
"Name": null,
"NeedsTrackingFlag": false,
"OldItemNumber": "610934002539",
"Option1Name": "Color",
"Option1Seq": null,
"Option1Value": "SHAMBHALA AQUA",
"Option1ValueCode": "SHMBLAQUA",
"Option1ValueId": 5380,
"Option2Name": "Size",
"Option2Seq": null,
"Option2Value": "S",
"Option2ValueCode": "S",
"Option2ValueId": 4105,
"Option3Name": "",
"Option3Seq": null,
"Option3Value": "",
"Option3ValueCode": "",
"Option3ValueId": null,
"OptionArray": null,
"PriceNotAvailable": false,
"ProductCategoryId": null,
"ProductHeaderId": 16901,
"ProductImageId": 0,
"ProductImages": null,
"ProductTags": null,
"ProjectClassId": null,
"ProjectClassName": null,
"PurchaseNotes": "",
"PurchaseTaxCode": "G",
"PurchaseTaxCodeId": 2,
"PurchaseTaxCodeName": "G - GST Only",
"PurchaseUomCode": null,
"PurchaseUomId": 4,
"PurchaseUomName": "Each",
"QtyDecimalFlag": false,
"ReCalculateCustomPrices": false,
"ReCalculateCustomPricesStr": null,
"ReOrderPointQty": null,
"ReOrderQty": null,
"ReadonlyFlag": false,
"RefId": null,
"RemoveImageFlag": false,
"ReorderPointQtyList": null,
"RestockingFeePer": null,
"ReturnableFlag": false,
"ReturnableFlagStr": "N",
"SaleTaxCode": "G",
"SaleTaxCodeName": "G - GST Only",
"SalesNotes": "",
"SalesTaxCodeId": 2,
"ScrapAccntId": "",
"ScrapAccountName": "",
"SearchKeywords": null,
"SeasonIdList": null,
"SeasonValues": "",
"SellPkgQty": null,
"SellUomCode": null,
"SellUomId": 4,
"SellUomName": "Each",
"ShelfLife": "",
"ShowItemPreviewSubForm": false,
"SizeUomCode": null,
"SizeUomId": 14,
"SizeUomName": "Inch",
"StandardUnitCost": 10,
"StandardUnitPrice": 20,
"SubCategoryId": null,
"SubCategoryName": null,
"Tags": "",
"TaxCategoryCode": "",
"TaxStateMappingProfile": null,
"TaxStateMappingProfileId": 0,
"ThirdPartyDisplayName": null,
"ThirdPartyIconUrl": null,
"ThirdPartyImageRefNo": null,
"ThirdPartyRefNo": null,
"ThirdPartySource": null,
"Title": "KAHONI SUPER CHEEK BLACK S",
"TrackingBySerialNumberFlag": false,
"TrackingBySerialNumberFlagStr": null,
"TxnTypeId": null,
"UniqueId": "UNIQUE_ID",
"UomFactor": null,
"UpdateDefaultItemImage": true,
"UpdatePastTransactionsFlag": false,
"UseImageForProductPreviewFlag": false,
"UseImageForProductPreviewFlagStr": null,
"VariantInfo": "SHMBLAQUA S",
"VariantInfoColored": "<span class='label label-default opt1Class'>SHMBLAQUA</span> <span class='label label-default opt2Class'>S</span>",
"VelocityCodeId": null,
"WarrantyTime": "",
"WarrantyUOM": "",
"WebUrl": "",
"Weight": null,
"WeightUomCode": null,
"WeightUomId": 3,
"WeightUomName": "Pound",
"Width": null,
"WipAccntId": "",
"WipAccountName": ""
}
],
"IsForwardRequest": false,
"Message": "Item data loaded successfully",
"MessageTitle": null,
"Page": 1,
"Result": true,
"TotalPages": 1
}Last updated
Was this helpful?