Draw a product card or grid with its products now

POST

/api/v1/workspaces/{workspace}/commerce/blocks/render

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/commerce/blocks/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "block": { "button": "example", "collection": "example", "compareAt": true, "count": 1, "heading": "example", "mode": "card", "products": [ "example" ], "soldOut": "hide", "store": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

• Your ReputeCast public URL

Permission: campaigns:view

Removed products are drawn and flagged; sends read prices and availability again.

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body^required

Media typeapplication/json

object

block

required

object

button

string

<= 40 characters

collection

string

<= 64 characters

compareAt

boolean

count

integer format: int64

<= 6

heading

string

<= 120 characters

mode

required

string

Allowed values: card chosen collection

products

required

Array<string>

<= 12 items

soldOut

string

Allowed values: hide label ""

store

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

disconnected

required

boolean

html

required

string

platform

required

string

products

required

Array<object>

object

available

required

boolean

compareAt

required

integer format: int64

currency

required

string

id

required

string

imageAlt

required

string

imageUrl

required

string

inventory

integer format: int64

price

required

integer format: int64

removed

required

boolean

removedAt

string format: date-time

title

required

string

url

required

string

removed

required

Array<object>

object

id

required

string

platform

required

string

removedAt

string format: date-time

title

required

string

soldOut

required

Array<string>

storeName

required

string

Example ^generated

{
  "disconnected": true,
  "html": "example",
  "platform": "example",
  "products": [
    {
      "available": true,
      "compareAt": 1,
      "currency": "example",
      "id": "example",
      "imageAlt": "example",
      "imageUrl": "example",
      "inventory": 1,
      "price": 1,
      "removed": true,
      "removedAt": "2026-04-15T12:00:00Z",
      "title": "example",
      "url": "example"
    }
  ],
  "removed": [
    {
      "id": "example",
      "platform": "example",
      "removedAt": "2026-04-15T12:00:00Z",
      "title": "example"
    }
  ],
  "soldOut": [
    "example"
  ],
  "storeName": "example"
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}