Proposal summary
The proposal covers the scope of Shipping Integration of MaxOptra and NetSuite
Requirement
The requirement is to analyze the API documentation of MaxOptra and finalize the Shipping Integration that needs to be performed
Our Solution
Shipment creation
We had analyzed the requirement and we will be using order create API in the Maxoptra API documentation for this Integration.
We will initiate the API call to create order in MaxOptra when an IF is created in NetSuite.
We are planning to create a user event script for fetching the details from the IF at the create context. Then we will send the request to the MaxOptra in JSON Format. We’ll get to know if the request was success or failure from the response of it
We will be sending the IF Internal id as the order reference In the JSON body. So that using the same internal id we can perform the deletion if the shipping method is changed.
If the request was a failure, we are planning to create a checkbox named “Exported to MaxOptra” to identify it. So, the checkbox will be true when the order is successfully imported to the Maxoptra else it will be false.
We’ll also save the error response from Maxoptra in a custom field in IF. So that you can rectify it and initiate it again at edit and save of Item Fulfilment.
We will be creating the shipment in MaxOptra only for the IFs that have the following shipping methods
- Harbour Van
- Packaging Removal
- Pergola Assembly
- Harbour Van Platinum
Shipment Deletion
When the shipping method in any of the IFs that are already exported to Maxoptra changes to anything other than the following shipping methods, we will call the delete order API
- Harbour Van
- Packaging Removal
- Pergola Assembly
- Harbour Van Platinum
In the edit context of all the IFs in which the “Exported to MaxOptra” Checkbox is true, we will check for the shipping method. If the shipping method is none of the above-mentioned ones, we will initiate the delete order API call with the order reference as the internal id of the IF. So that the corresponding Shipment will be deleted from the MaxOptra.
If the shipment Is successfully deleted then the response from MaxOptra would be “OK”. If it is “OK”, we will create another checkbox called “Deleted from MaxOptra” and flag it. So that this IF won’t be considered ever again in any of the context.
Prerequisites
- MaxOptra account Credentials
- API Key for Authentication
- MaxOptra account URL
Assumptions
- We assume that we can create a user event script and trigger it at the creation of IF itself without checking the IF status. Please confirm.
- We’ll be sending the details in the JSON format.
- We’ll create test IFs and send it to the MaxOptra for testing purpose.
- We’ll be referring the this documentation in the development of script
- We assume that the shipment will only be created in MaxOptra for the IFs that have following shipping methods
- Harbour Van
- Packaging Removal
- Pergola Assembly
- Harbour Van Platinum
- The creating shipment process will work at the create and edit context until the “Exported to MaxOptra” Checkbox is checked.
- The deleting shipment process will work at the edit context for the IF in which the “Exported to MaxOptra” is true.
- Once we delete it, we will make the “Deleted from MaxOptra” checkbox as true. If it is true the script won’t consider that IF record again.
Risks
- If the API request returns any error in response, at the edit and save of IF we will call the Order API again. So if the error was resolved, the order will be created in MaxOptra.
Time
36 Hours