This method retrieves the account profile information for an authenticated user, which requires a User access token. What is returned is controlled by the scopes. For a business account you use the default scope commerce.identity.readonly, which returns all the fields in the businessAccount container. These are returned because this is all public information. For an individual account, the fields returned in the individualAccount container are based on the scope you use. Using the default scope, only public information, such as eBay user ID, are returned. For details about what each scope returns, see the Identity API Overview. URLs for this method Production URL: Sandbox URL: In the Sandbox, this method returns mock data. Note: You must use the correct scope or scopes for the data you want returned.
643 matches
E-commerce/Identity
getUser
v1.0.0Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
{
"type": "object",
"description": "The type that defines the fields for the getUser method.",
"properties": {
"accountType": {
"type": "string",
"description": "Indicates the user account type. This is determined when the user registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following countries: EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL Valid Values: BUSINESS or INDIVIDUAL Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/api:AccountTypeEnum'>eBay API documentation</a>"
},
"businessAccount": {
"type": "object",
"description": "The container that returns the business account information of the user.",
"properties": {
"address": {
"type": "object",
"description": "The container that returns the address of the business account.",
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the street address."
},
"addressLine2": {
"type": "string",
"description": "The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'."
},
"city": {
"type": "string",
"description": "The city of the address."
},
"country": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/bas:CountryCodeEnum'>eBay API documentation</a>"
},
"county": {
"type": "string",
"description": "The county of the address."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province of the address."
}
}
},
"doingBusinessAs": {
"type": "string",
"description": "An additional name that is used for their business on eBay. The business name is returned in the name field."
},
"email": {
"type": "string",
"description": "The email address of the business account."
},
"name": {
"type": "string",
"description": "The business name associated with the user's eBay account."
},
"primaryContact": {
"type": "object",
"description": "The container that returns the contact details of the person who is the primary contact for this account.",
"properties": {
"firstName": {
"type": "string",
"description": "The first name of the contact person."
},
"lastName": {
"type": "string",
"description": "The last name of the contact person."
}
}
},
"primaryPhone": {
"type": "object",
"description": "The container that returns the primary phone number for the business account.",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country to which the phone number belongs."
},
"number": {
"type": "string",
"description": "The numeric string representing the phone number."
},
"phoneType": {
"type": "string",
"description": "The type of phone service. Valid Values: MOBILE or LAND_LINE Code so that your app gracefully handles any future changes to this list."
}
}
},
"secondaryPhone": {
"type": "object",
"description": "The container that returns the secondary phone number for the business account.",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country to which the phone number belongs."
},
"number": {
"type": "string",
"description": "The numeric string representing the phone number."
},
"phoneType": {
"type": "string",
"description": "The type of phone service. Valid Values: MOBILE or LAND_LINE Code so that your app gracefully handles any future changes to this list."
}
}
},
"website": {
"type": "string",
"description": "The business website address associated with the eBay account."
}
}
},
"individualAccount": {
"type": "object",
"description": "The account information of the user.",
"properties": {
"email": {
"type": "string",
"description": "The eBay user's registration email address."
},
"firstName": {
"type": "string",
"description": "The eBay user's first name."
},
"lastName": {
"type": "string",
"description": "The eBay user's last name."
},
"primaryPhone": {
"type": "object",
"description": "The container that returns the eBay user's primary phone number information.",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country to which the phone number belongs."
},
"number": {
"type": "string",
"description": "The numeric string representing the phone number."
},
"phoneType": {
"type": "string",
"description": "The type of phone service. Valid Values: MOBILE or LAND_LINE Code so that your app gracefully handles any future changes to this list."
}
}
},
"registrationAddress": {
"type": "object",
"description": "The container that returns the eBay user's address information.",
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line of the street address."
},
"addressLine2": {
"type": "string",
"description": "The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'."
},
"city": {
"type": "string",
"description": "The city of the address."
},
"country": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country of the address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/bas:CountryCodeEnum'>eBay API documentation</a>"
},
"county": {
"type": "string",
"description": "The county of the address."
},
"postalCode": {
"type": "string",
"description": "The postal code of the address."
},
"stateOrProvince": {
"type": "string",
"description": "The state or province of the address."
}
}
},
"secondaryPhone": {
"type": "object",
"description": "The container that returns the eBay user's secondary phone number information.",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 standard of the country to which the phone number belongs."
},
"number": {
"type": "string",
"description": "The numeric string representing the phone number."
},
"phoneType": {
"type": "string",
"description": "The type of phone service. Valid Values: MOBILE or LAND_LINE Code so that your app gracefully handles any future changes to this list."
}
}
}
}
},
"registrationMarketplaceId": {
"type": "string",
"description": "The eBay site on which the account is registered. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/bas:MarketplaceIdEnum'>eBay API documentation</a>"
},
"status": {
"type": "string",
"description": "Indicates the user's account status. Possible values: CONFIRMED, UNCONFIRMED, ACCOUNTONHOLD and UNDETERMINED. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/commerce/identity/types/api:UserStatusEnum'>eBay API documentation</a>"
},
"userId": {
"type": "string",
"description": "The eBay immutable user ID of the user's account and can always be used to identify the user."
},
"username": {
"type": "string",
"description": "The user name, which was specific by the user when they created the account. Note: This value can be changed by the user."
}
}
}