Settings

Get Settings

get
/settings
Responses
chevron-right
200

Successfully got settings

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got settings
get
/settings
200

Successfully got settings

Update store settings

post
/settings
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
metaTagTitlestringOptional
metaTagDescriptionstringOptional
metaTagKeywordsstringOptional
businessNamestringOptional
siteUrlstringOptional
storeOwnerstringOptional
storeAddress1stringOptional
storeAddress2stringOptional
storeDescriptionstringOptional
storeEmailstringOptional
storeTelephonestringOptional
storeCitystringOptional
storePostalCodestringOptional
siteCategorystringOptional
maintenanceModeintegerOptional
storeLanguageNamestringOptional
storeSecondaryLanguageNamestringOptional
storeCurrencyIdintegerOptional
timeZonestringOptional
twitterstringOptional
linkedInstringOptional
instagramstringOptional
youtubestringOptional
facebookstringOptional
statusintegerOptional
invoicePrefixstringOptional
orderStatusintegerOptional
categoryProductCountintegerOptional
itemsPerPageintegerOptional
settingIdintegerOptional
accessKeystringOptional
siteNamestringOptional
timeFormatstringOptional
currencySymbolstringOptional
defaultCountryintegerOptional
zoneIdintegerOptional
countryIdintegerOptional
countrystringOptional
defaultWebsiteintegerOptional
Responses
chevron-right
200

Settings Updated Successfully

post
/settings

No content

Get Country List

get
/country
Query parameters
limitintegerOptional

Limit of records

Default: 0
offsetintegerOptional

Offset for pagination

Default: 0
keywordstringOptional

Search keyword

countintegerOptional

Flag to get count (0 or 1)

Default: 0
statusintegerOptional

Filter by status

Default: 1
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully got all country list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully get all country List
get
/country
200

Successfully got all country list

Add a new country

post
/country
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequired

The name of the country

isoCode2stringRequired

The 2-letter ISO code for the country

isoCode3stringRequired

The 3-letter ISO code for the country

postcodeRequiredintegerOptional

Indicates whether a postcode is required (1 for true, 0 for false)

statusstringOptional

The status of the country (e.g., 0 for inactive, 1 for active)

countryIdstringOptional

The country ID (set to 0 for new country)

Responses
chevron-right
200

Successfully added the new country

*/*
statusintegerOptional
messagestringOptional
post
/country

Get Zone List

get
/list/zone
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully got all zone list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully get all zone list
get
/list/zone
200

Successfully got all zone list

Get Settings by ID

get
/settings/{id}
Path parameters
idintegerRequired

ID of the setting to fetch

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully fetched the settings

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully get settings
get
/settings/{id}
200

Successfully fetched the settings

Get complete list of currencies

get
/currency
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search keyword to filter the currencies

countintegerOptional

Count flag (should be 0 or true/false)

statusintegerOptional

Filter currencies by status (1 for active)

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the currency list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the complete currency list
get
/currency
200

Successfully retrieved the currency list

Add a new currency

post
/currency

Adds a new currency to the system.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringRequiredExample: test
codestringRequiredExample: sdf
symbolLeftstringOptionalExample: s
symbolRightstringOptionalExample: null
valuenumber · floatRequiredExample: 0
statusstringRequiredExample: 1
Responses
chevron-right
200

Successfully added a new currency

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully added new currency
post
/currency

Get complete list of languages

get
/language
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

countbooleanOptional

Count flag (should be 0 or true/false)

keywordstringOptional

Search keyword to filter the languages

statusintegerOptional

Filter languages by status (1 for active)

defaultLanguagebooleanOptional

Filter by default language

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the language list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got all language List
get
/language
200

Successfully retrieved the language list

Get complete list of categories

get
/category
Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

keywordstringOptional

Search keyword to filter the categories

sortOrderintegerOptional

Sort order (0 for ascending, 1 for descending)

statusintegerOptional

Filter categories by status (1 for active)

namestringOptional

Filter categories by name

industryIdintegerOptional

Filter categories by industry ID

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the category list

*/*
statusintegerOptional
messagestringOptional
get
/category
200

Successfully retrieved the category list

Update an existing country

