{"id":20516198,"url":"https://github.com/aftership/tracking-sdk-java","last_synced_at":"2025-09-21T18:22:03.613Z","repository":{"id":248093704,"uuid":"816567748","full_name":"AfterShip/tracking-sdk-java","owner":"AfterShip","description":"The official AfterShip Tracking Java API library","archived":false,"fork":false,"pushed_at":"2024-12-17T01:55:14.000Z","size":122,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":7,"default_branch":"2024-10","last_synced_at":"2024-12-20T08:23:09.543Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AfterShip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-18T02:21:30.000Z","updated_at":"2024-12-17T01:53:27.000Z","dependencies_parsed_at":"2025-01-10T11:39:40.989Z","dependency_job_id":null,"html_url":"https://github.com/AfterShip/tracking-sdk-java","commit_stats":null,"previous_names":["aftership/tracking-sdk-java"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Ftracking-sdk-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Ftracking-sdk-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Ftracking-sdk-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Ftracking-sdk-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AfterShip","download_url":"https://codeload.github.com/AfterShip/tracking-sdk-java/tar.gz/refs/heads/2024-10","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234177841,"owners_count":18791620,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T21:27:24.371Z","updated_at":"2025-09-21T18:21:58.314Z","avatar_url":"https://github.com/AfterShip.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AfterShip Tracking API library for Java\n\nThis library allows you to quickly and easily use the AfterShip Tracking API via Java.\n\nFor updates to this library, see our [GitHub release page](https://github.com/AfterShip/tracking-sdk-java/releases).\n\nIf you need support using AfterShip products, please contact support@aftership.com.\n\n## Table of Contents\n\n- [AfterShip Tracking API library for Java](#aftership-tracking-api-library-for-java)\n - [Table of Contents](#table-of-contents)\n - [Before you begin](#before-you-begin)\n - [API and SDK Version](#api-and-sdk-version)\n - [Quick Start](#quick-start)\n - [Installation](#installation)\n - [Constructor](#constructor)\n - [Example](#example)\n - [Rate Limiter](#rate-limiter)\n - [Error Handling](#error-handling)\n - [Error List](#error-list)\n - [Endpoints](#endpoints)\n - [/trackings](#trackings)\n - [/couriers](#couriers)\n - [/estimated-delivery-date](#estimated-delivery-date)\n - [Help](#help)\n - [License](#license)\n\n\n## Before you begin\n\nBefore you begin to integrate:\n\n- [Create an AfterShip account](https://admin.aftership.com/).\n- [Create an API key](https://organization.automizely.com/api-keys).\n- [Install Java](https://www.oracle.com/java/technologies/downloads/) version Java 1.8 or later.\n\n### API and SDK Version\n\nEach SDK version is designed to work with a specific API version. Please refer to the table below to identify the supported API versions for each SDK version, ensuring you select the appropriate SDK version for the API version you intend to use.\n\n| SDK Version | Supported API Version | Branch |\n| ----------- | --------------------- | ----------------------------------------------------------- |\n| 7.x.x | 2024-10 | https://github.com/AfterShip/tracking-sdk-java/tree/2024-10 |\n| 6.x.x | 2024-07 | https://github.com/AfterShip/tracking-sdk-java/tree/2024-07 |\n| 5.x.x | 2024-04 | https://github.com/AfterShip/tracking-sdk-java/tree/2024-04 |\n| 4.x.x | 2023-10 | https://github.com/AfterShip/aftership-sdk-java |\n| \u003c=3.x.x | Legacy API | https://github.com/AfterShip/aftership-sdk-java |\n\n## Quick Start\n\n### Installation\n```bash\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.aftership\u003c/groupId\u003e\n \u003cartifactId\u003etracking-sdk\u003c/artifactId\u003e\n \u003cversion\u003e7.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n\n## Constructor\n\nCreate AfterShip instance with options\n\n| Name | Type | Required | Description |\n| ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| api_key | string | ✔ | Your AfterShip API key |\n| auth_type | enum | | Default value: `AuthType.API_KEY` \u003cbr \u003e AES authentication: `AuthType.AES` \u003cbr \u003e RSA authentication: `AuthType.RSA` |\n| api_secret | string | | Required if the authentication type is `AuthType.AES` or `AuthType.RSA` |\n| domain | string | | AfterShip API domain. Default value: https://api.aftership.com |\n| user_agent | string | | User-defined user-agent string, please follow [RFC9110](https://www.rfc-editor.org/rfc/rfc9110#field.user-agent) format standard. |\n| proxy | string | | HTTP proxy URL to use for requests. \u003cbr \u003e Default value: `null` \u003cbr \u003e Example: `http://192.168.0.100:8888` |\n| max_retry | number | | Number of retries for each request. Default value: 2. Min is 0, Max is 10. |\n| timeout | number | | Timeout for each request in milliseconds. |\n\n### Example\n\n```java\nimport com.aftership.AfterShip;\nimport com.aftership.model.CreateTrackingRequest;\nimport com.aftership.model.CreateTrackingResponse;\nimport com.aftership.tracking.TrackingResource;\n\npublic class App {\n public static void main(String[] args) {\n try {\n AfterShip.init(\n \"YOUR_API_KEY\"\n );\n \n CreateTrackingRequest trackingCreateTrackingRequest = new CreateTrackingRequest();\n trackingCreateTrackingRequest.setTrackingNumber(\"\u003ctracking_number\u003e\");\n trackingCreateTrackingRequest.setSlug(\"\u003cslug\u003e\");\n Tracking response = TrackingResource.createTracking().\n setCreateTrackingRequest(trackingCreateTrackingRequest).\n create();\n System.out.println(response.getTrackingNumber());\n } catch (Exception e) {\n e.printStackTrace();\n }\n }\n}\n```\n\n## Rate Limiter\n\nSee the [Rate Limit](https://www.aftership.com/docs/tracking/2024-10/quickstart/rate-limit) to understand the AfterShip rate limit policy.\n\n## Error Handling\n\nThe SDK will return an error object when there is any error during the request, with the following specification:\n\n| Name | Type | Description |\n| ------------- | ------ | ------------------------------ |\n| message | string | Detail message of the error |\n| code | enum | Error code enum for API Error. |\n| meta_code | number | API response meta code. |\n| status_code | number | HTTP status code. |\n| response_body | string | API response body. |\n\n\n### Error List\n\n| code | meta_code | status_code | message |\n| --------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| INVALID_REQUEST | 400 | 400 | The request was invalid or cannot be otherwise served. |\n| INVALID_JSON | 4001 | 400 | Invalid JSON data. |\n| TRACKING_ALREADY_EXIST | 4003 | 400 | Tracking already exists. |\n| TRACKING_DOES_NOT_EXIST | 4004 | 404 | Tracking does not exist. |\n| TRACKING_NUMBER_INVALID | 4005 | 400 | The value of tracking_number is invalid. |\n| TRACKING_REQUIRED | 4006 | 400 | tracking object is required. |\n| TRACKING_NUMBER_REQUIRED | 4007 | 400 | tracking_number is required. |\n| VALUE_INVALID | 4008 | 400 | The value of [field_name] is invalid. |\n| VALUE_REQUIRED | 4009 | 400 | [field_name] is required. |\n| SLUG_INVALID | 4010 | 400 | The value of slug is invalid. |\n| MISSING_OR_INVALID_REQUIRED_FIELD | 4011 | 400 | Missing or invalid value of the required fields for this courier. Besides tracking_number, also required: [field_name] |\n| BAD_COURIER | 4012 | 400 | The error message will be one of the following:\u003cbr/\u003e1. Unable to import shipment as the carrier is not on your approved list for carrier auto-detection. Add the carrier here: https://admin.aftership.com/settings/couriers\u003cbr/\u003e2. Unable to import shipment as we don’t recognize the carrier from this tracking number.\u003cbr/\u003e3. Unable to import shipment as the tracking number has an invalid format.\u003cbr/\u003e4. Unable to import shipment as this carrier is no longer supported.\u003cbr/\u003e5. Unable to import shipment as the tracking number does not belong to a carrier in that group. |\n| INACTIVE_RETRACK_NOT_ALLOWED | 4013 | 400 | Retrack is not allowed. You can only retrack an inactive tracking. |\n| NOTIFICATION_REUQIRED | 4014 | 400 | notification object is required. |\n| ID_INVALID | 4015 | 400 | The value of id is invalid. |\n| RETRACK_ONCE_ALLOWED | 4016 | 400 | Retrack is not allowed. You can only retrack each shipment once. |\n| TRACKING_NUMBER_FORMAT_INVALID | 4017 | 400 | The format of tracking_number is invalid. |\n| API_KEY_INVALID | 401 | 401 | The API key is invalid. |\n| REQUEST_NOT_ALLOWED | 403 | 403 | The request is understood, but it has been refused or access is not allowed. |\n| NOT_FOUND | 404 | 404 | The URI requested is invalid or the resource requested does not exist. |\n| TOO_MANY_REQUEST | 429 | 429 | You have exceeded the API call rate limit. The default limit is 10 requests per second. |\n| INTERNAL_ERROR | 500 502 503 504 | 500 502 503 504 | Something went wrong on AfterShip's end. |\n\n## Endpoints\n\nThe AfterShip instance has the following properties which are exactly the same as the API endpoints:\n\n- courier - Get a list of our supported couriers.\n- tracking - Create trackings, update trackings, and get tracking results.\n- estimated-delivery-date - Get estimated delivery date for your order.\n\n### /trackings\n\n**POST** /trackings\n\n```java\nCreateTrackingRequest trackingCreateTrackingRequest = new CreateTrackingRequest();\ntrackingCreateTrackingRequest.setTrackingNumber(\"\u003ctracking_number\u003e\");\ntrackingCreateTrackingRequest.setSlug(\"\u003cslug\u003e\");\nTracking response = TrackingResource.createTracking().\n setCreateTrackingRequest(trackingCreateTrackingRequest).\n create();\nSystem.out.println(response.getTrackingNumber());\n```\n\n**DELETE** /trackings/:id\n\n```java\nTracking response = TrackingResource.deleteTrackingById()\n .setId(\"\u003ctracking_id\u003e\")\n .delete();\nSystem.out.println(response.getId());\n```\n\n**GET** /trackings\n\n```java\nPage\u003cTracking\u003e response = TrackingResource.getTrackings().setKeyword(\"test\").read();\nfor (Tracking tracking : response.getRecords()) {\n System.out.println(tracking.getTrackingNumber());\n}\n```\n\n**GET** /trackings/:id\n\n```java\nTracking response = TrackingResource.getTrackingById()\n .setId(\"\u003ctracking_id\u003e\")\n .fetch();\nSystem.out.println(response.getTrackingNumber());\n```\n\n**PUT** /trackings/:id\n\n```java\nUpdateTrackingByIdRequest request = new UpdateTrackingByIdRequest();\nrequest.setTitle(\"test\");\nTracking response = TrackingResource.updateTrackingById()\n .setId(\"\u003ctracking_id\u003e\")\n .setUpdateTrackingByIdRequest(request)\n .update();\nSystem.out.println(response.getTitle());\n```\n\n**POST** /trackings/:id/retrack\n\n```java\nTracking response = TrackingResource.retrackTrackingById()\n .setId(\"\u003ctracking_id\u003e\")\n .create();\nSystem.out.println(response.getTrackingNumber());\n```\n\n**POST** /trackings/:id/mark-as-completed\n\n```java\nMarkTrackingCompletedByIdRequest request = new MarkTrackingCompletedByIdRequest();\nrequest.setReason(\"LOST\");\nTracking response = TrackingResource.markTrackingCompletedById()\n .setId(\"\u003ctracking_id\u003e\")\n .setMarkTrackingCompletedByIdRequest(request)\n .create();\nSystem.out.println(response.getTrackingNumber());\n```\n\n### /couriers\n**GET** /couriers\n\n```java\nGetUserCouriersResponse response = CourierResource.getUserCouriers().fetch();\nSystem.out.println(response.getTotal());\n```\n\n**GET** /couriers/all\n\n```java\nGetAllCouriersResponse response = CourierResource.getAllCouriers().fetch();\nSystem.out.println(response.getTotal());\n```\n\n**POST** /couriers/detect\n\n```java\nDetectCourierRequest request = new DetectCourierRequest();\nrequest.setTrackingNumber(\"\u003ctracking_number\u003e\");\nDetectCourierResponse response = CourierResource.detectCourier()\n .setDetectCourierRequest(request)\n .create();\nSystem.out.println(response.getTotal());\n```\n\n### /estimated-delivery-date\n\n**POST** /estimated-delivery-date/predict-batch\n\n```java\nPredictBatchRequest request = new PredictBatchRequest();\nEstimatedDeliveryDateRequest edd = new EstimatedDeliveryDateRequest();\nedd.setSlug(\"\u003cslug\u003e\");\nDestinationAddressEstimatedDeliveryDateRequest dest = new DestinationAddressEstimatedDeliveryDateRequest();\ndest.setCountry(\"\u003cISO 3166-1 country/region code\u003e\");\ndest.setState(\"\u003cISO 3166-1 country/region code\u003e\");\n\nedd.setDestinationAddress( dest);\n\nOriginAddressEstimatedDeliveryDateRequest origin = new OriginAddressEstimatedDeliveryDateRequest();\norigin.setCountry(\"\u003cISO 3166-1 country/region code\u003e\");\norigin.setState(\"\u003cISO 3166-1 country/region code\u003e\");\nedd.setOriginAddress(origin);\n\nedd.setPickupTime(\"2024-08-01 06:42:30\");\nrequest.setEstimatedDeliveryDates(Arrays.asList(edd));\nPredictBatchResponse response = EstimatedDeliveryDateResource.predictBatch()\n .setPredictBatchRequest(request)\n .create();\nSystem.out.println(response.getEstimatedDeliveryDates().get(0).getSlug());\n```\n\n## Help\n\nIf you get stuck, we're here to help:\n\n- [Issue Tracker](https://github.com/AfterShip/tracking-sdk-java/issues) for questions, feature requests, bug reports and general discussion related to this package. Try searching before you create a new issue.\n- Contact AfterShip official support via support@aftership.com\n\n## License\nCopyright (c) 2024 AfterShip\n\nLicensed under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faftership%2Ftracking-sdk-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faftership%2Ftracking-sdk-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faftership%2Ftracking-sdk-java/lists"}