--- title: Get Order Existence slug: fourkites-api-reference/get-order-existence icon: {"apiMethod":"GET"} createdAt: 2025-11-10T06:00:35.000Z --- This API will allow you to check whether an order exists in the system by order number. :::hint{type="info"} **Rate Limit** This endpoint is subject to standard API rate limiting. Please refer to the general API documentation for rate limit details. ::: :::ApiMethodV2 ```json { "name": "Production", "method": "GET", "url": "https://api.fourkites.com/orders/exists?order_number=4302314363", "description": "", "tab": "examples", "examples": { "languages": [ { "id": "OGpHX2YHGFPPIAaOx3GjS", "language": "curl", "code": "curl --location 'https://api.fourkites.com/orders/exists?order_number=4302314363' \\\n--header 'apikey: YOUR_API_KEY'\n", "customLabel": "" }, { "id": "LZtv3scvA2q2mo7XK_vi5", "language": "java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.fourkites.com/orders/exists?order_number=4302314363\")\n .method(\"GET\", body)\n .addHeader(\"apikey\", \"YOUR_API_KEY\")\n .build();\nResponse response = client.newCall(request).execute();", "customLabel": "" }, { "id": "vqObsvgawylEV0g_unIES", "language": "javascript", "code": "var settings = {\n \"url\": \"https://api.fourkites.com/orders/exists?order_number=4302314363\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"apikey\": \"YOUR_API_KEY\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "customLabel": "" }, { "id": "WTGAcUfSsfDki9m3JNUSt", "language": "swift", "code": "var request = URLRequest(url: URL(string: \"https://api.fourkites.com/orders/exists?order_number=4302314363\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"YOUR_API_KEY\", forHTTPHeaderField: \"apikey\")\n\nrequest.httpMethod = \"GET\"\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n", "customLabel": "" }, { "id": "eSkJV-HP9EwAulB62nb3t", "language": "csharp", "code": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, \"https://api.fourkites.com/orders/exists?order_number=4302314363\");\nrequest.Headers.Add(\"apikey\", \"YOUR_API_KEY\");\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n", "customLabel": "" }, { "id": "IWBWpmy3NeN7y9xLCaCzN", "language": "go", "code": "package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.fourkites.com/orders/exists?order_number=4302314363\"\n method := \"GET\"\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, nil)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"apikey\", \"YOUR_API_KEY\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}", "customLabel": "" }, { "id": "EJmpW2QKumhqwBv51hhhQ", "language": "ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fourkites.com/orders/exists?order_number=4302314363\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"apikey\"] = \"YOUR_API_KEY\"\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" }, { "id": "vaGIODXavsfT_QIEiH5ru", "language": "python", "code": "import http.client\n\nconn = http.client.HTTPSConnection(\"api.fourkites.com\")\npayload = ''\nheaders = {\n 'apikey': 'YOUR_API_KEY'\n}\nconn.request(\"GET\", \"/orders/exists?order_number=4302314363\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))", "customLabel": "" } ], "selectedLanguageId": "OGpHX2YHGFPPIAaOx3GjS" }, "results": { "languages": [ { "id": "cAND6m1g9reHikjBk4tHL", "language": "200", "code": "{\n \"exists\": true,\n \"orderId\": \"b10dce6f-a119-4390-9d82-f291fbc3c229\",\n \"orderNumber\": \"4302314363\"\n}\n", "customLabel": "" }, { "id": "DYIHKUbY9NL4U6miYV5F3", "language": "400", "code": "{\n \"error\": \"order_number parameter is required\",\n \"message\": \"Missing required parameter: order_number\"\n}\n", "customLabel": "" }, { "id": "sR7AMe2kVLgnx2bt16Tke", "language": "401", "code": "{\n \"error\": \"Unauthorized\",\n \"message\": \"Invalid or missing API key\"\n}\n", "customLabel": "" }, { "id": "UxiOfAD59hqIYfxn4rrLb", "language": "403", "code": "{\n \"error\": \"Forbidden\", \n \"message\": \"Access denied\"\n}\n", "customLabel": "" }, { "id": "SSt_MbAvjmnAnToaWiqvi", "language": "500", "code": "{\n \"error\": \"Internal Server Error\",\n \"message\": \"An unexpected error occurred\"\n}\n", "customLabel": "" } ], "selectedLanguageId": "SSt_MbAvjmnAnToaWiqvi" }, "request": { "pathParameters": [], "queryParameters": [ { "name": "order_number", "kind": "required", "type": "string", "description": "The order number to check for existence", "": "required" } ], "headerParameters": [ { "name": "apikey", "kind": "required", "type": "string", "description": "Your API authentication key", "": "required" } ], "bodyDataParameters": [], "formDataParameters": [] }, "currentNewParameter": { "label": "Query Parameter", "value": "queryParameters" }, "hasTryItOut": false, "autoGeneratedAnchorSlug": "production", "legacyHash": "99-GeIcgoarxWWYFhLjkA" } ``` ::: :::ApiMethodV2 ```json { "name": "Staging", "method": "GET", "url": "https://api-staging.fourkites.com/orders/exists?order_number=4302314363", "description": "", "tab": "examples", "examples": { "languages": [ { "id": "OGpHX2YHGFPPIAaOx3GjS", "language": "curl", "code": "curl --location 'https://api-staging.fourkites.com/orders/exists?order_number=4302314363' \\\n--header 'apikey: YOUR_API_KEY'\n", "customLabel": "" }, { "id": "LZtv3scvA2q2mo7XK_vi5", "language": "java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\")\n .method(\"GET\", body)\n .addHeader(\"apikey\", \"YOUR_API_KEY\")\n .build();\nResponse response = client.newCall(request).execute();", "customLabel": "" }, { "id": "vqObsvgawylEV0g_unIES", "language": "javascript", "code": "var settings = {\n \"url\": \"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\",\n \"method\": \"GET\",\n \"timeout\": 0,\n \"headers\": {\n \"apikey\": \"YOUR_API_KEY\"\n },\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});", "customLabel": "" }, { "id": "WTGAcUfSsfDki9m3JNUSt", "language": "swift", "code": "var request = URLRequest(url: URL(string: \"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"YOUR_API_KEY\", forHTTPHeaderField: \"apikey\")\n\nrequest.httpMethod = \"GET\"\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n", "customLabel": "" }, { "id": "eSkJV-HP9EwAulB62nb3t", "language": "csharp", "code": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, \"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\");\nrequest.Headers.Add(\"apikey\", \"YOUR_API_KEY\");\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n", "customLabel": "" }, { "id": "IWBWpmy3NeN7y9xLCaCzN", "language": "go", "code": "package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\"\n method := \"GET\"\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, nil)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"apikey\", \"YOUR_API_KEY\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}", "customLabel": "" }, { "id": "EJmpW2QKumhqwBv51hhhQ", "language": "ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-staging.fourkites.com/orders/exists?order_number=4302314363\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"apikey\"] = \"YOUR_API_KEY\"\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" }, { "id": "vaGIODXavsfT_QIEiH5ru", "language": "python", "code": "import http.client\n\nconn = http.client.HTTPSConnection(\"api-staging.fourkites.com\")\npayload = ''\nheaders = {\n 'apikey': 'YOUR_API_KEY'\n}\nconn.request(\"GET\", \"/orders/exists?order_number=4302314363\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))", "customLabel": "" } ], "selectedLanguageId": "OGpHX2YHGFPPIAaOx3GjS" }, "results": { "languages": [ { "id": "cAND6m1g9reHikjBk4tHL", "language": "200", "code": "{\n \"exists\": true,\n \"orderId\": \"b10dce6f-a119-4390-9d82-f291fbc3c229\",\n \"orderNumber\": \"4302314363\"\n}\n", "customLabel": "" }, { "id": "DYIHKUbY9NL4U6miYV5F3", "language": "400", "code": "{\n \"error\": \"order_number parameter is required\",\n \"message\": \"Missing required parameter: order_number\"\n}\n", "customLabel": "" }, { "id": "sR7AMe2kVLgnx2bt16Tke", "language": "401", "code": "{\n \"error\": \"Unauthorized\",\n \"message\": \"Invalid or missing API key\"\n}\n", "customLabel": "" }, { "id": "UxiOfAD59hqIYfxn4rrLb", "language": "403", "code": "{\n \"error\": \"Forbidden\", \n \"message\": \"Access denied\"\n}\n", "customLabel": "" }, { "id": "SSt_MbAvjmnAnToaWiqvi", "language": "500", "code": "{\n \"error\": \"Internal Server Error\",\n \"message\": \"An unexpected error occurred\"\n}\n", "customLabel": "" } ], "selectedLanguageId": "SSt_MbAvjmnAnToaWiqvi" }, "request": { "pathParameters": [], "queryParameters": [ { "name": "order_number", "kind": "required", "type": "string", "description": "The order number to check for existence", "": "required" } ], "headerParameters": [ { "name": "apikey", "kind": "required", "type": "string", "description": "Your API authentication key", "": "required" } ], "bodyDataParameters": [], "formDataParameters": [] }, "currentNewParameter": { "label": "Query Parameter", "value": "queryParameters" }, "hasTryItOut": false, "autoGeneratedAnchorSlug": "staging", "legacyHash": "H_9nJ9hfB5UwVL9xvwODp" } ``` ::: ### 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: :::hint{type="info"} - 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 :::