put
/country/{id}
Path parameters
idintegerRequired

The ID of the country to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequired

The name of the country

isoCode2stringRequired

The 2-letter ISO code for the country

isoCode3stringRequired

The 3-letter ISO code for the country

postcodeRequiredintegerOptional

Indicates whether a postcode is required (1 for true, 0 for false)

statusstringOptional

The status of the country (e.g., 0 for inactive, 1 for active)

countryIdstringOptional

The country ID being updated

Responses
chevron-right
200

Successfully updated the country

*/*
statusintegerOptional
messagestringOptional
put
/country/{id}

Delete an existing country

delete
/country/{id}
Path parameters
idintegerRequired

The ID of the country to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the country

*/*
statusintegerOptional
messagestringOptional
delete
/country/{id}

Update an existing language

put
/language/{id}
Path parameters
idintegerRequired

The ID of the language to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
codestringRequired

The language code

namestringRequired

The language name

imagestringOptional

The image associated with the language

sortOrderintegerOptional

The sort order of the language

statusstringRequired

The status of the language

languageIdintegerRequired

The unique ID of the language to update

Responses
chevron-right
200

Successfully updated the language

*/*
statusintegerOptional
messagestringOptional
put
/language/{id}

Delete a language

delete
/language/{id}
Path parameters
idintegerRequired

The ID of the language to be deleted

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the language

*/*
statusintegerOptional

Status code

messagestringOptional

Success message

delete
/language/{id}

Create a new language

post
/language/
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
codestringRequired

The language code

namestringRequired

The language name

imagestringOptional

The image associated with the language (optional)

sortOrderintegerOptional

The sort order of the language

statusstringRequired

The status of the language

Responses
chevron-right
200

Successfully added a new language

*/*
statusintegerOptional
messagestringOptional
post
/language/

Get all zones

get
/zone
Query parameters
limitintegerOptional

The number of zones to retrieve. Defaults to 10.

offsetintegerOptional

The offset for pagination. Defaults to 0.

keywordstringOptional

A keyword to search zones.

countbooleanOptional

If true, will return a count of zones instead of the zone list.

statusintegerOptional

The status of the zones (1 for active, 0 for inactive).

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved all zone list

*/*
statusintegerOptional

Status code

messagestringOptional

Success message

get
/zone

Create a new zone

post
/zone
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
countryIdintegerRequired

The country ID to which the zone belongs.

codestringRequired

The unique code for the zone.

namestringRequired

The name of the zone.

statusintegerRequired

The status of the zone (1 for active, 0 for inactive).

Responses
chevron-right
200

Successfully created a new zone

