Class CatalogV2Service

constructor

• new CatalogV2Service(httpRequest): CatalogV2Service

• Parameters

  • httpRequest: BaseHttpRequest

  Returns CatalogV2Service

ReadonlyhttpRequest

getCategories

• getCategories(): CancelablePromise<any>

• Retrieve a list of catalog categories Returns list of all categories that are present in the catalog. The categories specify the type of the product that is associated with it. For example, the category "Men’s T-shirts" indicates that the product is a subgroup of T-shirts specifically targeted at Men. Categories can be used to filter the product list by specific tags See categories_ids

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getCategoriesByProductId

• getCategoriesByProductId(id, sellingRegionName?): CancelablePromise<any>

• Retrieve a list of catalog product categories To retrieve information about a particular products categories, use this feature. It returns details about the catalog categories associated with the catalog product. Categories help identify the type of product associated with them. For instance, the category "Men's T-shirts" denotes that the product is a subgroup of T-shirts intended for men.

  Parameters

  • id: number

    Product ID.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getCategoryById

• getCategoryById(id): CancelablePromise<any>

• Retrieve information about specific category Returns information about a specific catalog category. The categories specify the type of the product that is associated with it. For example, the category "Men’s T-shirts" indicates that the product is a subgroup of T-shirts specifically targeted at Men. Categories can be used to filter the product list by specific tags See categories_ids

  Parameters

  • id: number

    Category ID

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getMockupTemplatesByProductId

• getMockupTemplatesByProductId(id, placements?, sellingRegionName?, limit?, offset?, xPfLanguage?): CancelablePromise<any>

• Retrieve catalog product mockup templates Returns positional data for specified catalog product mockups. The data from this endpoint could be used to generate your own mockups without the need to use Printful's mockup generator.

  Parameters

  • id: number

    Product ID.
  • Optionalplacements: string[]

    One or more identifiers of a placement to return only products with variants that have that placement. The complete list of placements can be found here.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • limit: number = 20

    The number of results to return per page.
  • Optionaloffset: number

    The number of results to not include in the response starting from the beginning of the list.

    This can be used to return results after the initial 100. For example, sending offset 100
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductById

• getProductById(id, sellingRegionName?, xPfLanguage?): CancelablePromise<any>

• Retrieve a single catalog product Returns information about a single specified catalog product. See catalog product

  Parameters

  • id: number

    Product ID.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductImagesById

• getProductImagesById(id, mockupStyleIds?, colors?, placement?, xPfLanguage?): CancelablePromise<any>

• Retrieve blank images for a catalog product This feature helps to fetch blank images for a catalog product. These blank images are always white and semi-transparent and can be colored by the user on the client-side as per the specified color in the data.images.background_color field. For some mockups the data.images.background_image could apply. The endpoint allows filtering of the result based on the type of the mockup, the placement, and the color of the product.

  Parameters

  • id: number

    Product ID.
  • OptionalmockupStyleIds: number

    Used to specify style of images For example:

    • On the hanger
    • On the Male/Female model
    • Flat on the table
    • etc. Available mockup styles for catalog product can be found under Retrieve catalog product mockup styles.
  • Optionalcolors: string

    String values separated by comma. You can specify multiple variant colors filters.
  • Optionalplacement: string

    Filters result by specified placement
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductPricesById

• getProductPricesById(id, sellingRegionName?, currency?, xPfLanguage?): CancelablePromise<any>

• Retrieve catalog product prices

  Calculates prices for specific catalog product based on selling region and specified currency. Calculations also include Store discounts. Selling region is used to specify product production currency, that is the price that the product is natively manufactured in. Different selling regions might affect the overall price amount. Currency parameter is used only to define the currency that the prices will be displayed in.

  For more information on product pricing please refer to the information provided at https://www.printful.com/pricing

  When developing against either API be sure to inform your customers that a placement will be included in the price of the product. If one placement is provided that placement will be included in the price, if multiple are provided the included placement will generally be the placement that comes earliest in the list of placements at `/v2/catalog-products/71` (though the discount will generally be up to the price of the first placement in that list). Certain placements come with additional service fees, such as large embroidery, this additional price will never be included even if the only placement is large embroidery.

  There is a minor difference in the handling of prices for placements between V1 and V2. In V1 the price of the first placement is always null, this is because there is always a placement included in the price of each product. In V2 the price of placements is always displayed even if it is included in the price of the product because any placement can be included.

  Parameters

  • id: number

    Product ID.
  • OptionalsellingRegionName: string

    Specifies the region production currency that the product prices will be calculated in
  • Optionalcurrency: string

    The currency (3-letter code) used to determine currency in which the prices will be displayed. The store currency will be used by default. The format is compliant with ISO 4217 standard.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductSizeGuideById

• getProductSizeGuideById(id, unit?, xPfLanguage?): CancelablePromise<any>

• Retrieve size guide for a catalog product Returns information about the size guide for a specific product.

  Parameters

  • id: number

    Product ID.
  • Optionalunit: string

    A comma-separated list of measurement unit in which size tables are to be returned (inches or cm). The default value is determined based on the locale country. The inches are used for United States, Liberia and Myanmar, for other countries the unit defaults to centimeters.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductStockAvailabilityById

• getProductStockAvailabilityById(id, techniques?, sellingRegionName?, limit?, offset?, xPfLanguage?): CancelablePromise<any>

