Retrieve Mailing Address

get

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/mailingAddress/{idType}/{addressId}

Retrieve the full details of a specific mailing address by its identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

customerId

string

required

Unique identifier of the customer. The value corresponds to the identifier type specified in parentIdType.

idType

string

enum

required

Identifier type for the mailing address. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

addressId

string

required

Unique identifier of the mailing address. The value corresponds to the identifier type specified in idType.

Headers

PromiseMode

string

enum

required

Controls response timing. NEVER returns an immediate response; ALWAYS defers processing and returns a 202 Accepted while the operation completes asynchronously.

Allowed:

Responses

400

The request could not be processed due to invalid or missing parameters.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request completed successfully.