*/*
statusintegerOptional

Status code

messagestringOptional

Success message

post
/zone

Update an existing zone

put
/zone/{zoneId}

Updates a zone with the provided details.

Path parameters
zoneIdinteger · int64Required

ID of the zone to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
countryIdintegerRequiredExample: 4
codestringRequiredExample: df
namestringRequiredExample: test
statusstringRequiredExample: 1
zoneIdintegerRequiredExample: 110
Responses
chevron-right
200

Successfully updated the zone

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully updated the zone
put
/zone/{zoneId}

Delete a zone

delete
/zone/{zoneId}

Deletes a zone identified by its ID.

Path parameters
zoneIdinteger · int64Required

ID of the zone to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the zone

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted the Zone
delete
/zone/{zoneId}

Update an existing currency

put
/currency/{currencyId}

Updates an existing currency with the provided details.

Path parameters
currencyIdintegerRequired

ID of the currency to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringRequiredExample: test
codestringRequiredExample: sdf
symbolLeftstringOptionalExample: s
symbolRightstringOptionalExample: null
valuenumber · floatRequiredExample: 0
statusstringRequiredExample: 1
Responses
chevron-right
200

Successfully updated the currency

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully updated the currency
put
/currency/{currencyId}

Delete an existing currency

delete
/currency/{currencyId}

Deletes an existing currency by ID.

Path parameters
currencyIdintegerRequired

ID of the currency to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the currency

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted the currency
delete
/currency/{currencyId}

Get a list of taxes

get
/tax/tax-list

Retrieves a list of taxes based on the given filters.

Query parameters
limitintegerOptional

The maximum number of items to return

Default: 10
offsetintegerOptional

The offset for pagination

Default: 0
keywordstringOptional

Search keyword for filtering tax list

countbooleanOptional

If true, returns only the count of taxes, not the actual list

Default: false
statusstringOptional

Filter by status (e.g., active/inactive)

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of taxes

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully get all tax list
get
/tax/tax-list

Add a new tax

post
/tax/add-tax

Creates a new tax record with the provided details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
taxNamestringRequiredExample: test
taxPercentagestringRequiredExample: 44
taxStatusstringRequiredExample: 1
Responses
chevron-right
200

Successfully created the new tax

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully created new tax
post
/tax/add-tax

Update tax details

put
/tax/update-tax/{taxId}

Updates the tax with the provided ID and new details.

Path parameters
taxIdintegerRequired

The ID of the tax to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
taxNamestringRequiredExample: test
taxPercentageintegerRequiredExample: 44
taxStatusstringRequiredExample: 1
Responses
chevron-right
200

Successfully updated the tax

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully updated the tax
put
/tax/update-tax/{taxId}

Delete a tax

delete
/tax/delete-tax/{taxId}

Deletes a tax by ID.

Path parameters
taxIdintegerRequired

The ID of the tax to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the tax

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted the tax
delete
/tax/delete-tax/{taxId}

Get role list

get
/role/rolelist

Fetches a list of all roles with optional pagination and filtering.

Query parameters
limitintegerOptional

The number of results to return per page.

Default: 10
offsetintegerOptional

The number of records to skip before starting to return results.

Default: 0
countbooleanOptional

Indicates whether to count the total number of records available.

Default: false
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully fetched the role list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully get all role list
get
/role/rolelist
200

Successfully fetched the role list

Create a new role

post
/role/create-role

Creates a new role with a name and status.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: test
statusbooleanRequiredExample: true
Responses
chevron-right
200

Successfully created a new role

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully created a new role
post
/role/create-role

Update an existing role

put
/role/update-role/{roleId}

Updates the role details (name and status) for a given roleId.

Path parameters
roleIdintegerRequired

ID of the role to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: testtttt
statusintegerRequiredExample: 1
idintegerRequiredExample: 30
Responses
chevron-right
200

Role updated successfully

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Role updated successfully
put
/role/update-role/{roleId}
200

Role updated successfully

Get a complete list of permission modules

get
/permission-module/list

Retrieves a list of permission modules with pagination and filtering options.

Query parameters
limitintegerOptional

The number of permission modules to retrieve per request

offsetintegerOptional

The offset to retrieve the list from

keywordstringOptional

Search keyword to filter the permission modules

countbooleanOptional

Flag to include count in the response

statusstringOptional

Filter permission modules by status

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of permission modules

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the complete list of pages
get
/permission-module/list
200

Successfully retrieved the list of permission modules

Get permissions based on reference type and reference ID

get
/permission-module/get-permission

Retrieves a list of permissions for a specific reference type and ID.

Query parameters
refTypeintegerRequired

The reference type (e.g., 1 for a specific object)

refIdintegerRequired

The reference ID to fetch permissions for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the permission list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got permission list
get
/permission-module/get-permission
200

Successfully retrieved the permission list

Add permissions based on reference type and reference ID

post
/permission-module/add-permission

Adds a list of permissions for a specific reference type and ID.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
refTypeintegerRequiredExample: 1
permissionstring[]RequiredExample: ["list-order"]
refIdintegerRequiredExample: 30
Responses
chevron-right
200

Successfully updated the permissions

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully updated the permission
post
/permission-module/add-permission
200

Successfully updated the permissions

Delete a role by ID

delete
/role/delete-role/{roleId}

Deletes the role identified by the provided role ID.

Path parameters
roleIdintegerRequired

ID of the role to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the role

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted the role
delete
/role/delete-role/{roleId}
200

Successfully deleted the role

Get list of users

get
/auth/userlist

Retrieves a list of users based on the provided parameters like limit, offset, and status.

Query parameters
limitintegerOptional

Limit of users per request

Default: 10
offsetintegerOptional

Offset to start fetching the list

Default: 0
countbooleanOptional

Whether to count the total number of users

Default: false
statusstringOptional

Filter users based on their status

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the user list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got all user list
get
/auth/userlist
200

Successfully retrieved the user list

Create a new user

post
/auth/create-user

Creates a new user in the system with the provided user details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
firstNamestringRequired

The user's first name

lastNamestringRequired

The user's last name

emailstring · emailRequired

The user's email address

userGroupIdintegerRequired

The ID of the user's group

usernamestringRequired

The user's username

passwordstringRequired

The user's password

Responses
chevron-right
200

Successfully created the user

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: User created successfully
post
/auth/create-user

Update a user

put
/auth/update-user/{userId}

Updates an existing user in the system with the provided user details.

Path parameters
userIdintegerRequired

ID of the user to be updated

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
firstNamestringRequired

The user's first name

lastNamestringRequired

The user's last name

emailstring · emailRequired

The user's email address

userGroupIdintegerRequired

The ID of the user's group

usernamestringRequired

The user's username

passwordstringRequired

The user's password (hashed)

idintegerRequired

The ID of the user being updated

Responses
chevron-right
200

Successfully updated the user

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: User updated successfully
put
/auth/update-user/{userId}

Delete a user

delete
/auth/delete-user/{userId}

Deletes an existing user by user ID.

Path parameters
userIdintegerRequired

ID of the user to be deleted

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the user

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: User deleted successfully
delete
/auth/delete-user/{userId}

Update maintenance mode

put
/settings/maintainance

This endpoint is used to enable or disable the maintenance mode.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
modeintegerRequired

Set mode: 0 to disable maintenance mode, 1 to enable maintenance mode.

Example: 0
idintegerRequired

The ID of the setting to update

Example: 2
Responses
chevron-right
200

Successfully updated the maintenance mode

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Maintainance mode updated successfully
put
/settings/maintainance

Retrieve audit log list

get
/auditlog/auditLog-list

This endpoint is used to retrieve a list of audit logs with pagination and optional filters.

Query parameters
offsetintegerOptional

The number of items to skip (used for pagination)

Default: 0
limitintegerOptional

The number of items to return (used for pagination)

Default: 20
keywordstringOptional

Keyword to filter the results by

modulestringOptional

Filter the audit logs by the module

actionBystringOptional

Filter the audit logs by the user who performed the action

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved audit log list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got a audit log list
get
/auditlog/auditLog-list

Retrieve module log list

get
/auditlog/module-list

This endpoint is used to retrieve a list of modules involved in audit logs.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved module log list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got a module log list
get
/auditlog/module-list

Delete audit logs within a specified date range

post
/auditlog/delete-auditlog

This endpoint allows the deletion of audit logs between the given fromDate and toDate.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
fromDatestringRequired

The starting date for the range of audit logs to delete

Example: 2024-1-1
toDatestringRequired

The ending date for the range of audit logs to delete

Example: 2024-1-1
Responses
chevron-right
200

Successfully deleted the audit logs within the specified date range

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted audit logs
post
/auditlog/delete-auditlog

Fetch the list of order statuses

get
/order-status/order-status-list

This endpoint retrieves a list of order statuses based on the provided filters like status and keyword.

Query parameters
statusintegerOptional

Filter by status. If not provided, fetches all statuses.

keywordstringOptional

Filter by a keyword to search order statuses.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the order status list

*/*
statusintegerOptional

