API Test Cases

Below are the written steps to take to complete the test cases via API.

NOTE: You would use the Stage Portal Testing module to create your test orders as well as see the results on the files you send back (Acknowledgement, Shipment, Invoice).

Test Case Summary (see further below for the steps to take for each test):

TC1 - Multi-Line Ship in Multiple Boxes/Containers
- The purpose of this test is to send multiple boxes in a single Shipment file while specifying which items and quantities go in each box, then Invoice all shipped items.
TC2 - Cancel All Items
- The purpose of this test is to cancel all lines on the order via the Acknowledgement file.
TC3 - Partial Cancel First and Ship the Rest in Full
- The purpose of this test is to do a partial cancel of a single line and to accept/ship the remaining items in multiple boxes/containers, then Invoice all shipped items.
TC4 - Multi-Line Ship (Conditional)
- TC4 - Multi-Line Ship - The purpose of this test is to send multiple items in a single box and Shipment (856) file).
- TC4A - Multi-Line + Perishable Undeliverable Return - The purpose of this test is to send multiple items in a single box and Shipment (856) file, and return the perishable order as undeliverable/refused.
- Note: If you are not shipping perishable items, you complete TC4 and skip TC4A. If you are shipping perishable items, you skip TC4 and move on to TC4A.

TC1 - Multi-Line Ship in Multiple Boxes/Containers

Step	Document	Description	FTP/SFTP
1	Order	Vendor/Supplier will create the order in Stage Portal, then Logicbroker will send the order through the established connection. The order will contain two lines of items.	Follow the documentation and instructions at Supplier Order Lifecycle for getting an order.
2	Ack	The acknowledgement file should accept all quantities of the order. The estimated ship date should be included.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an acknowledgement.
3	Shipment	The shipment file will need to make sure to ship the order in 2 different boxes/containers (2 different tracking numbers). In the first box, quantity 1 (of 1 ordered) and quantity 2 (of 4). In the second box, the remaining quantity 2 (of 4). Make note of the shipping method requested on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting a shipment.
4	Invoice	The invoice will be for all shipped items on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an invoice.
5	Review Test Results	NOTE: Go back to the Testing module in Stage Portal to review the results of your tests.

NOTE: When you pick up an order from FTP/SFTP, you should either pick it up and delete it from the FTP folder location OR move it to a folder under /APIXML/Archive or /JSON/Archive.

TC2 - Cancel All Items

Step	Document	Description	FTP/SFTP
1	Order	Vendor/Supplier will create the order in Stage Portal, then Logicbroker will send the order through the established connection. The order will contain two lines of items.	Follow the documentation and instructions at Supplier Order Lifecycle for getting an order.
2	Ack	The acknowledgement file should cancel all lines and quantities of the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an acknowledgement.
3	Review Test Results	NOTE: Go back to the Testing module in Stage Portal to review the results of your tests.

TC3 - Partial Cancel First and Ship the Rest in Full

Step	Document	Description	FTP/SFTP
1	Order	Vendor/Supplier will create the order in Stage Portal, then Logicbroker will send the order through the established connection. The order will contain three lines of items.	Follow the documentation and instructions at Supplier Order Lifecycle for getting an order.
2	Ack	The acknowledgement file should cancel line 1, quantity 2 (of 4 ordered) and accept the second and third line of the drop ship order. Any cancel/change reason is acceptable. The estimated ship date should be included.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an acknowledgement.
3	Shipment	The shipment file will need to make sure to ship the order in 3 different boxes/containers (3 different tracking numbers). In the first box, line 1, quantity 2 (of 4 ordered). In the second box, line 2, quantity 2 (of 2). In the third box, line 3, quantity 1 (of 1). Make note of the shipping method requested on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting a shipment.
4	Invoice	The invoice file will be for all shipped items on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an invoice.
5	Review Test Results	NOTE: Go back to the Testing module in Stage Portal to review the results of your tests.

TC4 - Multi-Line Ship

Step	Document	Description	FTP/SFTP
1	Order	Vendor/Supplier will create the order in Stage Portal, then Logicbroker will send the order through the established connection. The order will contain one line.	Follow the documentation and instructions at Supplier Order Lifecycle for getting an order.
2	Ack	The acknowledgement file should accept all lines of the order. The estimated ship date should be included.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an acknowledgement.
3	Shipment	The shipment file will need to make sure to ship the order in 1 box. Make note of the shipping method requested on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting a shipment.
4	Invoice	The invoice file will be for all shipped items on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an invoice.
5	Review Test Results	NOTE: Go back to the Testing module in Stage Portal to review the results of your tests.

TC4A - Invoicing + Perishable Undeliverable Return (Conditional)

Step	Document	Description	FTP/SFTP
1	Order	Vendor/Supplier will create the order in Stage Portal, then Logicbroker will send the order through the established connection. The order will contain one line.	Follow the documentation and instructions at Supplier Order Lifecycle for getting an order.
2	Ack	The acknowledgement file should accept all lines of the order. The estimated ship date should be included.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an acknowledgement.
3	Shipment	The shipment file will need to make sure to ship the order in 1 box. Make note of the shipping method requested on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting a shipment.
4	Invoice	The invoice file will be for all shipped items on the order.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an invoice.
5	Return	The return file will be for all shipped items on the order. Make sure the Return Reason is Undeliverable/Refused.	Follow the documentation and instructions at Supplier Order Lifecycle for posting an invoice.
6	Review Test Results	NOTE: Go back to the Testing module in Stage Portal to review the results of your tests.

Articles in this section

Comments