GET storesearch/ShrinkDataPackage/{year}/{scope}/{searchTerm}?division={division}®ion={region}&district={district}&mailCode={mailCode}&id={id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| division | string |
Required |
|
| region | string |
Required |
|
| district | string |
Required |
|
| mailCode | string |
Required |
|
| year | integer |
Required |
|
| id | string |
Required |
|
| scope | string |
None. |
|
| searchTerm | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ShrinkFact| Name | Description | Type | Additional information |
|---|---|---|---|
| OrgItem | string |
None. |
|
| TYShrink | decimal number |
None. |
|
| LYShrink | decimal number |
None. |
|
| Y3Shrink | decimal number |
None. |
|
| Y4Shrink | decimal number |
None. |
|
| TYShrinkPct | decimal number |
None. |
|
| LYShrinkPct | decimal number |
None. |
|
| Y3ShrinkPct | decimal number |
None. |
|
| Y4ShrinkPct | decimal number |
None. |
|
| TYInventorySales | decimal number |
None. |
|
| LYInventorySales | decimal number |
None. |
|
| Y3InventorySales | decimal number |
None. |
|
| Y4InventorySales | decimal number |
None. |
|
| LYBasisPoints | decimal number |
None. |
|
| Y3BasisPoints | decimal number |
None. |
|
| Y4BasisPoints | decimal number |
None. |
|
| TYBasisPointsGoal | decimal number |
None. |
|
| LYBasisPointsGoal | decimal number |
None. |
|
| Y3BasisPointsGoal | decimal number |
None. |
|
| Y4BasisPointsGoal | decimal number |
None. |
|
| InventoryDate | date |
None. |
|
| ShrinkFlag | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OrgItem": "sample string 1",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"Y4Shrink": 1.1,
"TYShrinkPct": 1.1,
"LYShrinkPct": 1.1,
"Y3ShrinkPct": 1.1,
"Y4ShrinkPct": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1,
"Y4InventorySales": 1.1,
"LYBasisPoints": 1.1,
"Y3BasisPoints": 1.1,
"Y4BasisPoints": 1.1,
"TYBasisPointsGoal": 1.1,
"LYBasisPointsGoal": 1.1,
"Y3BasisPointsGoal": 1.1,
"Y4BasisPointsGoal": 1.1,
"InventoryDate": "2025-05-02T23:50:42.5231148-04:00",
"ShrinkFlag": "sample string 3"
},
{
"OrgItem": "sample string 1",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"Y4Shrink": 1.1,
"TYShrinkPct": 1.1,
"LYShrinkPct": 1.1,
"Y3ShrinkPct": 1.1,
"Y4ShrinkPct": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1,
"Y4InventorySales": 1.1,
"LYBasisPoints": 1.1,
"Y3BasisPoints": 1.1,
"Y4BasisPoints": 1.1,
"TYBasisPointsGoal": 1.1,
"LYBasisPointsGoal": 1.1,
"Y3BasisPointsGoal": 1.1,
"Y4BasisPointsGoal": 1.1,
"InventoryDate": "2025-05-02T23:50:42.5231148-04:00",
"ShrinkFlag": "sample string 3"
}
]