The status of the request, 1 for success

messagestringOptional

A message providing details about the status of the request

get
/order-status/order-status-list

Fetch the list of email templates

get
/email-template/email-templatelist

This endpoint retrieves a list of email templates based on the provided filters like limit, offset, keyword, and count.

Query parameters
limitintegerOptional

Limit the number of email templates returned.

offsetintegerOptional

Offset to start fetching the email templates.

keywordstringOptional

Filter by keyword to search email templates.

countbooleanOptional

If set to 1, it will return the count of email templates.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the email template list

*/*
statusintegerOptional

The status of the request, 1 for success

messagestringOptional

A message providing details about the request

get
/email-template/email-templatelist

Update an existing email template

put
/email-template/update-email-template/{id}

This endpoint allows updating an existing email template based on the provided template Id.

Path parameters
idintegerRequired

The unique identifier of the email template to be updated

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
titlestringOptional

The title of the email template

subjectstringOptional

The subject of the email template

contentstringOptional

The content/body of the email template

statusintegerOptional

The status of the email template (1 for active, 0 for inactive)

dynamicFieldsRefstringOptional

The dynamic fields reference for the email template

Responses
chevron-right
200

Successfully updated the email template

*/*
statusintegerOptional

The status of the request, 1 for success

messagestringOptional

