Getting Started

Public APIs

Public APIs are available for all clients to build new products, services, or customer experiences that leverage the unique data, functions, and applications of Kroger. To begin using Public APIs right away, complete the following steps:

1. Create an Account

Before you can register your application and begin making API requests, you must first Create an Account. After completing the account creation form, you will be asked to verify your account by email. Once you have verified your account, you can continue and register your first application.

2. Register Your Application

Once you have created an account, you need to Register Your Application to generate your application's OAuth2 client credentials.

Your client credentials should be treated the same as a username and password. You should never share your credentials with anyone or store them in a place that can be accessed by anyone but the application owner. If your credentials become compromised, you should delete your application and register for new credentials.

3. Make a Test Call

To make a test call using your OAuth2 credentials, base64 encode your client ID and client secret with a single colon in between the two (CLIENT_ID:CLIENT_SECRET). Place your encoded credentials in the authorization header using type Basic (see following example). Once you have included the authorization header in the request, you can execute the call from your terminal.

curl -X POST \
  'https://api.kroger.com/v1/connect/oauth2/token' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Authorization: Basic {{base64(CLIENT_ID:CLIENT_SECRET)}}' \
  -d 'grant_type=client_credentials'

After you execute the the request, the server authenticates your application, and an access token is returned as a JSON response. Once you receive a access token response, you have successful tested that your client credentials are registered.

4. View Documentation

After you have registered your application and tested your credentials, you are ready to integrate. The following is a list of documentation that covers all aspects of our Public APIs and includes helpful tips for integration.

Doc Descriptions
API Basics Describes the basic structure and functionality of all Kroger APIs.
API Reference Public API documentation detailing individual endpoints.
Branding Guidelines Describes the acceptable use of the Kroger brand within your experience.
Postman A guide to using our Postman API collections for testing integrations.
Security Describes API security using OAuth2.

Partner APIs

Partner APIs enable official partners to access strategic functionality and data. Since becoming a partner requires additional security consideration and a contractual agreement, Partner APIs are not available through our self-service app registration.

Partnership Request

If you would like to know more about becoming an official Kroger partner and consuming Partner APIs, submit a Partner Request. Once we receive the request, a member of our developer team will reach out with more information.