CatalogService class

Constructors

CatalogService.new({required String baseUrl, required bool secure})

Properties

baseUrl → String

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secure → bool

final

Methods

getCategoryDetails({required String authToken, required List<int> categoryIds}) → Future<List<ProductCategoryDto>>

This endpoint returns an array of categories whose Ids were specified in the categoryIds parameter. Categories that could be found are returned in the results array in the response. Categories that could not be found are indicated in the errors array.

getCategorySearchManifest({required String authToken, required int categoryId}) → Future<List<CategorySearchManifestDto>>

This endpoint returns a search manifest for the specified category. The search manifest describes all of the sorting options and filters that are available for this category. Its contents should be used to build requests to the POST /catalog/categories/{categoryId}/search endpoint.

getGroupDetails({required String authToken, required List<int> groupIds}) → Future<List<CategoryGroupDto>>

This endpoint returns an array of groups whose Ids were specified in the groupIds parameter. Groups that could be found are returned in the results array in the response. Groups that could not be found are indicated in the errors array.

getProductDetails({required String authToken, required List<int> productIds, bool getExtendedFields = false, bool includeSkus = false}) → Future<List<ProductDto>>

This endpoint returns an array of products whose Ids were specified in the productIds parameter. Products that could be found are returned in the results array in the response. Products that could not be found are indicated in the errors array.

getProductDetailsByGtin({required String authToken, required String gtin, bool getExtendedFields = false, bool includeSkus = false}) → Future<List<ProductDto>>

This endpoint returns a Product's details using a code from the GTIN family of product codes. NOTE: Not all products will have a GTIN.

getSkuDetails({required String authToken, required List<int> skuIds}) → Future<List<ProductSkuDto>>

This endpoint returns an array of SKUs whose Ids were specified in the skuIds parameter. SKUs that could be found are returned in the results array in the response. SKUs that could not be found are indicated in the errors array.

listAllCategories({required String authToken, String sortOrder = "Name", bool sortDesc = false, int offset = 0, int limit = 10}) → Future<TcgPlayerPage<ProductCategoryDto>>

This returns a paged list of all categories supported by TCGplayer.

listAllCategoryConditions({required String authToken, required int categoryId}) → Future<List<CategoryConditionDto>>

This endpoint returns all available conditions associated with the specified category.

listAllCategoryGroups({required String authToken, required int categoryId, int offset = 0, int limit = 10}) → Future<TcgPlayerPage<CategoryGroupDto>>

This endpoint returns a paged list of all the groups associated with the specified category.

listAllCategoryLanguages({required String authToken, required int categoryId}) → Future<List<CategoryLanguageDto>>

This endpoint returns all available languages associated with the specified category.

listAllCategoryMedia({required String authToken, required int categoryId}) → Future<List<CategoryMediaDto>>

This endpoint returns all available media (e.g. images) associated with the specified category.

listAllCategoryPrintings({required String authToken, required int categoryId}) → Future<List<CategoryPrintingDto>>

This endpoint returns all available printings associated with the specified category.

listAllCategoryRarities({required String authToken, required int categoryId}) → Future<List<CategoryRarityDto>>

This endpoint returns all available rarities associated with the specified category.

listAllGroupDetails({required String authToken, int? categoryId, String? categoryName, bool? isSupplemental, bool? hasSealed, String? sortOrder, bool sortDesc = false, int offset = 0, int limit = 10}) → Future<TcgPlayerPage<CategoryGroupDto>>

This endpoint returns all groups that match the specified criteria.

listAllGroupMedia({required String authToken, required int groupId}) → Future<List<CategoryMediaDto>>

This endpoint returns all available media (e.g. images) associated with the specified group.

listAllProductMediaType({required String authToken, required int productId}) → Future<List<CategoryMediaDto>>

This endpoint can be used to return the URL of a product picture. It makes it so you can display that shiny Charizard on your page more easily. The product details page will also return an image URL so this endpoint doesn't need to be called if an application is already calling the Get Product Details endpoint.

listAllProducts({required String authToken, int offset = 0, int limit = 10, int? categoryId, String? categoryName, int? groupId, String? groupName, String? productName, bool getExtendedFields = false, List<String>? productTypes, bool includeSkus = false}) → Future<TcgPlayerPage<ProductDto>>

This endpoint returns all products that match the specified criteria.

listConditions({required String authToken}) → Future<List<CategoryConditionDto>>

This endpoint returns an array contain all of the normalized conditions supported by TCGplayer, e.g. Near Mint, Lightly Played.

listProductSkus({required String authToken, required int productId}) → Future<List<ProductSkuDto>>

This endpoint returns all of the available SKUs for the specified product.

listRelatedProducts({required String authToken, required int productId, int offset = 0, int limit = 10}) → Future<TcgPlayerPage<RelatedProductDto>>

Returns other products that are commonly found in the same orders as the specified anchor product.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchCategoryProducts({required String authToken, required int categoryId, required CategorySearchRequestDto request}) → Future<TcgPlayerPage<int>>

This endpoint returns an array of product Ids that match the provided search critera. Use the search manifest from the GET /catalog/categories/{categoryId}/search/manifest endpoint to build requests to this endpoint. If an invalid filter name is specified in the request, it will be ignored. Use the GET /catalog/products/{productIds} endpoint to get the details about the returned product Ids.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited