{"info":{"_postman_id":"284c6d44-013a-4382-a86e-46bea2724669","name":"AT&T Tool API (v1)","description":"

As of now, AT&T Tool provides an API for two actions:

Placing an order
Checking the order status

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6526725","collectionId":"284c6d44-013a-4382-a86e-46bea2724669","publishedId":"RztkN9TN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-01-29T22:56:50.000Z"},"item":[{"name":"Placing an order","item":[{"name":"Via POST request","id":"b7058261-7474-43c1-8101-c15c58a25cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"your_api_key\",\n \"pingback_url\": \"url_to_pingback_on_completion\",\n \"imeis\": [\n \"imei_1\",\n \"imei_2\",\n \"etc\"\n ]\n}"},"url":"https://atttool.com/v1/place","urlObject":{"protocol":"https","path":["v1","place"],"host":["atttool","com"],"query":[],"variable":[]}},"response":[{"id":"17f20efc-b6f6-4c39-958a-8574606dd365","name":"Successful request (with pingback URL)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"pingback_url\": \"https://some.com/valid/url\",\n \"imeis\": [\n \"354865093010294\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"order_id\": \"7fe808fd-78c1-49fe-a3aa-17489c8b4e28\",\n \"total_cost\": \"0.75\"\n}"},{"id":"273487a8-f097-46e9-9f13-c07e59fa3346","name":"Missing a required parameter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"pingback_url\": \"https://some.com/valid/url\"\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_JSON_SCHEMA\"\n}"},{"id":"3a4c394a-6f80-4fe3-a5b2-983f64eedd09","name":"Invalid API key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"invalid_api_key\",\n \"pingback_url\": \"https://some.com/valid/url\",\n \"imeis\": [\n \"354865093010294\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_API_KEY\"\n}"},{"id":"3f8e4edf-5862-45dc-b6e8-8ef0fe2edbc4","name":"Not enough funds for proceeding","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"pingback_url\": \"https://some.com/valid/url\",\n \"imeis\": [\n \"354865093010294\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_NOT_ENOUGH_FUNDS\"\n}"},{"id":"8a59993d-2951-4545-ae36-04c050c54aac","name":"Invalid IMEI","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"pingback_url\": \"https://some.com/valid/url\",\n \"imeis\": [\n \"invalid_imei\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_IMEI\"\n}"},{"id":"e6bf6578-097c-4120-a429-28c8f24b46a8","name":"Invalid pingback URL","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"pingback_url\": \"invalid_pingback_url\",\n \"imeis\": [\n \"354865093010294\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_PINGBACK_URL\"\n}"},{"id":"ef0bc7e3-25de-4080-8fa8-d84565daaec6","name":"Successful request (without pingback URL)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"1e57f6246a384c978866154c3efea037\",\n \"imeis\": [\n \"354865093010294\",\n \"353057101229741\",\n \"357339099838618\"\n ]\n}"},"url":"https://atttool.com/v1/place"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"order_id\": \"b2d39aa5-cd0f-4788-9912-5a2d0884b3d4\",\n \"total_cost\": \"0.75\"\n}"}],"_postman_id":"b7058261-7474-43c1-8101-c15c58a25cbf"}],"id":"f572ca22-3e87-4957-b266-06c417a97285","description":"

Placing orders is available only via POST requests.

Required parameters:

api_key
imeis

Optional parameters:

pingback_url

What's a pingback URL?

A pingback URL is a URL to which, on order completion, AT&T Tool will send a POST request its body being of application/json type with the contents shown below. AT&T Tool expects to receive the 200 OK response and retries several times before giving up if it couldn't achieve it right away.

