Source
This page was generated with Wiki Builder. Do not change the format!
Info
Get currently available vendors from the list of vendors that can possibly have rotating inventory. Note that this does not include things like preview vendors and vendors-as-kiosks, neither of whom have rotating/dynamic inventories. Use their definitions as-is for those. PREVIEW: This service is not yet active, but we are returning the planned schema of the endpoint for review, comment, and preparation for its eventual implementation.
- URI: /Destiny2/{membershipType}/Profile/{destinyMembershipId}/Character/{characterId}/Vendors/
- Basepath: https://www.bungie.net/Platform
- Method: GET
- Service: Destiny2
- Permissions: None
- Officially Supported: Yes
Parameters
Path Parameters
| Name | Schema | Required | Description |
|---|---|---|---|
| characterId | integer:int64 | Yes | The Destiny Character ID of the character for whom we're getting vendor info. |
| destinyMembershipId | integer:int64 | Yes | Destiny membership ID of another user. You may be denied. |
| membershipType | BungieMembershipType:Enum | Yes | A valid non-BungieNet membership type. |
Query String Parameters
| Name | Schema | Required | Description |
|---|---|---|---|
| components | DestinyComponentType:Enum[] | No | A comma separated list of components to return (as strings or numeric values). See the DestinyComponentType enum for valid components to request. You must request at least one component to receive results. |
Example
Request
Response
PlatformErrorCode: 200
{
// Type: DestinyVendorsResponse
"Response": {
// Type: DictionaryComponentResponseOfuint32AndDestinyVendorComponent
"vendors": {},
// Type: DictionaryComponentResponseOfuint32AndDestinyVendorCategoriesComponent
"categories": {},
// Type: DictionaryComponentResponseOfuint32AndDestinyVendorSaleItemSetComponent
"sales": {},
// Type: Dictionary<integer:uint32,DestinyItemComponentSetOfint32>
"itemComponents": {
"0": {
// Type: DictionaryComponentResponseOfint32AndDestinyItemInstanceComponent
"instances": {
// Type: Dictionary<integer:int32,DestinyItemInstanceComponent>
"data": {
"0": {
// Type: DamageType:Enum
"damageType": {},
// Type: Destiny.Definitions.DestinyDamageTypeDefinition:integer:uint32:nullable
"damageTypeHash": 0,
// Type: DestinyStat
"primaryStat": {},
// Type: integer:int32
"itemLevel": 0,
// Type: integer:int32
"quality": 0,
// Type: boolean
"isEquipped": false,
// Type: boolean
"canEquip": false,
// Type: integer:int32
"equipRequiredLevel": 0,
// Type: Destiny.Definitions.DestinyUnlockDefinition:integer:uint32[]
"unlockHashesRequiredToEquip": [
// Type: integer:uint32
0
],
// Type: EquipFailureReason:Enum
"cannotEquipReason": {}
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemObjectivesComponent
"objectives": {
// Type: Dictionary<integer:int32,DestinyItemObjectivesComponent>
"data": {
"0": {
// Type: DestinyObjectiveProgress[]
"objectives": [
// Type: DestinyObjectiveProgress
{
// Type: Destiny.Definitions.DestinyObjectiveDefinition:integer:uint32
"objectiveHash": 0,
// Type: Destiny.Definitions.DestinyDestinationDefinition:integer:uint32:nullable
"destinationHash": 0,
// Type: Destiny.Definitions.DestinyActivityDefinition:integer:uint32:nullable
"activityHash": 0,
// Type: integer:int32:nullable
"progress": 0,
// Type: boolean
"complete": false
}
]
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemPerksComponent
"perks": {
// Type: Dictionary<integer:int32,DestinyItemPerksComponent>
"data": {
"0": {
// Type: DestinyPerkReference[]
"perks": [
// Type: DestinyPerkReference
{
// Type: Destiny.Definitions.DestinySandboxPerkDefinition:integer:uint32
"perkHash": 0,
// Type: string
"iconPath": "",
// Type: boolean
"isActive": false,
// Type: boolean
"visible": false
}
]
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemRenderComponent
"renderData": {
// Type: Dictionary<integer:int32,DestinyItemRenderComponent>
"data": {
"0": {
// Type: boolean
"useCustomDyes": false,
// Type: Dictionary<integer:int32,integer:int32>
"artRegions": {
"0": 0
}
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemStatsComponent
"stats": {
// Type: Dictionary<integer:int32,DestinyItemStatsComponent>
"data": {
"0": {
// Type: Dictionary<Destiny.Definitions.DestinyStatDefinition:integer:uint32,DestinyStat>
"stats": {
"0": {
// Type: Destiny.Definitions.DestinyStatDefinition:integer:uint32
"statHash": 0,
// Type: integer:int32
"value": 0,
// Type: integer:int32
"maximumValue": 0
}
}
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemSocketsComponent
"sockets": {
// Type: Dictionary<integer:int32,DestinyItemSocketsComponent>
"data": {
"0": {
// Type: DestinyItemSocketState[]
"sockets": [
// Type: DestinyItemSocketState
{
// Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32:nullable
"plugHash": 0,
// Type: boolean
"isEnabled": false,
// Type: integer:int32[]
"enableFailIndexes": [
// Type: integer:int32
0
],
// Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32[]
"reusablePlugHashes": [
// Type: integer:uint32
0
]
}
]
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfint32AndDestinyItemTalentGridComponent
"talentGrids": {
// Type: Dictionary<integer:int32,DestinyItemTalentGridComponent>
"data": {
"0": {
// Type: Destiny.Definitions.DestinyTalentGridDefinition:integer:uint32
"talentGridHash": 0,
// Type: DestinyTalentNode[]
"nodes": [
// Type: DestinyTalentNode
{
// Type: integer:int32
"nodeIndex": 0,
// Type: integer:uint32
"nodeHash": 0,
// Type: DestinyTalentNodeState:Enum
"state": {},
// Type: boolean
"isActivated": false,
// Type: integer:int32
"stepIndex": 0,
// Type: DestinyMaterialRequirement:Definition[]
"materialsToUpgrade": [
// Type: DestinyMaterialRequirement:Definition
{
// Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32
"itemHash": 0,
// Type: boolean
"deleteOnAction": false,
// Type: integer:int32
"count": 0,
// Type: boolean
"omitFromRequirements": false
}
],
// Type: integer:int32
"activationGridLevel": 0,
// Type: number:float
"progressPercent": 0,
// Type: boolean
"hidden": false,
// Type: DestinyTalentNodeStatBlock
"nodeStatsBlock": {}
}
],
// Type: boolean
"isGridComplete": false,
// Type: DestinyProgression
"gridProgression": {}
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
},
// Type: DictionaryComponentResponseOfuint32AndDestinyItemPlugComponent
"plugStates": {
// Type: Dictionary<integer:uint32,DestinyItemPlugComponent>
"data": {
"0": {
// Type: integer:int32[]
"insertFailIndexes": [
// Type: integer:int32
0
],
// Type: integer:int32[]
"enableFailIndexes": [
// Type: integer:int32
0
]
}
},
// Type: ComponentPrivacySetting:Enum
"privacy": 0
}
}
}
},
// Type: PlatformErrorCodes:Enum
"ErrorCode": 0,
// Type: integer:int32
"ThrottleSeconds": 0,
// Type: string
"ErrorStatus": "",
// Type: string
"Message": "",
// Type: Dictionary<string,string>
"MessageData": {
"{string}": ""
},
// Type: object
}