Improve/api response guides #1486

carolinamenezes · 2024-10-09T14:02:23Z

Types of changes

New content (guides, endpoints, app documentation)
Improvement (make a documentation even better)
Fix (fix a documentation error)
Spelling and grammar accuracy (self-explanatory)

github-actions · 2024-10-09T14:02:50Z

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

github-actions · 2024-10-09T14:02:51Z

Navigation Preview Link

No changes detected in the navigation.json file

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

markdownlint

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in 6fe3436

    
           | 401 Unauthorized       | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in 6fe3436

    
           | 401 Unauthorized       | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in 6fe3436

    
           | 401 Unauthorized       | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in 6fe3436

    
           | 401 Unauthorized       | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in 6fe3436

    
           | `500 Internal Server Error`  | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in 6fe3436

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in 6fe3436

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in 6fe3436

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in 6fe3436

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in 6fe3436

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in 6fe3436

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in 6fe3436

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in 6fe3436

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in 6fe3436

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

docs/guides/Getting-Started/handling-errors-and-exceptions.md

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

markdownlint

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in dbc9a8d

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in dbc9a8d

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in dbc9a8d

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 42 in dbc9a8d

    
           | `503 Service Unavailable`    | <ul><li>Retry the request after some time, as the error might be temporary.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in dbc9a8d

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in dbc9a8d

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in dbc9a8d

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in dbc9a8d

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 43 in dbc9a8d

    
           | `504 Gateway Timeout`        | <ul><li>Check for potential network connectivity problems on your end.</li><li>Investigate if the request payload size or complexity might be causing the timeout.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li><li>Consider [implementing retry mechanisms or backoff strategies](https://en.wikipedia.org/wiki/Exponential_backoff) to manage timeouts effectively.</li></ul> |

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@ HTTP status codes in the 4xx range denote client errors, typically originating f
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

github-actions · 2024-10-09T14:09:08Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

@@ -30,6 +30,7 @@
 | `403 Forbidden`          | <ul><li>Ensure you have the appropriate [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc?&utm_source=autocomplete) to perform the desired action.</li><li>Check the expiration or validity of your access credentials.</li></ul> |
 | `404 Not Found`          | <ul><li>Refer to [API Reference](https://developers.vtex.com/docs/api-reference) for correct endpoint naming.</li><li>Double-check the URL or endpoint for accuracy.</li><li>Confirm if the resource has been moved or deleted.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports. If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |
 | `405 Method Not Allowed` | <ul><li>Ensure the request method matches the allowed methods for the resource. Refer to [VTEX API Reference](https://developers.vtex.com/docs/api-reference) for supported methods.</li><li>Check for spelling errors in the method used.</li></ul> |
+| `429 Too Many Requests` | <ul><li>Reduce the frequency of requests by optimizing code to limit unnecessary API calls or batch requests when possible.</li><li>Implement an [exponential backoff strategy](https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors) to gradually increase the delay between retries after receiving a 429 error.</li><li>Monitor your API request patterns closely to identify any areas that may be triggering rate limits frequently and adjust accordingly.</li><<li>Consider implementing a queue system to better manage and distribute requests over time.</li><li>In case of persistent rate limit issues, consider reaching out to [VTEX Support](https://help.vtex.com/support) for further assistance or clarification.</li></ul> |


[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

github-actions · 2024-10-09T14:09:10Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in dbc9a8d

| 401 Unauthorized | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

github-actions · 2024-10-09T14:09:11Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in dbc9a8d

| 401 Unauthorized | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

github-actions · 2024-10-09T14:09:11Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in dbc9a8d

| 401 Unauthorized | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

github-actions · 2024-10-09T14:09:12Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 29 in dbc9a8d

| 401 Unauthorized | <ul><li>Verify the authentication method used. Refer to [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information.</li><li>Ensure that authentication tokens or API keys are correctly passed in the request headers.</li><li>Re-authenticate with valid credentials.</li></ul> |

github-actions · 2024-10-09T14:09:14Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

github-actions · 2024-10-09T14:09:15Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

github-actions · 2024-10-09T14:09:16Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

github-actions · 2024-10-09T14:09:17Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

github-actions · 2024-10-09T14:09:18Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: li]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

github-actions · 2024-10-09T14:09:19Z

docs/guides/Getting-Started/handling-errors-and-exceptions.md

[markdownlint] _{reported by reviewdog 🐶}
MD033/no-inline-html Inline HTML [Element: ul]

dev-portal-content/docs/guides/Getting-Started/handling-errors-and-exceptions.md

Line 41 in dbc9a8d

| `500 Internal Server Error` | <ul><li>Check if the issue is on your end or the server's.</li><li>If possible, test the same request on different tools to confirm the issue.</li><li>Check the [VTEX status page](https://status.vtex.com/) for real-time outages and incident reports.</li><li>Retry the request after some time, as the error might be temporary.</li><li>If the issue persists, reach out to [VTEX Support](https://help.vtex.com/support).</li></ul> |

carolinamenezes added 2 commits October 9, 2024 10:56

Update handling-errors-and-exceptions.md

d3e4307

Update api-response-codes.md

6fe3436

carolinamenezes requested a review from georgebrindeiro October 9, 2024 14:02

carolinamenezes self-assigned this Oct 9, 2024

github-actions bot reviewed Oct 9, 2024

View reviewed changes

docs/guides/Getting-Started/handling-errors-and-exceptions.md Show resolved Hide resolved