Products

Products represent the items in your e-commerce catalog. Each product belongs to a language and can have variants, categories, related products, and custom attributes.

The product model

The product model contains all the information about an item in your catalog, including pricing, images, descriptions, and relationships to categories and other products.

Properties

Name
id
Type
string
Description
Unique identifier for the product.
Name
name
Type
string
Description
The name of the product.
Name
visible
Type
boolean
Description
Whether the product is visible in the store.
Name
main_image
Type
string
Description
URL of the main product image.
Name
url
Type
string
Description
The product page URL.
Name
short_description
Type
string
Description
A short description of the product.
Name
price
Type
number
Description
The price of the product.
Name
brand_id
Type
string
Description
The identifier of the brand this product belongs to.
Name
category_ids
Type
array
Description
An array of category identifiers the product is assigned to.
Name
relevant_product_ids
Type
array
Description
An array of related product identifiers.
Name
custom_attributes
Type
array
Description
An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

GET/v2/languages/:language_id/products

List all products

This endpoint allows you to retrieve a paginated list of all products for a given language. By default, a maximum of ten products are shown per page, with a maximum of 250 per page.

Optional attributes

Name
page
Type
integer
Description
Page offset to fetch. Defaults to 1.
Name
per_page
Type
integer
Description
Number of products per page. Defaults to 10, maximum 250.
Name
created_after
Type
timestamp
Description
Only return products created after this date.
Name
created_before
Type
timestamp
Description
Only return products created before this date.
Name
updated_after
Type
timestamp
Description
Only return products updated after this date.
Name
updated_before
Type
timestamp
Description
Only return products updated before this date.

Request

GET

/v2/languages/:language_id/products

curl -G https://app.reloadify.com/api/v2/languages/en/products \
  -H "Authorization: Bearer {token}" \
  -d per_page=10 \
  -d page=1

Response

{
  "data": [
    {
      "id": "prod_wbh400",
      "name": "Wireless Bluetooth Headphones",
      "visible": true,
      "main_image": "https://example.com/images/headphones.jpg",
      "url": "https://example.com/products/wireless-bluetooth-headphones",
      "short_description": "Premium noise-cancelling wireless headphones with 30-hour battery life.",
      "price": 79.99,
      "brand_id": "brand_sony",
      "category_ids": ["cat_electronics", "cat_audio"],
      "relevant_product_ids": ["prod_case100", "prod_cable200"],
      "custom_attributes": [
        {
          "name": "color",
          "string_value": "Matte Black"
        }
      ]
    },
    {
      "id": "prod_tsh500"
      // ...
    }
  ]
}

PUT/v2/languages/:language_id/products

Create or update a product

This endpoint allows you to create a new product or update an existing one. If a product with the given ID already exists, it will be updated with the provided fields.

Required attributes

Name
id
Type
string
Description
The unique identifier for the product in your system.

Optional attributes

Name
name
Type
string
Description
The name of the product.
Name
visible
Type
boolean
Description
Whether the product is visible in the store.
Name
main_image
Type
string
Description
URL of the main product image.
Name
url
Type
string
Description
The product page URL.
Name
short_description
Type
string
Description
A short description of the product.
Name
price
Type
number
Description
The price of the product.
Name
brand_id
Type
string
Description
The identifier of the brand this product belongs to.
Name
created_at
Type
timestamp
Description
The creation date of the product.
Name
updated_at
Type
timestamp
Description
The last updated date of the product.
Name
custom_attributes
Type
array
Description
An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT

/v2/languages/:language_id/products

curl -X PUT https://app.reloadify.com/api/v2/languages/en/products \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "product": {
      "id": "prod_wbh400",
      "name": "Wireless Bluetooth Headphones",
      "visible": true,
      "main_image": "https://example.com/images/headphones.jpg",
      "url": "https://example.com/products/wireless-bluetooth-headphones",
      "short_description": "Premium noise-cancelling wireless headphones with 30-hour battery life.",
      "price": 79.99,
      "brand_id": "brand_sony",
      "custom_attributes": [
        {
          "name": "color",
          "string_value": "Matte Black"
        },
        {
          "name": "weight_grams",
          "integer_value": 250
        }
      ]
    }
  }'

