Skip to main content

API: Firm and Planned Orders (Legacy)

Updated

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: Gets a  list of firm-and-planned orders, organized by Order Date

Resource: FirmAndPlannedOrderDetail/

Verb: GET

Query String Options:

  • SupplierLevel:
    • 1 = Primary (Ex: & supplierLevels = 1)
  • showLoadBalancedPlan
    true
    false
  • interval:
    • 2 = Weekly
    • 4 = Monthly
  • supplierId (optional)
    • The ID associated with the supplier you would like to filter on

Returns: JSON Array of FirmAndPlannedDetail objects

Example URL:

https://ABC.stockiqtech.net/api/FirmAndPlannedOrderDetail?interval=4&showLoadBalancedPlan=true

Example Response JSON:

[{
"TotalQuantity": 451.00000,
"TotalDollars": 2255.000000000,
"TotalCubes": 0.0,
"SupplierId": 26,
"ItemId": 33,
"SiteId": 6,
"ItemSiteId": 29,
"MonthId": 60,
"SupplierCode": "V0035",
"SupplierName": "Vendor V0035",
"ItemCode": "0101010",
"SiteCode": "261",
"ItemDescription": "Contoso 4G MP3 Player E400 Green",
"SupplierItemCode": "0101010",
"AbcClass": "C",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"PeriodDate": "2020/06/01",
"PeriodStartDate": "2020/06/01",
"PeriodEndDate": "2020/06/30",
"PlannedQuantity": 451.00000,
"PlannedDollars": 2255.000000000
}, {
"TotalQuantity": 840.00000,
"TotalDollars": 4200.000000000,
"TotalCubes": 0.0,
"SupplierId": 26,
"ItemId": 33,
"SiteId": 1,
"ItemSiteId": 30,
"MonthId": 61,
"SupplierCode": "V0035",
"SupplierName": "Vendor V0035",
"ItemCode": "0101010",
"SiteCode": "111",
"ItemDescription": "Contoso 4G MP3 Player E400 Green",
"SupplierItemCode": "0101010",
"AbcClass": "A",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"PeriodDate": "2020/07/01",
"PeriodStartDate": "2020/07/01",
"PeriodEndDate": "2020/07/31",
"FirmQuantity": 840.00000,
"FirmDollars": 4200.000000000
}, {
"TotalQuantity": 3962.00000,
"TotalDollars": 19810.000000000,
"TotalCubes": 0.0,
"SupplierId": 26,
"ItemId": 33,
"SiteId": 1,
"ItemSiteId": 30,
"MonthId": 63,
"SupplierCode": "V0035",
"SupplierName": "Vendor V0035",
"ItemCode": "0101010",
"SiteCode": "111",
"ItemDescription": "Contoso 4G MP3 Player E400 Green",
"SupplierItemCode": "0101010",
"AbcClass": "A",
"ItemSiteCategory1Name": "Audio",
"ItemSiteCategory2Name": "MP4&MP3",
"ItemSiteCategory3Name": "Unassigned",
"ItemSiteCategory4Name": "Unassigned",
"ItemSiteCategory5Name": "Unassigned",
"PeriodDate": "2020/09/01",
"PeriodStartDate": "2020/09/01",
"PeriodEndDate": "2020/09/30",
"PlannedQuantity": 3962.00000,
"PlannedDollars": 19810.000000000
}
...
]

Related articles