Settings

The Settings module of the EShopBox SDK provides APIs for managing workspaces, portals, sales channels, contacts, fulfillment centers, and team members.

This page documents all available Settings operations with examples.

Example: Setup Settings Using EShopBox SDK

"""
Example: Setup Settings using EShopBox SDK
"""

from eshopbox import EShopBoxSDK
import os
from dotenv import load_dotenv
load_dotenv()


def get_portals(sdk):
    response = sdk.settings.get_portals()
    print(response)


def create_workspace(sdk):
    data = {
        "data": {
            "accountSlug": "eshop",
            "accountName": "Eshopbox"
        }
    }
    response = sdk.settings.create_workspace(data)
    print(response)


def get_all_workspace(sdk):
    params = {
        "page": 1,
        "limit": 10
    }
    response = sdk.settings.get_all_workspace(params)
    print(response)


def get_workspace(sdk):
    response = sdk.settings.get_workspace()
    print(response)


def update_workspace(sdk):
    data = {
        "data": {
            "accountSlug": "eshop",
            "accountName": "XXXXXXXX"
        }
    }
    response = sdk.settings.update_workspace(data)
    print(response)


def create_sales_channel(sdk):
    data = {
        "data": {
            "portalId": 1,
            "integrationModelId": 1,
            "channelAccountId": 1,
            "fulfillmentChannels": [
                {"warehouseId": 1},
                {"warehouseId": 2}
            ]
        }
    }
    response = sdk.settings.create_sales_channel(data)
    print(response)


def update_sales_channel(sdk):
    data = {
        "data": {
            "portalId": 1,
            "integrationModelId": 1,
            "channelAccountId": 1,
            "fulfillmentChannels": [
                {"warehouseId": 1},
                {"warehouseId": 2}
            ]
        }
    }
    response = sdk.settings.update_sales_channel(1, data)
    print(response)


def get_all_sales_channel(sdk):
    response = sdk.settings.get_all_sales_channel()
    print(response)


def get_sales_channel(sdk):
    response = sdk.settings.get_sales_channel(4801)
    print(response)


def create_fc_submission(sdk):
    data = {
        "data": {
            "warehouseId": "1",
            "warehouseName": "TCNS Banglore",
            "externalWmsAccountId": "1",
            "facility": "BDBLR108",
            "operatingModel": "consignment",
            "requestDocuments": {
                "gstCertificateUrl": "http://abc.com/1.jpg",
                "signatureUrl": "http://abc.com/2.jpg",
                "companyLogoUrl": "http://abc.com/3.jpg"
            }
        }
    }
    response = sdk.settings.create_fc_submission(data)
    print(response)


def get_all_fc_submission(sdk):
    response = sdk.settings.get_all_fc_submission()
    print(response)


def get_fc_submission(sdk):
    response = sdk.settings.get_fc_submission(1)
    print(response)


def update_fc_submission(sdk):
    data = {
        "data": {
            "warehouseId": "1",
            "warehouseName": "TCNS Banglore",
            "externalWmsAccountId": "1",
            "facility": "BDBLR108",
            "operatingModel": "consignment",
            "requestDocuments": {
                "gstCertificateUrl": "XXXXXXXXXXXXXXXXXXXX",
                "signatureUrl": "XXXXXXXXXXXXXXXXXXXX",
                "companyLogoUrl": "XXXXXXXXXXXXXXXXXXXX"
            }
        }
    }
    response = sdk.settings.update_fc_submission(1, data)
    print(response)


def create_contact(sdk):
    data = {
        "data": {
            "contactCode": "1234",
            "contactName": "ABC",
            "contactEmail": "XXXXXXXXXXXXX",
            "contactPhone": "1234567890",
            "contactType": "seller",
            "contactAddress": "ABC"
        }
    }
    response = sdk.settings.create_contact(data)
    print(response)


def get_all_contact(sdk):
    response = sdk.settings.get_all_contact()
    print(response)


def get_contact(sdk):
    params = {"contactCode": "1234"}
    response = sdk.settings.get_contact(params)
    print(response)


def update_contact(sdk):
    data = {
        "data": {
            "contactCode": "1234",
            "contactName": "ABC",
            "contactEmail": "XXXXXXXXXXXXX",
            "contactPhone": "1234567890",
            "contactType": "seller",
            "contactAddress": "ABC"
        }
    }
    response = sdk.settings.update_contact("1234", data)
    print(response)


def create_team_member(sdk):
    data = {
        "data": {
            "userId": 1,
            "portalId": 1,
            "integrationModelId": 1,
            "channelAccountId": 1,
            "warehouseId": 1
        }
    }
    response = sdk.settings.create_team_member(data)
    print(response)


def update_team_member(sdk):
    data = {
        "data": {
            "userId": 1,
            "portalId": 1,
            "integrationModelId": 1,
            "channelAccountId": 1,
            "warehouseId": 1
        }
    }
    response = sdk.settings.update_team_member(1, data)
    print(response)


def get_team_member(sdk):
    response = sdk.settings.get_team_member(1)
    print(response)


def get_all_team_member(sdk):
    response = sdk.settings.get_all_team_member()
    print(response)


def main():

    sdk = EShopBoxSDK(
        workspace=os.getenv('ESHOPBOX_WORKSPACE', ''),
        client_id=os.getenv('ESHOPBOX_CLIENT_ID', ''),
        client_secret=os.getenv('ESHOPBOX_SECRET_ID', ''),
        refresh_token=os.getenv('ESHOPBOX_REFRESH_TOKEN', '')
    )

    get_all_team_member(sdk)


if __name__ == "__main__":
    main()

Workspaces

### Get Portals

sdk.settings.get_portals()

Returns a list of available portals.

### Create Workspace

sdk.settings.create_workspace(data)

Required Fields:

Field	Type	Required	Description
accountSlug	string	Yes	Unique workspace identifier
accountName	string	Yes	Display name for account

### Get All Workspaces

sdk.settings.get_all_workspace(params)

### Get Workspace

sdk.settings.get_workspace()

### Update Workspace

sdk.settings.update_workspace(data)

Sales Channels

### Create Sales Channel

sdk.settings.create_sales_channel(data)

### Update Sales Channel

sdk.settings.update_sales_channel(channel_id, data)

### Get All Sales Channels

sdk.settings.get_all_sales_channel()

### Get Sales Channel

sdk.settings.get_sales_channel(channel_id)

Fulfillment Center (FC) Submissions

### Create FC Submission

sdk.settings.create_fc_submission(data)

### Get All FC Submissions

sdk.settings.get_all_fc_submission()

### Get FC Submission

sdk.settings.get_fc_submission(fc_id)

### Update FC Submission

sdk.settings.update_fc_submission(fc_id, data)

Contacts

### Create Contact

sdk.settings.create_contact(data)

### Get All Contacts

sdk.settings.get_all_contact()

### Get Contact

sdk.settings.get_contact(params)

### Update Contact

sdk.settings.update_contact(contact_code, data)

Team Members

### Create Team Member

sdk.settings.create_team_member(data)

### Update Team Member

sdk.settings.update_team_member(member_id, data)

### Get Team Member

sdk.settings.get_team_member(member_id)

### Get All Team Members

sdk.settings.get_all_team_member()

Notes

• All methods return JSON responses according to EShopBox Settings API.

• Required data structures follow the standard { “data”: { … } } pattern.

• Workspace initialization requires valid SDK credentials from environment variables.