RateLimitExceededException
extends ShipEngineException
in package
This error occurs when a request to ShipEngine API is blocked due to the rate limit being exceeded.
Table of Contents
- $errorCode : string|null
- A code that indicates the specific error that occurred, such as missing a required field, an invalid address, a timeout, etc.
- $requestId : string|null
- If the error came from the ShipEngine server (as opposed to a client-side error) then this is the unique ID of the HTTP request that returned the error.
- $retryAfter : DateInterval
- The amount of time (in milliseconds) to wait before retrying the request.
- $source : string|null
- Indicates where the error originated. This lets you know whether you should contact ShipEngine for support or if you should contact the carrier or marketplace instead.
- $type : string|null
- Indicates the type of error that occurred, such as a validation error, a security error, etc.
- $url : string|null
- Some errors include a URL that you can visit to learn more about the error, find out how to resolve it, or get support.
- __construct() : mixed
- RateLimitExceededException constructor - Instantiates a server-side error.
- jsonSerialize() : array<string|int, mixed>
Properties
$errorCode
A code that indicates the specific error that occurred, such as missing a required field, an invalid address, a timeout, etc.
public
string|null
$errorCode
$requestId
If the error came from the ShipEngine server (as opposed to a client-side error) then this is the unique ID of the HTTP request that returned the error.
public
string|null
$requestId
You can use this ID when contacting ShipEngine support for help.
$retryAfter
The amount of time (in milliseconds) to wait before retrying the request.
public
DateInterval
$retryAfter
$source
Indicates where the error originated. This lets you know whether you should contact ShipEngine for support or if you should contact the carrier or marketplace instead.
public
string|null
$source
Tags
$type
Indicates the type of error that occurred, such as a validation error, a security error, etc.
public
string|null
$type
Tags
$url
Some errors include a URL that you can visit to learn more about the error, find out how to resolve it, or get support.
public
string|null
$url
Methods
__construct()
RateLimitExceededException constructor - Instantiates a server-side error.
public
__construct(DateInterval $retryAfter[, string|null $source = null ][, string|null $requestId = null ]) : mixed
Parameters
- $retryAfter : DateInterval
- $source : string|null = null
- $requestId : string|null = null
Return values
mixed —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>