{\n    \"order_id\": \"99634c0b-824c-4d41-9479-65abf0357695\",\n    \"total_cost\": \"0.25\",\n    \"imeis\": {\n        \"359488091564579\": {\n            \"status\": \"Unlocked\",\n            \"att_order_num\": \"NUL818548439915\",\n            \"note\": \"Unlock code is 0959490308474628\",\n            \"refunded\": false\n        },\n        \"359488091497812\": {\n            \"status\": \"Rejected\",\n            \"att_order_num\": null,\n            \"note\": \"This device has been reported as lost or stolen\",\n            \"refunded\": true\n        }\n    }\n}\n

","event":[{"listen":"prerequest","script":{"id":"97d47f8e-ea0c-40eb-b895-ccab6d166a45","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7d1ddf7b-cb35-4137-986a-628acfe7a120","type":"text/javascript","exec":[""]}}],"_postman_id":"f572ca22-3e87-4957-b266-06c417a97285"},{"name":"Checking the order status","item":[{"name":"Via POST request","id":"f7d32df9-e2de-425a-a3ef-11621aab85df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"api_key\":\"your_api_key\",\r\n \"order_id\":\"desired_order_id\"\r\n}"},"url":"https://atttool.com/v1/get","urlObject":{"protocol":"https","path":["v1","get"],"host":["atttool","com"],"query":[],"variable":[]}},"response":[{"id":"391ae4b5-1ef9-4e35-8659-5ac3faff85a6","name":"Missing a required parameter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"6372a5bab4ae435a8baf33c0556771d9\"\n}"},"url":"https://atttool.com/v1/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_JSON_SCHEMA\"\n}"},{"id":"591bd95b-2118-47b4-8dea-3af3f881e21a","name":"Invalid order ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"6372a5bab4ae435a8baf33c0556771d9\",\n \"order_id\": \"invalid_order_id\"\n}"},"url":"https://atttool.com/v1/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_ORDER_ID\"\n}"},{"id":"884bb198-2f18-40be-a525-52aab8fcc163","name":"Invalid API key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"invalid_api_key\",\n \"order_id\": \"17b8e0f2-3523-45e1-90d2-455e4b70ecf1\"\n}"},"url":"https://atttool.com/v1/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_API_KEY\"\n}"},{"id":"cf689802-1ef5-490e-9611-54ea37b5ff7a","name":"Successful request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"6372a5bab4ae435a8baf33c0556771d9\",\n \"order_id\": \"17b8e0f2-3523-45e1-90d2-455e4b70ecf1\"\n}"},"url":"https://atttool.com/v1/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"is_completed\": true,\n \"total_cost\": \"1.00\",\n \"imeis\": {\n \"359488091047476\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091998041\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL122348439826\",\n \"note\": \"This device hasn't been active for at least six months of paid service\",\n \"refunded\": true\n },\n \"359488091576250\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL823248476655\",\n \"note\": \"This IMEI number doesn't match a device that's compatible with the AT&T network\",\n \"refunded\": true\n },\n \"359488091991541\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL222448439895\",\n \"note\": \"Unlock code is 2515274636951606\",\n \"refunded\": false\n },\n \"359488091548762\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL922248439634\",\n \"note\": \"This IMEI number doesn't match a device that's compatible with the AT&T network\",\n \"refunded\": true\n },\n \"359488091408850\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091562110\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL814448440475\",\n \"note\": \"Unlock code is 4041319607205724\",\n \"refunded\": false\n },\n \"359488091456164\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091564579\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL818548439915\",\n \"note\": \"Unlock code is 0959490308474628\",\n \"refunded\": false\n },\n \"359488091535843\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL914548440320\",\n \"note\": \"Unlock code is 5073137519050468\",\n \"refunded\": false\n },\n \"359488091497812\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n }\n }\n}"}],"_postman_id":"f7d32df9-e2de-425a-a3ef-11621aab85df"},{"name":"Via GET request","id":"34645451-901c-4509-9104-77e9ef6029bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://atttool.com/v1/get?api_key=your_api_key&order_id=desired_order_id","urlObject":{"protocol":"https","path":["v1","get"],"host":["atttool","com"],"query":[{"key":"api_key","value":"your_api_key"},{"key":"order_id","value":"desired_order_id"}],"variable":[]}},"response":[{"id":"47b7231e-1da0-43e7-9cc7-6d095fbde02d","name":"Missing a required parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://atttool.com/v1/get?api_key=6372a5bab4ae435a8baf33c0556771d9","protocol":"https","host":["atttool","com"],"path":["v1","get"],"query":[{"key":"api_key","value":"6372a5bab4ae435a8baf33c0556771d9"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Content-Type","value":"text/html; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"empty"},{"id":"496a1b22-89c8-4f68-ad4b-4b5218309764","name":"Invalid API key","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://atttool.com/v1/get?api_key=invalid_api_key&order_id=17b8e0f2-3523-45e1-90d2-455e4b70ecf1","protocol":"https","host":["atttool","com"],"path":["v1","get"],"query":[{"key":"api_key","value":"invalid_api_key"},{"key":"order_id","value":"17b8e0f2-3523-45e1-90d2-455e4b70ecf1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_API_KEY\"\n}"},{"id":"5e767999-79f5-4417-9e80-35f634c95352","name":"Successful request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://atttool.com/v1/get?api_key=6372a5bab4ae435a8baf33c0556771d9&order_id=17b8e0f2-3523-45e1-90d2-455e4b70ecf1","protocol":"https","host":["atttool","com"],"path":["v1","get"],"query":[{"key":"api_key","value":"6372a5bab4ae435a8baf33c0556771d9"},{"key":"order_id","value":"17b8e0f2-3523-45e1-90d2-455e4b70ecf1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"is_completed\": true,\n \"total_cost\": \"1.00\",\n \"imeis\": {\n \"359488091047476\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091998041\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL122348439826\",\n \"note\": \"This device hasn't been active for at least six months of paid service\",\n \"refunded\": true\n },\n \"359488091576250\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL823248476655\",\n \"note\": \"This IMEI number doesn't match a device that's compatible with the AT&T network\",\n \"refunded\": true\n },\n \"359488091991541\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL222448439895\",\n \"note\": \"Unlock code is 2515274636951606\",\n \"refunded\": false\n },\n \"359488091548762\": {\n \"status\": \"Rejected\",\n \"att_order_num\": \"NUL922248439634\",\n \"note\": \"This IMEI number doesn't match a device that's compatible with the AT&T network\",\n \"refunded\": true\n },\n \"359488091408850\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091562110\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL814448440475\",\n \"note\": \"Unlock code is 4041319607205724\",\n \"refunded\": false\n },\n \"359488091456164\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n },\n \"359488091564579\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL818548439915\",\n \"note\": \"Unlock code is 0959490308474628\",\n \"refunded\": false\n },\n \"359488091535843\": {\n \"status\": \"Unlocked\",\n \"att_order_num\": \"NUL914548440320\",\n \"note\": \"Unlock code is 5073137519050468\",\n \"refunded\": false\n },\n \"359488091497812\": {\n \"status\": \"Rejected\",\n \"att_order_num\": null,\n \"note\": \"This device has been reported as lost or stolen\",\n \"refunded\": true\n }\n }\n}"},{"id":"ee308e6a-e648-435c-ac9b-358558a68280","name":"Invalid order ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://atttool.com/v1/get?api_key=6372a5bab4ae435a8baf33c0556771d9&order_id=invalid_order_id","protocol":"https","host":["atttool","com"],"path":["v1","get"],"query":[{"key":"api_key","value":"6372a5bab4ae435a8baf33c0556771d9"},{"key":"order_id","value":"invalid_order_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ERR_INVALID_ORDER_ID\"\n}"}],"_postman_id":"34645451-901c-4509-9104-77e9ef6029bc"}],"id":"2f7d832f-a9b2-4dff-a8a8-5f18d167957d","description":"

Two options are available for checking the order status:

via POST request
via GET request

All parameters are required.

\n","event":[{"listen":"prerequest","script":{"id":"aeeb363e-e02e-432b-86cf-161f1d06b4d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"99dd1c0f-1d9d-4f14-97ae-49be8029db2b","type":"text/javascript","exec":[""]}}],"_postman_id":"2f7d832f-a9b2-4dff-a8a8-5f18d167957d"}],"event":[{"listen":"prerequest","script":{"id":"11062fd7-05fa-423e-adc3-70c1368ed271","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f77fe28d-cb95-4034-935e-f5698430d882","type":"text/javascript","exec":[""]}}]}