Configuration
Application configuration apis
Manage and update API tokens for your application, enabling secure access to your application's services and data.
Operations
GET
# Get application API tokens.
POST
# Update application API tokens.
POST
# Create tokens for application
DEL
# Delete tokens for application
Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
Success
TokenResponseSchema
tokens
object (Tokens)
Tokens
firebase
object (Firebase)
Firebase
credentials
object (Credentials)
Credentials
ios
object (Ios)
Ios
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for IOS
android
object (Android)
Android
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for Android
project_id
string
| base64
Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console.
gcm_sender_id
string
| base64
Google Cloud Manager's Sender ID for Firebase. It is a unique numerical value which is created when you configure your project in the Google Developers Console/Google Cloud Console.
application_id
string
| base64
Alphanumeric ID allotted to the current application created within the current business account
api_key
string
| base64
An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase.
enabled
boolean
Shows whether Firebase integration is enabled or disabled for the sales channel
moengage
object (Moengage)
Moengage
credentials
object (MoengageCredentials)
MoengageCredentials
app_id
string
APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard.
enabled
boolean
Shows whether MoEngage integation is enabled or disabled for the sales channel
segment
object (Segment)
Segment
credentials
object (SegmentCredentials)
SegmentCredentials
write_key
string
| base64
The unique identifier for a source that tells Segment from which source data is coming from, to which workspace the data belongs, and which destinations should receive the data.
enabled
boolean
Shows whether Segment integration is enabled or disabled for the sales channel
gtm
object (Gtm)
Gtm
credentials
object (GtmCredentials)
GtmCredentials
api_key
string
| base64
Secret credential API key for GTM
enabled
boolean
Shows whether GTM integration is enabled or disabled for the sales channel
freshchat
object (Freshchat)
Freshchat
credentials
object (FreshchatCredentials)
FreshchatCredentials
app_id
string
| base64
The unique app_id of your Freshchat account for integrating Freshchat with your sales channel
app_key
string
| base64
The unique app_key of your Freshchat account for integrating Freshchat with your sales channel
web_token
string
| base64
Web token used for accessing the Freshchat APIs
enabled
boolean
Shows whether Freshchat integration is enabled or disabled for the sales channel
safetynet
object (Safetynet)
Safetynet
credentials
object (SafetynetCredentials)
SafetynetCredentials
api_key
string
| base64
Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs.
enabled
boolean
Shows whether Safetynet integration is enabled or disabled for the sales channel
fynd_rewards
object (FyndRewards)
FyndRewards
credentials
object (FyndRewardsCredentials)
FyndRewardsCredentials
public_key
string
| base64
Public key for integrating with Fynd rewards.
private_key
string
| base64
Public key for integrating with Fynd rewards.
google_map
object (GoogleMap)
GoogleMap
enabled
boolean
Shows whether Google map integration is enabled or not.
credentials
object (GoogleMapCredentials)
GoogleMapCredentials
api_key
string
| base64
Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API.
_id
string
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
| date-time
ISO 8601 timestamp of token creation
modified_at
string
| date-time
ISO 8601 timestamp of token updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application API tokens.
getAppApiTokens
Add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
tokens
object (Tokens)
Tokens
firebase
object (Firebase)
Firebase
credentials
object (Credentials)
Credentials
ios
object (Ios)
Ios
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for IOS
android
object (Android)
Android
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for Android
project_id
string
| base64
Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console.
gcm_sender_id
string
| base64
Google Cloud Manager's Sender ID for Firebase. It is a unique numerical value which is created when you configure your project in the Google Developers Console/Google Cloud Console.
application_id
string
| base64
Alphanumeric ID allotted to the current application created within the current business account
api_key
string
| base64
An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase.
enabled
boolean
Shows whether Firebase integration is enabled or disabled for the sales channel
moengage
object (Moengage)
Moengage
credentials
object (MoengageCredentials)
MoengageCredentials
app_id
string
APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard.
enabled
boolean
Shows whether MoEngage integation is enabled or disabled for the sales channel
segment
object (Segment)
Segment
credentials
object (SegmentCredentials)
SegmentCredentials
write_key
string
| base64
The unique identifier for a source that tells Segment from which source data is coming from, to which workspace the data belongs, and which destinations should receive the data.
enabled
boolean
Shows whether Segment integration is enabled or disabled for the sales channel
gtm
object (Gtm)
Gtm
credentials
object (GtmCredentials)
GtmCredentials
api_key
string
| base64
Secret credential API key for GTM
enabled
boolean
Shows whether GTM integration is enabled or disabled for the sales channel
freshchat
object (Freshchat)
Freshchat
credentials
object (FreshchatCredentials)
FreshchatCredentials
app_id
string
| base64
The unique app_id of your Freshchat account for integrating Freshchat with your sales channel
app_key
string
| base64
The unique app_key of your Freshchat account for integrating Freshchat with your sales channel
web_token
string
| base64
Web token used for accessing the Freshchat APIs
enabled
boolean
Shows whether Freshchat integration is enabled or disabled for the sales channel
safetynet
object (Safetynet)
Safetynet
credentials
object (SafetynetCredentials)
SafetynetCredentials
api_key
string
| base64
Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs.
enabled
boolean
Shows whether Safetynet integration is enabled or disabled for the sales channel
fynd_rewards
object (FyndRewards)
FyndRewards
credentials
object (FyndRewardsCredentials)
FyndRewardsCredentials
public_key
string
| base64
Public key for integrating with Fynd rewards.
private_key
string
| base64
Public key for integrating with Fynd rewards.
google_map
object (GoogleMap)
GoogleMap
enabled
boolean
Shows whether Google map integration is enabled or not.
credentials
object (GoogleMapCredentials)
GoogleMapCredentials
api_key
string
| base64
Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API.
_id
string
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
| date-time
ISO 8601 timestamp of token creation
modified_at
string
| date-time
ISO 8601 timestamp of token updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Response
200
400
Success
TokenResponseSchema
tokens
object (Tokens)
Tokens
firebase
object (Firebase)
Firebase
credentials
object (Credentials)
Credentials
ios
object (Ios)
Ios
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for IOS
android
object (Android)
Android
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account
api_key
string
| base64
Firebase secret credential API key for Android
project_id
string
| base64
Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console.
gcm_sender_id
string
| base64
Google Cloud Manager's Sender ID for Firebase. It is a unique numerical value which is created when you configure your project in the Google Developers Console/Google Cloud Console.
application_id
string
| base64
Alphanumeric ID allotted to the current application created within the current business account
api_key
string
| base64
An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase.
enabled
boolean
Shows whether Firebase integration is enabled or disabled for the sales channel
moengage
object (Moengage)
Moengage
credentials
object (MoengageCredentials)
MoengageCredentials
app_id
string
APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard.
enabled
boolean
Shows whether MoEngage integation is enabled or disabled for the sales channel
segment
object (Segment)
Segment
credentials
object (SegmentCredentials)
SegmentCredentials
write_key
string
| base64
The unique identifier for a source that tells Segment from which source data is coming from, to which workspace the data belongs, and which destinations should receive the data.
enabled
boolean
Shows whether Segment integration is enabled or disabled for the sales channel
gtm
object (Gtm)
Gtm
credentials
object (GtmCredentials)
GtmCredentials
api_key
string
| base64
Secret credential API key for GTM
enabled
boolean
Shows whether GTM integration is enabled or disabled for the sales channel
freshchat
object (Freshchat)
Freshchat
credentials
object (FreshchatCredentials)
FreshchatCredentials
app_id
string
| base64
The unique app_id of your Freshchat account for integrating Freshchat with your sales channel
app_key
string
| base64
The unique app_key of your Freshchat account for integrating Freshchat with your sales channel
web_token
string
| base64
Web token used for accessing the Freshchat APIs
enabled
boolean
Shows whether Freshchat integration is enabled or disabled for the sales channel
safetynet
object (Safetynet)
Safetynet
credentials
object (SafetynetCredentials)
SafetynetCredentials
api_key
string
| base64
Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs.
enabled
boolean
Shows whether Safetynet integration is enabled or disabled for the sales channel
fynd_rewards
object (FyndRewards)
FyndRewards
credentials
object (FyndRewardsCredentials)
FyndRewardsCredentials
public_key
string
| base64
Public key for integrating with Fynd rewards.
private_key
string
| base64
Public key for integrating with Fynd rewards.
google_map
object (GoogleMap)
GoogleMap
enabled
boolean
Shows whether Google map integration is enabled or not.
credentials
object (GoogleMapCredentials)
GoogleMapCredentials
api_key
string
| base64
Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API.
_id
string
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
| date-time
ISO 8601 timestamp of token creation
modified_at
string
| date-time
ISO 8601 timestamp of token updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update application API tokens.
updateAppApiTokens
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Response
200
Successful response
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
POST
Response
Create tokens for application
createTokens
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
token
string
Required
Token
Response
200
Second App Headers
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000002"
token:
"ZRoeLTbj8"
Was this section helpful?
DEL
Response
Delete tokens for application
deleteToken
Access and manage application features, enabling you to retrieve information about available features, update feature configurations, and make modifications as needed.
Operations
GET
# Get application features.
POST
# Update application features.
PATCH
# Modify application features.
Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
AppFeatureResponseSchema
feature
object (AppFeature)
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in
login_btn_text
string
Shows the text displayed over the login button
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available
show_register_btn
boolean
Shows whether register button is available in the login/landing page
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Default Value : popular
Enum
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default vaule is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Shows whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Shows whether product comparison feature is enabled on PDP
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staff_selection
boolean
Shows whether staff selection is enabled on cart page
placing_for_customer
boolean
Shows whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Shows whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Shows whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
buybox
object (BuyboxFeature)
BuyboxFeature
show_name
boolean
Allow users to see seller/stores name on PDP (product detail page).
enable_selection
boolean
Allow selection of sellers/stores on PDP (product detail page).
is_seller_buybox_enabled
boolean
Toggle buybox listing between sellers and stores. True indicates seller listing, while False indicates store listing.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Application ID of the sales channel
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Version key for tracking revisions. Default value is zero
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application features.
getAppFeatures
Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
feature
object (AppFeature)
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in
login_btn_text
string
Shows the text displayed over the login button
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available
show_register_btn
boolean
Shows whether register button is available in the login/landing page
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Default Value : popular
Enum
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default vaule is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Shows whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Shows whether product comparison feature is enabled on PDP
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staff_selection
boolean
Shows whether staff selection is enabled on cart page
placing_for_customer
boolean
Shows whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Shows whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Shows whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
buybox
object (BuyboxFeature)
BuyboxFeature
show_name
boolean
Allow users to see seller/stores name on PDP (product detail page).
enable_selection
boolean
Allow selection of sellers/stores on PDP (product detail page).
is_seller_buybox_enabled
boolean
Toggle buybox listing between sellers and stores. True indicates seller listing, while False indicates store listing.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Application ID of the sales channel
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Version key for tracking revisions. Default value is zero
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Response
200
400
Success
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in
login_btn_text
string
Shows the text displayed over the login button
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available
show_register_btn
boolean
Shows whether register button is available in the login/landing page
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Default Value : popular
Enum
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default vaule is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Shows whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Shows whether product comparison feature is enabled on PDP
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staff_selection
boolean
Shows whether staff selection is enabled on cart page
placing_for_customer
boolean
Shows whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Shows whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Shows whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
buybox
object (BuyboxFeature)
BuyboxFeature
show_name
boolean
Allow users to see seller/stores name on PDP (product detail page).
enable_selection
boolean
Allow selection of sellers/stores on PDP (product detail page).
is_seller_buybox_enabled
boolean
Toggle buybox listing between sellers and stores. True indicates seller listing, while False indicates store listing.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Application ID of the sales channel
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Version key for tracking revisions. Default value is zero
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update application features.
updateAppFeatures
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
feature
object (AppFeature)
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in
login_btn_text
string
Shows the text displayed over the login button
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available
show_register_btn
boolean
Shows whether register button is available in the login/landing page
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Default Value : popular
Enum
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default vaule is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Shows whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Shows whether product comparison feature is enabled on PDP
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staff_selection
boolean
Shows whether staff selection is enabled on cart page
placing_for_customer
boolean
Shows whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Shows whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Shows whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
buybox
object (BuyboxFeature)
BuyboxFeature
show_name
boolean
Allow users to see seller/stores name on PDP (product detail page).
enable_selection
boolean
Allow selection of sellers/stores on PDP (product detail page).
is_seller_buybox_enabled
boolean
Toggle buybox listing between sellers and stores. True indicates seller listing, while False indicates store listing.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Application ID of the sales channel
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Version key for tracking revisions. Default value is zero
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Response
200
400
404
Success
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in
login_btn_text
string
Shows the text displayed over the login button
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available
show_register_btn
boolean
Shows whether register button is available in the login/landing page
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Default Value : popular
Enum
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default vaule is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Shows whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Shows whether product comparison feature is enabled on PDP
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staff_selection
boolean
Shows whether staff selection is enabled on cart page
placing_for_customer
boolean
Shows whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Shows whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Shows whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
buybox
object (BuyboxFeature)
BuyboxFeature
show_name
boolean
Allow users to see seller/stores name on PDP (product detail page).
enable_selection
boolean
Allow selection of sellers/stores on PDP (product detail page).
is_seller_buybox_enabled
boolean
Toggle buybox listing between sellers and stores. True indicates seller listing, while False indicates store listing.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Application ID of the sales channel
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Version key for tracking revisions. Default value is zero
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PATCH
Response
Modify application features.
modifyAppFeatures
Retrieve and update essential information about your application, such as its basic details and configurations.
Operations
GET
# Get application basic details.
PUT
# Update application basic details.
GET
# Get URL redirections
POST
# Create a URL redirection
GET
# Get URL redirections
PUT
# Update a URL redirection
DEL
# Delete a URL redirection
Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
Success
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
company_id
integer
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application basic details.
getAppBasicDetails
Modify sales channel details like name, description, logo, domain, company ID, and other related information.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
name
string
Required
Name of the sales channel. It is required.
description
string
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
company_id
integer
Response
200
Success
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
company_id
integer
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update application basic details.
updateAppBasicDetails
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Response
200
Successful response
UrlRedirectionResponseSchema
redirections
array of object (UrlRedirection)
Array of UrlRedirection
redirect_from
string
redirect_to
string
type
string
_id
string
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get URL redirections
getUrlRedirections
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Request body
redirection
object (UrlRedirection)
UrlRedirection
redirect_from
string
redirect_to
string
type
string
_id
string
Response
200
URL redirection created
UrlRedirection
redirect_from
string
redirect_to
string
type
string
_id
string
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create a URL redirection
createUrlRedirection
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
redirection_domain_id
string
Required
Redirection domain id that needs to be fetched
application_id
string
Required
Application Id
Response
200
Successful response
UrlRedirection
redirect_from
string
redirect_to
string
type
string
_id
string
Examples
Parameters
company_id:
2
redirection_domain_id:
"667e4d30d31bbdbfb125ee53"
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get URL redirections
getUrlRedirection
Parameters
redirection_domain_id
string
Required
Redirection domain id that needs to be fetched
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Request body
redirect_from
string
redirect_to
string
type
string
_id
string
Response
200
URL redirection created
UrlRedirection
redirect_from
string
redirect_to
string
type
string
_id
string
Examples
Parameters
redirection_domain_id:
"667e4d30d31bbdbfb125ee53"
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update a URL redirection
updateUrlRedirection
Parameters
redirection_domain_id
string
Required
Redirection domain id that needs to be fetched
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Response
200
Second App Headers
SuccessMessageResponseSchema
success
boolean
Shows whether domain was deleted successfully
message
string
Success message shown to the user (in a string format)
Examples
Parameters
redirection_domain_id:
"667e4d30d31bbdbfb125ee53"
company_id:
2
application_id:
"000000000000000000000002"
Was this section helpful?
DEL
Response
Delete a URL redirection
deleteUrlRedirection
Perform various actions related to application management, including creating applications, retrieving application details, and getting a list of applications.
Operations
GET
# Get application by ID.
PUT
# Get application by ID.
Retrieve detailed information about a specific application. Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application by ID.
getApplicationById
Update detailed information about a specific application. Use application ID to update the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
404
Success
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Get application by ID.
updateApplication
Retrieve information about previous versions of the application to assist with version control and deployment processes.
Operations
PUT
# Update Application Version
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Application Id
Request body
app_code_name
string
Required
app_name
string
Required
force_version
string
Required
latest_version
string
Required
is_app_blocked
boolean
Required
update_dialog
object (UpdateDiealog)
Required
UpdateDiealog
type
string
Required
interval
integer
Response
200
Successful response
PlatformVersion
app_code_name
string
app_name
string
force_version
string
latest_version
string
is_app_blocked
boolean
update_dialog
object (UpdateDiealog)
UpdateDiealog
type
string
interval
integer
_id
string
modified_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
__v
number
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update Application Version
updateApplicationVersion
Retrieve information about companies and stores associated with your application. Access details such as company profiles and store data for your application's functionality.
Operations
GET
# Get application companies.
GET
# Get application stores.
Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
uid
integer
UID of companies to be fetched
page_no
integer
The current page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
CompaniesResponseSchema
items
array of object (AppInventoryCompanies)
Array of AppInventoryCompanies
uid
integer
| int32
UID of the company, e.g. 108
name
string
Name of the company, e.g. Newton Traders
company_type
string
Indicates the type of the company, e.g. franchisee, distributor, etc.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
uid:
1080
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Get application companies.
getAppCompanies
Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
page_no
integer
The current page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
StoresResponseSchema
items
array of object (AppInventoryStores)
Array of AppInventoryStores
_id
string
The unique identifier of the store (24-digit Mongo Object ID) in the sales channel inventory
modified_on
string
| date-time
ISO 8601 timestamp of last known updation to the stores in sales channel inventory
uid
integer
| int32
Sales channel inventory store UID
name
string
Name of the store in the sales channel inventory, e.g. Reebok Mumbai
display_name
string
Display name of the sales channel inventory store (can be different than the actual store name), e.g. Reebok MUM
store_type
string
Store type of the sales channel inventory store, such as mall, warehouse, high_street
Enum
store_code
string
Store code of the enabled inventory store, e.g. HS-c9bac. It is unique for every store.
company_id
integer
| int32
Company ID of the selling location (store) added to the sales channel's inventory
address
object
integration_type
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get application stores.
getAppStores
Access and modify your application's contact information, ensuring accurate communication with users and stakeholders.
Operations
GET
# Get application contact information.
PUT
# Update application contact information.
Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
Success
ApplicationInformation
address
object (InformationAddress)
InformationAddress
loc
object (InformationLoc)
InformationLoc
type
string
Country code for contact number, e.g. +91 (for India)
coordinates
array of integer
10-digit mobile number
address_line
array of string
Contact address of the sales channel
phone
array of object (InformationPhone)
Array of InformationPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
city
string
Name of the city, e.g. Mumbai
country
string
Name of the country, e.g. India
pincode
integer
| int32
6-digit PIN Code of the city, e.g. 400001
support
object (InformationSupport)
InformationSupport
phone
array of object (InformationSupportPhone)
Array of InformationSupportPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
key
string
email
array of object (InformationSupportEmail)
Array of InformationSupportEmail
value
string
Value of email.
key
string
timing
string
Working hours of support team, e.g. 9 AM to 9 PM
social_links
object (SocialLinks)
SocialLinks
facebook
object (FacebookLink)
FacebookLink
title
string
Name of the social media platform, e.g. Facebook
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Facebook page
instagram
object (InstagramLink)
InstagramLink
title
string
Name of the social media platform, e.g. Instagram
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Instagram page
twitter
object (TwitterLink)
TwitterLink
title
string
Name of the social media platform, e.g. Twitter
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Twitter account
pinterest
object (PinterestLink)
PinterestLink
title
string
Name of the social media platform, e.g. Pinterest
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Pinterest page
google_plus
object (GooglePlusLink)
GooglePlusLink
title
string
Name of the social media platform, e.g. Google+
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Google+ account
youtube
object (YoutubeLink)
YoutubeLink
title
string
Name of the social media platform, e.g. YouTube
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's YouTube channel
linked_in
object (LinkedInLink)
LinkedInLink
title
string
Name of the social media platform, e.g. LinkedIn
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's LinkedIn channel
vimeo
object (VimeoLink)
VimeoLink
title
string
Name of the video hosting platform, e.g. Vimeo
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Vimeo channel
blog_link
object (BlogLink)
BlogLink
title
string
Name of the brand's blog page
icon
string
Hosted URL of icon image shown on the website
link
string
Web URL of brand's blog page
links
array of object (Links)
Array of Links
title
string
Name of the related page or link
link
string
Web URL for redirecting to a related page
copyright_text
string
Copyright statement usually seen at the site's footer
_id
string
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Array of BusinessHighlights
_id
string
Unique identifier (24-digit Mongo Object ID) of the related business
title
string
Title of the business highlight, e.g. Superfast Delivery
icon
string
Hosted URL of icon image representing the business highlight
sub_title
string
Detailed information about the highlight
application
string
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
| date-time
ISO 8601 timestamp of creation of the application information
modified_at
string
| date-time
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application contact information.
getAppContactInfo
Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
address
object (InformationAddress)
InformationAddress
loc
object (InformationLoc)
InformationLoc
type
string
Country code for contact number, e.g. +91 (for India)
coordinates
array of integer
10-digit mobile number
address_line
array of string
Contact address of the sales channel
phone
array of object (InformationPhone)
Array of InformationPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
city
string
Name of the city, e.g. Mumbai
country
string
Name of the country, e.g. India
pincode
integer
| int32
6-digit PIN Code of the city, e.g. 400001
support
object (InformationSupport)
InformationSupport
phone
array of object (InformationSupportPhone)
Array of InformationSupportPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
key
string
email
array of object (InformationSupportEmail)
Array of InformationSupportEmail
value
string
Value of email.
key
string
timing
string
Working hours of support team, e.g. 9 AM to 9 PM
social_links
object (SocialLinks)
SocialLinks
facebook
object (FacebookLink)
FacebookLink
title
string
Name of the social media platform, e.g. Facebook
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Facebook page
instagram
object (InstagramLink)
InstagramLink
title
string
Name of the social media platform, e.g. Instagram
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Instagram page
twitter
object (TwitterLink)
TwitterLink
title
string
Name of the social media platform, e.g. Twitter
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Twitter account
pinterest
object (PinterestLink)
PinterestLink
title
string
Name of the social media platform, e.g. Pinterest
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Pinterest page
google_plus
object (GooglePlusLink)
GooglePlusLink
title
string
Name of the social media platform, e.g. Google+
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Google+ account
youtube
object (YoutubeLink)
YoutubeLink
title
string
Name of the social media platform, e.g. YouTube
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's YouTube channel
linked_in
object (LinkedInLink)
LinkedInLink
title
string
Name of the social media platform, e.g. LinkedIn
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's LinkedIn channel
vimeo
object (VimeoLink)
VimeoLink
title
string
Name of the video hosting platform, e.g. Vimeo
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Vimeo channel
blog_link
object (BlogLink)
BlogLink
title
string
Name of the brand's blog page
icon
string
Hosted URL of icon image shown on the website
link
string
Web URL of brand's blog page
links
array of object (Links)
Array of Links
title
string
Name of the related page or link
link
string
Web URL for redirecting to a related page
copyright_text
string
Copyright statement usually seen at the site's footer
_id
string
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Array of BusinessHighlights
_id
string
Unique identifier (24-digit Mongo Object ID) of the related business
title
string
Title of the business highlight, e.g. Superfast Delivery
icon
string
Hosted URL of icon image representing the business highlight
sub_title
string
Detailed information about the highlight
application
string
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
| date-time
ISO 8601 timestamp of creation of the application information
modified_at
string
| date-time
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Response
200
Success
ApplicationInformation
address
object (InformationAddress)
InformationAddress
loc
object (InformationLoc)
InformationLoc
type
string
Country code for contact number, e.g. +91 (for India)
coordinates
array of integer
10-digit mobile number
address_line
array of string
Contact address of the sales channel
phone
array of object (InformationPhone)
Array of InformationPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
city
string
Name of the city, e.g. Mumbai
country
string
Name of the country, e.g. India
pincode
integer
| int32
6-digit PIN Code of the city, e.g. 400001
support
object (InformationSupport)
InformationSupport
phone
array of object (InformationSupportPhone)
Array of InformationSupportPhone
code
string
Country code for contact number, e.g. +91 (for India)
number
string
10-digit mobile number
key
string
email
array of object (InformationSupportEmail)
Array of InformationSupportEmail
value
string
Value of email.
key
string
timing
string
Working hours of support team, e.g. 9 AM to 9 PM
social_links
object (SocialLinks)
SocialLinks
facebook
object (FacebookLink)
FacebookLink
title
string
Name of the social media platform, e.g. Facebook
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Facebook page
instagram
object (InstagramLink)
InstagramLink
title
string
Name of the social media platform, e.g. Instagram
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Instagram page
twitter
object (TwitterLink)
TwitterLink
title
string
Name of the social media platform, e.g. Twitter
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Twitter account
pinterest
object (PinterestLink)
PinterestLink
title
string
Name of the social media platform, e.g. Pinterest
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Pinterest page
google_plus
object (GooglePlusLink)
GooglePlusLink
title
string
Name of the social media platform, e.g. Google+
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Google+ account
youtube
object (YoutubeLink)
YoutubeLink
title
string
Name of the social media platform, e.g. YouTube
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's YouTube channel
linked_in
object (LinkedInLink)
LinkedInLink
title
string
Name of the social media platform, e.g. LinkedIn
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's LinkedIn channel
vimeo
object (VimeoLink)
VimeoLink
title
string
Name of the video hosting platform, e.g. Vimeo
icon
string
Hosted URL of social icon image shown on the website
link
string
Web URL of brand's Vimeo channel
blog_link
object (BlogLink)
BlogLink
title
string
Name of the brand's blog page
icon
string
Hosted URL of icon image shown on the website
link
string
Web URL of brand's blog page
links
array of object (Links)
Array of Links
title
string
Name of the related page or link
link
string
Web URL for redirecting to a related page
copyright_text
string
Copyright statement usually seen at the site's footer
_id
string
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Array of BusinessHighlights
_id
string
Unique identifier (24-digit Mongo Object ID) of the related business
title
string
Title of the business highlight, e.g. Superfast Delivery
icon
string
Hosted URL of icon image representing the business highlight
sub_title
string
Detailed information about the highlight
application
string
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
| date-time
ISO 8601 timestamp of creation of the application information
modified_at
string
| date-time
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update application contact information.
updateAppContactInfo
Access and modify currency-related settings, update currency configurations, and retrieve supported currencies for your application.
Operations
GET
# Get application currency configuration.
POST
# Update application currency configuration.
PUT
# Update application currency configuration.
GET
# Get supported currencies.
Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
400
Success
AppSupportedCurrency
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get application currency configuration.
getAppCurrencyConfig
Modify currency configuration settings for the application. Add and edit the currencies supported in the application. Initially, INR will be enabled by default.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Response
200
Success
AppSupportedCurrency
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update application currency configuration.
createAppCurrencyConfig
Modify currency configuration settings for the application. Add and edit the currencies supported in the application. Initially, INR will be enabled by default.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Response
200
Success
AppSupportedCurrency
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update application currency configuration.
updateAppCurrencyConfig
Retrieve a list of supported currencies for the application. A list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
400
Success. Check the example shown below or refer `AppCurrencyResponseSchema` for more details.
AppCurrencyResponseSchema
_id
string
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency
code
string
3-character code of the default currency, e.g. INR, EUR, USD
supported_currency
array of object (Currency)
Array of Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
created_at
string
| date-time
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
| date-time
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get supported currencies.
getAppSupportedCurrency
Check the availability of a domain name for registration and pre-defined custom domain is supported.
Operations
POST
# Get domain availability.
Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
domain_url
string
Domain url
is_custom_domain
boolean
Get suggestions for custom domains or Fynd domains
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Success
DomainSuggestionsResponseSchema
domains
array of object (DomainSuggestion)
Domain URL
Array of DomainSuggestion
name
string
URL of the custom domain
unsupported
boolean
Shows whether TLD domain is supported or not
is_available
boolean
Shows whether the custom domain of your choice is available or not available
price
number
Cost of purchasing a custom domain. Not present for Fynd domains.
currency
string
Custom domain currency. Not present for Fynd domains.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Get domain availability.
getApplicationDomainAvailibility
Handle domain-related operations, including getting domains, adding domains, removing domains by ID, changing domain types, and checking domain status.
Operations
GET
# Get domains.
POST
# Add domain.
DEL
# Remove domain by ID.
POST
# Change domain type.
POST
# Get domain status.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
Success
DomainsResponseSchema
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get domains.
getDomains
Add a new domain. Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand)
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
domain
object (DomainAdd)
DomainAdd
name
string
Full domain name, e.g. uniket.hostx0.de
_id
string
The unique identifier (24-digit Mongo Object ID) of the domain
verified
boolean
Domain is verified or not (indicates if A records and TXT records are correct)
is_primary
boolean
Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)
is_shortlink
boolean
Indicates if the domain is a short link domain (short URL e.g. bitly)
message
string
Shows the message shown after adding a domain successfully, e.g. 'New domain added successfully'
txt_records
array of string
Response
200
400
Success
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Add domain.
addDomain
Delete a specific domain from the application. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
domain_id
string
Required
The unique identifier (24-digit Mongo Object ID) of the domain
Response
200
400
404
Success
SuccessMessageResponseSchema
success
boolean
Shows whether domain was deleted successfully
message
string
Success message shown to the user (in a string format)
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
domain_id:
"5caf4f967583794673424d77"
Was this section helpful?
DEL
Response
Remove domain by ID.
removeDomainById
Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
domain
object (UpdateDomain)
UpdateDomain
name
string
Full domain name, e.g. zenz.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the domain
verified
boolean
Domain is verified or not (indicates if A records and TXT records are correct)
is_primary
boolean
Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)
is_shortlink
boolean
Indicates if the domain is a short link domain (short URL e.g. bit.ly)
action
string
Shows domain is made primary domain for the sales channel or shorlink is created for the sales channel domain
Enum
Response
200
404
Success
DomainsResponseSchema
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Change domain type.
changeDomainType
Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
domain_url
string
URL of the domain, e.g. uniket.hostx0.de
Response
200
Success
DomainStatusResponseSchema
connected
boolean
Check if domain is live and mapped to appropriate IP of Fynd Servers
status
array of object (DomainStatus)
Array of DomainStatus
display
string
Shows TXT record and A records for the domain
status
boolean
Shows whether TXT record or A records for the domain are correctly propagating via DNS servers
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Get domain status.
getDomainStatus
Manage ordering store configurations, retrieve ordering store details, and update ordering store configurations, including staff-specific ordering stores.
Operations
POST
# Get ordering store by filter
POST
# Update ordering store configuration.
GET
# Get ordering store configuration.
GET
# Get deployment stores
POST
# Get an Ordering Store signed cookie on selection of ordering store.
DEL
# Unset the Ordering Store signed cookie.
GET
# Get ordering store details
GET
# Get all deployment stores
Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Request body
all_stores
boolean
Allow all stores from the ordering stores
deployed_stores
array of integer
q
string
Store code or name of the ordering store
Response
200
Success
OrderingStores
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
items
array of object (OrderingStore)
Array of OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
uid
integer
| int32
Ordering store UID
name
string
Store name of the ordering store
display_name
string
Display name of the ordering store
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse
store_code
string
Store code of the ordering store, e.g. MUM-102
pincode
string
6-digit PIN Code of the ordering store, e.g. 400001
code
string
Code of the ordering store (usually same as Store Code)
deployed_stores
array of integer
all_stores
boolean
Allow all stores of the ordering stores
enabled
boolean
Allow ordering stores for current sales channel
type
string
For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
| int32
Version key for tracking ordering stores. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Get ordering store by filter
getOrderingStoresByFilter
Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders)
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
deployment_meta
object (DeploymentMeta)
DeploymentMeta
deployed_stores
array of integer
all_stores
boolean
Allow all stores from the ordering store
enabled
boolean
Allow ordering stores for current sales channel
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering stores
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
Response
200
400
Success
DeploymentMeta
deployed_stores
array of integer
all_stores
boolean
Allow all stores from the ordering store
enabled
boolean
Allow ordering stores for current sales channel
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering stores
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update ordering store configuration.
updateOrderingStoreConfig
Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
OrderingStoreConfig
deployment_meta
object (DeploymentMeta)
DeploymentMeta
deployed_stores
array of integer
all_stores
boolean
Allow all stores from the ordering store
enabled
boolean
Allow ordering stores for current sales channel
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering stores
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get ordering store configuration.
getOrderingStoreConfig
Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
q
string
Store code or name of the ordering store.
Response
200
Success. Check the example shown below or refer `OrderingStoresResponseSchema` for more details.
OrderingStoresResponseSchema
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
items
array of object (OrderingStore)
Array of OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
uid
integer
| int32
Ordering store UID
name
string
Store name of the ordering store
display_name
string
Display name of the ordering store
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse
store_code
string
Store code of the ordering store, e.g. MUM-102
pincode
string
6-digit PIN Code of the ordering store, e.g. 400001
code
string
Code of the ordering store (usually same as Store Code)
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get deployment stores
getStaffOrderingStores
Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
ordering_store
object (OrderingStoreSelect)
Required
OrderingStoreSelect
uid
integer
| int32
Required
Ordering store unique uid. It is required.
Response
200
400
success
SuccessMessageResponseSchema
success
boolean
Shows whether domain was deleted successfully
message
string
Success message shown to the user (in a string format)
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Get an Ordering Store signed cookie on selection of ordering store.
getOrderingStoreCookie
Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
success
SuccessMessageResponseSchema
success
boolean
Shows whether domain was deleted successfully
message
string
Success message shown to the user (in a string format)
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
DEL
Response
Unset the Ordering Store signed cookie.
removeOrderingStoreCookie
Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
store_id
integer
Required
Store uid
Response
200
404
Success. Check the example shown below or refer `OrderingStore` for more details.
OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
uid
integer
| int32
Ordering store UID
name
string
Store name of the ordering store
display_name
string
Display name of the ordering store
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse
store_code
string
Store code of the ordering store, e.g. MUM-102
pincode
string
6-digit PIN Code of the ordering store, e.g. 400001
code
string
Code of the ordering store (usually same as Store Code)
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
store_id:
1
Was this section helpful?
GET
Response
Get ordering store details
getStoreDetailById
Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
q
string
Store code or name of the ordering store.
Response
200
422
Success. Check the example shown below or refer `OrderingStores` for more details.
OrderingStores
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
items
array of object (OrderingStore)
Array of OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
uid
integer
| int32
Ordering store UID
name
string
Store name of the ordering store
display_name
string
Display name of the ordering store
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse
store_code
string
Store code of the ordering store, e.g. MUM-102
pincode
string
6-digit PIN Code of the ordering store, e.g. 400001
code
string
Code of the ordering store (usually same as Store Code)
deployed_stores
array of integer
all_stores
boolean
Allow all stores of the ordering stores
enabled
boolean
Allow ordering stores for current sales channel
type
string
For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
| int32
Version key for tracking ordering stores. Default value is zero.
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
q:
"MRVLB01"
Was this section helpful?
GET
Response
Get all deployment stores
getOrderingStores
Operations
GET
# Get inventory configuration.
PUT
# Update inventory configuration.
PATCH
# Partially update inventory configuration.
GET
# Get Application configuration.
Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get inventory configuration.
getInventoryConfig
Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Response
200
429
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000003"
body:
body
Was this section helpful?
PUT
Response
Update inventory configuration.
updateInventoryConfig
Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Request body
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
comms_enabled
boolean
Shows communication (comms) is enabled or not for sales channel partial inventory update
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
Response
200
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PATCH
Response
Partially update inventory configuration.
partiallyUpdateInventoryConfig
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
OwnerAppConfig
inventory
object (OwnerAppInventoryConfig)
OwnerAppInventoryConfig
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response