API Details

Delving deeper into the API request's body and/or path parameters and responses

In every API endpoint body parameters (also called query parameters) and/or path parameters are passed along with the GET, POST, PUT and DELETE requests.

body parameters for Create item,
path parameters for Get a specific item OR
both body parameters and path parameters for Update an item

The responses contain attributes related to the passed-in body parameters and/or path parameters which unveil the data model used in the application.

Data attributes

We break down the attributes consistent with each broad categorization of the API endpoints in:

  1. Related to Items
  2. Related to Sales