Products

Create a product

Creates a hidden product. It appears in the store once its price is set and it is activated.

POST/stores/{storeId}/v1/products

Scopeproducts:writeCreate products and update content

A new product has status: inactive, price 0.00 and price_state: required. Sending price in the body also requires products.prices:write.

Headers

Idempotency-Keystringrequired

Request body

namestringrequired
descriptionstring
short_descstring
imagestring | null
imagesarray<string>
image_altstring
categorystring | null
slugstring
keywordsarray<string>
supported_devicesarray<string>
seo_titlestring
seo_descriptionstring
og_imagestring | null
product_kindstringrequired: digital service physical
pricestring
old_pricestring | null

Response

dataobjectrequired
idinteger
namestring
descriptionstring
short_descstring | null
imagestring | null
imagesarray<string>
image_altstring | null
categorystring | null: Category name.
slugstring | null
keywordsarray<string>
supported_devicesobject
seo_titlestring | null
seo_descriptionstring | null
og_imagestring | null
product_kindobject: digital service physical
statusobject: active inactive
pricestring: Price in SAR.
old_pricestring | null: Price before discount.
price_stateobject: required until a price is set; a new product is created inactive with price 0.00.required ready
resource_versioninteger
executionobject: Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid): The request ID; include it in any support request.

Errors

HTTP	Code	Meaning
400	`IDEMPOTENCY_KEY_REQUIRED`	No Idempotency-Key header.
422	`CATEGORY_NOT_FOUND`	The category does not exist.
422	`UNKNOWN_FIELD`	Unknown field.

Shared codes are listed in Errors.

curl -X POST "https://larm.sa/stores/$STORE_ID/v1/products" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Idempotency-Key: $UUID" \ -H "Content-Type: application/json" \ -d '{ "name": "Top-up card 200 SAR", "description": "A 200 SAR balance top-up card.", "product_kind": "digital", "category": "Top-up cards" }'

{ "data": { "id": 312, "name": "Top-up card 200 SAR", "description": "A 100 SAR balance top-up card, delivered instantly after payment.", "short_desc": "Delivered instantly after payment", "image": "https://cdn.example/p/311.webp", "images": [ "https://cdn.example/p/311-2.webp" ], "image_alt": "Top-up card", "category": "Top-up cards", "slug": "charge-100", "keywords": [ "top-up", "balance" ], "supported_devices": null, "seo_title": "Top-up card 100 SAR", "seo_description": "Buy a top-up card and get the code instantly.", "og_image": null, "product_kind": "digital", "status": "inactive", "price": "0.00", "old_price": null, "price_state": "required", "resource_version": 1 }, "execution": { "appId": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9", "versionId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "installationId": "c7e4a1f2-6b3d-4e8a-9c05-1d2f3a4b5c6d", "storeId": "5b1d7a62-0c4e-4f38-9a51-2e7b3c9d8f10", "requestId": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a", "generation": 1, "routeEpoch": 4, "appAuthEpoch": 1, "grantRevision": 2 }, "meta": { "request_id": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a" } }