{"id":30738857,"url":"https://github.com/aftership/shipping-sdk-java","last_synced_at":"2025-09-03T22:11:01.822Z","repository":{"id":308703905,"uuid":"1032987037","full_name":"AfterShip/shipping-sdk-java","owner":"AfterShip","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-19T03:04:19.000Z","size":71,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-19T05:27:27.309Z","etag":null,"topics":["post-purchase-be-redbull"],"latest_commit_sha":null,"homepage":null,"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,"zenodo":null}},"created_at":"2025-08-06T06:13:41.000Z","updated_at":"2025-08-19T03:04:23.000Z","dependencies_parsed_at":"2025-08-07T12:29:08.117Z","dependency_job_id":"f11c1613-7e3a-41d0-81e3-4bccb8d2952b","html_url":"https://github.com/AfterShip/shipping-sdk-java","commit_stats":null,"previous_names":["aftership/shipping-sdk-java"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/AfterShip/shipping-sdk-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Fshipping-sdk-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Fshipping-sdk-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Fshipping-sdk-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Fshipping-sdk-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AfterShip","download_url":"https://codeload.github.com/AfterShip/shipping-sdk-java/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AfterShip%2Fshipping-sdk-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273518738,"owners_count":25120031,"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-09-03T02:00:09.631Z","response_time":76,"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":["post-purchase-be-redbull"],"created_at":"2025-09-03T22:11:00.447Z","updated_at":"2025-09-03T22:11:01.799Z","avatar_url":"https://github.com/AfterShip.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AfterShip Shipping API library for Java\n\nThis library allows you to quickly and easily use the AfterShip Shipping API via Java.\n\nFor updates to this library, see our [GitHub release page](https://github.com/AfterShip/shipping-sdk-java/releases).\n\nIf you need support using AfterShip products, please contact support@aftership.com.\n\n## Table of Contents\n\n- [AfterShip Shipping API library for Java](#aftership-shipping-api-library-for-java)\n - [Table of Contents](#table-of-contents)\n - [Before you begin](#before-you-begin)\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 - [/couriers](#couriers)\n - [/locations](#locations)\n - [/manifests](#manifests)\n - [/shipper-accounts](#shipper-accounts)\n - [/labels](#labels)\n - [/cancel-labels](#cancel-labels)\n - [/address-validations](#address-validations)\n - [/rates](#rates)\n - [/pickups](#pickups)\n - [/cancel-pickups](#cancel-pickups)\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## Quick Start\n\n### Installation\n```bash\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.aftership\u003c/groupId\u003e\n \u003cartifactId\u003eshipping-sdk\u003c/artifactId\u003e\n \u003cversion\u003e2.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://sandbox-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.PostLabelsRequest;\nimport com.aftership.model.PostLabelsResponse;\nimport com.aftership.labels.LabelsResource;\n\npublic class App {\n public static void main(String[] args) {\n try {\n AfterShip.init(\n \"YOUR_API_KEY\"\n );\n PostLabelsRequest request = new PostLabelsRequest();\n PostLabelsResponse response = LabelsResource.postLabels()\n .setPostLabelsRequest(request)\n .create();\n System.out.println(response.getData());\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/shipping/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| response_header | object | API response header. |\n\n\n### Error List\n\n| code | meta_code | status_code | message |\n| --------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| OK | 200 | 200 | OK | |\n| UNAUTHORIZED | 401 | 401 | Invalid API key. | |\n| TOO_MANY_REQUESTS | 429 | 429 | You have exceeded the API call rate limit. Please check the header field \u0026#39;X-RateLimit-Reset\u0026#39; for time left until the limit release. | |\n| INTERNAL_SERVER_ERROR | 500 | 500 | Something went wrong on AfterShip Shipping\u0026#39;s end. | |\n| BAD_GATEWAY | 502 | 502 | Something went wrong on AfterShip Shipping\u0026#39;s end. | |\n| SERVICE_UNAVAILABLE | 503 | 503 | Something went wrong on AfterShip Shipping\u0026#39;s end. | |\n| GATEWAY_TIMEOUT | 504 | 504 | Something went wrong on AfterShip Shipping\u0026#39;s end. | |\n| PENDING | 3001 | 200 | The request has been accepted for processing, but the processing has not been completed. | |\n| INTERNAL_ERROR | 4100 | 200 | Internal Error. | |\n| INTERNAL_ERROR_RETRY | 4101 | 200 | Internal Error, please try again. | |\n| BAD_REQUEST | 4104 | 200 | The request was invalid or cannot be otherwise served. | |\n| INVALID_JSON | 4109 | 200 | Invalid JSON. | |\n| SHIPPER_ACCOUNT_NOT_FOUND | 4140 | 200 | Shipper account not found. | |\n| RECORD_NOT_FOUND | 4153 | 200 | Item does not exist. | |\n| SHIPPER_ACCOUNT_LOCKED | 4155 | 200 | Access to shipper_account locked during manifest/cancel-label operation. | |\n| RATE_NOT_FOUND | 4157 | 200 | Rate is not found | |\n| PREPAID_ACCOUNT_DISABLED | 4159 | 200 | The prepaid account is currently deactivated, please try again later. | |\n| PAYMENT_CARD_ERROR | 4161 | 200 | Your card is declined by payment gateway. | |\n| PAYMENT_API_ERROR | 4162 | 200 | There is an error when connecting to payment gateway. | |\n| PAYMENT_INVALID_REQUEST_AMOUNT_ERROR | 4163 | 200 | The amount of given transaction is invalid. | |\n| PAYMENT_INVALID_REQUEST_ERROR | 4164 | 200 | The payment request is invalid. | |\n| OPERATION_NOT_ALLOWED_COURIER | 4171 | 200 | Operation is not allowed on this courier. | |\n| TOO_MANY_CUSTOM_REQUESTS | 4172 | 200 | You have exceeded the limit on number of requests, please try again later | |\n| RESPONSE_ERROR | 4703 | 200 | The courier seems to be currently unavailable, please try again later. | |\n| NO_RESPONSE | 4705 | 200 | No response was returned. | |\n| RATE_REQUEST_FAILED | 4713 | 200 | All or partial failed in rate request. | |\n| COURIER_ERROR | 4715 | 200 | The request is invalid or cannot be served by courier. | |\n| ADDRESS_TOO_LONG | 4716 | 200 | The address length is too long. | |\n| ALREADY_CANCELED | 4722 | 200 | The tracking number is already canceled, it can not be canceled again. | |\n| DOES_NOT_EXIST | 4723 | 200 | The tracking number does not exist, can not not be canceled. | |\n| ALREADY_MANIFESTED | 4724 | 200 | The tracking number is manifested, so can not be canceled. | |\n| NO_SHIPMENTS_MANIFEST | 4725 | 200 | There is no shipments to manifest. | |\n| NO_AVAILABLE_NUMBER | 4730 | 200 | No more pre-assigned tracking numbers available in this shipper account. Please input the new tracking numbers in your shipper account setting page. | |\n| CREDENTIALS_ERROR | 4732 | 200 | The credential error, please check your shipper account. | |\n| PAYLOAD_ERROR | 4733 | 200 | The request is invalid or cannot be served by AfterShip Shipping. | |\n| DUPLICATE_ORDER_NUMBER | 4801 | 200 | Duplicate order_number, please specify a different order_number and try again. | |\n| UNAVAILABLE_SERVICE_TYPE | 4802 | 200 | The service_type is not available for this shipment. | |\n| UNAVAILABLE_SERVICE_TYPE_SERVICE_OPTION | 4803 | 200 | The service_type and service_option are not available for this shipment. | |\n| MAX_WEIGHT | 4804 | 200 | The weight is not available for this shipment. | |\n |\n\n## Endpoints\n\nThe AfterShip SDK has the following resource which are exactly the same as the API endpoints:\n\n- CouriersResource\n - Get all couriers\n- LocationsResource\n - Get locations\n- ManifestsResource\n - Get manifests\n - Create a manifest\n - Get a manifest\n- ShipperAccountsResource\n - Get shipper accounts\n - Create a shipper account\n - Get a shipper account\n - Delete a shipper account\n - Update a shipper account\u0026#39;s information\n - Update a shipper account\u0026#39;s credentials\n - Update a shipper account\u0026#39;s settings\n- LabelsResource\n - Get labels\n - Create a label\n - Get a label\n- CancelLabelsResource\n - Get the cancelled labels\n - Cancel a label\n - Get a cancelled label\n- AddressValidationsBetaResource\n - Create an address validation\n- RatesResource\n - Get rates\n - Calculate rates\n - Get a rate\n- PickupsResource\n - Get pickups\n - Create a pickup\n - Get a pickup\n- CancelPickupsResource\n - Get the cancelled pickups\n - Cancel a pickup\n - Get a cancelled pickup\n\n### /couriers\n**GET** /couriers\n\n```java\n GetCouriersResponse response = CouriersResource.getCouriers()\n .fetch();\n System.out.println(response.getData());\n```\n\n### /locations\n**GET** /locations\n\n```java\n GetLocationsResponse response = LocationsResource.getLocations()\n .fetch();\n System.out.println(response.getData());\n```\n\n### /manifests\n**GET** /manifests\n\n```java\n GetManifestsResponse response = ManifestsResource.getManifests()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /manifests\n\n```java\n PostManifestsRequest request = new PostManifestsRequest();\n PostManifestsResponse response = ManifestsResource.postManifests()\n .setPostManifestsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /manifests/{id}\n\n```java\n GetManifestResponse response = ManifestsResource.getManifest()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n### /shipper-accounts\n**GET** /shipper-accounts\n\n```java\n GetShipperAccountsResponse response = ShipperAccountsResource.getShipperAccounts()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /shipper-accounts\n\n```java\n PostShipperAccountsRequest request = new PostShipperAccountsRequest();\n PostShipperAccountsResponse response = ShipperAccountsResource.postShipperAccounts()\n .setPostShipperAccountsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /shipper-accounts/{id}\n\n```java\n GetShipperAccountsIdResponse response = ShipperAccountsResource.getShipperAccountsId()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n**DELETE** /shipper-accounts/{id}\n\n```java\n DeleteShipperAccountsIdResponse response = ShipperAccountsResource.deleteShipperAccountsId()\n .setId(\"valid_value\")\n .delete();\n System.out.println(response.getData());\n```\n\n**PUT** /shipper-accounts/{id}/info\n\n```java\n PutShipperAccountsIdInfoRequest request = new PutShipperAccountsIdInfoRequest();\n PutShipperAccountsIdInfoResponse response = ShipperAccountsResource.putShipperAccountsIdInfo()\n .setId(\"valid_value\")\n .setPutShipperAccountsIdInfoRequest(request)\n .update();\n System.out.println(response.getData());\n```\n\n**PATCH** /shipper-accounts/{id}/credentials\n\n```java\n PatchShipperAccountsIdCredentialsRequest request = new PatchShipperAccountsIdCredentialsRequest();\n PatchShipperAccountsIdCredentialsResponse response = ShipperAccountsResource.patchShipperAccountsIdCredentials()\n .setId(\"valid_value\")\n .setPatchShipperAccountsIdCredentialsRequest(request)\n .update();\n System.out.println(response.getData());\n```\n\n**PATCH** /shipper-accounts/{id}/settings\n\n```java\n PatchShipperAccountsIdSettingsRequest request = new PatchShipperAccountsIdSettingsRequest();\n PatchShipperAccountsIdSettingsResponse response = ShipperAccountsResource.patchShipperAccountsIdSettings()\n .setId(\"valid_value\")\n .setPatchShipperAccountsIdSettingsRequest(request)\n .update();\n System.out.println(response.getData());\n```\n\n### /labels\n**GET** /labels\n\n```java\n GetLabelsResponse response = LabelsResource.getLabels()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /labels\n\n```java\n PostLabelsRequest request = new PostLabelsRequest();\n PostLabelsResponse response = LabelsResource.postLabels()\n .setPostLabelsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /labels/{id}\n\n```java\n GetLabelResponse response = LabelsResource.getLabel()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n### /cancel-labels\n**GET** /cancel-labels\n\n```java\n GetCancelLabelsResponse response = CancelLabelsResource.getCancelLabels()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /cancel-labels\n\n```java\n PostCancelLabelsRequest request = new PostCancelLabelsRequest();\n PostCancelLabelsResponse response = CancelLabelsResource.postCancelLabels()\n .setPostCancelLabelsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /cancel-labels/{id}\n\n```java\n GetCancelLabelResponse response = CancelLabelsResource.getCancelLabel()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n### /address-validations\n**POST** /address-validations\n\n```java\n PostAddressValidationsRequest request = new PostAddressValidationsRequest();\n PostAddressValidationsResponse response = AddressValidationsBetaResource.postAddressValidations()\n .setPostAddressValidationsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n### /rates\n**GET** /rates\n\n```java\n GetRatesResponse response = RatesResource.getRates()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /rates\n\n```java\n PostRatesRequest request = new PostRatesRequest();\n PostRatesResponse response = RatesResource.postRates()\n .setPostRatesRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /rates/{id}\n\n```java\n GetRateResponse response = RatesResource.getRate()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n### /pickups\n**GET** /pickups\n\n```java\n GetPickupsResponse response = PickupsResource.getPickups()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /pickups\n\n```java\n PostPickupsRequest request = new PostPickupsRequest();\n request.setPickupStartTime(\"valid_value\");\n request.setPickupEndTime(\"valid_value\");\n AddressV3 pickupFrom = new AddressV3();\n request.setPickupFrom(pickupFrom);\n PostPickupsResponse response = PickupsResource.postPickups()\n .setPostPickupsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /pickups/{id}\n\n```java\n GetPickupResponse response = PickupsResource.getPickup()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n### /cancel-pickups\n**GET** /cancel-pickups\n\n```java\n GetCancelPickupsResponse response = CancelPickupsResource.getCancelPickups()\n .fetch();\n System.out.println(response.getData());\n```\n\n**POST** /cancel-pickups\n\n```java\n PostCancelPickupsRequest request = new PostCancelPickupsRequest();\n PostCancelPickupsRequestPickup pickup = new PostCancelPickupsRequestPickup();\n request.setPickup(pickup);\n PostCancelPickupsResponse response = CancelPickupsResource.postCancelPickups()\n .setPostCancelPickupsRequest(request)\n .create();\n System.out.println(response.getData());\n```\n\n**GET** /cancel-pickups/{id}\n\n```java\n GetCancelPickupResponse response = CancelPickupsResource.getCancelPickup()\n .setId(\"valid_value\")\n .fetch();\n System.out.println(response.getData());\n```\n\n\n## Help\n\nIf you get stuck, we're here to help:\n\n- [Issue Tracker](https://github.com/AfterShip/shipping-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) 2025 AfterShip\n\nLicensed under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faftership%2Fshipping-sdk-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faftership%2Fshipping-sdk-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faftership%2Fshipping-sdk-java/lists"}