• Retrieve catalog product stock availability Provides information about the catalog product stock status. Stock availability is grouped by variants → techniques → selling regions.

  Parameters

  • id: number

    Product ID.
  • Optionaltechniques: TechniqueEnum[]

    One or more techniques to return only products with variants that can be printed using one of the techniques.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • limit: number = 20

    The number of results to return per page.
  • Optionaloffset: number

    The number of results to not include in the response starting from the beginning of the list.

    This can be used to return results after the initial 100. For example, sending offset 100
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProductVariantsById

• getProductVariantsById(id, xPfLanguage?): CancelablePromise<any>

• Retrieve information about catalog product variants Returns information about all catalog variants associated with the specified catalog product. See catalog variant

  Parameters

  • id: number

    Product ID.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getProducts

• getProducts(categoryIds?, colors?, limit?, _new?, offset?, placements?, sellingRegionName?, sortDirection?, sortType?, techniques?, xPfLanguage?): CancelablePromise<any>

• Retrieve a list of catalog products This endpoint retrieves a list of the products available in Printful's catalog. The list is paginated and can be filtered using various filters. The information returned includes details on how each product can be designed, such as the available placements, techniques, and additional options. For a visual representation of the design data, please see the following diagram:

  Parameters

  • OptionalcategoryIds: number[]

    One or more category IDs to return only products in those categories. The IDs can be found in the response of the operation Get Categories.
  • Optionalcolors: string[]

    One or more color names to return only products with variants of one the those colors.
  • limit: number = 20

    The number of results to return per page.
  • _new: boolean = false

    If true only new Products will be returned.
  • Optionaloffset: number

    The number of results to not include in the response starting from the beginning of the list.

    This can be used to return results after the initial 100. For example, sending offset 100
  • Optionalplacements: string[]

    One or more identifiers of a placement to return only products with variants that have that placement. The complete list of placements can be found here.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • sortDirection: "ascending" | "descending" = 'descending'

    This parameter only is used if sort_type is also present and it changes the order of the returned products. The exact meaning varies depending on the value of sort_type:

    • sort_type=new
    • ascending sorts from newest to oldest.
    • descending sorts from oldest to newest.
    • sort_type=rating
    • ascending from lowest to highest rated.
    • descending from highest to lowest rated.
    • sort_type=price
    • ascending from lowest to highest price.
    • descending from highest to lowest price.
    • sort_type=bestseller
    • ascending from non bestsellers to bestsellers.
    • descending from bestsellers to non bestsellers.
  • OptionalsortType:
        | "new"
        | "rating"
        | "price"
        | "bestseller"

    The sorting strategy to use when sorting the result. When it's not present, no specific order is guaranteed.
  • Optionaltechniques: TechniqueEnum[]

    One or more techniques to return only products with variants that can be printed using one of the techniques.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getVariantById

• getVariantById(id, xPfLanguage?): CancelablePromise<any>

• Retrieve information about specific catalog variant Returns information about single specified catalog variant. See catalog variant

  Parameters

  • id: number

    Variant ID
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getVariantImagesById

• getVariantImagesById(id, mockupStyleIds?, placement?, xPfLanguage?): CancelablePromise<any>

• Retrieve blank images for a catalog variant Returns images for a specified Variant.

  Parameters

  • id: number

    Variant ID
  • OptionalmockupStyleIds: number

    Used to specify style of images For example:

    • On the hanger
    • On the Male/Female model
    • Flat on the table
    • etc. Available mockup styles for catalog product can be found under Retrieve catalog product mockup styles.
  • Optionalplacement: string

    Filters result by specified placement
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getVariantPricesById

• getVariantPricesById(id, sellingRegionName?, currency?, xPfLanguage?): CancelablePromise<any>

• Retrieve pricing information for the catalog variant Return pricing information from a single variant and the parent product

  Parameters

  • id: number

    Variant ID
  • OptionalsellingRegionName: string

    Specifies the region production currency that the product prices will be calculated in
  • Optionalcurrency: string

    The currency (3-letter code) used to determine currency in which the prices will be displayed. The store currency will be used by default. The format is compliant with ISO 4217 standard.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getVariantStockAvailabilityById

• getVariantStockAvailabilityById(id, techniques?, sellingRegionName?, xPfLanguage?): CancelablePromise<any>

• Retrieve catalog variant stock availability Provides information about the catalog variant stock status. Stock availability is grouped by variants → techniques → selling regions.

  Parameters

  • id: number

    Variant ID
  • Optionaltechniques: TechniqueEnum[]

    One or more techniques to return only products with variants that can be printed using one of the techniques.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

retrieveMockupStylesByProductId

• retrieveMockupStylesByProductId(id, placements?, sellingRegionName?, offset?, limit?, xPfLanguage?): CancelablePromise<any>

• Retrieve catalog product mockup styles Returns information about available mockup styles for specified catalog product.

  Parameters

  • id: number

    Product ID.
  • Optionalplacements: string[]

    One or more placement idenitifiers used to filter in mockup styles that match a given placement. The complete list of placements can be found here.
  • sellingRegionName:
        | "worldwide"
        | "north_america"
        | "canada"
        | "europe"
        | "spain"
        | "latvia"
        | "uk"
        | "france"
        | "germany"
        | "australia"
        | "japan"
        | "new_zealand"
        | "italy"
        | "brazil"
        | "southeast_asia"
        | "republic_of_korea"
        | "english_speaking_regions"
        | "all" = 'worldwide'

    Only returns the products that can be sold in the specified region. If is set to 'all' returns each region availability for specified product.
  • Optionaloffset: number

    Result set offset
  • Optionallimit: number

    Number of items per page (max 100)
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError