This API serves as a design best practice to work with availability process data from systems like Salesforce via a set of RESTful services that are designed in RAML, making it easily consumable by any developer within the enterprise. This API defines endpoints for checking product availability and product reservation. Also it defines HTTP requests for checking product availability, shipping price and tax percentage depending on location.
System APIs provide a means of hiding complexity from the user while exposing data and providing downstream insulation from any interface changes or rationalization of those systems. This RAML API specification is part of the Retail Accelerator.
This API depends on these RAML fragments:
- AvailabilityForLocation - Defines availability for location (such as for store, warehouse, partner).
- ReservationRequest - Defines reservation request.
- Tax - Defines tax percentage.
- Shipping - Defines shipping cost.