NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document
Description: Returns the Due to Buy grid from the Due To Buy screen in the Sales module
Resource: CustomerItemDueToBuyDetail/
Verb: GET
Query String Arguments
-
itemStatus (option):
- 1 = Active
- 2 = Discontinued
-
usagePatterns (optional):
- 0 = Unknown
- 1 = New
- 2 = Recurring
- 4 = Sporadic
- 8 = Slow
- 16 = Dead
Returns: JSON Array containing records matching due to buy details
Example Response JSON:
[{
"DaysSinceLastPurchase": 82,
"ProbabilityOfPurchase": 0.55068364001480385,
"LostCustomerItemRecordExists": false,
"CustomerId": 8,
"CustomerCode": "HD",
"CustomerName": "Home Depot, Inc.",
"ItemId": 1,
"ItemCode": "0101023",
"ItemDescription": "Contoso 8GB MP3 Player new model M820 White",
"ItemSiteCategory1Id": 2,
"ItemSiteCategory2Id": 8,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"MeanInterarrivalDays": 103,
"MaxOnTimeInterarrivalDays": 133,
"GeometricParameter": 0.0097090000,
"CustomerItemStatus": 2,
"CustomerItemUsagePattern": 8,
"ExpectedNextPurchaseDate": "2024/07/08",
"LatestExpectedNextPurchaseDate": "2024/08/07",
"FirstPurchaseDate": "2021/06/02",
"LastPurchaseDate": "2024/03/27",
"LastOrderNumber": "00040361",
"LifetimeQuantitySold": 17.00000,
"LifetimeHits": 17.00000,
"LifetimeCogs": 176.00661,
"LifetimeRevenue": 264.01000,
"LifetimeMargin": 88.00339,
"YTDQuantitySold": 2.00000,
"YTDHits": 2.00000,
"YTDCogs": 20.70666,
"YTDRevenue": 31.06000,
"YTDMargin": 10.35334,
"LostItemCustomerId": 0
},
{
"DaysSinceLastPurchase": -66,
"ProbabilityOfPurchase": -2.0901584265864042,
"LostCustomerItemRecordExists": false,
"CustomerId": 307,
"CustomerCode": "SIQ11310",
"CustomerName": "Erin Sanders",
"ItemId": 3,
"ItemCode": "0101018",
"ItemDescription": "Contoso 8GB Super-Slim MP3/Video Player M800 Green",
"ItemSiteCategory1Id": 2,
"ItemSiteCategory2Id": 8,
"ItemSiteCategory3Id": 1,
"ItemSiteCategory4Id": 1,
"ItemSiteCategory5Id": 1,
"ItemSiteCategory6Id": 1,
"ItemSiteCategory7Id": 1,
"ItemSiteCategory8Id": 1,
"MeanInterarrivalDays": 59,
"MaxOnTimeInterarrivalDays": 89,
"GeometricParameter": 0.0169490000,
"CustomerItemStatus": 2,
"CustomerItemUsagePattern": 2,
"ExpectedNextPurchaseDate": "2024/10/20",
"LatestExpectedNextPurchaseDate": "2024/11/19",
"FirstPurchaseDate": "2024/02/15",
"LastPurchaseDate": "2024/08/22",
"LastOrderNumber": "00046533",
"LifetimeQuantitySold": 13.00000,
"LifetimeHits": 8.00000,
"LifetimeCogs": 43.03000,
"LifetimeRevenue": 45.76000,
"LifetimeMargin": 2.73000,
"YTDQuantitySold": 13.00000,
"YTDHits": 8.00000,
"YTDCogs": 43.03000,
"YTDRevenue": 45.76000,
"YTDMargin": 2.73000,
"LostItemCustomerId": 0
},
... ]