Obtener lista de artículos por grupo especificado

Xsolla Developers

Obtener lista de artículos por grupo especificadoClient-side

get/v2/project/{project_id}/items/virtual_items/group/{external_id}

Gets an items list from the specified group for building a catalog.

Attention

All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields.

Note

This endpoint, accessible without authorization, returns generic data. However, authorization enriches the response with user-specific details for a personalized result, such as available user limits and promotions.

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id required	integer ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto. Example: 44056
external_id required	string Default: "all" ID externo del grupo.

query Parameters

limit	integer Límite para el número de elementos presentes en la página. Example: limit=50
offset	integer Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0). Example: offset=0
locale	string Default: "en" Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.
additional_fields[]	Array of strings La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud. Items Enum: "media_list" "order" "long_description" "custom_attributes"
country	string Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla and the process of determining the country. Example: country=US
promo_code	string [ 1 .. 128 ] characters Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números. Example: promo_code=WINTER2021
show_inactive_time_limited_items	integer Default: 0 Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado. Example: show_inactive_time_limited_items=1

Responses

200

Se se recibió correctamente la lista de artículos del grupo especificado.

404

No se encontró el grupo. Asegúrese de que el external_id es correcto y de que el grupo no está desactivado ni eliminado.

Request samples

Response samples

application/json

{"has_more": false,
"items": [{"attributes": [{"external_id": "stack_size",
"name": {"en": "Stack size"
},
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"can_be_bought": true,
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": "Big Rocket - description",
"groups": [{"external_id": "weapons",
"name": {"en": "weapons"
}
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"is_free": false,
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"name": "Big Rocket",
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"price": {"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"promotions": [{"bonus": [{"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"name": "Xsolla Minigun",
"quantity": 1,
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
],
"date_end": "2026-04-15T16:16:00+03:00",
"date_start": "2020-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"name": "Bonus promotion"
}
],
"sku": "com.xsolla.big_rocket_1",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [{"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_1",
"type": "virtual_currency"
}
],
"vp_rewards": [{"amount": 130,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"item_id": 175232,
"name": "Value point",
"sku": "com.xsolla.value_point_1"
},
{"amount": 50,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true,
"item_id": 186321,
"name": "Clan Reward VP 1",
"sku": "com.xsolla.clan_value_point_1"
}
]
},
{"attributes": [{"external_id": "stack_size",
"name": {"en": "Stack size"
},
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{"external_id": "rating",
"name": {"en": "Rating"
},
"values": [{"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"can_be_bought": true,
"description": "description",
"groups": [{"external_id": "weapons",
"name": {"en": "weapons"
}
}
],
"image_url": "http://image.png",
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"is_free": false,
"limits": {"per_user": {"available": 3,
"recurrent_schedule": {"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"name": "SHOTGUN FOR TRUE RAIDERS",
"periods": [ ],
"price": {"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"promotions": [{"bonus": [{"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"name": "Xsolla Minigun",
"quantity": 1,
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
],
"date_end": "2026-04-15T16:16:00+03:00",
"date_start": "2020-04-15T16:16:00+03:00",
"discount": {"percent": "50.00"
},
"name": "Bonus promotion"
}
],
"sku": "com.xsolla.shotgun_raider_1",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [{"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_1",
"type": "virtual_currency"
},
{"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "com.xsolla.vc_2",
"type": "virtual_currency"
}
],
"vp_rewards": [ ]
}
]
}