61 lines
2.3 KiB
TypeScript
61 lines
2.3 KiB
TypeScript
/**
|
|
* will store and maintain all queries for datamart here.
|
|
* this way they can all be easily maintained and updated as we progress with the changes and updates to v3
|
|
*
|
|
* for options when putting them into the docs we will show examples on how to pull this
|
|
*/
|
|
|
|
export const datamartData = [
|
|
{
|
|
name: "Active articles",
|
|
endpoint: "activeArticles",
|
|
description: "returns all active articles for the server with custom data",
|
|
options: "",
|
|
optionsRequired: false,
|
|
},
|
|
{
|
|
name: "Delivery by date range",
|
|
endpoint: "deliveryByDateRange",
|
|
description: `Returns all Deliveries in selected date range IE: 1/1/${new Date(Date.now()).getFullYear()} to 1/31/${new Date(Date.now()).getFullYear()}`,
|
|
options: "startDate,endDate",
|
|
optionsRequired: true,
|
|
howManyOptionsRequired: 2,
|
|
},
|
|
{
|
|
name: "Get Customer Inventory",
|
|
endpoint: "customerInventory",
|
|
description: `Returns specific customer inventory based on there address ID, IE: 8,12,145. \nWith option to include specific warehousesIds, IE 36,41,5. \nNOTES: *leaving warehouse blank will just pull everything for the customer, Inventory dose not include PPOO or INV`,
|
|
options: "customer,whseToInclude",
|
|
optionsRequired: true,
|
|
howManyOptionsRequired: 1,
|
|
},
|
|
{
|
|
name: "Get open order",
|
|
endpoint: "openOrders",
|
|
description: `Returns open orders based on day count sent over, IE: startDay 15 days in the past endDay 5 days in the future, can be left empty for this default days`,
|
|
options: "startDay,endDay",
|
|
optionsRequired: true,
|
|
howManyOptionsRequired: 2,
|
|
},
|
|
{
|
|
name: "Get inventory",
|
|
endpoint: "inventory",
|
|
description: `Returns all inventory, excludes inv location. adding an x in one of the options will enable it.`,
|
|
options: "includeRunningNumbers,locations,lots",
|
|
},
|
|
{
|
|
name: "Fake EDI Update",
|
|
endpoint: "fakeEDIUpdate",
|
|
description: `Returns all open orders to correct and resubmit via lst demand mgt, leaving blank will get everything putting an address only returns the specified address. \nNOTE: only orders that were created via edi will populate here.`,
|
|
options: "address",
|
|
},
|
|
{
|
|
name: "Production Data",
|
|
endpoint: "productionData",
|
|
description: `Returns all production data from the date range with the option to have 1 to many avs to search by.`,
|
|
options: "startDate,endDate,articles",
|
|
optionsRequired: true,
|
|
howManyOptionsRequired: 2,
|
|
},
|
|
];
|