A message providing details about the request

put
/email-template/update-email-template/{id}

Get order fulfillment status list

get
/order-status/order-fullfillment-status-list

This endpoint retrieves the complete list of order fulfillment statuses.

Query parameters
limitintegerOptional

Number of records to return in a single response

offsetintegerOptional

Offset from which to start the records (for pagination)

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the order fulfillment status list

*/*
statusintegerOptional

The status of the operation

messagestringOptional

The response message

get
/order-status/order-fullfillment-status-list

Create a new order status

post
/order-status/create-order-status

This endpoint creates a new order status with the given details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
isFullfillmentintegerOptional

Indicates if the order status is related to fulfillment

namestringOptional

Name of the order status

colorCodestringOptional

Hexadecimal color code for the order status

prioritystringOptional

Priority level of the order status

statusintegerOptional

Status of the order (1 for active, 0 for inactive)

isAdminintegerOptional

Indicates if the order status is for admin

isVendorintegerOptional

Indicates if the order status is for vendor

isBuyerintegerOptional

Indicates if the order status is for buyer

isApiintegerOptional

Indicates if the order status is related to API

Responses
chevron-right
200

Successfully created a new order status

*/*
statusintegerOptional
messagestringOptional
post
/order-status/create-order-status

Update an existing order status

put
/order-status/update-order-status/{orderStatusId}

This endpoint updates an existing order status with the provided details.

Path parameters
orderStatusIdintegerRequired

ID of the order status to be updated

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
isFullfillmentintegerOptional

Indicates if the order status is related to fulfillment

namestringOptional

Name of the order status

colorCodestringOptional

Hexadecimal color code for the order status

priorityintegerOptional

Priority level of the order status

statusintegerOptional

Status of the order (1 for active, 0 for inactive)

parentIdintegerOptional

ID of the parent order status

isAdminintegerOptional

Indicates if the order status is for admin

isVendorintegerOptional

Indicates if the order status is for vendor

isBuyerintegerOptional

Indicates if the order status is for buyer

isApiintegerOptional

Indicates if the order status is related to API

orderStatusIdintegerOptional

ID of the order status

Responses
chevron-right
200

Successfully updated the order status

*/*
statusintegerOptional
messagestringOptional
put
/order-status/update-order-status/{orderStatusId}

Update the order fulfillment status

put
/order-status/update-order-fullfillment-status/{orderStatusId}

This endpoint updates the order fulfillment status for a specific order status ID.

Path parameters
orderStatusIdintegerRequired

ID of the order status whose fulfillment status is to be updated

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
statusintegerOptional

The order fulfillment status (1 for active, 0 for inactive)

Responses
chevron-right
200

Successfully updated the order fulfillment status

*/*
statusintegerOptional
messagestringOptional
put
/order-status/update-order-fullfillment-status/{orderStatusId}

Delete the order status

delete
/order-status/{orderStatusId}

This endpoint deletes the order status for a given order status ID.

Path parameters
orderStatusIdintegerRequired

ID of the order status to be deleted

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the order status

*/*
statusintegerOptional
messagestringOptional
delete
/order-status/{orderStatusId}

Get complete order fulfillment status list

get
/order-status/fullfillment

This endpoint retrieves a complete list of order fulfillment statuses.

Query parameters
limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

isFullfillmentintegerOptional

Filter by fulfillment status

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the order fulfillment status list

*/*
statusintegerOptional
messagestringOptional
get
/order-status/fullfillment
200

Successfully retrieved the order fulfillment status list

Assign order statuses to fulfillment statuses

put
/order-status/fullfillment

