get consumer's profile
1 min
GET
https://api.upstartcommerce.com/v1/customer/profile
Header Parameters
- x-upstart-tenantstringrequiredDescription
- x-upstart-sitestringDescription
Responses
200
- CustomerSummaryDescription
- addressesAddressesDescription
- addressesAddress[]requiredDescription
- businessNamestringExampleDescription
- citystringrequiredExampleDescription
- countrystringrequiredExampleDescriptionPattern^[A-Z]{2}$
- countystring
- labelstringrequiredExampleDescription
- nameNameDescription
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- phoneNumberstringExampleDescription
- poBoxbooleanDescriptionDefaultfalse
- postalCodestringrequiredExampleDescription
- stateOrRegionstringrequiredExampleDescription
- street1stringrequiredExampleDescription
- street2stringExampleDescription
- defaultBillingAddressDescription
- businessNamestringExampleDescription
- citystringrequiredExampleDescription
- countrystringrequiredExampleDescriptionPattern^[A-Z]{2}$
- countystring
- labelstringrequiredExampleDescription
- nameNameDescription
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- phoneNumberstringExampleDescription
- poBoxbooleanDescriptionDefaultfalse
- postalCodestringrequiredExampleDescription
- stateOrRegionstringrequiredExampleDescription
- street1stringrequiredExampleDescription
- street2stringExampleDescription
- defaultShippingAddressrequiredDescription
- businessNamestringExampleDescription
- citystringrequiredExampleDescription
- countrystringrequiredExampleDescriptionPattern^[A-Z]{2}$
- countystring
- labelstringrequiredExampleDescription
- nameNameDescription
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- phoneNumberstringExampleDescription
- poBoxbooleanDescriptionDefaultfalse
- postalCodestringrequiredExampleDescription
- stateOrRegionstringrequiredExampleDescription
- street1stringrequiredExampleDescription
- street2stringExampleDescription
- birthDatestring<date>ExampleFormatdate
- creditCardsCreditCardsDescription
- cardsCreditCard[]requiredDescription
- cardNumberstringrequiredExampleDescriptionPattern[0-9]{4}
- cardTypestringrequiredExampleDescription
- expirationMonthstringrequiredExampleDescriptionPattern^[0,1][0-9]$
- expirationYearstringrequiredExampleDescriptionPattern^2[0-9]{3}$
- labelstringrequiredExampleDescription
- tokenstringrequiredExampleDescription
- defaultCreditCardrequiredDescription
- cardNumberstringrequiredExampleDescriptionPattern[0-9]{4}
- cardTypestringrequiredExampleDescription
- expirationMonthstringrequiredExampleDescriptionPattern^[0,1][0-9]$
- expirationYearstringrequiredExampleDescriptionPattern^2[0-9]{3}$
- labelstringrequiredExampleDescription
- tokenstringrequiredExampleDescription
- defaultLocationIdstringExampleDescription
- emailAddressesEmailAddressesrequiredDescription
- addressesEmailAddress[]requiredDescription
- addressstring<email>requiredExampleDescriptionFormatemail
- labelstringrequiredExampleDescription
- defaultEmailAddressrequiredDescription
- addressstring<email>requiredExampleDescriptionFormatemail
- labelstringrequiredExampleDescription
- genderstringExampleDescription
- idstring<uuid>requiredExampleFormatuuid
- loginstringrequiredExampleDescription
- nameNamerequiredDescription
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- registrationDatestring<date-time>ExampleDescriptionFormatdate-time
- siteIdsstring[]requiredDescription
- subscriptionsSubscriptionsDescription
- addressCatalogsAddressSubscription[]requiredDescription
- addressAddressDescription
- businessNamestringExampleDescription
- citystringrequiredExampleDescription
- countrystringrequiredExampleDescriptionPattern^[A-Z]{2}$
- countystring
- labelstringrequiredExampleDescription
- nameNameDescription
- firststringrequiredExampleDescription
- laststringrequiredExampleDescription
- middleInitialstringExampleDescription
- salutationstringExampleDescription
- suffixstringExampleDescription
- phoneNumberstringExampleDescription
- poBoxbooleanDescriptionDefaultfalse
- postalCodestringrequiredExampleDescription
- stateOrRegionstringrequiredExampleDescription
- street1stringrequiredExampleDescription
- street2stringExampleDescription
- labelstringrequiredExampleDescription
- emailCatalogsEmailSubscription[]requiredDescription
- emailstring<email>ExampleDescriptionFormatemail
- labelstringrequiredExampleDescription
- emailNewslettersEmailSubscription[]requiredDescription
- emailstring<email>ExampleDescriptionFormatemail
- labelstringrequiredExampleDescription
400
- ValidationErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstring
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
404
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request GET \
--url https://api.upstartcommerce.com/v1/customer/profile \
--header 'accept: application/json' \
--header 'x-upstart-tenant: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/customer/profile", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/v1/customer/profile")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/customer/profile"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success-entire consumer profile returned.
{
"addresses": {
"addresses": [
{
"businessName": "Acme Fireworks",
"city": "Boston",
"country": "US",
"county": "",
"label": "Home",
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"phoneNumber": "8668675309",
"poBox": false,
"postalCode": "03031",
"stateOrRegion": "NH",
"street1": "123 Main St. Suite 1",
"street2": "C/O Bob"
}
],
"defaultBilling": {
"businessName": "Acme Fireworks",
"city": "Boston",
"country": "US",
"county": "",
"label": "Home",
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"phoneNumber": "8668675309",
"poBox": false,
"postalCode": "03031",
"stateOrRegion": "NH",
"street1": "123 Main St. Suite 1",
"street2": "C/O Bob"
},
"defaultShipping": {
"businessName": "Acme Fireworks",
"city": "Boston",
"country": "US",
"county": "",
"label": "Home",
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"phoneNumber": "8668675309",
"poBox": false,
"postalCode": "03031",
"stateOrRegion": "NH",
"street1": "123 Main St. Suite 1",
"street2": "C/O Bob"
}
},
"birthDate": "2005-05-17",
"creditCards": {
"cards": [
{
"cardNumber": "8111",
"cardType": "Visa",
"expirationMonth": "10",
"expirationYear": "2025",
"label": "Personal",
"token": "65FZG32BYZ756JH345"
}
],
"default": {
"cardNumber": "8111",
"cardType": "Visa",
"expirationMonth": "10",
"expirationYear": "2025",
"label": "Personal",
"token": "65FZG32BYZ756JH345"
}
},
"defaultLocationId": "ced8ef74-c968-47f6-98e0-d780d3da85fb",
"emailAddresses": {
"addresses": [
{
"address": "[email protected]",
"label": "Work email"
}
],
"default": {
"address": "[email protected]",
"label": "Work email"
}
},
"gender": "m",
"id": "ced8ef74-c968-47f6-98e0-d780d3da85fb",
"login": "bob.smith.29",
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"registrationDate": "2017-07-21T17:32:28Z",
"siteIds": [
""
],
"subscriptions": {
"addressCatalogs": [
{
"address": {
"businessName": "Acme Fireworks",
"city": "Boston",
"country": "US",
"county": "",
"label": "Home",
"name": {
"first": "John",
"last": "Smith",
"middleInitial": "D.",
"salutation": "Capt.",
"suffix": "Sr."
},
"phoneNumber": "8668675309",
"poBox": false,
"postalCode": "03031",
"stateOrRegion": "NH",
"street1": "123 Main St. Suite 1",
"street2": "C/O Bob"
},
"label": "The Big Catalog"
}
],
"emailCatalogs": [
{
"email": "[email protected]",
"label": "Daily Deals"
}
],
"emailNewsletters": [
{
"email": "[email protected]",
"label": "Daily Deals"
}
]
}
}400
// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
"name": "",
"code": "",
"detail": ""
}401
// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}404
// The requested resource was not found in the NoChannel system.
{
"name": "",
"code": "",
"detail": "",
"reason": ""
}