ConvertedIn | DOCS
  • Overview
  • Before you start
    • Integrating Firebase Cloud Messaging for Push Notifications
  • Android
    • Getting started with Android SDK
  • IOS
    • Getting started with the iOS SDK
  • WooCommerce
    • Getting Started
    • Plugin installation steps
  • Shopify
    • Getting Started
  • API
    • Connect your store using API, Getting started
    • Categories
    • Products
    • Customers
    • Orders
    • Webhooks
  • magento | webhooks
    • Getting started
  • Salla
    • Getting started
  • Pixel
    • Getting Started
    • Client SDK
    • Integrate ConvertedIn Pixel using GTM
    • Shopify Integration for Initiate checkout Event
  • DSP
    • Getting Started
Powered by GitBook
On this page
  • Authentication
  • Notice:
  • Store Info
  • Response

Was this helpful?

  1. API

Connect your store using API, Getting started

You can connect your custom made store to Convertedin by creating an API with the following instructions

PreviousGetting StartedNextCategories

Last updated 1 year ago

Was this helpful?

Doc for more details

For speeding up integration you can use You should login to , choose api option from data sources

You'll be prompted to enter your base url for the api , for example if your API baseUrl was https://cake-store.com/, your Store info api should be https://cake-store.com/convertedin/storeinfo

We expect you to create an API that complies with the following documentation

Authentication

Use your token provided inside converted.in after on boarding process to authenticate the request using form-data body

Notice:

All endpoints should follow the following standard pagination form Except for the store info API

{
    "current_page": 1,  // current page
    "data": [ ],
    "from": 1, // start for current page
    "to": 100,  // end for current page
    "last_page": 23, // last available page 
    "per_page": 100, // limit per page
    "total": 2220 // total number of entities
}

Store Info

POST YOUR_BASEURL/convertedin/storeinfo

Request Body

Name
Type
Description

token*

string

Fixed token provided by Convertedin platform.

{
    "code": 200,
    "data": {
        "name" : "store name",
        "currency" : "USD",
        "time_zone": "",
        "email" : "user@example.com",
        "description": "A great store selling stuff",
        "country": "US"
    }
}

Response

{
    "code": 200,
    "data": {
        "name": "store Name",
        "currency": "EGP",
        "time_zone": "GMT+2",
        "email": "info@cake-store.com",
        "description": "buy all your cake",
        "country": "eg",
        "country_code": "EG"
    }
}

key

description

name

Store name or title

currency

currency in ISO format (USD, EUR, etc...)

time_zone

store default timezone in your format

email

Admin or store contact email

description

store brief or headline

country

operating country in ISO code (US, GB)

Here
postman collection
app.converted.in