LIlivelike

Create Product

Creates a product in a reward store. It is always created in the draft state, so it is not visible to members until you publish it. Variants, which carry the price and stock, are added afterwards through the nested variants endpoint, and a product can't be published until it has at least one. Requires a producer access token for the application.

Send JSON, or multipart/form-data when you upload product images.

post/{client_id}/products/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/products/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application the product belongs to.

Request body

product_store_idstring uuid required

The reward store this product belongs to. It must be an active store in this application. Write-only.

namestring required

Name of the product. Max 255 characters.

product_type'badge' | 'multiplier' | 'flair' | 'common_code' | 'unique_code' | 'merchandise' | 'experience' | 'konekt' nullable

The kind of product. Optional here, but required before the product can be published.

redemption_provider'konekt' nullable

The third party that redeems and fulfils the product. Must be konekt when product_type is konekt, and must be empty for every other product_type. Leave it out when you fulfil the product yourself.

redemption_method'reward_item' | 'cash'

How members pay for the product. reward_item debits the member's reward item balance. cash means money is collected by an external provider and no reward item is debited.

descriptionstring

Description of the product, as plain text.

reward_item_idstring uuid nullable

The reward item that variant prices are denominated in. It must be one of the reward items attached to the product's store. Required before the product can be published.

gating_profile_group_idsstring[]

Profile groups whose members are the only ones who can redeem the product. Each group must belong to this application.

sponsor_idsstring[]

Sponsors to attach. Each sponsor must belong to this application.

start_atstring date-time

When the product becomes available. Can't be in the past.

expiry_atstring date-time

When the product stops being available. Must be in the future and not before start_at.

redemption_success_messageobject

Message shown to the member after a successful redemption, as a JSON object such as {"title": "Success!", "message": "Your reward has been redeemed"}.

redemption_failure_messageobject

Message shown to the member when a redemption fails, as a JSON object such as {"title": "Oops!", "message": "We could not redeem your reward"}.

custom_datastring

Free text, for example serialized JSON.

Response

Created. The product is returned in the draft state.

idstring uuid
urlstring
publish_urlstring
unpublish_urlstring
variants_urlstring

The endpoint for adding variants to this product.

namestring
product_typestring nullable
redemption_providerstring nullable
redemption_methodstring
state'draft' | 'published' | 'unpublished'

Always draft on create.

display_statusstring

How the product reads to a member: draft, unpublished, or, once published, coming soon or expired.

descriptionstring nullable
is_eligible_to_redeemboolean
redemption_rulesobject nullable
start_atstring date-time nullable
expiry_atstring date-time nullable
redemption_success_messageobject nullable
redemption_failure_messageobject nullable
is_activeboolean
custom_datastring nullable
created_atstring date-time
updated_atstring date-time
created_byobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.