Product

Products are physical items that are for sale at a Convention. You must have the merch ConventionPrivilege to access this. Products are accessed via /api/product.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in ProductProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this product belongs to.

image

A ConventionImage representing a view of the product.

Relationships

See "Relationships" in Introduction for how to use them.

mysoldproducts

The list of SoldProducts of this product type that the user making this request has already purchased.

productvariants

The list of ProductVariants that are for sale from this product.

Services

The services used to fetch and manipulate products.

Search Products

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/product

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "T-Shirt",
          ...
        },
        ...
    ]
 }

Create Product

 POST /api/product

Required Params

convention_id

name

Returns the same as a normal read.

Read Product

 GET /api/product/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "T-Shirt",
   ...
 }

Update Product

 PUT /api/product/xxx

Returns the same as a normal read.

Delete Product

 DELETE /api/product/xxx

Returns:

 {
   "success" : 1
 }

Product's Sold Products

Gets any SoldProducts for the product. (These are grandchildren of the Product via its ProductVariants.)

 GET /api/product/xxx/my-sold-products

Returns the list of SoldProducts.

Available Discounts

Gets any Discounts still available to the product.

 GET /api/product/xxx/available-discounts

Returns the list of Discounts.