This endpoint assigns multiple order statuses to fulfillment statuses.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
orderStatusIdintegerRequired
fullfillmentStatusIdsinteger[]Required
Responses
chevron-right
200

Successfully updated order statuses with fulfillment status assignments

*/*
statusintegerOptional
messagestringOptional
put
/order-status/fullfillment
200

Successfully updated order statuses with fulfillment status assignments

Create new order fulfillment status

post
/order-status/fullfillment

This endpoint creates a new order fulfillment status.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
isFullfillmentintegerRequiredExample: 1
namestringRequiredExample: test
colorCodestringRequiredExample: #9c2a2a
priorityintegerRequiredExample: 5
statusintegerRequiredExample: 1
Responses
chevron-right
200

Successfully created order fulfillment status

*/*
statusintegerOptional
messagestringOptional
post
/order-status/fullfillment
200

Successfully created order fulfillment status

Update order fulfillment status

put
/order-status/fullfillment/{id}

This endpoint updates the status of an existing order fulfillment.

Path parameters
idintegerRequired

The ID of the order fulfillment status to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
idintegerRequired
statusintegerRequired
Responses
chevron-right
200

Successfully updated the order fulfillment status

*/*
statusintegerOptional
messagestringOptional
put
/order-status/fullfillment/{id}
200

Successfully updated the order fulfillment status

Delete order fulfillment status

delete
/order-status/fullfillment/{id}

This endpoint deletes an existing order fulfillment status.

Path parameters
idintegerRequired

The ID of the order fulfillment status to be deleted.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the order fulfillment status

*/*
statusintegerOptional
messagestringOptional
delete
/order-status/fullfillment/{id}
200

Successfully deleted the order fulfillment status

Get the plugin list

get
/plugins/

This endpoint retrieves the list of available plugins.

Responses
chevron-right
200

Successfully retrieved the plugin list

*/*
statusintegerOptional
messagestringOptional
get
/plugins/

Get plugin details

get
/plugins/{id}

This endpoint retrieves the details of a specific plugin by its ID.

Path parameters
idintegerRequired

The ID of the plugin.

Query parameters
idintegerOptional

Optional query parameter for the plugin ID.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the plugin details

*/*
statusintegerOptional
messagestringOptional
get
/plugins/{id}

Update plugin status

put
/plugins/{id}

This endpoint updates the status of a specific plugin.

Path parameters
idintegerRequired

The ID of the plugin to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
pluginStatusstringRequiredExample: 0
Responses
chevron-right
200

Successfully updated the plugin status

*/*
statusintegerOptional
messagestringOptional
put
/plugins/{id}

Update PayPal payment settings

post
/paypal-payment

This endpoint updates PayPal settings, including client credentials and test mode.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
clientIdstringRequired

The client ID for PayPal API.

clientSecretstringRequired

The client secret for PayPal API.

isTestbooleanRequired

Flag to indicate if PayPal is in test mode.

Responses
chevron-right
200

Successfully updated the PayPal payment settings

*/*
statusintegerOptional
messagestringOptional
post
/paypal-payment

Get attribute list

get
/attribute

Retrieve a list of product attributes with optional pagination and search keyword.

Query parameters
limitintegerOptional

Number of records to return

Example: 10
offsetintegerOptional

Offset for pagination

Example: 0
keywordstringOptional

Search keyword to filter attributes

Example: color
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the attribute list

