Electra Logistic for Generic Orders

Document Logs
Change log:

Terms and definitions:

---- 

1 - Purpose of Document

This document provides the overall technical details and design of implementing and using the functionality as specified in section 2 - Introduction. This document will not cover implementation details – for this the code base should be inspected.

2 - Introduction to Functionality

The Electra Logistics Engine handles the order placing and the retrieval of the order status from Electra.

The Electra Logistic for Generic Orders uses the generic order framework in core. While the Electra Logistic Engine project uses the shop order and webshop.

3 - API

The Electra Logistic for Generic Orders is located in

<dependency>
  <groupId>com.cdrator.integration.logistics</groupId>
  <artifactId>rator-logistics-dk-electra-generic</artifactId>
</dependency>

The way to invoke functionality in the project is through Actions, which there are presently two of

PlaceOrder

For placing a new order an Electra

@Action
@Description("Place a generic order to Electra")
public class PlaceOrder {

	/**
	 * Place an order at Electra
	 *
	 * Possible outcomes:
	 * DONE: Succesfull
	 * ERROR: unexpected error
	 *
	 * @param order
	 * @return
	 * @throws Exception
	 */
	@ActionMethod
	@ReturnValue(description = @Description("String: DONE, ERROR"))
	public String execute(GenericOrder order) throws Exception {}

The order must have

• 1-* order lines, which have DESCRIPTION, PRODUCTNUMBER and optional QUANTITY in parameters. If no quantity is present, '1' will be send
• a valid deliveryAddress, which have FULLNAME, ADDRESS1, CITY, ZIP. Optional COMPANY.
• a valid ACCOUNT, use to find brand
• an ORDER_NUMBER

If no errors occurred which communicating with Electra the ACTION will return "DONE", other wise it will return "ERROR".

Order status

sdadsa

4 - Configuration

Parameters under ENGINE.LOGISTICS.ELECTRA

5 - Operational Considerations

Security

At time of writing Electra validates incoming requests based upon the senders IP. No other security is used.

Migration

The Electra Logistics Engine solely picks up ShopOrders with the field logistic_key set 'ELECTRA'.
ShopSKU's which should be handled by Electra should have the field logistics_provider_key changed to 'ELECTRA'.