invalid_request_parameter
Error type indicating the request failed due to invalid or incorrectly formatted parameters.
What this means
The request structure is valid and parseable, but one or more parameters contain values that violate validation rules, format requirements, or business logic constraints. This is the most common error type you'll encounter when integrating with the Commerce API. For example, paginating through orders with page_number: 15 when the maximum is 10, or paying for an order with a payment_method_id that doesn't exist or belongs to a different application.
The error detail field will explain exactly which parameter is invalid and why, allowing you to correct the specific value before retrying. Unlike transient errors that resolve themselves, invalid parameter errors require you to modify your request—retrying the exact same request will always produce the same error.
Example error response
{
"error": {
"type": "invalid_request_parameter",
"cause": "invalid_request_parameter",
"code": "1564",
"message": "page_number out of bounds",
"detail": "The `page_number` value you provided, `15`, is out of bounds. It should be between 1 and 10 inclusive.",
"fix_code": "change_request_parameters",
"url": "https://commerce.zebo.dev/e/1564"
}
}
Related errors
- missing_request_parameter - Required parameter not provided
- change_request_parameters - Fix code for this error type