GET shrink/TheftFraudDataPackage/GetDataPackage/{division}/{region}/{district}/{mailCode}/{year}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| division | string |
Required |
|
| region | string |
Required |
|
| district | string |
Required |
|
| year | integer |
Required |
|
| mailCode | string |
None. |
Body Parameters
None.
Response Information
Resource Description
TheftFraudDataPackage| Name | Description | Type | Additional information |
|---|---|---|---|
| APMFacts | Collection of TheftFraudAPMFact |
None. |
|
| Fact | TheftFraudFact |
None. |
|
| AssociateFactsAPS | Collection of TheftFraudAssociateFact |
None. |
|
| AssociateFactsAPM | Collection of TheftFraudAssociateFact |
None. |
|
| FactDetails | Collection of TheftFraudOrgFact |
None. |
|
| RateFactItem | RateFact |
None. |
|
| CaseStatistics | Collection of TheftFraudCaseStatistic |
None. |
|
| ShrinkFacts | Collection of TheftFraudShrinkFact |
None. |
|
| RoutineReportingFacts | Collection of RoutineReportingFact |
None. |
Response Formats
application/json, text/json
Sample:
{
"APMFacts": [
{
"APMType": "sample string 1",
"InternalCount": 2.1,
"InternalDollars": 3.1,
"LYInternalDollars": 4.1,
"LYInternalCount": 5.1,
"LaborHours": 6.1,
"LYLaborHours": 7.1,
"SalesPlan": 8.1,
"LYSalesPlan": 9.1,
"InternalAvgValue": 10.1,
"LYInternalAvgValue": 11.1,
"InternalAppsMetric": 12.1,
"LYInternalAppsMetric": 13.1,
"PercentDifference": 14.1
},
{
"APMType": "sample string 1",
"InternalCount": 2.1,
"InternalDollars": 3.1,
"LYInternalDollars": 4.1,
"LYInternalCount": 5.1,
"LaborHours": 6.1,
"LYLaborHours": 7.1,
"SalesPlan": 8.1,
"LYSalesPlan": 9.1,
"InternalAvgValue": 10.1,
"LYInternalAvgValue": 11.1,
"InternalAppsMetric": 12.1,
"LYInternalAppsMetric": 13.1,
"PercentDifference": 14.1
}
],
"Fact": {
"FiscalYear": 1,
"FiscalWeek": 2,
"InternalCount": 3.1,
"ExternalCount": 4.1,
"LYInternalCount": 5.1,
"LYExternalCount": 6.1,
"InternalDollars": 7.1,
"ExternalDollars": 8.1,
"LYInternalDollars": 9.1,
"LYExternalDollars": 10.1,
"LaborHours": 11.1,
"LYLaborHours": 12.1,
"SalesPlan": 13.1,
"LYSalesPlan": 14.1,
"ExternalAvgValue": 15.1,
"InternalAvgValue": 16.1,
"LYExternalAvgValue": 17.1,
"LYInternalAvgValue": 18.1,
"ExternalAppsMetric": 19.1,
"LYExternalAppsMetric": 20.1,
"InternalAppsMetric": 21.1,
"LYInternalAppsMetric": 22.1,
"PercentDifference": 23.1,
"NRI": 24.1,
"KT": 25.1,
"MRI": 26.1,
"RAI": 27.1,
"SIR": 28.1,
"RWD": 29.1,
"LYNRI": 30.1,
"LYKT": 31.1,
"LYMRI": 32.1,
"LYRAI": 33.1,
"LYSIR": 34.1,
"LYRWD": 35.1
},
"AssociateFactsAPS": [
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:12:53.8303866-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:12:53.8303866-04:00"
},
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:12:53.8303866-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:12:53.8303866-04:00"
}
],
"AssociateFactsAPM": [
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:12:53.8303866-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:12:53.8303866-04:00"
},
{
"UserID": "sample string 1",
"AssociateName": "sample string 2",
"Stores": "sample string 3",
"Division": "sample string 4",
"Region": "sample string 5",
"District": "sample string 6",
"Type": "sample string 7",
"InternalCount": 8.1,
"ExternalCount": 9.1,
"LYInternalCount": 10.1,
"LYExternalCount": 11.1,
"InternalDollars": 12.1,
"ExternalDollars": 13.1,
"LYInternalDollars": 14.1,
"LYExternalDollars": 15.1,
"LaborHours": 16.1,
"LYLaborHours": 17.1,
"SalesPlan": 18.1,
"LYSalesPlan": 19.1,
"ExternalAvgValue": 20.1,
"InternalAvgValue": 21.1,
"LYExternalAvgValue": 22.1,
"LYInternalAvgValue": 23.1,
"ExternalAppsMetric": 24.1,
"LYExternalAppsMetric": 25.1,
"InternalAppsMetric": 26.1,
"LYInternalAppsMetric": 27.1,
"PercentDifference": 28.1,
"CompanyRank": 29,
"DivisionRank": 30,
"RegionRank": 31,
"DistrictRank": 32,
"CompanyCount": 33,
"DivisionCount": 34,
"RegionCount": 35,
"DistrictCount": 36,
"BeginDate": "2025-05-02T23:12:53.8303866-04:00",
"CurriculumPastDue": [
"sample string 1",
"sample string 2"
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReporting": {
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
"CaseDetails": [
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
},
{
"MailCode": "sample string 1",
"Division": "sample string 2",
"Region": "sample string 3",
"District": "sample string 4",
"IICE_ID": "sample string 5",
"EventDate": "2025-05-02T23:12:53.8303866-04:00",
"EventSubType": "sample string 7",
"CaseValue": 1.1,
"Category": "sample string 8"
}
],
"APCertFlag": "sample string 38",
"APCertDate": "2025-05-02T23:12:53.8303866-04:00"
}
],
"FactDetails": [
{
"OrgItem": "sample string 1",
"APMCount": 2,
"APSCount": 3,
"FiscalYear": 4,
"FiscalWeek": 5,
"InternalCount": 6.1,
"ExternalCount": 7.1,
"LYInternalCount": 8.1,
"LYExternalCount": 9.1,
"InternalDollars": 10.1,
"ExternalDollars": 11.1,
"LYInternalDollars": 12.1,
"LYExternalDollars": 13.1,
"LaborHours": 14.1,
"LYLaborHours": 15.1,
"SalesPlan": 16.1,
"LYSalesPlan": 17.1,
"ExternalAvgValue": 18.1,
"InternalAvgValue": 19.1,
"LYExternalAvgValue": 20.1,
"LYInternalAvgValue": 21.1,
"ExternalAppsMetric": 22.1,
"LYExternalAppsMetric": 23.1,
"InternalAppsMetric": 24.1,
"LYInternalAppsMetric": 25.1,
"PercentDifference": 26.1,
"NRI": 27.1,
"KT": 28.1,
"MRI": 29.1,
"RAI": 30.1,
"SIR": 31.1,
"RWD": 32.1,
"LYNRI": 33.1,
"LYKT": 34.1,
"LYMRI": 35.1,
"LYRAI": 36.1,
"LYSIR": 37.1,
"LYRWD": 38.1
},
{
"OrgItem": "sample string 1",
"APMCount": 2,
"APSCount": 3,
"FiscalYear": 4,
"FiscalWeek": 5,
"InternalCount": 6.1,
"ExternalCount": 7.1,
"LYInternalCount": 8.1,
"LYExternalCount": 9.1,
"InternalDollars": 10.1,
"ExternalDollars": 11.1,
"LYInternalDollars": 12.1,
"LYExternalDollars": 13.1,
"LaborHours": 14.1,
"LYLaborHours": 15.1,
"SalesPlan": 16.1,
"LYSalesPlan": 17.1,
"ExternalAvgValue": 18.1,
"InternalAvgValue": 19.1,
"LYExternalAvgValue": 20.1,
"LYInternalAvgValue": 21.1,
"ExternalAppsMetric": 22.1,
"LYExternalAppsMetric": 23.1,
"InternalAppsMetric": 24.1,
"LYInternalAppsMetric": 25.1,
"PercentDifference": 26.1,
"NRI": 27.1,
"KT": 28.1,
"MRI": 29.1,
"RAI": 30.1,
"SIR": 31.1,
"RWD": 32.1,
"LYNRI": 33.1,
"LYKT": 34.1,
"LYMRI": 35.1,
"LYRAI": 36.1,
"LYSIR": 37.1,
"LYRWD": 38.1
}
],
"RateFactItem": {
"EntityType": "sample string 1",
"EntityName": "sample string 2",
"OSHARate": 3.1,
"LTRate": 4.1,
"GLBIRate": 5.1,
"LYOSHARate": 6.1,
"LYLTRate": 7.1,
"LYGLBIRate": 8.1,
"OSHADifferential": 9.1,
"OSHAPlan": 10.1,
"GLBIDifferentialLY": 11.1
},
"CaseStatistics": [
{
"EventType": "sample string 1",
"MostRecentCase": "2025-05-02T23:12:53.8303866-04:00"
},
{
"EventType": "sample string 1",
"MostRecentCase": "2025-05-02T23:12:53.8303866-04:00"
}
],
"ShrinkFacts": [
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
},
{
"FacilityID": 1,
"MailCode": "sample string 2",
"Division": "sample string 3",
"Region": "sample string 4",
"District": "sample string 5",
"TYShrink": 1.1,
"LYShrink": 1.1,
"Y3Shrink": 1.1,
"InventoryDate": "2025-05-02T23:12:53.8303866-04:00",
"TYShrinkGoal": 1.1,
"LYShrinkGoal": 1.1,
"TYSalesGoal": 1.1,
"LYSalesGoal": 1.1,
"TYInventorySales": 1.1,
"LYInventorySales": 1.1,
"Y3InventorySales": 1.1
}
],
"RoutineReportingFacts": [
{
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
},
{
"Entity": "sample string 1",
"EntityType": "sample string 2",
"FiscalYear": 3,
"FiscalPeriod": 4,
"Daily": 1.1,
"Weekly": 1.1,
"Quarterly": 1.1,
"Monthly": 1.1,
"Overnight": 1.1,
"Total": 1.1,
"ReportingType": "sample string 5"
}
]
}