> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mycargoextra.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mycargoextra.com/_mcp/server. # Get Address By ID GET http://localhost:9000/api/v1/address_admin/{addressId} Returns one address by Mongo ObjectId. Path parameter: `addressId`. Response fields: `message`, `data` address document. Possible errors: - 400: Invalid address Id - path id is not a valid Mongo ObjectId. - 404: Address not found or not authorized - address does not exist or belongs to another customer. - 409: Address already exists - duplicate address detected. - 400: Default address cannot be deleted - unset/change default first. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure. Reference: https://docs.mycargoextra.com/cargo-extra-gateway-api-copy/address-admin/address-admin-address-id/get-address-by-id ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/address_admin/{addressId}: get: operationId: get-address-by-id summary: Get Address By ID description: >- Returns one address by Mongo ObjectId. Path parameter: `addressId`. Response fields: `message`, `data` address document. Possible errors: - 400: Invalid address Id - path id is not a valid Mongo ObjectId. - 404: Address not found or not authorized - address does not exist or belongs to another customer. - 409: Address already exists - duplicate address detected. - 400: Default address cannot be deleted - unset/change default first. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure. tags: - subpackage_addressAdmin.subpackage_addressAdmin/addressAdminAddressId parameters: - name: addressId in: path description: AddressId path parameter. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/address_admin_address_admin > {addressId}_Get Address By ID_Response_200 '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestBadRequestError '401': description: Unauthorized content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestUnauthorizedError '403': description: Forbidden content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestForbiddenError '404': description: Not Found content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestNotFoundError '409': description: Conflict content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestConflictError '429': description: Too Many Requests content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestTooManyRequestsError '500': description: Internal Server Error content: application/json: schema: $ref: >- #/components/schemas/GetApiV1Address_adminAddressidRequestInternalServerError servers: - url: http://localhost:9000 description: http://localhost:9000 components: schemas: address_admin_address_admin > {addressId}_Get Address By ID_Response_200: type: object properties: key_0: type: integer key_1: type: string key_2: type: number format: double key_3: type: string key_4: type: boolean required: - key_0 - key_1 - key_2 - key_3 - key_4 title: address_admin_address_admin > {addressId}_Get Address By ID_Response_200 GetApiV1Address_adminAddressidRequestBadRequestError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestBadRequestError GetApiV1Address_adminAddressidRequestUnauthorizedError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestUnauthorizedError GetApiV1Address_adminAddressidRequestForbiddenError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestForbiddenError GetApiV1Address_adminAddressidRequestNotFoundError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestNotFoundError GetApiV1Address_adminAddressidRequestConflictError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestConflictError GetApiV1Address_adminAddressidRequestTooManyRequestsError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestTooManyRequestsError GetApiV1Address_adminAddressidRequestInternalServerError: type: object properties: message: type: string required: - message title: GetApiV1Address_adminAddressidRequestInternalServerError ``` ## Examples **Request** ```json {} ``` **Response** ```json { "key_0": 1234, "key_1": "742 Evergreen Terrace, Springfield", "key_2": 39.7817, "key_3": "IL", "key_4": true } ``` **SDK Code** ```python address_admin_address_admin > {addressId}_Get Address By ID_example import requests url = "http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456" payload = {} headers = {"Content-Type": "application/json"} response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript address_admin_address_admin > {addressId}_Get Address By ID_example const url = 'http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456'; const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go address_admin_address_admin > {addressId}_Get Address By ID_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby address_admin_address_admin > {addressId}_Get Address By ID_example require 'uri' require 'net/http' url = URI("http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java address_admin_address_admin > {addressId}_Get Address By ID_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php address_admin_address_admin > {addressId}_Get Address By ID_example request('GET', 'http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp address_admin_address_admin > {addressId}_Get Address By ID_example using RestSharp; var client = new RestClient("http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456"); var request = new RestRequest(Method.GET); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift address_admin_address_admin > {addressId}_Get Address By ID_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:9000/api/v1/address_admin/64b7f9a2e4b0c8a1d2f3e456")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```