*/*
statusintegerOptional
messagestringOptional
get
/attribute
200

Successfully retrieved the attribute list

Create a new attribute

post
/attribute/

This endpoint creates a new attribute with specified properties.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: test
typestringRequiredExample: short-text
isMandatoryintegerRequiredExample: 0
useAsFilterintegerOptionalExample: 1
isActiveintegerRequiredExample: 1
descriptionstringOptionalExample: test
labelstringOptionalExample: test
sectionNamestringOptional
defaultValuestringOptionalExample: test
sortOrderintegerOptionalExample: 1
Responses
chevron-right
200

Attribute added successfully

application/json
statusintegerOptionalExample: 1
messagestringOptionalExample: Attribute added successfully.
post
/attribute/
200

Attribute added successfully

Get attribute group list

get
/attribute-group/

Retrieves a list of attribute groups with optional pagination and search filters.

Query parameters
limitintegerOptional

Number of items to return per page.

Default: 10
offsetintegerOptional

Offset to start listing attribute groups from.

Default: 0
keywordstringOptional

Search keyword to filter attribute groups.

countintegerOptional

Flag to return count of attribute groups.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the attribute group list

application/json
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got the attribute group list.
get
/attribute-group/
200

Successfully retrieved the attribute group list

Create a new attribute group

post
/attribute-group/

Creates a new attribute group with the specified details.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequired

The name of the attribute group.

Example: testg
sortOrderintegerRequired

The sort order of the attribute group.

Example: 1
attributeIdsinteger[]Required

List of attribute IDs associated with the group.

Example: [106]
Responses
chevron-right
200

Successfully created the attribute group

application/json
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully added Attribute Group
post
/attribute-group/
200

Successfully created the attribute group

Get attribute group by ID

get
/attribute-group/{id}

Retrieves details of a specific attribute group by its ID.

Path parameters
idintegerRequired

The ID of the attribute group to retrieve.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the attribute group

application/json
statusintegerOptional
messagestringOptional
get
/attribute-group/{id}

Update attribute group by ID

put
/attribute-group/{id}

Updates an existing attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to be updated.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: Updated Group Name
sortOrderintegerRequiredExample: 1
attributeIdsinteger[]RequiredExample: [106,107]
Responses
chevron-right
200

Successfully updated the attribute group

application/json
statusintegerOptional
messagestringOptional
put
/attribute-group/{id}

Delete attribute group by ID

delete
/attribute-group/{id}

Deletes an existing attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to be deleted.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the attribute group

statusintegerOptional
messagestringOptional
delete
/attribute-group/{id}

Get translations for an attribute group by ID

get
/attribute-group-translation/attribute-group/{id}

Retrieves the translation for the specified attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to retrieve translations for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved translation for the attribute group

statusintegerOptional
messagestringOptional
get
/attribute-group-translation/attribute-group/{id}

Create translation for an attribute group by ID

post
/attribute-group-translation/attribute-group/{id}

Creates a new translation for the specified attribute group.

Path parameters
idintegerRequired

The ID of the attribute group to create a translation for.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
languagestringRequired

The language of the translation.

translatedNamestringRequired

The translated name for the attribute group.

translatedDescriptionstringOptional

The translated description for the attribute group.

Responses
chevron-right
200

Successfully created translation for the attribute group

statusintegerOptional
messagestringOptional
post
/attribute-group-translation/attribute-group/{id}

Get list of specifications

get
/specification/

Fetches a list of specifications with optional filtering.

Query parameters
limitintegerOptional

The number of specifications to return (pagination).

Default: 10
offsetintegerOptional

The offset from where to start retrieving specifications.

Default: 0
keywordstringOptional

A search keyword to filter specifications by.

countintegerOptional

If set to 1, only returns the count of specifications instead of the list.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of specifications

statusintegerOptional
messagestringOptional
get
/specification/

Get list of attribute groups

get
/attribute-group

Fetches a list of attribute groups with optional filtering.

Query parameters
limitintegerOptional

The number of attribute groups to return (pagination).

Default: 10
offsetintegerOptional

The offset from where to start retrieving attribute groups.

Default: 0
countintegerOptional

If set to 1, only returns the count of attribute groups instead of the list.

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of attribute groups

statusintegerOptional
messagestringOptional
get
/attribute-group

Get list of specifications

get
/specification

This endpoint retrieves the list of specifications.

Query parameters
limitintegerOptional

Number of records to return

Default: 10
offsetintegerOptional

The starting position of the records

Default: 0
keywordstringOptional

Keyword for searching specifications

countintegerOptional

Whether to return the count of records (0 = no, 1 = yes)

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of specifications

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got Specification List.
get
/specification

Create a new specification

post
/specification

This endpoint is used to create a new specification, which may include associated attribute groups and attributes.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringOptionalExample: tests
statusintegerOptionalExample: 1
attributeGroupIdinteger[]OptionalExample: 101
Responses
chevron-right
200

Successfully created the specification

statusintegerOptional
messagestringOptional
post
/specification

Get a specification by ID

get
/specification/{id}

This endpoint retrieves a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to retrieve

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the specification

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Got Specification.
get
/specification/{id}

Update a specification by ID

put
/specification/{id}

This endpoint updates a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
namestringRequiredExample: tests
statusintegerRequiredExample: 1
attributeGroupIdinteger[]Optional
deleteAttributeGroupIdsinteger[]Optional
idstringOptionalExample: 52
Responses
chevron-right
200

Successfully updated the specification

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Update Specification.
put
/specification/{id}

Delete a specification by ID

delete
/specification/{id}

This endpoint deletes a specification based on the provided specification ID.

Path parameters
idintegerRequired

ID of the specification to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the specification

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted Specification..!
delete
/specification/{id}

Get specification translation details by ID

get
/specification-translation/specification/{id}

This endpoint retrieves the translation details of a specification by its ID.

Path parameters
idintegerRequired

ID of the specification translation to retrieve

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved specification translation details

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got specification translation detail
get
/specification-translation/specification/{id}

Create new specification translation for the given specification ID

post
/specification-translation/specification/{id}

This endpoint creates a new translation for the specified specification by its ID.

Path parameters
idintegerRequired

ID of the specification to add the translation for

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body

Details of the new specification translation

languagestringOptionalExample: en
translationstringOptionalExample: This is the translated specification
Responses
chevron-right
200

Successfully created new specification translation

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully created new specification translation
post
/specification-translation/specification/{id}

Get list of specification categories

get
/specification/category

This endpoint retrieves the list of specification categories, with optional query parameters for filtering and pagination.

Query parameters
limitintegerOptional

Number of records to return

Default: 10
offsetintegerOptional

The starting position of the records

Default: 0
keywordstringOptional

Keyword for searching specification categories

countintegerOptional

Whether to return the count of records (0 = no, 1 = yes)

Default: 0
Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the list of specification categories

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Got Specification Category List.
get
/specification/category

Update specification for a category

put
/specification/category

This endpoint updates the specifications assigned to a category.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Bodyobject[]
categoryIdintegerRequired

The ID of the category

Example: 1424
specificationIdsinteger[]Required

List of specification IDs to associate with the category

Example: 51
deleteSpecificationIdsinteger[]Optional

List of specification IDs to remove from the category

Responses
chevron-right
200

Successfully updated the specifications for the category

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully Updated Specification To Category.
put
/specification/category

Get a list of site filters

get
/site-filter/site-filter-list

This endpoint retrieves a list of site filters based on the specified query parameters.

Query parameters
limitintegerOptional

Number of records to return.

offsetintegerOptional

The starting point for the filter records.

keywordstringOptional

Search keyword for filtering the list.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the filter list

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got filter list
get
/site-filter/site-filter-list

Create a new site filter

post
/site-filter/create-site-filter

This endpoint creates a new site filter based on the provided data.

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
filterNamestringOptional

The name of the filter

categoryIdinteger[]Optional

A list of category IDs associated with the filter

Responses
chevron-right
200

Successfully created the site filter

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully created a new Filter
post
/site-filter/create-site-filter

Get details of a specific site filter

get
/site-filter/filter-detail/{id}

This endpoint retrieves the details of a site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully retrieved the filter details

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully got filter detail
get
/site-filter/filter-detail/{id}

Update a site filter

put
/site-filter/update-site-filter/{id}

This endpoint updates the details of a site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter to update

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Body
filterNamestringRequired

The name of the site filter

categoryIdinteger[]Required

List of category IDs associated with the filter

editIdstringRequired

The ID of the site filter being edited

Responses
chevron-right
200

Successfully updated the site filter

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully updated the site filter
put
/site-filter/update-site-filter/{id}

Delete a site filter

delete
/site-filter/delete-site-filter/{id}

This endpoint deletes a specific site filter by its ID.

Path parameters
idintegerRequired

The ID of the site filter to delete

Header parameters
AuthorizationstringRequired

Bearer token for authentication.

Responses
chevron-right
200

Successfully deleted the site filter

*/*
statusintegerOptionalExample: 1
messagestringOptionalExample: Successfully deleted the filter
delete
/site-filter/delete-site-filter/{id}

Last updated