[CFAMX-6218] Spike - Order API Framework - HotSchedules JIRA

Details

Type: Story
Status: Closed (View Workflow)
Resolution: Completed
Affects Version/s: None
Fix Version/s: CFA 2020R1
Component/s: Inventory
Labels:
- API
- Ordering

Sprint:
CFAMX 2020R1 Sprint 2, CFAMX 2020R1 Sprint 3
SCRUM Team:
Brotherhood of Mutants
Story Points:
2
Work Type Classification:
Sustaining

Description

Story
As a supply chain user, I would like the ability to send and receive order information via an API.

Details
Put together the necessary documentation on Confluence for sending and receiving orders through an API. The confluence link can be found at:
CFA Confluence: https://cfacorp.atlassian.net/wiki/spaces/IN/pages/251429383/Create+API+to+support+receiving+of+an+order
HS Confluence: https://fourthlimited.atlassian.net/wiki/spaces/RBCD/pages/1667465336/CFA+-+InFORM+Enter+Order+via+API

Need to research and document what is needed to do an integration between a third-party device and InFORM. The API(s) will need to support sending and receiving data to an external device.

The initial thought is two methods will be required.
POST method -pushes placed orders
GET method -retrieving received orders

Some notes

GET list of available open orders (Store/Distributor)
GET a specific order (Order Number)
Manipulate order data
POST order details to InFORM in a received status

Will NOT support Correct Receive
Only orders in placed/Shipped status will be returned
Note: will be used for produce, outer will be scanned, and then passed to InFORM (tracking/trace-ability).
Will NOT support adding items to order

Acceptance Criteria:

Confirm that the Ordering API is documented in Confluence
Confirm the API can push a list of open orders.
Confirm that the API can retrieve a list of available open Orders (Store/Distributor)
Confirm that the API can retrieve a specific Order (Order Number)
Confirm that the API can retrieve orders into InFORM with a status of received.
New API Call
- Confirm that there is a new API that takes in the Store Number and returns the Entity Id
- Confirm that this new API is documented
- Staten Putnal Please add a confluence page for this new endpoint