Introduction

Welcome to Pincode Business API Integration Documentation for Seller Partners. This guide provides instructions for integrating your systems with our platform, enabling catalog/inventory updates through APIs / SFTP and real-time order updates, and receiving callbacks.

Contents

This documentation is divided into the following section:

1. Authentication: Highlights the process for making API calls to Pincode. This section is crucial for understanding how to authenticate your API calls to Pincode.
2. Receiving Callbacks:
   You may choose to listen to updates in the order / catalog lifecycle. Details on how to receive callbacks from Pincode are mentioned in this section.
3. Store Updates:
   Describes the APIs for updating store properties. Currently, toggling the state of the store is the only feature supported through APIs. Changing other attributes will be supported later.
4. Catalog/Inventory Updates:
   The process for propagating Seller Inventory updates to Pincode currently happens through the SFTP Integration Process, or through a direct API integration.
5. Order Updates:
   APIs that allow clients to make changes to an existing order, or to pull details about an order. Optionally, Seller Partners can opt-in for order updates to be relayed directly to their systems. All order updates ( which include any partial or complete update on the order) will be sent as a full order update callback ( synchronously or asynchronously).

How should you read this doc?

Before delving into the specifics of the create/update APIs, it is imperative to grasp the basics of communication with Pincode, as well as how Pincode communicates with you. The first section (Authentication) elucidates the authentication process for making API calls to Pincode. The second section (Receiving Callbacks) details the necessary steps for receiving callbacks from Pincode. Subsequent sections provide comprehensive information on the various catalog and order APIs offered by Pincode.