Product data object specification for the Cratejoy Merchant API

Properties

Property Filter Edit Type Description
id INT Unique identifier
deleted BOOLEAN Whether this product has been deleted
description STRING Text describing the product
flat_ship_price INT If ship_option is flat, price for shipping
gift_shipping INT
giftable BOOLEAN
has_subscribers BOOLEAN Whether this product current has any subscribers
listed BOOLEAN Whether this product has been listed on the Cratejoy Marketplace or not.
name STRING Product Name
product_billing_id INT
product_type INT Subscription (0), One-time product (1), or gift card (2). When filtering, use the enum, e.g. product_type=0.
reviewable BOOLEAN Whether this product can be reviewed on the Cratejoy Marketplace or not.
ship_option STRING One of flat, calculate, pricedin
ship_weight FLOAT Shipping weight of product in lbs.
single_purchasable BOOLEAN Whether this product can be purchased without a subscription
sku STRING SKU of Product
slug STRING URL-friendly version of product name
store_id INT
visible BOOLEAN Whether the product should be displayed in store
type STRING Always product
url STRING

Relation Properties

PropertyResourceDescriptionFilter?
base_term_pricesTermPricesA collection of TermPricesNo
billingProduct BillingProduct Billing object.No
gift_term_pricesTerm Prices[Deprecated] Gifting 1.0 prices associated with gift_termsNo
gift_termsGift Terms[Deprecated] Gifting 1.0 terms.No
gift_instancesGift Instances[Deprecated] Gifting 1.0 product instance IDs.No
instancesProduct InstancesNo
metaNo
metadataProduct metadataNo
rule_typesShipping Rule typesNo
subscription_typesNo
variantsProduct VariantsNo

The above properties are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a url to fetch the related resources OR contain the resources themselves