Get Order Existence
5 min
This API will allow you to check whether an order exists in the system by order number.
Rate Limit
This endpoint is subject to standard API rate limiting. Please refer to the general API documentation for rate limit details.
Production
GET
https://api.fourkites.com/orders/exists?order_number=4302314363
curl --location 'https://api.fourkites.com/orders/exists?order_number=4302314363' \
--header 'apikey: YOUR_API_KEY'
Staging
GET
https://api-staging.fourkites.com/orders/exists?order_number=4302314363
curl --location 'https://api-staging.fourkites.com/orders/exists?order_number=4302314363' \
--header 'apikey: YOUR_API_KEY'
Response Fields
Field | Type | Description |
|---|---|---|
exists | boolean | Indicates whether the order exists in the system |
orderId | string | Unique identifier for the order (UUID format) |
orderNumber | string | The order number that was queried |
Error
Field | Type | Description |
|---|---|---|
error | string | Error type or category |
message | string | Detailed error message |
Points to note:
- The order_number parameter is case-sensitive
- The orderId field will be null when exists is false
- This endpoint only checks for existence and does not return full order details
- For retrieving complete order information, use the /orders/ endpoint