Skip to content
ShopentlyLearn
English

Shopently API

Our comprehensive API lets you fully integrate your Shopently store with external systems, applications and automation tools.

Connect your store to ERP systems, warehouses, accounting software or marketing tools to automate everyday work and synchronize data in real time.

Get started in three steps

  1. Create an API key
  2. Get an access token
  3. Send API requests

Documentation for AI agents

If you’re building an integration with an AI agent, you can share the API description as an OpenAPI file. It brings together the available operations, parameters, and example requests and responses to help the agent work with Shopently’s extensive documentation.

Send the agent a link to this page. If it can access the internet and download files, it can download OpenAPI and read the descriptions of the features you need.

OpenAPIJSON · 4897 KiB
Download OpenAPI (JSON) https://learn.shopently.com/api/docs/openapi.json

Browse by resource

OrdersRetrieve orders from your store and send them to other systems. View their details, check available statuses and change an order’s status or payment status. Returns, complaints and exchangesRead customer requests and change their status or recorded refund amount. ProductsRead, create, update and delete catalog products in the selected context. CategoriesRead and maintain the category hierarchy and translated content. CMS pagesRead, create, update and delete store content pages. Variants and optionsMaintain product variants and the option dictionaries they use. Features and valuesMaintain feature dictionaries and the values assigned to products. BrandsRead and maintain the brands referenced by catalog products. Search analytics and rulesRead search activity and maintain rules used by the store search. InventoryRead stock and apply controlled adjustments, sales limits and manual reservations. DeliveriesCreate planned or received deliveries and read their recorded stock effects. Warehouses and locationsDiscover warehouses and the locations used by inventory operations. Discounts / PromotionsView discounts. View promotions. Blog · ArticlesRead articles and preview drafts Blog · CommentsRead comments and moderation status Blog · AuthorsRead article authors Blog · PhotosRead and preview article photos

Read before creating an API key

AuthenticationCreate an API key and get a token to send requests. Error codesIdentify the cause of an error and choose the appropriate recovery action. Rate limitsAdjust your request frequency to the API limits. PermissionsCheck which operations your store plan and key permissions allow.