{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "signup", "description": "", "item": [ { "id": "8524cf8f-09d7-46db-b621-0e7da6b20e36", "name": "Instant signup \u2014 returns an API key in one call", "request": { "name": "Instant signup \u2014 returns an API key in one call", "description": {}, "url": { "path": [ "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "44ff52da-c295-4532-82a9-41387b0f8886", "name": "Account already exists; a login link was emailed.", "originalRequest": { "url": { "path": [ "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a80b4f4-71dc-419b-a340-87f512c9baeb", "name": "Account created; the key is shown only once.", "originalRequest": { "url": { "path": [ "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"\",\n \"email\": \"\",\n \"plan\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5f7f52-7b85-41e0-ab64-5d3e167f5bf8", "name": "Signups are closed on this instance (`signups_closed`); an existing account still gets a login link.", "originalRequest": { "url": { "path": [ "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16115558-1c28-493e-be26-fb1e8c7ce4c3", "name": "Burst rate limit exceeded (code rate_limited); honor Retry-After.", "originalRequest": { "url": { "path": [ "v1", "signup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "me", "description": "", "item": [ { "id": "c38a45a9-e413-45ca-87f4-3cdaef21d068", "name": "Current account and usage", "request": { "name": "Current account and usage", "description": {}, "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3eb56a49-ff09-4ef8-b3dd-5c7357423cc4", "name": "Account info", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"\",\n \"email_verified\": \"\",\n \"plan\": \"\",\n \"usage\": {\n \"period_start\": \"\",\n \"used\": \"\",\n \"quota\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "trackings", "description": "", "item": [ { "id": "07356d04-2b26-4d09-b447-f6c059606732", "name": "Start tracking a package", "request": { "name": "Start tracking a package", "description": { "content": "Unknown JSON fields are rejected with 400 (a typo never silently drops\na setting). Everything you send back-fills the Tracking object, so\n`metadata` and the `notify_*` settings are readable on every GET,\nlist and webhook payload.\n\nRe-submitting a number you already track is idempotent and free (200),\nand it **updates** `external_order_id`, `metadata`, `notify_email`,\n`notify_statuses` and `seller_alert_email` with the same\nrules as `PATCH /v1/trackings/{id}`: a field you omit keeps its stored\nvalue, a field you send as `\"\"` (or `{}` / `[]`) clears it. So the\ncreate call is safe to replay from an order pipeline that only learns\nthe order id on the second pass. `tracking_number`, `carrier` and\n`extra` are not re-applied \u2014 the shipment is already registered.\n", "type": "text/plain" }, "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3a4ce9e6-df7c-4812-b58c-22a28c281e84", "name": "Already tracked \u2014 idempotent, not billed. Any settings in the body were applied (PATCH semantics) and the response is the updated row.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351b78b1-0948-42a6-9079-cfd939ba9f0c", "name": "New tracking created (1 quota unit).", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3228338e-2059-422d-a0ce-fa10760d246a", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9bfad7-2c58-4d2c-b4d0-035b4bcffaf8", "name": "Monthly tracking quota reached (code quota_exceeded). Not retryable until the next period or an upgrade.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4cd25ad-085a-4687-b3ec-3d6a81371d53", "name": "Invalid tracking number (`invalid_number`), or the pinned carrier requires an `extra` the request lacks (`missing_extra`; `error.missing` lists the keys \u2014 see `required_extras` on /v1/carriers).", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c3edc4-2642-41d2-98ca-6e1828a1bf9d", "name": "Burst rate limit exceeded (code rate_limited); honor Retry-After.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"returned\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37c27df6-f22c-41ca-883f-d99aed8e8c58", "name": "List trackings", "request": { "name": "List trackings", "description": { "content": "Filters combine with AND. `tracking_number` is normalized (case,\nspaces) and matched exactly; `carrier` accepts any alias and is\ncanonicalized. `created_to` is exclusive; a bare date means \"through\nthat day\". `limit` <= 0 falls back to the default.\n", "type": "text/plain" }, "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5cc38ec8-31f0-4613-aa3d-a8d8ba73afe9", "name": "Trackings, most recent first.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"pending\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"in_transit\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n }\n ],\n \"total\": \"\",\n \"has_more\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1aa2b057-c9fe-4d41-b2c0-39cdbea0d875", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "trackings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "batch", "description": "", "item": [ { "id": "52eba0df-1f67-4bff-b6a4-c7e09a102e1f", "name": "Start tracking up to 100 packages in one call", "request": { "name": "Start tracking up to 100 packages in one call", "description": { "content": "Each item goes through exactly the create path (same validation,\ndedup, quota). The response is always 200 with one result per item,\nin order; validation failures, invalid numbers and quota exhaustion\nare reported per item, never as a whole-request error.\n", "type": "text/plain" }, "url": { "path": [ "v1", "trackings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trackings\": [\n {\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"delivered\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "db04e4fb-ee0e-4012-9e33-1d0ac1f51241", "name": "Per-item results.", "originalRequest": { "url": { "path": [ "v1", "trackings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trackings\": [\n {\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"delivered\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"tracking_number\": \"\",\n \"status\": \"created\",\n \"error\": \"bad_request\",\n \"message\": \"\",\n \"missing\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n }\n },\n {\n \"tracking_number\": \"\",\n \"status\": \"exists\",\n \"error\": \"quota_exceeded\",\n \"message\": \"\",\n \"missing\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40be0896-a0c3-4a6c-96a4-10046e5ace29", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "trackings", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trackings\": [\n {\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"external_order_id\": \"\",\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"exception\",\n \"delivered\"\n ],\n \"seller_alert_email\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"extra\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "3f557829-b176-426b-ab11-7c33af0e857a", "name": "Get one tracking with its full event timeline", "request": { "name": "Get one tracking with its full event timeline", "description": {}, "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e039cdd3-d19a-4954-9fb1-948600784b98", "name": "Tracking detail.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f26d4866-47df-4311-a494-e012956812fb", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "707a20ff-cc75-425e-870b-ae7a7dbfc504", "name": "Edit order id, metadata and notification settings", "request": { "name": "Edit order id, metadata and notification settings", "description": { "content": "Partial update, free (no quota). Fields absent or null are left\nalone; send \"\" (or {} / []) to clear one. Tracking number and\ncarrier cannot change \u2014 stop the tracking and create a new one.\n", "type": "text/plain" }, "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_order_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"out_for_delivery\",\n \"out_for_delivery\"\n ],\n \"seller_alert_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "658ee1b9-2918-4038-833d-99e171cac42e", "name": "Updated tracking (with events, like GET).", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_order_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"out_for_delivery\",\n \"out_for_delivery\"\n ],\n \"seller_alert_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"available_for_pickup\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db3a014-258a-4729-8341-3c15df707e90", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_order_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"out_for_delivery\",\n \"out_for_delivery\"\n ],\n \"seller_alert_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a0a52a-29bb-4e19-a64e-a73f348138f9", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_order_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"out_for_delivery\",\n \"out_for_delivery\"\n ],\n \"seller_alert_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65ab12cf-8a01-43b2-9fc5-88e7cd42ddca", "name": "Stop tracking (archive)", "request": { "name": "Stop tracking (archive)", "description": {}, "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8ac99c3f-4f05-4d93-b25d-474cbea768b9", "name": "Archived.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd70ebd6-0c74-4158-8cd8-4037c6690e84", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "refresh", "description": "", "item": [ { "id": "897133ff-cf3a-4b0c-b70a-d2cbb6a3825c", "name": "Request an immediate re-poll (rate-clamped server-side)", "request": { "name": "Request an immediate re-poll (rate-clamped server-side)", "description": {}, "url": { "path": [ "v1", "trackings", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "9ea6ae8d-1fdd-4f41-87ce-a58cd9e090b3", "name": "Nothing to do \u2014 already due, delivered/expired, or idle for 60+ days.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scheduled\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f80d00a-fd0d-4954-a2d8-02b664a8dc7e", "name": "A poll was pulled forward.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scheduled\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5482f56d-730d-48d2-961d-8e22bb85b1b7", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "trackings", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "trackings.csv", "description": "", "item": [ { "id": "6cbcb0c7-15e1-4659-9b9a-0c9704a269ee", "name": "Export trackings as CSV", "request": { "name": "Export trackings as CSV", "description": { "content": "Streams the tenant's shipments as a CSV download. Accepts the same filters as GET /v1/trackings.", "type": "text/plain" }, "url": { "path": [ "v1", "trackings.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8c8a26b4-d586-4444-aef7-a9179b1d0c72", "name": "CSV of shipments.", "originalRequest": { "url": { "path": [ "v1", "trackings.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08072503-38d2-4baa-8855-1a55c799cb99", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "trackings.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Exact match after normalization.", "type": "text/plain" }, "key": "tracking_number", "value": "" }, { "disabled": false, "description": { "content": "Exact match.", "type": "text/plain" }, "key": "external_order_id", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the tracking number OR the external order id \u2014 the single field a human searches with.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,info_received,in_transit,out_for_delivery,available_for_pickup,delivery_failure,delivered,exception,returned,expired)", "type": "text/plain" }, "key": "status", "value": "expired" }, { "disabled": false, "description": { "content": "Canonical slug or any alias.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 or YYYY-MM-DD, inclusive.", "type": "text/plain" }, "key": "created_from", "value": "" }, { "disabled": false, "description": { "content": "RFC3339 (exclusive) or YYYY-MM-DD (through that day).", "type": "text/plain" }, "key": "created_to", "value": "" }, { "disabled": false, "description": { "content": "Exact match on the closed substatus vocabulary, e.g. exception.customs_hold. A value outside the vocabulary matches nothing rather than being ignored.", "type": "text/plain" }, "key": "substatus", "value": "" }, { "disabled": false, "description": { "content": "Only parcels that are still moving and have had no scan for this many days. Terminal shipments (delivered, returned, expired) are never included \u2014 they are quiet because they are finished.", "type": "text/plain" }, "key": "quiet_days", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "stats", "description": "", "item": [ { "id": "1267cbc4-92d0-4181-a00e-fa699977813d", "name": "Shipment analytics", "request": { "name": "Shipment analytics", "description": { "content": "Status distribution and delivered transit-time bands over the tenant's\nshipments. Cached per user and window for 60 s. `from`/`to` restrict\nthe aggregate to shipments you started tracking in [from, to): RFC 3339\nor YYYY-MM-DD (UTC; a bare date in `to` covers that whole day).\n", "type": "text/plain" }, "url": { "path": [ "v1", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd37826b-0ca7-47a8-8a07-5c5c934f69cb", "name": "Aggregated stats.", "originalRequest": { "url": { "path": [ "v1", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": \"\",\n \"status_counts\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"transit_bands\": {\n \"key_0\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a843c8cb-36c5-43a7-b13a-8f64d9b8e753", "name": "Unparseable from/to.", "originalRequest": { "url": { "path": [ "v1", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "carriers", "description": "", "item": [ { "id": "71ca0f00-314b-49a4-a495-9bf97322d9ec", "name": "List supported carriers", "request": { "name": "List supported carriers", "description": { "content": "The full catalog is ~3,400 entries and changes at most daily, so it is\nserved with an `ETag` and `Cache-Control: public, max-age=3600`; send\n`If-None-Match` to get a bodiless 304. Unauthenticated, limited per IP\n(60 burst, then 1/s).\n", "type": "text/plain" }, "url": { "path": [ "v1", "carriers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Case-insensitive substring over code, name, name_zh, aliases and provider keys.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Max entries to return; 0 = all.", "type": "text/plain" }, "key": "limit", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ETag from a previous response; when it still matches, 304.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "79be9807-ab7f-40e9-ba71-d85932b3bd3e", "name": "Carrier catalog.", "originalRequest": { "url": { "path": [ "v1", "carriers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Case-insensitive substring over code, name, name_zh, aliases and provider keys.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Max entries to return; 0 = all.", "type": "text/plain" }, "key": "limit", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ETag from a previous response; when it still matches, 304.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Strong validator for this (catalog, q, limit).", "type": "text/plain" }, "key": "ETag", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" } ], "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"name_zh\": \"\",\n \"kind\": \"direct\",\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"providers\": [\n \"\",\n \"\"\n ],\n \"required_extras\": [\n \"postal\",\n \"country\"\n ],\n \"retired\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"name_zh\": \"\",\n \"kind\": \"direct\",\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"providers\": [\n \"\",\n \"\"\n ],\n \"required_extras\": [\n \"postal\",\n \"ship_date\"\n ],\n \"retired\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ab37523-8120-40c1-af7c-32fe0991790f", "name": "Not modified \u2014 the catalog matches If-None-Match.", "originalRequest": { "url": { "path": [ "v1", "carriers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Case-insensitive substring over code, name, name_zh, aliases and provider keys.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Max entries to return; 0 = all.", "type": "text/plain" }, "key": "limit", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ETag from a previous response; when it still matches, 304.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Modified", "code": 304, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "719a20bd-1ad7-42ee-8fb0-dd6ee37b0423", "name": "Burst rate limit exceeded (code rate_limited); honor Retry-After.", "originalRequest": { "url": { "path": [ "v1", "carriers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Case-insensitive substring over code, name, name_zh, aliases and provider keys.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Max entries to return; 0 = all.", "type": "text/plain" }, "key": "limit", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "ETag from a previous response; when it still matches, 304.", "type": "text/plain" }, "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "detect", "description": "", "item": [ { "id": "1d549776-3781-4f12-94f6-71a63ac32773", "name": "Identify the carrier(s) for a tracking number", "request": { "name": "Identify the carrier(s) for a tracking number", "description": { "content": "Pattern-matches the number against our detection rules and returns the\nranked canonical carrier candidates (highest confidence first). For each\ncandidate, `providers` gives that carrier's code in every third-party\nprovider that serves it (17track numeric key, 51tracking/track123/kuaidi100\ncourier code). Pass `provider` to also surface `provider_carrier` \u2014 that\none provider's code \u2014 per candidate. Local mapping only: instant, no\nquota. `ambiguous` is true when only an aggregator fallback matched\n(no specific carrier could be pinned).\n", "type": "text/plain" }, "url": { "path": [ "v1", "detect" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "" }, { "disabled": false, "description": { "content": "Optional provider to translate each detected carrier into. (This can only be one of 17track,51tracking,kuaidi100,track123)", "type": "text/plain" }, "key": "provider", "value": "kuaidi100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c7025559-dc65-411c-9944-55b1ef6b2f07", "name": "Detection result.", "originalRequest": { "url": { "path": [ "v1", "detect" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "" }, { "disabled": false, "description": { "content": "Optional provider to translate each detected carrier into. (This can only be one of 17track,51tracking,kuaidi100,track123)", "type": "text/plain" }, "key": "provider", "value": "kuaidi100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"number\": \"\",\n \"provider\": \"\",\n \"ambiguous\": \"\",\n \"candidates\": [\n {\n \"carrier\": \"\",\n \"name\": \"\",\n \"name_zh\": \"\",\n \"confidence\": \"\",\n \"providers\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"provider_carrier\": \"\"\n },\n {\n \"carrier\": \"\",\n \"name\": \"\",\n \"name_zh\": \"\",\n \"confidence\": \"\",\n \"providers\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"provider_carrier\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fba21e12-b312-43a1-b932-df219f18e3fb", "name": "Missing number or unknown provider.", "originalRequest": { "url": { "path": [ "v1", "detect" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "" }, { "disabled": false, "description": { "content": "Optional provider to translate each detected carrier into. (This can only be one of 17track,51tracking,kuaidi100,track123)", "type": "text/plain" }, "key": "provider", "value": "kuaidi100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "496c2bc7-4b72-4f08-9808-965c2315e49d", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": { "content": "All of your endpoints. The signing secret is shown only once, at creation, and never here.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d67a1107-e7f1-40a8-ada4-fd6b2440f8f1", "name": "Endpoints.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"disabled\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"disabled\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "134d10a0-bd83-4614-9033-ebd406014c9e", "name": "Add a webhook endpoint", "request": { "name": "Add a webhook endpoint", "description": { "content": "Requires a verified email. Deliveries are signed with\n`X-Track-Signature: t=,v1=`,\nretried up to 7 times over ~3 days, unordered, at-least-once.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ab90b581-ffca-4360-aa48-a0fa1ba2aaca", "name": "Created. The signing secret is shown only once.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"secret\": \"\",\n \"note\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0970ea8c-e84d-4d29-aa49-0bedd8618790", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a56c7f46-bffc-4a50-bb28-ac461e34ab08", "name": "Email not verified.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "700366ac-e536-4d8e-808e-57c572bf20eb", "name": "An endpoint with this URL already exists; its id is returned.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"missing_extra\",\n \"missing\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "9aa72e94-af84-468f-801c-ae1a1ba64af3", "name": "Delete a webhook endpoint", "request": { "name": "Delete a webhook endpoint", "description": {}, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "22205b0f-bfe0-4173-b975-2c1b50430cec", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94ffed7c-c541-4e82-b559-991c6ff44806", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "enable", "description": "", "item": [ { "id": "69eb939d-d970-4f42-abdd-8bb31a92e2f6", "name": "Re-enable an endpoint and release its backlog", "request": { "name": "Re-enable an endpoint and release its backlog", "description": { "content": "20 consecutive delivery failures disable an endpoint. Events are still queued while it is disabled \u2014 they are parked, not dropped \u2014 so this clears the failure count and immediately releases every parked delivery, oldest first. Deliveries older than your retention window are not released; they have expired.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "21c662f7-225f-4333-9280-ac7b70e50a6e", "name": "Enabled; parked deliveries released.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a70e8b81-ffbb-48ac-b051-530f9e35c339", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "debug", "description": "", "item": [ { "id": "3a958e69-2f5b-4663-9e3a-6b9dc4ea777e", "name": "Turn debug mode on or off for an endpoint", "request": { "name": "Turn debug mode on or off for an endpoint", "description": { "content": "Debug mode records the exact headers we sent with every delivery to this endpoint \u2014 signature included \u2014 so you can replay our request while you are writing your handler, and stops this endpoint's failures counting toward auto-disable. It does not expire on its own; turn it off when you are done.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "debug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "839b5bba-8c6d-4802-a638-4451c4070a17", "name": "Updated.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "debug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58e6e69d-30a1-4386-88a0-99e4d214a97c", "name": "Invalid body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "debug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e923c38-ffd5-4357-9e6e-162dfd52dc19", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "debug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "test", "description": "", "item": [ { "id": "f40eaab1-dea4-418b-b2ad-64a35f953def", "name": "Send a tracking.test event to an endpoint", "request": { "name": "Send a tracking.test event to an endpoint", "description": { "content": "Queues a `tracking.test` delivery: the normal envelope and signature\naround a synthetic delivered stub shipment, so you can verify your\nhandler end to end without waiting for a real update. Ignores the\nendpoint's `events` filter. Watch it on `GET /v1/webhooks/deliveries`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "2113e16c-7340-492c-9ae5-be330cd3d332", "name": "Queued; the dispatcher sends it within seconds.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc7a796-f4f7-4ec4-8928-0080a687bb0f", "name": "Not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99836f94-8420-4fc0-aa49-66b36de14fc5", "name": "The endpoint is disabled; enable it first.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e6aa4cf-ef52-432c-8b7e-bca442b2bb51", "name": "Burst rate limit exceeded (code rate_limited); honor Retry-After.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "retention", "description": "", "item": [ { "id": "76f34475-fecc-4ff6-a67b-b42a3fd4604c", "name": "Set how long deliveries are kept and replayable", "request": { "name": "Set how long deliveries are kept and replayable", "description": { "content": "One window does both jobs: how long a failed or parked delivery can still be retried or replayed, and how long we keep its payload before deleting it. Account-wide, 1 to 168 hours (7 days, the maximum). Read the current value from GET /v1/me.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "retention" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "deb2e900-2521-4cf8-aa70-1e804b2c9816", "name": "Updated.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "retention" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eea5a320-e166-4f4a-9b50-96790ae28202", "name": "Out of range.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "retention" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deliveries", "description": "", "item": [ { "id": "214cd0d2-fd61-456e-9b09-09760a1d505a", "name": "List webhook deliveries", "request": { "name": "List webhook deliveries", "description": { "content": "Newest first across all of your endpoints, each with the frozen payload and the first 1 KB of your endpoint's reply.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "endpoint_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,ok,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b0d8f48c-698b-413d-9c0a-cad39d9c73dc", "name": "Deliveries.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "endpoint_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,ok,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"endpoint_id\": \"\",\n \"event_type\": \"\",\n \"status\": \"pending\",\n \"attempt\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_excerpt\": \"\",\n \"payload\": {\n \"id\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"expired\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n }\n },\n \"created_at\": \"\",\n \"next_attempt_at\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoint_id\": \"\",\n \"event_type\": \"\",\n \"status\": \"pending\",\n \"attempt\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_excerpt\": \"\",\n \"payload\": {\n \"id\": \"\",\n \"type\": \"\",\n \"api_version\": \"\",\n \"created_at\": \"\",\n \"data\": {\n \"id\": \"\",\n \"tracking_number\": \"\",\n \"carrier\": \"\",\n \"status\": \"out_for_delivery\",\n \"substatus\": \"\",\n \"external_order_id\": \"\",\n \"estimated_delivery\": \"\",\n \"origin_country\": \"\",\n \"destination_country\": \"\",\n \"signed_by\": \"\",\n \"last_mile_carrier\": \"\",\n \"last_mile_number\": \"\",\n \"last_event_at\": \"\",\n \"created_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"notify_email\": \"\",\n \"notify_statuses\": [\n \"\",\n \"\"\n ],\n \"seller_alert_email\": \"\",\n \"events\": [\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n },\n {\n \"occurred_at\": \"\",\n \"status\": \"\",\n \"substatus\": \"\",\n \"description\": \"\",\n \"location\": {\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postal\": \"\"\n }\n }\n ]\n }\n },\n \"created_at\": \"\",\n \"next_attempt_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be4cfb77-4080-4963-a0ed-c5123914b431", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "endpoint_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,ok,dead)", "type": "text/plain" }, "key": "status", "value": "dead" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "redeliver", "description": "", "item": [ { "id": "5e67011f-f0ef-4e7e-8fb2-b30705d02d51", "name": "Send a delivery again", "request": { "name": "Send a delivery again", "description": { "content": "Requeues any settled (ok or dead) delivery from attempt 0 with the same payload and a fresh signature. A delivery still pending is left to the dispatcher (404).", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "14d14ab3-a0db-4be4-a793-3c8952f5f9ed", "name": "Requeued.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7c45363-b9a5-429a-b5b0-e3cff1f46a37", "name": "No such delivery, or it is still pending.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "billing", "description": "", "item": [ { "name": "checkout", "description": "", "item": [ { "id": "55a551e4-abf9-445d-b03c-9ff1ccd6d7bd", "name": "Create a checkout session for a paid plan", "request": { "name": "Create a checkout session for a paid plan", "description": {}, "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ded48295-34b0-40f6-b456-e4b05714d33e", "name": "Redirect the user to this URL.", "originalRequest": { "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a01d94b5-1c99-4847-bf51-8157d62705e2", "name": "Malformed body, unknown JSON field, or invalid parameter \u2014 the message names it.", "originalRequest": { "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c2271dc-ee1f-426c-ab68-6c6dea746d98", "name": "Email not verified (`email_unverified`).", "originalRequest": { "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4960d646-8540-4929-a444-ecc1a9c040a0", "name": "Already on a paid plan (`already_subscribed`).", "originalRequest": { "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2191b34-6056-412d-8cd5-c64abdb80f2e", "name": "Billing is not configured on this instance (`billing_unavailable`) \u2014 the current deployment returns this.", "originalRequest": { "url": { "path": [ "v1", "billing", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"business\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "portal", "description": "", "item": [ { "id": "9146bd15-1a93-4194-973c-d52ea6b6d18e", "name": "Create a billing-portal session", "request": { "name": "Create a billing-portal session", "description": {}, "url": { "path": [ "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "dc62e878-f452-4bfb-8a8a-dfb0e4d1191f", "name": "Portal URL.", "originalRequest": { "url": { "path": [ "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80744e2f-8af2-48cc-846b-45b2791d6d9a", "name": "Email not verified (`email_unverified`).", "originalRequest": { "url": { "path": [ "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0235f44c-b2e0-435e-8f8a-b281eea1b0c8", "name": "Billing is not configured on this instance (`billing_unavailable`) \u2014 the current deployment returns this.", "originalRequest": { "url": { "path": [ "v1", "billing", "portal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Implemented", "code": 501, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"message\": \"\",\n \"code\": \"method_not_allowed\",\n \"missing\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://track.example.com" }, { "key": "bearerToken", "value": "trk_live_REPLACE_ME", "type": "string" } ], "info": { "_postman_id": "d7ccc86d-d1af-46d2-9a89-a284256596d9", "name": "Track API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Package tracking API. Auto-detects carriers, normalizes statuses across\n3,400+ carriers, pushes signed webhooks on updates.\n\nCarrier codes are canonical slugs (sf-express, zto, ups, fedex) \u2014 one\nstable code per real-world carrier, independent of which upstream data\nprovider serves it. Requests accept aliases (sf, \u987a\u4e30, shunfeng) and the\nlegacy provider-namespaced forms (kuaidi100:shunfeng, 17track:100012),\nall normalized to the slug. BREAKING (2026-07): tracking and webhook\n\"carrier\" values changed from provider-namespaced codes to canonical\nslugs; carriers not in the registry still appear as 17track:.\n\nBREAKING (2026-09): `substatus` is now a closed `status.detail` vocabulary\nshared by every carrier (see the Tracking schema); the provider tokens it\nused to carry (IN_TRANSIT_01, transit001, in_transit.other, \u2026) are gone,\nand stored history was rewritten onto the vocabulary. A number the carrier\nrejects outright is `exception` + `exception.invalid_number` (was\n`exception.rejected`); a recipient refusal is `delivery_failure` +\n`delivery_failure.rejected` (was `exception`); a completed return is the\nnew terminal status `returned` (webhook `tracking.returned`); a customs\nhold is `exception` + `exception.customs_hold` from every provider.\nWebhook payloads carry `api_version: \"2026-09\"`.\n\nBilling counts trackings created per calendar month; reads and webhooks\nare free. Resubmitting an already-tracked number is idempotent and never\nbilled twice.\n", "type": "text/plain" } } }