Create a product
/productsCreates a product in the given showcase. New products are created with the draft status.
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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
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
curl -X POST "https://example.com/products" \ -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.