Skip to content
ShopentlyLearn
English

Products

Read, create, update and delete catalog products in the selected context.

Operations

List productsFilter products and paginate results in the selected language and market. GET Get a productView product lists and product details. GET Create a productAdd new products to the catalog. POST Update a productChange existing products, prices and publication data. PATCH Delete a productRemove products from the admin panel, storefront and search while preserving historical commerce data. DELETE Products · Add files · upload_idUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. POST Products · Status · upload_idUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. GET Products · Add files · multipartUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. PUT Products · Product filesUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. GET Products · Add files · product_idUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. POST Products · Download · FileUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. GET Products · HeadersUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. HEAD Products · Add files · VersionUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. POST Products · Remove · FileUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. DELETE Products · Digital releasesUpload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers. GET Products · Add files · DraftThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. POST Products · Request · DraftThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. PATCH Products · Remove · DraftThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. DELETE Products · Publish releaseThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. POST Products · Withdraw offerThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. POST Products · Access to future files after purchaseThis operation has been retired and returns 409 without changing data. Set access separately for each digital file using the audience operation. PATCH Read a file access ruleRead who qualifies for the current file version and obtain the product version needed to change the rule. GET Choose who receives a filePublish or change the access rule for one shared digital file. Every newly uploaded version requires an explicit rule. PATCH

How it works

The integration can read non-deleted products, including drafts, except products blocked by a plan limit. Blocked products are excluded from lists; direct access returns entitlements.resource_blocked. Product visibility in API therefore differs from storefront publication.

Use existing identifiers for brands, categories, features and media. Prices carry an explicit currency, price list, tax mode and concurrency versions. Product and variant pricing are distinct; use the supported pricing structure and exact decimal strings.

Product files

Upload files as multipart/form-data after creating upload_id, then assign them to a product. Downloads require a Bearer token and permission for category; the response contains file bytes, without a public address or password. Explicit access rule for the uploaded shared digital file. new_purchases / recent_and_new / selected / all_purchasers.

Choose a valid PDF, ZIP, EPUB, MP3, MP4, WebP, PNG, JPG, SVG or AVIF file. Up to 250 MiB per file. A product can have up to 20 active files.