Get items list by specified group

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.

SecurityAuthForClient

Request

path Parameters

project_id required	integer Project ID. Example: 44056
external_id required	string Default: "all" Group external ID.

query Parameters

limit	integer Limit for the number of elements on the page. Example: limit=50
offset	integer Number of the element from which the list is generated (the count starts from 0). Example: offset=0
locale	string Default: "en" Response language. Two-letter lowercase language code per ISO 639-1.
additional_fields[]	Array of strings The list of additional fields. These fields will be in the response if you send them in your request. Available fields `media_list`, `order`, `long_description`.
country	string Default: "US" Country to calculate regional prices and restrictions for catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2. If you do not specify the country explicitly, it will be calculated based on user's IP address.

Responses

200

The list of items from the specified group was successfully received.

404

The group wasn’t found. Make sure that the external_id is correct and the group isn’t turned off or deleted.

Request samples

Response samples

application/json

{"items": [{"sku": "big_rocket",
"name": "Big Rocket",
"groups": [{"external_id": "accessory",
"name": "Accessory"
}
],
"attributes": [{"external_id": "stack_size",
"name": "Stack size",
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [{"amount": 100,
"sku": "vc_test",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"virtual_item_type": "non_renewing_subscription"
},
{"sku": "shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [{"external_id": "accessory",
"name": "Accessory"
}
],
"attributes": [{"external_id": "stack_size",
"name": "Stack size",
"values": [{"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{"external_id": "rating",
"name": "Rating",
"values": [{"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [{"amount": 100,
"sku": "vc_test",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{"amount": 200,
"sku": "vc_test_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"inventory_options": {"consumable": {"usages_count": 1
},
"expiration_period": {"type": "day",
"value": 1
}
},
"virtual_item_type": "non_renewing_subscription"
}
]
}