GET Waste Items

As a third party system I want to be able to GET active Items that can be Wasted and relevant details from InFORM so that when I send a Waste transaction I can include the appropriate details

Notes

• Note: We do not have any details about the solutions that CFA are planning to implement, other than they would like to use APIs to inject waste, this story is a part of the effort to provide robust, external facing API calls that can be used to GET and POST data.
• Response should include details that we will require when sending a waste transaction to InFORM
• For example:
  • Item Code (Not Item ID)
  • Outer - Unit Of Measure
  • Inner - Unit Of Measure
  • Unit - Unit Of Measure
  • Metric Unit - Unit Of Measure
  • Raw / Finished (I am not sure whether this is necessary in the response or not?
• Note: UOM can vary between stores, therefore this request, to InFORM must include a Store Number

Acceptance Criteria

1. Confirm that the request is restaurant specific
2. Confirm that the response is as streamlined as possible, and only returns data that truly needs to be passed back to InFORM to inject a Waste transaction via the new API calls being developed under this feature
3. Confirm that the response only returns data for items that are InUse/Active at the store requested
4. Confirm that the response identifies the item using the item code
5. Confirm that the response includes the following units of measures, if configured:
   • Outer
   • Inner
   • Unit
   • Metric Unit
6. Confirm that the developer has documented the call in Confluence
   • Variable names
   • Variable definitions
   • Variable usage
   • Example Call
   • Example response
   • See this page for guidance: https://cfacorp.atlassian.net/l/c/yje7GDs6