...
| API | In params | Response | Provider name |
|---|---|---|---|
| GetPrice | Authentication information A list of part numbers | Price and currency for each part. NLA code for each part. Replacement information for each part. Result codes (message and error on each part) | <PriceProvider> |
GetAvailability | Authentication information A list of part numbers | List of availabilities for each part (if several warehouses) Result codes (message and error on each part) | <AvailabilityProvider> |
| GetAddresses | Authentication information | List of addresses List of order types Temporary address permission (optional) Result code (message and error on each address) | <AddressProvider> |
| AddToOrderCart | Authentication information A list of part numbers | Order line results Result codes | <AddToOrderCartProvider> |
PlaceOrder / ValidateOrder | Authentication information Order (header and order lines) | Order (updated if needed with NLA and replacements) Resut Result codes (message on order, error on order, message on order line, error on order lines) | <PlaceOrderProvider> |
GetOrders | Authentication information | Orders, one line per order Result codes | <OrderHistoryProvider> |
GetOrderDetails | Authentication information Order number | Order header, order lines, shipment lines Result codes | <OrderDetailProvider> |
...
- There is an active order in web viewer stored in an order object
- Order object is sent in PlaceOrder / ValidateOrder call
- If call is successful, PlaceOrder / ValidateOrder call returns an order object. This returned object is used to update the active order.
- Prices on order lines in active order is updated
- Total price and charges on the active order is updated
- Parts may be marked as NLA or a replacement may be returned and active order is updated based on this
- Messages on order or order lines are set on the active order
- Error code on order lines or on order is set on active order. If an error code exist the corresponding message will display in red and it will not be possible to place the order
- Result is presented
- For ValidateOrder call user stays on the order page and gets to see the active order
- For PlaceOrder call user is either
- directed to a confirmation page if PlaceOrder call accepted the order
- stays on the order page and gets to see the active order if PlaceOrder call did not accept the order
Validation
Order is validated when parts are added and when user arrives at order. The validation can be turned off using a setting.
<RESTPlaceOrderProvider order-validation-required="false" save-external-order-to-server-database="false" delete-old-trace-log-after-number-of-folder="30" trace-folder="C:\Temp\Trace-logs\" url="http://5.179.112.210/IntegrationWebAPI/"/>
Providers
Providers for integrations are normally custom built for each integration and params needed for each custom provider will vary. Typically a custom provider is configured according to the below pattern in profile.config:
...