Skip to content

Products

Open .md

API reference Products and catalog

Your own products. A simple product is one item with one price; a variant product has sizes, colors or both, and each combination is a variant with its own price and stock. Supplier catalog products are not stored here: see Supplier catalog.

Learn more: Products and pricing · Look up products and prices

13 operations

  • POSTCreate a product/v1/api/store/{team_slug}/productCreates one of your own products and returns it.
  • GETList all product brands/v1/api/store/{team_slug}/get_all_product_brandsReturns every brand name in use: the brands of all supplier catalogs YoPrint carries, plus the brands of your own products (deleted ones included).
  • GETList all size names/v1/api/store/{team_slug}/get_all_product_sizesReturns every size name in use: the size names of your variant products (deleted variants included) plus every size name in the supplier catalogs YoPrint carries.
  • GETList products/v1/api/store/{team_slug}/productLists your own products (simple and variant products), paged.
  • GETGet a product/v1/api/store/{team_slug}/product/{hash_id}One product in the products list row shape, deleted ones included (trashed).
  • POSTCheck whether a product can be deleted/v1/api/store/{team_slug}/product/{hash_id}/delete_checkChecks whether a product can be safely deleted.
  • POSTLoad a product for a sales order line/v1/api/store/{team_slug}/hydrate_productReturns a product with every option you can sell, in the shape sales order line pickers use: size_data, color_data and attr_data (one row per size and color combination).
  • PUTUpdate a product/v1/api/store/{team_slug}/product/{hash_id}Updates a product.
  • PATCHUpdate a product (PATCH)/v1/api/store/{team_slug}/product/{hash_id}Updates a product.
  • POSTPhase out a simple product/v1/api/store/{team_slug}/product/{hash_id}/phase_outStops selling a simple product.
  • POSTPut a phased-out simple product back on sale/v1/api/store/{team_slug}/product/{hash_id}/resumeNew sales order and quote lines can use it again.
  • DELETEDelete a product/v1/api/store/{team_slug}/product/{hash_id}Deletes a product that is not in use.
  • PATCHRestore a deleted product/v1/api/store/{team_slug}/product/{hash_id}/restoreRestores a deleted product, its stock rows, and its variants that were removed when the product was deleted (variants deleted individually beforehand remain deleted).