General Overview


Welcome to the imPowered API Reference! The imPowered API empowers you to integrate our service seamlessly into your Shopify merchant experience. This documentation will guide you through the essential aspects of the imPowered API.

Overview


The imPowered API is designed with simplicity and efficiency in mind, providing you with the tools to effortlessly enhance your ecommerce capabilities. Here are some key characteristics of our API:


  • Resource-Oriented URLs: Our API endpoints are organized in a logical and resource-oriented manner, making it intuitive to interact with our services.
  • Request Payloads: When communicating with the imPowered API, you can send various request payloads to customize and enhance the experience.
  • Standard HTTP Response Codes: We use standard HTTP response codes to ensure clarity regarding the status and results of your API requests.
  • Authentication and Verbs: Secure your interactions using authentication methods, and employ standard HTTP verbs such as GET, POST, PUT, and DELETE to perform various operations.
overview
Please contact us for the URI
cURL
1
curl -X GET "Please contact us for the URI" \
2
-H "impowerd-access: {access_token}"
2
-D "View the docs for the body, if at all"
{}
Response
JSON
  1. {
  2. text: "A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key. To test requests using your account, replace the sample API key with your actual API key or sign in."
  3. }

Authentication


Authentication is a crucial aspect of the imPowered API, ensuring secure interactions between your Shopify store and our service. This documentation will guide you through the authentication process and best practices to keep your interactions safe and reliable.

API Keys


In the imPowered ecosystem, API keys serve as the foundation of authentication. You can manage your API keys through your imPowered Dashboard, allowing you to control access and permissions for your Shopify store's integration.

Types of API Keys


Test Mode Secret Keys: These keys are prefixed with sk_test_ and are used for testing purposes. They enable you to experiment with our without affecting live interactions.

Live Mode Secret Keys: Live mode keys are prefixed with sk_live_ and are intended for production use. Use these keys when your Shopify store is live and serving customers.

Restricted API Keys: For enhanced security and granular control, you can also generate restricted API keys. These keys have limited permissions, making them suitable for specific use cases.
authentication
Contact us for the API Key as well
cURL
1
curl -X GET "Contact us for the API Key as well" \
2
-H "impowerd-access: {access_token}"
{}
Response
JSON
  1. {
  2. text: "A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key. To test requests using your account, replace the sample API key with your actual API key or sign in."
  3. }

Endpoints & Requests


Welcome to the imPowered API documentation! The imPowered API empowers you to integrate our service seamlessly into your Shopify merchant experience. To make the most of our API, it's crucial to understand how to interact with our endpoints effectively. This guide will walk you through the fundamentals of working with imPowered REST API endpoints.

Endpoint Structure


All REST API endpoints are organized by resource type, allowing you to access and manipulate different aspects of your Shopify store's service. The endpoint structure follows this pattern: Here's a breakdown of the key components:

https://{imPowered_uri}/{resource}

  • {imPowered_uri}: Replace this placeholder with your store's domain.
  • {resource}: Indicates the specific resource you want to interact with.
endpoints
429 Response code
cURL
1
curl -X GET "429 Response code" \
2
-H "impowerd-access: {access_token}"
{}
Response
JSON
  1. {
  2. _: " 🚨[ERROR]: 429 Too Many Requests"
  3. }

Rate Limits


At imPowered, we understand the importance of maintaining a smooth and responsive integration with your Shopify store. To ensure fair usage and optimal performance, it's essential to be aware of our rate limits and usage limitations. This guide provides you with insights into how these limits work and how they may impact your integration.

Standard Rate Limit for Shopify


The REST Admin API enforces a standard rate limit of 40 requests per app per store per minute. This allocation is designed to accommodate the needs of most Shopify merchants while preventing abuse of our services.

Rate Limit Replenishment for Shopify


For your convenience, the rate limit replenishes at a rate of 2 requests per second, ensuring a steady flow of interactions with our API.

imPowerd Limits


The app rate limit self are 2,999 requests per minute per Merchant. This is to ensure scalability needs.

Usage Limitations


The REST Admin API has specific usage limitations in place to ensure a fair and consistent experience for all users.

Handling Exceeding Limits


If you exceed the rate limit, the API will respond with a 429 Too Many Requests error. This error informs you that your app has reached the rate limit threshold for the specified timeframe.

Retry-After Header


For now please impliment either monitoring or error hadnling to address the scenario where the limit is temprarily reached.
rate
429 Too Many Requests
cURL
1
curl -X GET "429 Too Many Requests" \
2
-H "impowerd-access: {access_token}"
2
-D "429 Too Many Requests"
{}
Response
JSON
  1. {
  2. text: "A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key. To test requests using your account, replace the sample API key with your actual API key or sign in."
  3. }

Status & Error Codes


In your journey to seamlessly integrate imPowered's service into your Shopify store, understanding the status and error codes that our API returns is crucial. These codes provide valuable insights into the outcome of your API queries, helping you troubleshoot and optimize your integration. Here's a comprehensive guide to imPowered's API status and error codes:

200 ok


Description: The 'ok' status code.

201 ok - no data


Description: The 'ok' status code, data returns null.

401 Unauthorized


Description: This status code indicates that the client attempting the request does not possess correct authentication credentials.

402 Payment Required


Description: In this scenario, the shop associated with the request is frozen due to an outstanding balance. The shop owner must clear the balance to unfreeze the shop and resume normal operations.

403 Forbidden


Description: The server refuses to respond to the request. This typically occurs when the client's access scopes are incorrect or insufficient.

404 Not Found


Description: This status code signifies that the requested resource was not found at the moment. However, it may become available again in the future.

409 Conflict


Description: This status code signifies that there is a conlfict in data from the client and the database.

422 Unprocessable Entity


Description: When you encounter this status code, it means that the request body contains semantic errors. This can result from incorrect formatting, omitting required fields, or logical errors such as initiating a checkout for an out-of-stock product.

429 Too Many Requests


Description: The client has exceeded the rate limit for API requests. It's an indication that the rate of requests has surpassed the allocated quota.

5xx Errors


Description: These errors indicate that an internal error occurred within Shopify. To get more information about these errors, we recommend visiting the Shopify status page.
status
cURL
1
curl -X GET "" \
2
-H "impowerd-access: {access_token}"
{}
Response
JSON
  1. {}