Qodex.ai

Kroger Experimental APIs

Number of APIs: 8

Introduction

Experimental APIs are used to test future API products and get feedback from the developer community around API desirability and design. All experimental APIs are mock services that simulate data and functionality, allowing API Consumers to test and validate integrations.

Note: Experimental APIs are likely to change as we incorporate feedback from the community. Not all experimental APIs will become part of our product offering, so you should consider them as potential products that may or may not be available in the future.

API Standards and Naming

You may notice some names, structures, and syntax in these APIs that differ from the currently available public APIs. We are making these changes to align with our most recently adopted Internal API Style Guide. New versions of existing public APIs will be released to align with these standards if and when breaking changes are made to those APIs.

API Status

Each API product is labeled with a status to indicate which phase the API is in. Currently, all Experimental APIs have one of the follow statuses:

  • Accepting Feedback: we are currently accepting feedback on the API contract. During this phase, you should expect the contract to change.

  • Deprecated: the API feedback period has ended and we have decided not to move forward with development of the API at this time.

  • In Development: the API is in development and will be available as a Production API in the future. During this phase, you should not see any changes in the Experimental API contract, but the Production API contract may be different from the Experimental API contract.

Type

Each API product is labeled with a type to indicate which API offering the API is intended for. Currently, APIs are one of the two following types:

  • Public: these APIs are intended to be publicly available for anyone to consume.

  • Partner: these APIs require approval and a contractual agreement with Kroger, if they become part of our product offering.

Expected Rate Limit

Each API product has a rate limit specified. These rate limits do not apply while the APIs are experimental. Instead, they indicate the expected rate limits if the API becomes part of the product offering. If you have thoughts on a specific limit, please provide it when you submit your feedback.

Expected Grant Type

Because we use mock data in our experimental APIs, no authentication or authorization is required to try them out. If an API becomes part of our product offering, it will require authentication and authorization. We use OAuth2 at Kroger, so the grant type will be one of the two following:

  • Authorization Code: Allows the application to request permission from the customer to make API requests on their behalf, including accessing personal data.
  • Client Credentials: Allows the application to access Kroger data, such as product data or clinic appointments.

To learn more about OAuth2, see Understanding OAuth2.

Try Out an API

We have created a mock server in Qodex to support the Experimental APIs documented here. If you'd like to give them a try, you'll need to provide the desired response by specifying the HTTP Response Code in the `x-mock-response-code` header.

There are two ways you can try out our experimental APIs on the Qodex mock server, which are :

  1. Use the endpoint provided in this documentation to call them directly from the browser, command line, or an application.
  2. Export the Experimental APIs collection and the Experimental APIs Mock Server environment from the public workspace and import them into one of your workspaces.

Submit Feedback

Let us know what you think of our experimental APIs by submitting your feedback. You can submit feedback more than once if you have new feedback to share--we'd really like to hear your thoughts, since we want to create APIs that are helpful to you.

Submit Feedback ->

Note: Be as detailed as possible when providing feedback about an API, since your input will be used to determine what changes are needed to the API and whether or not the API will become a part of our API product offering.

Changelog

Since Experimental API contracts are likely to change, we will update the changelog with details for each new release.

V0.3.0, January 4, 2022

  • Initial release of Experimental APIs.

Contact Support:
Name: API Program
Email: apisupport@kroger.com

  1. health - Appointment Availability GET {{baseUrl}}/experimental/health/v0/appointments?filter.clinicId=98989898&filter.typeName=FLU&filter.days=2&page.size=1&page.offset=0

  2. shopping lists - Create Shopping List REVIEW POST {{baseUrl}}/experimental/shopping/v0/lists

  3. health-clinics - Clinic Locations GET {{baseUrl}}/experimental/health/v0/clinics?filter.id=989898&filter.postalCode=45202&filter.radiusInMiles=10&page.size=1&page.offset=0

  4. health-clinics - Clinic Location Data GET {{baseUrl}}/experimental/health/v0/clinics/:id

  5. shopping lists - Get Shopping Lists GET {{baseUrl}}/experimental/shopping/v0/lists?filter.id=eaf02512-f18b-4fd8-b31f-71607a4b6d50

  6. shopping lists - Add to Shopping List REVIEW PATCH {{baseUrl}}/experimental/shopping/v0/lists/:id

  7. Search Term Trends GET {{baseUrl}}/experimental/search/v0/terms?filter.locationId=98989898&option.type=MOST_FREQUENT&page.size=2&page.offset=0&sort=rank[DESC]

  8. Get Discounts GET {{baseUrl}}/experimental/savings/v0/discounts?filter.productId=7495563456235&filter.locationId=98989898&page.size=1&page.offset=0