# Gets Items for a Specific Store The expected body payload change between the items endpoint and the stores items endpoint (this) is best described though the following examples. Note that by using this endpoint it will bring only the items that are available to this store and only include this store in the expanded stores section of the item. /api/v2/items? Expand = Stores + filter = lastUpdated >= 2023 - 10 - 30T17:12:12.009Z json [ { "id": "35542435-cf86-11eb-b6e8-8cae4ce6cd26", "description": "tesssst", "posDescription1": "tesssst", "posDescription2": null, "sku": "000000000471", "noCount": false, "shippingWeight": 0.0, "shippingHeight": 0.0, "shippingWidth": 0.0, "shippingLength": 0.0, "uom": null, "childCount": 1.0, "childUsage": 100.0, "upc": [], "active": true, "lastUpdated": "2023-10-30T17:12:12.009Z", "dimension1": null, "dimension2": null, "dimension3": null, "dimension4": null, "dimension5": null, "dimension6": null, "dimension7": null, "dimension8": null, "dimension9": null, "dimension10": null, "level": { "id": "07ab7a19-a9ea-11e3-9931-002590a52022", "code": "00010", "description": "RESTAURANT" }, "level1": { "id": "07ab7a19-a9ea-11e3-9931-002590a52022", "code": "00010", "description": "RESTAURANT" }, "level2": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "level3": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "level4": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "parentItem": null, "recipe": null, "matrix": null, "webProperties": null, "stores": [ { "id": "140e0635-b934-11e3-be42-002590a52022", "bin": null, "reorderPoint": 0.0, "parLevel": 0.0, "tariffCode": null, "description": "Mordor", "code": "1", "revenueCenterNumber": "1", "onHand": 0.0, "retailPrice1": 0.0, "retailPrice2": 0.0, "retailPrice3": 0.0, "retailPrice4": 0.0, "retailPrice5": 0.0, "retailPrice6": 0.0, "retailPrice7": 0.0, "retailPrice8": 0.0, "retailPrice9": 0.0, "retailPrice10": 0.0, "flags": [], "interfaces": { "AccountingGroup": "100", "COGS": "Food", "MicrosClass": "101", "MicrosCondimentsAllowed": "1001", "MicrosFamily": "301", "MicrosItemGroup": "101", "MicrosLevelClass": "999", "MicrosMajor": "101", "MicrosNLUGroup": "10", "MicrosPrintClass": "101", "Publish": "1", "RevenueCenter": "1", "StartingNumber": "950001", "GenericCodeA": "", "GenericCodeB": "", "GenericCodeC": "", "GenericCodeD": "", "GenericCodeE": "", "GenericCodeF": "", "GenericCodeG": "", "GenericLevelA": "", "GenericLevelB": "", "GenericLevelC": "", "ItemNumber": "" } } ], }, { "id": "c81f9a9f-985e-11eb-b6e6-d89c672bbc04", "bin": null, "reorderPoint": 0.0, "parLevel": 0.0, "tariffCode": null, "description": "The Shire", "code": "11", "revenueCenterNumber": "1", "onHand": 0.0, "retailPrice1": 0.0, "retailPrice2": 0.0, "retailPrice3": 0.0, "retailPrice4": 0.0, "retailPrice5": 0.0, "retailPrice6": 0.0, "retailPrice7": 0.0, "retailPrice8": 0.0, "retailPrice9": 0.0, "retailPrice10": 0.0, "flags": [], "interfaces": { "AccountingGroup": "", "GenericCodeA": "", "GenericCodeB": "", "GenericCodeC": "", "GenericCodeD": "", "GenericCodeE": "", "GenericCodeF": "", "GenericCodeG": "", "GenericLevelA": "", "GenericLevelB": "", "GenericLevelC": "", "ItemNumber": "", "Publish": "" }, } ] pulling a single store at a time /api/v2/stores/c81f9a9f-985e-11eb-b6e6-d89c672bbc04/items?Expand=Stores+filter=lastUpdated>=2023-10-30T17:12:12.009Z json [ { "id": "35542435-cf86-11eb-b6e8-8cae4ce6cd26", "description": "tesssst", "posDescription1": "tesssst", "posDescription2": null, "sku": "000000000471", "noCount": false, "shippingWeight": 0, "shippingHeight": 0, "shippingWidth": 0, "shippingLength": 0, "uom": null, "childCount": 1, "childUsage": 100, "upc": [], "active": true, "lastUpdated": "2023-10-30T17:12:12.009Z", "dimension1": null, "dimension2": null, "dimension3": null, "dimension4": null, "dimension5": null, "dimension6": null, "dimension7": null, "dimension8": null, "dimension9": null, "dimension10": null, "level": { "id": "07ab7a19-a9ea-11e3-9931-002590a52022", "code": "00010", "description": "RESTAURANT" }, "level1": { "id": "07ab7a19-a9ea-11e3-9931-002590a52022", "code": "00010", "description": "RESTAURANT" }, "level2": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "level3": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "level4": { "id": "00000000-0000-0000-0000-000000000000", "code": "", "description": "" }, "parentItem": null, "recipe": null, "matrix": null, "webProperties": null, "stores": [ { "id": "c81f9a9f-985e-11eb-b6e6-d89c672bbc04", "bin": null, "reorderPoint": 0, "parLevel": 0, "tariffCode": null, "description": "The Shire", "code": "11", "revenueCenterNumber": "1", "onHand": 0, "retailPrice1": 0, "retailPrice2": 0, "retailPrice3": 0, "retailPrice4": 0, "retailPrice5": 0, "retailPrice6": 0, "retailPrice7": 0, "retailPrice8": 0, "retailPrice9": 0, "retailPrice10": 0, "flags": [], "interfaces": { "AccountingGroup": "", "GenericCodeA": "", "GenericCodeB": "", "GenericCodeC": "", "GenericCodeD": "", "GenericCodeE": "", "GenericCodeF": "", "GenericCodeG": "", "GenericLevelA": "", "GenericLevelB": "", "GenericLevelC": "", "ItemNumber": "", "Publish": "" }, } ], "vendors": [], "images": [], "shortDescription": null, "isEvergreen": null, "style": null, "expirationDays": null, "reference": null, "attributes": null } ] Endpoint: GET /stores/{id}/items Version: v3.0: 3.26.2.2 Security: Auth API User Token ## Path parameters: - `id` (string, required) ## Query parameters: - `Filter` (array) ### Filter Options: - active (boolean: when this is not passed in as a filter option it will present both active and non-active Items) - lastUpdated (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information) - levelId (UUID: This is the items level.id property for requesting only a certain type of item) - sku (string: When passed in it will allow lookup of an item using the Item's sku) - webAvailable (boolean: when this is not passed in as a filter option it will present both true and false values) - `Expand` (array) ### Expand Options: - stores - vendors - images (available on database versions above 366) - extended-item (shortDescription, isEvergreen, style, expirationDays, reference, attributes, etc...) - Dimensions (see examples for more than ten dimensions) - `OrderBy` (array) ### Order By Options: - sku - description - itemId - `PageNumber` (integer) Page Number for the result set. This is expected to be an integer value greater than 0. Defaults to 1 when not passed in. For more information see the Getting Started Section for Pagination. - `PageSize` (integer) Page Size - Default page size: 100 - Max page size: 500 This is expected to be an integer value greater than 0. Defaults to 100 when not passed in. For more information see the Getting Started Section for Pagination. ## Response 200 fields (application/json): - `id` (string, required) Yellow Dog's primary key for the Item; always unique. When pushing items to the API, if an ItemID is present, Yellow Dog will update or create an item. If ItemID is not present, Yellow Dog will create an item and provide the ItemID in response. ItemID is formatted as a GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) - `description` (string,null) Main item description in Yellow Dog - `posDescription1` (string,null) Shorter item description for POS terminals; usually limited to 16 characters - `posDescription2` (string,null) Shorter item description for POS terminals; usually limited to 12 characters - `sku` (string,null) Main number associated with the item in the Yellow Dog UI; auto generated by Yellow Dog when the item is created; unique per database - `noCount` (boolean) When true, this item's on hand will always report as zero, and no costs or inventory adjustments will be stored. - `shippingWeight` (number) Shipping Weight of the item. The unit of measure is not specified; this field contains a number only. - `shippingHeight` (number) Shipping Height of the item. The unit of measure is not specified; this field contains a number only. - `shippingWidth` (number) Shipping Width of the item. The unit of measure is not specified; this field contains a number only. - `shippingLength` (number) Shipping Length of the item. The unit of measure is not specified; this field contains a number only. - `uom` (string,null) Unit of Measure; additional text field used to describe the way an item is measured; not often used because we use Dimension 1 for item size - `childCount` (number) Set how much the parent the Child Item of a Parent/Child relationship. Examples: - Parent Child where the Parent is an Each and the Child is a 2 Pack of the Parent the childCount is .5 (1/2). - Parent Child where the Parent is an Each and the Child is a Case Size of 24 the childCount is 0.041666666667 (1/24) - `childUsage` (number) This is the expected usage amount of a child item. This should be the decimal representation of the percentage.This defaults to 1.0 (100%) - `upc` (array,null) - `active` (boolean) True=Item is active in Yellow Dog; False=Item is inactive in Yellow Dog; inactive items can have an on hand count, but are not sold at the POS; this is generally used for seasonal or special event items that are only sold at specific times - `lastUpdated` (string,null) DateTime when this item was last updated in Yellow Dog, in ISO 8601 format. This is not impacted by changes of an Item's onhand value. This is used to indicate when a change to an items configuration has been adjusted. Example Scenarios that would trigger a lastUpdated value change: - Changing an Item's Dimension - Making an Item available to a Store - Adjusting the Item's Retail Price for a Store - Adjusting the Item's Default Retail Price - Changing the Item's Level Assignment - Adjusting an Interface for an Item's Store Example Scenarios that would not trigger a lastUpdated value change: - Item being Sold as part of a Transaction - Item included on an Invoice, Receipt, Purchasing Order Document - `dimension1` (object) - `dimension1.id` (string) DimensionID is the unique identifier for the Dimension; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) - `dimension1.description` (string,null) Description of the Dimension - `dimension2` (object) - `dimension3` (object) - `dimension4` (object) - `dimension5` (object) - `dimension6` (object) - `dimension7` (object) - `dimension8` (object) - `dimension9` (object) - `dimension10` (object) - `level` (object) Level is a hierarchy of groupings that are used for reporting and third party interface purposes - `level.id` (string) LevelID is the unique identifier for the Level; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) - `level.code` (string,null) - `level.description` (string,null) Description of the Level to which the item belongs - `level1` (object) Level is a hierarchy of groupings that are used for reporting and third party interface purposes - `level2` (object) Level is a hierarchy of groupings that are used for reporting and third party interface purposes - `level3` (object) Level is a hierarchy of groupings that are used for reporting and third party interface purposes - `level4` (object) Level is a hierarchy of groupings that are used for reporting and third party interface purposes - `parentItem` (object) - `parentItem.id` (string) - `recipe` (object) - `matrix` (object) - `webProperties` (object) - `webProperties.title` (string,null) Main item description for the item in the web cart; limited to 256 characters; can be HTML if the user specifies formatting in text areas - `webProperties.description` (string,null) A short text description for the item, to be displayed in the web cart; can be HTML if the user specifies formatting in text areas - `webProperties.extendedDescription` (string,null) A longer text description for the item, to be displayed in the web cart; can be HTML if the user specifies formatting in text areas - `webProperties.availableDate` (string,null) DateTime when the item will start to be available to the web cart, in ISO 8601 format - `webProperties.expiresDate` (string,null) DateTime when the item will stop being available to the web cart, in ISO 8601 format. - `webProperties.sale` (boolean) True= This item is on sale and should be sold at either the ItemSaleRetail or ItemSalePercentOff, whichever is present; False=This item should be sold at it's store retail price. - `webProperties.itemSaleRetail` (number,null) Web Sale price; used only when Sale=True; an item can only have either ItemSaleRetail or ItemSalePercentOff, not both - `webProperties.itemSalePercentOff` (number,null) Web sale discount percentage; used when Sale=True; an item can only have either ItemSaleRetail or ItemSalePercentOff, not both - `webProperties.saleBegins` (string,null) DateTime when the Web Sale will begin, in ISO 8601 format - `webProperties.saleEnds` (string,null) DateTime when the Web Sale will end, in ISO 8601 format - `webProperties.available` (boolean) True=This item is available to be sold in the Web Cart; False=This item is not available to be sold in the web cart - `webProperties.flagA` (boolean) True=This item should be designated as Flag A in the web cart; False=This item should not be designated as Flag A in the web cart - `webProperties.flagB` (boolean) True=This item should be designated as Flag B in the web cart; False=This item should not be designated as Flag B in the web cart - `webProperties.flagC` (boolean) True=This item should be designated as Flag C in the web cart; False=This item should not be designated as Flag C in the web cart - `webProperties.tags` (string,null) - `webProperties.productType` (string,null) - `stores` (array,null) Items have specific store availability and can have different on hand counts, retail prices, and costs per store This is only available when expand vendors is passed in the query string. example: /items?Expand=Stores - `stores.id` (string) Yellow Dog's primary key for the Store; always unique; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) - `stores.bin` (string,null) - `stores.reorderPoint` (number) - `stores.parLevel` (number) - `stores.tariffCode` (string,null) - `stores.description` (string,null) Main store description in Yellow Dog - `stores.code` (string,null) Main number associated with the store in the Yellow Dog UI; unique per database - `stores.revenueCenterNumber` (string,null) The code used by the third party system that corresponds to their store/location ID - `stores.onHand` (number) ___WARNING: This value represents a count of inventory that may be hours old because it is not refreshed frequently.___ The latest on hand information for this item or any items since a specified time is accomplished using the POST /inventory endpoint. - `stores.retailPrice1` (number) - `stores.retailPrice2` (number) - `stores.retailPrice3` (number) - `stores.retailPrice4` (number) - `stores.retailPrice5` (number) - `stores.retailPrice6` (number) - `stores.retailPrice7` (number) - `stores.retailPrice8` (number) - `stores.retailPrice9` (number) - `stores.retailPrice10` (number) - `stores.flags` (array,null) Flags designate storage locations, such as Walk-In, Storage Closet, Freezer, etc., making ordering and physical inventories easier - `stores.interfaces` (object,null) These are values that can be set differently per third party system; these values correspond to Yellow Dog's Generic Level A-C and Code A-G, which can be individually named in Yellow Dog to fit your system's naming scheme. For example, if your system has a Major Category, you can rename Generic Level A to Major Category, and you may have Major Category codes and descriptions like 200 Retail, 300 Golf, etc. - `stores.additionalInterfaces` (array,null) List of interfaces that appear to be set to two values In some scenarios it is possible for an Interface to be set to two different values. When this happens the initial value received is added to the Interfaces property:value. Any additional settings will be added to the AdditionalInterfaces as a list of KeyValuePairs. - `stores.additionalInterfaces.key` (string,null) - `stores.additionalInterfaces.value` (string,null) - `vendors` (array,null) Items are assigned to at least one specific vendor in Yellow Dog. This is only available when expand vendors is passed in the query string. example: /items?Expand=Vendors - `vendors.id` (string) Yellow Dog's primary key for the Vendor; always unique; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) - `vendors.code` (string,null) Main number associated with the vendor in the Yellow Dog UI; unique per database - `vendors.description` (string,null) Main vendor description in Yellow Dog - `vendors.sku` (string,null) Vendor's unique ID for the item - `vendors.price` (number) Vendor's Price for the item - `vendors.isPrimary` (boolean) - `images` (array,null) - `images.placement` (integer) - `images.description` (string,null) - `images.imageURL` (string,null) - `shortDescription` (string,null) Short Description of the item; this is a free form text field that should describe the item in less characters than the item.Description. This is commonly used for smaller screen devices or when a more concise description is needed. This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `isEvergreen` (boolean,null) Evergreen items are items that do not expire or do not "Age". This indicator is used to help manage the items that are always good for inventory or do not turn by season/year. This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `style` (string,null) Style code of the item. This is used to group like items together, such as a matrix of shirts that all have the same Style code/number. This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `expirationDays` (number,null) Generally, how many days before this type of item expires once added to inventory. This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `reference` (string,null) Free text field for additional reference notes or identifiers. Reference has no specific business use within YDI. Use this field to record other necessary, customer-specific information. This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `attributes` (string,null) This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item - `dimensions` (object,null) This value is only available when the expand option Dimensions is passed in the query string example: /items?Expand=Dimensions ## Response 500 fields (application/json): - `message` (string,null) - `errors` (array,null) - `errors.extensions` (string,null) ## Response 429 fields