{"id":15045875,"url":"https://github.com/shipengine/shipengine-java","last_synced_at":"2026-02-13T04:17:59.936Z","repository":{"id":42681719,"uuid":"392441370","full_name":"ShipEngine/shipengine-java","owner":"ShipEngine","description":"The official Java SDK for ShipEngine API","archived":false,"fork":false,"pushed_at":"2025-01-09T08:53:20.000Z","size":219,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-08-06T23:19:12.185Z","etag":null,"topics":["address-validation","api","dhl-api","fedex-api","java","jdk","package-tracking","rest-api","sdk","shipengine","shipment-tracking","shipping-api","shipping-label","shipping-rates","tracking-number","ups-api","usps-api"],"latest_commit_sha":null,"homepage":"https://www.shipengine.com/docs/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShipEngine.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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":"2021-08-03T20:04:32.000Z","updated_at":"2025-01-09T08:53:25.000Z","dependencies_parsed_at":"2024-05-21T15:56:54.058Z","dependency_job_id":"1b73bfdd-59c0-46d3-95fa-c12459e46fff","html_url":"https://github.com/ShipEngine/shipengine-java","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ShipEngine/shipengine-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipengine-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipengine-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipengine-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipengine-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShipEngine","download_url":"https://codeload.github.com/ShipEngine/shipengine-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShipEngine%2Fshipengine-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272935834,"owners_count":25018156,"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","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["address-validation","api","dhl-api","fedex-api","java","jdk","package-tracking","rest-api","sdk","shipengine","shipment-tracking","shipping-api","shipping-label","shipping-rates","tracking-number","ups-api","usps-api"],"created_at":"2024-09-24T20:52:23.992Z","updated_at":"2026-02-13T04:17:59.894Z","avatar_url":"https://github.com/ShipEngine.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![ShipEngine](https://shipengine.github.io/img/shipengine-logo-wide.png)](https://www.shipengine.com/)\n\nShipEngine Java SDK\n===================\n### The official Java SDK for ShipEngine API.\n![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/ShipEngine/shipengine-java/shipengine-java%20CI/main?label=ShipEngine%20Java%20CI\u0026logo=github)\n[![Coverage Status](https://coveralls.io/repos/github/ShipEngine/shipengine-java/badge.svg?branch=main)](https://coveralls.io/github/ShipEngine/shipengine-java?branch=main)\n![GitHub](https://img.shields.io/github/license/shipengine/shipengine-java?color=blue)\n![OS Compatibility](https://shipengine.github.io/img/badges/os-badges.svg)\n\nQuick Start\n-----------\nInstall `shipengine` from the `Maven Central Repository` by adding the following under the dependencies key in your `pom.xml`:\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.shipengine\u003c/groupId\u003e\n    \u003cartifactId\u003eshipengine\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n- The only configuration requirement for the SDK is providing an [API Key](https://www.shipengine.com/docs/auth/#api-keys \"ShipEngine Authentication Docs\").\n\nInstantiate ShipEngine Class\n----------------------------\n\n```java\nimport com.shipengine.ShipEngine;\n\npublic class ShipEngineDemo {\n    public static void main() {\n        ShipEngine shipengine = new ShipEngine(\"\u003cYOUR_API_KEY_HERE\u003e\");\n    }\n}\n```\n\n- You can also pass in a `HashMap/Map` containing configuration options instead of just passing in a string that is your `API Key`.\n\n```java\nimport com.shipengine.ShipEngine;\n\npublic class ShipEngineDemo {\n    public static void main() {\n        ShipEngine shipengine = new ShipEngine(new HashMap\u003c\u003e() {{\n            put(\"apiKey\", \"\u003cYOUR_API_KEY_HERE\u003e\");\n            put(\"pageSize\", 75);\n            put(\"retries\", 3);\n            put(\"timeout\", 60000);\n        }});\n    }\n}\n```\n\nMethods\n-------\n* [`createLabelFromRate`](./docs/create-label-from-rate-id.md) - When retrieving rates for shipments using the `getRatesWithShipmentDetails` method, the returned information contains a `rateId` property that can be used to purchase a label without having to refill in the shipment information repeatedly.\n* [`createLabelFromShipmentDetails`](./docs/create-label-from-shipment-details.md) - Purchase and print a label for shipment.\n* [`getRatesWithShipmentDetails`](./docs/get-rates-with-shipment-details.md) - Given some shipment details and rate options, this method returns a list of rate quotes.\n* [`listCarriers`](./docs/list-carriers.md) - Returns a list of carrier accounts that have been connected through\nthe [ShipEngine dashboard](https://www.shipengine.com/docs/carriers/setup/).\n* [`trackUsingLabelId`](./docs/track-using-label-id.md) - Track a package by its associated label ID.\n* [`trackUsingCarrierCodeAndTrackingNumber`](./docs/track-using-carrier-code-and-tracking-number.md) - Track a package for a given carrier and tracking number.\n* [`validateAddresses`](./docs/validate-addresses.md) - Indicates whether the provided addresses are valid. If the addresses are valid, the method returns a normalized version based on the standards of the country in which the address resides. If an address cannot be normalized, an error is returned.\n* [`voidLabelWithLabelId`](./docs/void-label-with-label-id.md) - Void a label with its Label ID.\n\nContributing\n------------\nContributions, enhancements, and bug-fixes are welcome!  [Open an issue](https://github.com/ShipEngine/shipengine-java/issues) on GitHub and [submit a pull request](https://github.com/ShipEngine/shipengine-java/pulls).\n\n#### Building\nTo build the project locally on your computer:\n\n1. __Clone this repo__\u003cbr\u003e\n`git clone https://github.com/ShipEngine/shipengine-java.git`\n\n2. __Install dependencies__\u003cbr\u003e\n`mvn install`\n\n3. __Build the code__\u003cbr\u003e\n`mvn package`\n\n4. __Lint the code__\u003cbr\u003e\n`mvn checkstyle:check`\n\n5. __Run the tests__\u003cbr\u003e\n`mvn test`\n\nVS Code Setup\n-------------\nInstall the [Java Extension Pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) to help write, test and debug the application, and install [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) to enable code formatting.\n\nCommitting\n----------\nThis project adheres to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fshipengine-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipengine%2Fshipengine-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipengine%2Fshipengine-java/lists"}