Developers
Products

Create a product

POST/products

Creates a product in the given showcase. New products are created with the draft status. position is 1-based within the showcase; a value greater than the number of products places the product at the end.

external_id must be unique among the account's products that are not in the trash; a duplicate value returns the already_exists error code.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/products" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "format": "course",    "name": "string",    "showcase_id": "string"  }'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "definitions": null,    "deleted": true,    "display": null,    "external_id": "string",    "format": "course",    "id": "string",    "image": "string",    "lessons_count": 0,    "modules_count": 0,    "name": "string",    "object": "product",    "offer": null,    "position": 0,    "revision": "string",    "showcase_id": "string",    "status": "published",    "updated_at": "2019-08-24T14:15:22Z"  }}

List products GET

Lists the products of the account. Results are paginated with a cursor and can be filtered by showcase, status, external ID, search term, and deletion state. If the credentials are limited to specific products, only those products are returned.

Retrieve a product GET

Retrieves a product by its public ID. The `offer` object is included only when the credentials have the `products.read_offer` permission. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the product to avoid overwriting a newer version.