Skip to content

Get Catalog Vendor

GET
/inventory/v1/catalog/vendor/{vendor_id}

Get a specific Vendor.

Authorizations

Parameters

Path Parameters

vendor_id
required
integer

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

string

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

Responses

200

Successful Response

A collection of Loot and how to fulfill them.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
type

Determines how the Vendor fulfills the loot

string
Allowed values: recipe randomly_sampled
legacy_type
integer
legacy_config_version
integer
loot

The Loot the Vendor will fulfill mapped by Loot ID.

object
key
additional properties

Loot determines how an Item fulfilled. When Loot is fulfilled, the Item is granted to the player or the Sub Vendor is fulfilled but not both.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
loot_id
required

The Loot ID

integer
vendor_id
required

The Vendor ID

integer
item_id

The Item ID. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

integer
item

In-line Item definition. Optional Item that will be granted to the player if Sub Vendor ID is not specified.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
type

The type of item.

string
Allowed values: unit recipe recipe_with_price_reduction entitlement dynamic_bundle
legacy_type
integer
legacy_subtype
integer
ref_item_id
integer
availability_flags
integer
entitled_loot_id

This is only valid for an entitlement Item. When this item is granted and Inventory Session creation, this is the Loot ID that will be fulfilled.

integer
level_xp_table_id

The XP Table that is used to determine the Player’s level for this XP. The level increase occurs when the quantity of this Item increases above the minimum XP of an XP Level. This is only valid for an unit Item.

integer
level_vendor_id

The Vendor that is used filfill level up rewards for this item. The level of the Player is used as the index into the Vendor’s Loot table. This is only valid for an unit Item.

integer
coupon_discount_currency_item_id

The item of the currency used by this coupon. This is only valid for an unit Item.

integer
coupon_discount_percentage

The percentage of the discount. This is only valid for an unit Item.

number
<= 1
coupon_consume_on_use

If true, the coupon will be consumed when used; reducing the Player’s Inventory quantity by 1. This is only valid for an unit Item.

boolean
item_portal_use_ruleset_id
integer
inventory_bucket_use_rule_set_id

The Inventory Bucket Use Rule Set ID that determines how this item can be used across buckets.

string
coupon_discount_loot

List of Loot IDs this item can discount

Array<integer>
default:
cache_info

Cache information for this item.

object
etag
required
string
>= 1 characters
str_rep
string
sub_vendor_id

The Sub Vendor ID. Optional Vendor ID that will be used to fulfill the Loot instead of granting the Item.

integer
quantity

The quantity of the Item or Sub Vendor to fulfill. This will be multiplied by the quantity of fulfilled Loot and the parent Loot if quantity_type is relative.

integer
inventory_selector_type

The Inventory Selector Type. Determine how the Inventory is selected and quantity is modified.

string
Allowed values: invalid own rent rent_timeframe_locked own_transient inherit_entitlement_inventory
inventory_operation

The Inventory Operation. Determine how the Loot quantity is modified based on the context it is fulfilled in. This also determines the order Loot will be fulfilled in when sort_order is the same.

string
Allowed values: invalid add subtract set check_greater_than_or_equal check_less_than check_greater_than_or_equal_and_subtract
active

Determines if the Loot is active. Inactive Loot will not be fulfilled.

boolean
sort_order

The sort order of the Loot. Lower sort order will be fulfilled first. Inventory Operation is used as a tie breaker when sort_order is the same.

integer
drop_weight

The drop weight of the Loot. Higher drop weight will be more likely to be fulfilled.

integer
fill_in_new_order

When dropped in a randomly sampled vendor, will this create a new order or fill inline?. The primary use case for this is when you want the same loot to be dropped multiple times in a randomly sampled vendor.

boolean
allow_partial_bundles

When dropped in a randomly sampled vendor, will the sub vendor allow dropping part of the the bundle? False means it will only drop if the entire sub vendor can be given to the player

boolean
default: true
required_item_id

Item required to be owned/rented to drop this Loot in a randomly sampled vendor

integer
required_item_count

Amount of the required_item_id to be owned/rented to drop this Loot in a randomly sampled vendor

integer
stack_limit

Amount of owned/rented of this Loot’s item that will prevent this Loot from dropping in a randomly sampled vendor

integer
ui_hint
integer
effective_from
string format: date-time
quantity_type

Determines how the quantity is modified in the context it is fulfilled in.

string
Allowed values: relative absolute
quantity_mult_inventory_item_id

When fulfilling Loot if this is set the quantity will be multiplied by the quantity of this Item in the Player’s Inventory.

integer
is_claimable_by_client

Determines if the Loot can be claimed by the client. This is dangerous without the correct loot confiuration as a client could claim Loot multiple times.

boolean
time_frame_id

The Time Frame ID. Optional Time Frame ID that will be used the expiration of Loot when it is fulfilled.

integer
use_inventory_bucket

Inventory Bucket to use for this Loot.

string
Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid
xp_quantity_transform_type

Allows treating quantity as additional levels to grant to the Player.

string
Allowed values: none from_current_xp_to_target_additional_level_min_xp from_current_level_min_xp_to_target_additional_level_min_xp from_zero_to_target_exact_level_min_xp
current_price_point_guid

The current price point guid. Optional Price Point ID that will be used to determine the price of the Loot when it is fulfilled.

string
>= 1 characters
pre_sale_price_point_guid

The pre sale price point guid. Optional Price Point ID that will be used to show the previous price of the Loot.

string
>= 1 characters
cache_info

Cache info for the Loot.

object
etag
required
string
>= 1 characters
str_rep
string
hard_quantity_maximum

Hard cap on quantity of an item this Loot can give. Disabled with 0

integer
cache_info

Cache info for the Vendor.

object
etag
required
string
>= 1 characters
str_rep
string

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

304

Content still has the same etag and has not changed

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Not Found

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string