eBay · Schema
UserResponse
The type that defines the fields for the getUser method.
AuctionsCommerceProductsMarketplaceFortune 500
Properties
| Name | Type | Description |
|---|---|---|
| accountType | string | 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, thi |
| businessAccount | object | The container that returns the business account information of the user. |
| individualAccount | object | The account information of the user. |
| registrationMarketplaceId | string | The eBay site on which the account is registered. For implementation help, refer to eBay API documentation |
| status | string | Indicates the user's account status. Possible values: CONFIRMED, UNCONFIRMED, ACCOUNTONHOLD and UNDETERMINED. For implementation help, refer to
|
| userId | string | The eBay immutable user ID of the user's account and can always be used to identify the user. |
| username | string | The user name, which was specific by the user when they created the account. Note: This value can be changed by the user. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserResponse",
"title": "UserResponse",
"type": "object",
"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: <br /><br />EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL <br /><br /><b> Valid Values:</b> BUSINESS or INDIVIDUAL <br /><br />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": {
"description": "The container that returns the business account information of the user.",
"$ref": "#/components/schemas/BusinessAccount"
},
"individualAccount": {
"description": "The account information of the user.",
"$ref": "#/components/schemas/IndividualAccount"
},
"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: <code>CONFIRMED</code>, <code>UNCONFIRMED</code>, <code>ACCOUNTONHOLD</code> and <code>UNDETERMINED</code>. 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. <br /><br /><span class=\"tablenote\"><b>Note: </b> This value can be changed by the user.</span>"
}
},
"description": "The type that defines the fields for the <b>getUser</b> method."
}