Shopery

Docs

Visit shopery.com

Dev Docs

Welcome to the Shopery Developer Documentation!

This docs are created to help developers effectively integrate with and utilize the features of our platform. Whether you're building your first integration or enhancing an existing one, you'll find step-by-step guides, API references, and best practices to ensure a seamless development experience.

Our platform is built with flexibility and scalability in mind, providing a comprehensive suite of APIs and tools to meet a variety of use cases. From users and data management to custom fields, this documentation will equip you with the information you need.

What You’ll Find in This Documentation:

  • Getting Started: How to set up your developer account, access API keys, users management and familiarize yourself with our environment.
  • API Reference: Descriptions of our APIs, including endpoints, parameters, and example requests/responses.
  • Guides and Tutorials: Step-by-step instructions on common use cases like managing orders, updating product, catalogs, handling users, and more.
  • Error Handling & Debugging: Common error codes, troubleshooting tips, and guidance on how to resolve issues.

Our goal is to ensure that developers have all the tools and knowledge needed to build powerful and reliable integrations. Let’s dive in!

No items found.
Getting Started via API

To start setting up the platform via API and be ready to perform it is important to notice key issues to have in mind.

Api
November 6, 2024
Custom Fields

This article provides information, step-by-step instructions, and tips for configuring and managing custom fields to meet specific business needs.

Custom fields
October 31, 2024
Authentication

This article will walk you through the process of authenticating against our API using JSON Web Token. JWT is a secure and compact method for exchanging claims between two parties and is commonly used for API authentication due to its simplicity and scalability. By following this guide, you will learn how to obtain and utilize JWT tokens to access protected resources within Shopery's API.

Api
Authentication
November 6, 2024
Webhooks

Webhooks allow apps, or custom Storefronts, to stay in sync with Shopery data or perform an action after a specific event occurs. In this article you will find information related to webhooks management

Api
Webhooks
November 6, 2024
User States

One key element of setting up the platform properly, is managing the creation of companies and users. In this article, we will walk you through all the instructions, information, and tips for using the correct endpoints to manage user states.

Api
Create user
User states
November 6, 2024