Response

{
  "id": "prod_wbh400",
  "name": "Wireless Bluetooth Headphones",
  "visible": true,
  "main_image": "https://example.com/images/headphones.jpg",
  "url": "https://example.com/products/wireless-bluetooth-headphones",
  "short_description": "Premium noise-cancelling wireless headphones with 30-hour battery life.",
  "price": 79.99,
  "brand_id": "brand_sony",
  "category_ids": [],
  "relevant_product_ids": [],
  "custom_attributes": [
    {
      "name": "color",
      "string_value": "Matte Black"
    },
    {
      "name": "weight_grams",
      "integer_value": 250
    }
  ]
}

GET/v2/languages/:language_id/products/:product_id

Retrieve a product

This endpoint allows you to retrieve a product by providing the product ID. Refer to the model at the top of this page to see which properties are included with product objects.

Request

GET

/v2/languages/en/products/prod_wbh400

curl https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "prod_wbh400",
  "name": "Wireless Bluetooth Headphones",
  "visible": true,
  "main_image": "https://example.com/images/headphones.jpg",
  "url": "https://example.com/products/wireless-bluetooth-headphones",
  "short_description": "Premium noise-cancelling wireless headphones with 30-hour battery life.",
  "price": 79.99,
  "brand_id": "brand_sony",
  "category_ids": ["cat_electronics", "cat_audio"],
  "relevant_product_ids": ["prod_case100", "prod_cable200"],
  "custom_attributes": [
    {
      "name": "color",
      "string_value": "Matte Black"
    },
    {
      "name": "weight_grams",
      "integer_value": 250
    }
  ]
}

DELETE/v2/languages/:language_id/products/:product_id

Delete a product

This endpoint allows you to delete a product. Be careful — this action is irreversible and will remove the product and all its associated data including variants and category assignments.

Request

DELETE

/v2/languages/en/products/prod_wbh400

curl -X DELETE https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400 \
  -H "Authorization: Bearer {token}"

GET/v2/languages/:language_id/products/:product_id/variants

List product variants

This endpoint allows you to retrieve all variants for a specific product. Variants represent different configurations of the same product, such as different sizes or colors.

Request

GET

/v2/languages/en/products/prod_wbh400/variants

curl https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400/variants \
  -H "Authorization: Bearer {token}"

Response

{
  "data": [
    {
      "id": "var_wbh400_blk",
      "name": "Wireless Bluetooth Headphones - Black",
      "price": 79.99,
      "main_image": "https://example.com/images/headphones-black.jpg"
    },
    {
      "id": "var_wbh400_wht",
      "name": "Wireless Bluetooth Headphones - White",
      "price": 79.99,
      "main_image": "https://example.com/images/headphones-white.jpg"
    }
  ]
}

GET/v2/languages/:language_id/products/:product_id/categories

List product categories

This endpoint allows you to retrieve all categories that a specific product is assigned to.

Request

GET

/v2/languages/en/products/prod_wbh400/categories

curl https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400/categories \
  -H "Authorization: Bearer {token}"

Response

{
  "data": [
    {
      "id": "cat_electronics"
    },
    {
      "id": "cat_audio"
    }
  ]
}

PUT/v2/languages/:language_id/products/:product_id/categories/:category_id

Assign product to category

This endpoint allows you to assign a product to a specific category. If the product is already assigned to the category, this operation has no effect.

Request

PUT

/v2/languages/en/products/prod_wbh400/categories/cat_deals

curl -X PUT https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400/categories/cat_deals \
  -H "Authorization: Bearer {token}"

DELETE/v2/languages/:language_id/products/:product_id/categories/:category_id

Remove product from category

This endpoint allows you to remove a product from a specific category. The product itself will not be deleted, only the category assignment will be removed.

Request

DELETE

/v2/languages/en/products/prod_wbh400/categories/cat_deals

curl -X DELETE https://app.reloadify.com/api/v2/languages/en/products/prod_wbh400/categories/cat_deals \
  -H "Authorization: Bearer {token}"