Skip to main content
GET
Retrieve

Headers

string
required
Your API key for authorization.

Path Parameters

string
required
The ID of the profile to retrieve.

Response

boolean
Indicates whether the operation was successful.
object
The profile object with associated styles and shipping information.
string
The ID of the profile.
array
Array of style objects associated with this profile, each containing:
  • id: The style ID
  • text: The style description
object
Shipping information associated with this profile, containing:
  • id: The shipping ID
  • address_1: First line of the address
  • address_2: Second line of the address (optional)
  • city: City name
  • country: Country name
  • province: Province or state name
  • zip: Postal or ZIP code
  • country_code: Two-letter country code
  • province_code: Province or state code
string
A code indicating the result of the operation. Possible values:
  • PROFILE_RETRIEVED: Profile retrieved successfully
  • PROFILE_NOT_FOUND: Profile not found
string
Error message if the request fails.