Application configuration apis
Methods with example and description Get configuration of latest mobile build
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getBuildConfig ( platformType: platformType) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
platformType
String
yes
The device platform for which the mobile app is built, e.g. android, ios.
Fetch latest build configuration, such as app name, landing page image, splash image used in a mobile build.
Returned Response:
MobileAppConfiguration
Success
Example: {
"is_active" : true ,
"_id" : " 5ea9b318bc23a343ab6d442f" "app_name" : " TestUniket" "landing_image" : {
"aspect_ratio" : " 57/51" "secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-landing/original/yKnXY1ATx-store-landing-image.png" "splash_image" : {
"aspect_ratio" : " 1/1" "secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-splash/original/s6d7oYfY6-store-splash-image.png" "application" : " 000000000000000000000004" "platform_type" : " android" "created_at" : " 2020-04-29T17:02:16.976Z" "modified_at" : " 2021-02-23T17:10:26.872Z" "__v" : 0 ,
"package_name" : " com.fynd.store.x000000000000000000000004"
Update the configuration for next mobile build
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateBuildConfig ( platformType: platformType, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
platformType
String
yes
The device platform for which the mobile app is built, e.g. android, ios.
body
MobileAppConfigRequest
yes
Request body
Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build.
Returned Response:
MobileAppConfiguration
Success
Example: {
"is_active" : true ,
"_id" : " 5ea9b318bc23a343ab6d442f" "app_name" : " TestUniket" "landing_image" : {
"aspect_ratio" : " 57/51" "secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-landing/original/yKnXY1ATx-store-landing-image.png" "splash_image" : {
"aspect_ratio" : " 1/1" "secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/mobile-build/pictures/free-splash/original/s6d7oYfY6-store-splash-image.png" "application" : " 000000000000000000000004" "platform_type" : " android" "created_at" : " 2020-04-29T17:02:16.976Z" "modified_at" : " 2021-02-23T17:10:26.872Z" "__v" : 0 ,
"package_name" : " com.fynd.store.x000000000000000000000004"
Get details of previous mobile builds
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getPreviousVersions ( platformType: platformType) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
platformType
String
yes
The device platform for which the mobile app is built, e.g. android, ios.
Fetch version details of the app, this includes the build status, build date, version name, latest version, and a lot more.
Returned Response:
BuildVersionHistory
Success
Example: {
"versions" : {
"_id" : " 6035376ab937c5f7c5462888" "application" : " 000000000000000000000004" "platform_type" : " android" "build_status" : " pending" "version_name" : " 0.5.6" "version_code" : 1 ,
"created_at" : " 2021-02-23T17:12:10.977Z" "modified_at" : " 2021-02-23T17:12:10.977Z" "__v" : 0
},
"latest_available_version_name" : " 0.5.7"
Get the sales channel configuration and features
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppFeatures ( ) { ( response, error) in
// Use response
} 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.
Returned Response:
AppFeatureResponse
Success
Example: {
"feature" : {
"product_detail" : {
"similar" : [
" basic" " visual" " brand" " category" " seller" " price" " specs" "seller_selection" : true ,
"update_product_meta" : true ,
"request_product" : true
},
"landing_page" : {
"launch_page" : {
"page_type" : " home" "params" : {},
"query" : {}
},
"continue_as_guest" : true ,
"login_btn_text" : " Click here to sign-in" "show_domain_textbox" : true ,
"show_register_btn" : true
},
"registration_page" : {
"ask_store_address" : false
},
"home_page" : {
"order_processing" : true
},
"common" : {
"communication_optin_dialog" : {
"visibility" : true
},
"deployment_store_selection" : {
"enabled" : true ,
"type" : " hard" "listing_price" : {
"value" : " min" "sort" : " min" "currency" : {
"value" : [
" INR" "type" : " explicit" "default_currency" : " INR" "revenue_engine" : {
"enabled" : false
},
"feedback" : {
"enabled" : true
},
"compare_products" : {
"enabled" : true
},
"reward_points" : {
"credit" : {
"enabled" : true
},
"debit" : {
"enabled" : true ,
"auto_apply" : false ,
"strategy_channel" : " REWARDS" "cart" : {
"gst_input" : true ,
"staff_selection" : true ,
"placing_for_customer" : true ,
"google_map" : true ,
"revenue_engine_coupon" : false
},
"qr" : {
"application" : true ,
"products" : true ,
"collections" : true
},
"pcr" : {
"staff_selection" : true
},
"order" : {
"buy_again" : true
},
"_id" : " 5e57643c986e4119c973df7d" "app" : " 000000000000000000000004" "created_at" : " 2020-02-27T06:39:56.088Z" "modified_at" : " 2021-02-02T11:04:14.289Z" "__v" : 1
}
}
Update the sales channel configuration and features
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateAppFeatures ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
AppFeatureRequest
yes
Request body
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.
Returned Response:
AppFeature
Success
Example: {
"product_detail" : {
"similar" : [
" basic" " visual" " brand" " category" " seller" " price" " specs" "seller_selection" : true ,
"update_product_meta" : true ,
"request_product" : true
},
"landing_page" : {
"launch_page" : {
"page_type" : " home" "params" : {},
"query" : {}
},
"continue_as_guest" : true ,
"login_btn_text" : " Click here to sign-in" "show_domain_textbox" : true ,
"show_register_btn" : true
},
"registration_page" : {
"ask_store_address" : false
},
"home_page" : {
"order_processing" : true
},
"common" : {
"communication_optin_dialog" : {
"visibility" : true
},
"deployment_store_selection" : {
"enabled" : true ,
"type" : " hard" "listing_price" : {
"value" : " min" "sort" : " min" "currency" : {
"value" : [
" INR" "type" : " explicit" "default_currency" : " INR" "revenue_engine" : {
"enabled" : false
},
"feedback" : {
"enabled" : true
},
"compare_products" : {
"enabled" : true
}
},
"cart" : {
"gst_input" : true ,
"staff_selection" : true ,
"placing_for_customer" : true ,
"google_map" : true ,
"revenue_engine_coupon" : false
},
"qr" : {
"application" : true ,
"products" : true ,
"collections" : true
},
"pcr" : {
"staff_selection" : true
},
"order" : {
"buy_again" : true
},
"_id" : " 5e57643c986e4119c973df7d" "app" : " 000000000000000000000004" "created_at" : " 2020-02-27T06:39:56.088Z" "modified_at" : " 2021-03-09T15:40:29.188Z" "__v" : 1
}
Update features of application
platformClient. application ( " <APPLICATION_ID> " ) . configuration. modifyAppFeatures ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
AppFeatureRequest
yes
Request body
Update features of application
Returned Response:
AppFeature
Success
Example: {
"product_detail" : {
"similar" : [
" basic" " visual" " brand" " category" " seller" " price" " specs" "seller_selection" : true ,
"update_product_meta" : true ,
"request_product" : true
},
"landing_page" : {
"launch_page" : {
"page_type" : " home" "params" : {},
"query" : {}
},
"continue_as_guest" : true ,
"login_btn_text" : " Click here to sign-in" "show_domain_textbox" : true ,
"show_register_btn" : true
},
"registration_page" : {
"ask_store_address" : false
},
"home_page" : {
"order_processing" : true
},
"common" : {
"international_shipping" : {
"enabled" : true
},
"communication_optin_dialog" : {
"visibility" : true
},
"deployment_store_selection" : {
"enabled" : true ,
"type" : " hard" "listing_price" : {
"value" : " min" "sort" : " min" "currency" : {
"value" : [
" INR" "type" : " explicit" "default_currency" : " INR" "revenue_engine" : {
"enabled" : false
},
"feedback" : {
"enabled" : true
},
"compare_products" : {
"enabled" : true
}
},
"cart" : {
"gst_input" : true ,
"staff_selection" : true ,
"placing_for_customer" : true ,
"google_map" : true ,
"revenue_engine_coupon" : false
},
"qr" : {
"application" : true ,
"products" : true ,
"collections" : true
},
"pcr" : {
"staff_selection" : true
},
"order" : {
"buy_again" : true
},
"_id" : " 5e57643c986e4119c973df7d" "app" : " 000000000000000000000004" "created_at" : " 2020-02-27T06:39:56.088Z" "modified_at" : " 2021-03-09T15:40:29.188Z" "__v" : 1
}
Get sales channel details
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppBasicDetails ( ) { ( response, error) in
// Use response
} Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.
Returned Response:
ApplicationDetail
Success
Example: {
"name" : " Uniket B2B" "description" : " Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan" "logo" : {
"secure_url" : " https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png" "mobile_logo" : {
"secure_url" : " https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png" "favicon" : {
"secure_url" : " https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png" "banner" : {
"secure_url" : " https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x1/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png" "domain" : {
"verified" : true ,
"is_primary" : true ,
"is_shortlink" : false ,
"_id" : " 5eb1177748312a3bd55d0f1e" "name" : " uniket.hostx0.de" "domains" : [
{
"verified" : true ,
"is_primary" : true ,
"is_shortlink" : false ,
"_id" : " 5eb1177748312a3bd55d0f1e" "name" : " uniket.hostx0.de" "verified" : true ,
"is_primary" : false ,
"is_shortlink" : true ,
"_id" : " 5f0858c5f86e00cd42dccc8d" "name" : " jd.hostx0.de" "company_id" : 1 ,
"_id" : " 000000000000000000000004"
Update sales channel details
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateAppBasicDetails ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
ApplicationDetail
yes
Request body
Modify sales channel details like name, description, logo, domain, company ID, and other related information.
Returned Response:
ApplicationDetail
Success
Example: {
"name" : " Uniket B2B" "description" : " Uniket B2B - India's Fastest Growing Retail Store - Aapki Badhti Dukaan" "logo" : {
"secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png" "mobile_logo" : {
"secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/free-logo/original/oEf3SQjda-Uniket-B2B.png" "favicon" : {
"secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/favicon/original/y3h6SSlY5-Uniket-B2B.png" "banner" : {
"secure_url" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/application/pictures/landscape-banner/original/uSwlNpygq-Uniket-B2B.png" "domain" : {
"verified" : true ,
"is_primary" : true ,
"is_shortlink" : false ,
"_id" : " 5eb1177748312a3bd55d0f1e" "name" : " uniket.hostx0.de" "domains" : [
{
"verified" : true ,
"is_primary" : true ,
"is_shortlink" : false ,
"_id" : " 5eb1177748312a3bd55d0f1e" "name" : " uniket.hostx0.de" "verified" : true ,
"is_primary" : false ,
"is_shortlink" : true ,
"_id" : " 5f0858c5f86e00cd42dccc8d" "name" : " jd.hostx0.de"
Get current information of the sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppContactInfo ( ) { ( response, error) in
// Use response
} Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
Returned Response:
ApplicationInformation
Success
Example: {
"value" : {
"address" : {
"loc" : null ,
"address_line" : [
" Warehouse 5, Near Industrial Complex" " 2nd Lane, Andheri" "phone" : [
{
"code" : " +91" "number" : " 9988998899" "city" : " Mumbai , Maharashtra , India" "country" : " India" "pincode" : 400059
},
"support" : {
"phone" : [],
"email" : [],
"timing" : " 9 AM to 9 PM" "social_links" : {
"facebook" : {
"title" : " Facebook" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg" "link" : " " "instagram" : {
"title" : " Instagram" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg" "link" : " " "twitter" : {
"title" : " Twitter" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg" "link" : " " "pinterest" : {
"title" : " Pinterest" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg" "link" : " " "google_plus" : {
"title" : " Google+" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png" "link" : " " "youtube" : {
"title" : " Youtube" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg" "link" : " " "linked_in" : {
"title" : " LinkedIn" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg" "link" : " " "vimeo" : {
"title" : " Vimeo" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/Ttc80b3U78-vimeofooternho4br.svg" "link" : " " "blog_link" : {
"title" : " Blog" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg" "link" : " " "links" : [
{
"title" : " Shipping" "link" : " www.uniket.store/shipping-details" "title" : " Returns" "link" : " www.uniket.store/policy/return-policy" "title" : " Privacy" "link" : " www.uniket.store/policy/privacy-policy" "title" : " Terms" "link" : " www.uniket.store/policy/terms-conditions" "copyright_text" : " #MadeInIndia © 2020 Shopsense Retail Technologies" "_id" : " 5e6627bd0732616083e83750" "business_highlights" : [
{
"_id" : " 5fc901611dfba6c2e87d1ca9" "title" : " 100% Genuine Products" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png" "sub_title" : " Directly from brands" "_id" : " 5fc901611dfba64ce57d1caa" "title" : " Credit Facility Available" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png" "sub_title" : " Free 30 Days Credit" "_id" : " 5fc901611dfba64b2e7d1cab" "title" : " Assured Returns" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png" "sub_title" : " For all damaged/wrong items" "application" : " 000000000000000000000004" "created_at" : " 2020-03-09T11:25:49.921Z" "modified_at" : " 2020-12-03T15:16:49.087Z" "__v" : 99
}
}
Save or update current information of the sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateAppContactInfo ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
ApplicationInformation
yes
Request body
Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
Returned Response:
ApplicationInformation
Success
Example: {
"_id" : " 5e6627bd0732616083e83750" "address" : {
"address_line" : [
" Warehouse 5, Near Industrial Complex" " 2nd Lane, Andheri" "phone" : [
{
"code" : " +91" "number" : " 9988998899" "city" : " Mumbai , Maharashtra , India" "country" : " India" "pincode" : 400059
},
"social_links" : {
"facebook" : {
"title" : " Facebook" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/hQAbAKdvHK-facebookfooteraopcjq.svg" "link" : " " "instagram" : {
"title" : " Instagram" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/UZYsGWOqXp-instagramfooterl3utrr.svg" "link" : " " "twitter" : {
"title" : " Twitter" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/oT2hW-BJjq-twitterfooternajsyr.svg" "link" : " " "pinterest" : {
"title" : " Pinterest" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/v0erlcMk8p-pinterestfooternzmq4b.svg" "link" : " " "google_plus" : {
"title" : " Google+" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/lw3Y5S58h4-googleplusysukr1.png" "link" : " " "youtube" : {
"title" : " Youtube" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/EYV03PDST_-youtubefootermqhcr7.svg" "link" : " " "linked_in" : {
"title" : " LinkedIn" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/qa7gx_bW9O-linkedinfooterrcr0yq.svg" "link" : " " "blog_link" : {
"title" : " Blog" "icon" : " https://hdn-1.fynd.com/system/svg/social-media/icon/original/LKpxTk1I3s-mediumfooterdtvrva.svg" "link" : " " "links" : [
{
"title" : " Shipping" "link" : " www.uniket.store/shipping-details" "title" : " Returns" "link" : " www.uniket.store/policy/return-policy" "title" : " Privacy" "link" : " www.uniket.store/policy/privacy-policy" "title" : " Terms" "link" : " www.uniket.store/policy/terms-conditions" "copyright_text" : " #MadeInIndia © 2020 Shopsense Retail Technologies" "support" : {
"timing" : " 9 AM to 9 PM" "phone" : [],
"email" : [],
"business_highlights" : [
{
"_id" : " 60479413a32f774d754b00ef" "title" : " 100% Genuine Products" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/bVlx43F2a-H6pvZ9tzp-business-logo-icon.png" "sub_title" : " Directly from brands" "_id" : " 60479413a32f7717df4b00f0" "title" : " Credit Facility Available" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/VMnltS1m3-QuUnEjOsA-business-logo-icon.png" "sub_title" : " Free 30 Days Credit" "_id" : " 60479413a32f77e70b4b00f1" "title" : " Assured Returns" "icon" : " https://hdn-1.addsale.com/x0/company/1/applications/000000000000000000000004/business-highlights/pictures/square-logo/original/cTHzgHJXK-sROtLMalN-business-logo-icon.png" "sub_title" : " For all damaged/wrong items" "application" : " 000000000000000000000004" "created_at" : " 2020-03-09T11:25:49.921Z" "modified_at" : " 2021-03-09T15:28:19.598Z" "__v" : 101
}
Get social tokens for the sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppApiTokens ( ) { ( response, error) in
// Use response
} Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. Note - Token values are encrypted with AES encryption using a secret key.
Returned Response:
TokenResponse
Success
Example: {
"tokens" : {
"firebase" : {
"credentials" : {
"ios" : {
"application_id" : " test" "api_key" : " test" "android" : {
"application_id" : " test" "api_key" : " test" "project_id" : " uniket-d8cdc" "gcm_sender_id" : " test" "application_id" : " test" "api_key" : " test" "enabled" : true
},
"moengage" : {
"credentials" : {
"app_id" : " test" "enabled" : true
},
"segment" : {
"credentials" : {
"write_key" : " test" "enabled" : true
},
"gtm" : {
"credentials" : {
"api_key" : " test" "enabled" : false
},
"freshchat" : {
"credentials" : {
"app_id" : " 123456" "app_key" : " 123456789" "web_token" : " " "enabled" : false
},
"safetynet" : {
"credentials" : {
"api_key" : " test" "enabled" : true
},
"fynd_rewards" : {
"credentials" : {
"public_key" : " test" "auth" : {
"google" : {
"appId" : " test" "facebook" : {
"appId" : " test" "accountkit" : {
"appId" : " " "google_map" : {
"credentials" : {
"api_key" : " test" "_id" : " 5e66282a073261060ee83751" "application" : " 000000000000000000000004" "created_at" : " 2020-03-09T11:27:38.894Z" "modified_at" : " 2020-12-24T05:39:17.054Z" "__v" : 0
}
Add or update social tokens for the sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateAppApiTokens ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
TokenResponse
yes
Request body
Use this API to add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.
Returned Response:
TokenResponse
Success
Example: {
"tokens" : {
"firebase" : {
"credentials" : {
"ios" : {
"application_id" : " test" "api_key" : " test" "android" : {
"application_id" : " test" "api_key" : " test" "project_id" : " uniket-d8cdc" "gcm_sender_id" : " test" "application_id" : " test" "api_key" : " test" "enabled" : true
},
"moengage" : {
"credentials" : {
"app_id" : " test" "enabled" : true
},
"segment" : {
"credentials" : {
"write_key" : " test" "enabled" : true
},
"gtm" : {
"credentials" : {
"api_key" : " 1234567890" "enabled" : false
},
"freshchat" : {
"credentials" : {
"app_id" : " 123456" "app_key" : " 123456789" "web_token" : " " "enabled" : false
},
"safetynet" : {
"credentials" : {
"api_key" : " test" "enabled" : true
},
"fynd_rewards" : {
"credentials" : {
"public_key" : " test" "auth" : {
"google" : {
"appId" : " test" "facebook" : {
"appId" : " test" "accountkit" : {
"appId" : " " "google_map" : {
"credentials" : {
"api_key" : " test" "_id" : " 5e66282a073261060ee83751" "application" : " 000000000000000000000004" "created_at" : " 2020-03-09T11:27:38.894Z" "modified_at" : " 2020-12-24T05:39:17.054Z" "__v" : 0
}
Get companies enabled in the sales channel inventory
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppCompanies ( uid: uid, pageNo: pageNo, pageSize: pageSize) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
uid
Int?
no
UID of companies to be fetched
pageNo
Int?
no
The current page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
Returned Response:
CompaniesResponse
Success
Example: {
"items" : {
"uid" : 108 ,
"name" : " Sample2 Company" "company_type" : " mbo" "page" : {
"type" : " number" "size" : 200 ,
"current" : 1 ,
"has_next" : false ,
"item_total" : 3
}
}
Get stores enabled in the sales channel inventory
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppStores ( pageNo: pageNo, pageSize: pageSize) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The current page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
Fetch info 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
Returned Response:
StoresResponse
Success
Example: {
"items" : {
"id" : " 5ec2c0b168fc2800017112f5" "uid" : 1 ,
"name" : " RRL01" "display_name" : " RRL01" "store_type" : " warehouse" "store_code" : " WH_8513" "company_id" : 1
},
"page" : {
"type" : " number" "size" : 200 ,
"current" : 1 ,
"has_next" : true ,
"item_total" : 3
}
}
Get sales channel configuration
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getInventoryConfig ( ) { ( response, error) in
// Use response
} Use this API to fetch configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Returned Response:
ApplicationInventory
Success
Example: {
"inventory" : {
"brand" : {
"criteria" : " all" "brands" : []
},
"store" : {
"criteria" : " filter" "stores" : [],
"rules" : [
{
"companies" : [
1 ,
3 ,
4
],
"brands" : []
}
]
},
"category" : {
"criteria" : " all" "categories" : []
},
"price" : {
"min" : 1 ,
"max" : 10000
},
"discount" : {
"min" : 0 ,
"max" : 100
},
"out_of_stock" : true ,
"franchise_enabled" : true ,
"exclude_category" : [],
"image" : [
" standard" " substandard" " default" "company_store" : []
},
"authentication" : {
"required" : true ,
"provider" : " fynd" "article_assignment" : {
"rules" : {
"store_priority" : {
"enabled" : false ,
"storetype_order" : []
}
},
"post_order_reassignment" : true
},
"reward_points" : {
"credit" : {
"enabled" : true
},
"debit" : {
"enabled" : true ,
"auto_apply" : false ,
"strategy_channel" : " rewards" "cart" : {
"delivery_charges" : {
"enabled" : true ,
"charges" : [
{
"threshold" : 1000 ,
"charges" : 49
},
{
"threshold" : 200000 ,
"charges" : 79
}
]
},
"enabled" : true ,
"max_cart_items" : 0 ,
"min_cart_value" : 120 ,
"bulk_coupons" : true ,
"revenue_engine_coupon" : false
},
"payment" : {
"callback_url" : {
"app" : " " "web" : " " "methods" : {
"pl" : {
"enabled" : true
},
"card" : {
"enabled" : true
},
"nb" : {
"enabled" : true
},
"wl" : {
"enabled" : true
},
"ps" : {
"enabled" : true
},
"upi" : {
"enabled" : true
},
"qr" : {
"enabled" : true
},
"cod" : {
"enabled" : true
},
"pp" : {
"enabled" : true
},
"jp" : {
"enabled" : false
},
"pac" : {
"enabled" : false
},
"fc" : {
"enabled" : false
},
"jiopp" : {
"enabled" : false
},
"stripepg" : {
"enabled" : true
},
"juspaypg" : {
"enabled" : false
},
"payubizpg" : {
"enabled" : true
},
"payumoneypg" : {
"enabled" : true
},
"rupifipg" : {
"enabled" : false
},
"simpl" : {
"enabled" : true
}
},
"payment_selection_lock" : {
"enabled" : false ,
"default_options" : " " "payment_identifier" : " " "mode_of_payment" : " uniket_b2b" "source" : " uniket" "enabled" : true ,
"cod_amount_limit" : 100000 ,
"cod_charges" : 1500
},
"order" : {
"enabled" : true ,
"force_reassignment" : false
},
"logistics" : {
"logistics_by_seller" : false ,
"serviceability_check" : true ,
"same_day_delivery" : true ,
"dp_assignment" : true
},
"business" : " retail" "comms_enabled" : true ,
"communication" : {
"email" : {
"enabled" : false
},
"sms" : {
"enabled" : false
},
"voice" : {
"enabled" : false
}
},
"platforms" : [
" uniket_wholesale" "_id" : " 5e04c76b8dd8c003577fdd0a" "loyalty_points" : {
"enabled" : true ,
"auto_apply" : false
},
"app" : " 000000000000000000000004" "created_at" : " 2019-12-26t14:44:59.835z" "modified_at" : " 2021-03-09t15:40:29.208z" "__v" : 3 ,
"modified_by" : " 5e199eed98cfe16dc61385de"
Update sales channel configuration
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateInventoryConfig ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
ApplicationInventory
yes
Request body
Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Returned Response:
ApplicationInventory
Success
Example: {
"inventory" : {
"brand" : {
"criteria" : " all" "brands" : []
},
"store" : {
"criteria" : " filter" "stores" : [],
"rules" : [
{
"companies" : [
1 ,
3 ,
4
],
"brands" : []
}
]
},
"category" : {
"criteria" : " all" "categories" : []
},
"price" : {
"min" : 1 ,
"max" : 10000
},
"discount" : {
"min" : 0 ,
"max" : 100
},
"out_of_stock" : true ,
"franchise_enabled" : true ,
"exclude_category" : [],
"image" : [
" standard" " substandard" " default" "company_store" : []
},
"authentication" : {
"required" : true ,
"provider" : " fynd" "article_assignment" : {
"rules" : {
"store_priority" : {
"enabled" : false ,
"storetype_order" : []
}
},
"post_order_reassignment" : true
},
"reward_points" : {
"credit" : {
"enabled" : true
},
"debit" : {
"enabled" : true ,
"auto_apply" : false ,
"strategy_channel" : " REWARDS" "cart" : {
"delivery_charges" : {
"enabled" : true ,
"charges" : [
{
"threshold" : 1000 ,
"charges" : 49
},
{
"threshold" : 200000 ,
"charges" : 79
}
]
},
"enabled" : true ,
"max_cart_items" : 0 ,
"min_cart_value" : 120 ,
"bulk_coupons" : true ,
"revenue_engine_coupon" : false
},
"payment" : {
"callback_url" : {
"app" : " " "web" : " " "methods" : {
"PL" : {
"enabled" : true
},
"CARD" : {
"enabled" : true
},
"NB" : {
"enabled" : true
},
"WL" : {
"enabled" : true
},
"PS" : {
"enabled" : true
},
"UPI" : {
"enabled" : true
},
"QR" : {
"enabled" : true
},
"COD" : {
"enabled" : true
},
"PP" : {
"enabled" : true
},
"JP" : {
"enabled" : false
},
"PAC" : {
"enabled" : false
},
"FC" : {
"enabled" : false
},
"JIOPP" : {
"enabled" : false
},
"STRIPEPG" : {
"enabled" : true
},
"JUSPAYPG" : {
"enabled" : false
},
"PAYUBIZPG" : {
"enabled" : true
},
"PAYUMONEYPG" : {
"enabled" : true
},
"RUPIFIPG" : {
"enabled" : false
},
"SIMPL" : {
"enabled" : true
}
},
"payment_selection_lock" : {
"enabled" : false ,
"default_options" : " " "payment_identifier" : " " "mode_of_payment" : " UNIKET_B2B" "source" : " UNIKET" "enabled" : true ,
"cod_amount_limit" : 100000 ,
"cod_charges" : 1500
},
"order" : {
"enabled" : true ,
"force_reassignment" : false
},
"logistics" : {
"logistics_by_seller" : false ,
"serviceability_check" : true ,
"same_day_delivery" : true ,
"dp_assignment" : true
},
"business" : " retail" "comms_enabled" : true ,
"communication" : {
"email" : {
"enabled" : false
},
"sms" : {
"enabled" : false
},
"voice" : {
"enabled" : false
}
},
"platforms" : [
" uniket_wholesale" "_id" : " 5e04c76b8dd8c003577fdd0a" "loyalty_points" : {
"enabled" : true ,
"auto_apply" : false
},
"app" : " 000000000000000000000004" "created_at" : " 2019-12-26T14:44:59.835Z" "modified_at" : " 2021-03-09T15:40:29.208Z" "__v" : 3 ,
"modified_by" : " 5e199eed98cfe16dc61385de"
partiallyUpdateInventoryConfig Partially update sales channel configuration
platformClient. application ( " <APPLICATION_ID> " ) . configuration. partiallyUpdateInventoryConfig ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
AppInventoryPartialUpdate
yes
Request body
Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Returned Response:
ApplicationInventory
Success
Example: {
"inventory" : {
"brand" : {
"criteria" : " all" "brands" : []
},
"store" : {
"criteria" : " filter" "stores" : [],
"rules" : [
{
"companies" : [
1 ,
3 ,
4
],
"brands" : []
}
]
},
"category" : {
"criteria" : " all" "categories" : []
},
"price" : {
"min" : 1 ,
"max" : 10000
},
"discount" : {
"min" : 0 ,
"max" : 100
},
"out_of_stock" : true ,
"franchise_enabled" : true ,
"exclude_category" : [],
"image" : [
" standard" " substandard" " default" "company_store" : []
},
"authentication" : {
"required" : true ,
"provider" : " fynd" "article_assignment" : {
"rules" : {
"store_priority" : {
"enabled" : false ,
"storetype_order" : []
}
},
"post_order_reassignment" : true
},
"reward_points" : {
"credit" : {
"enabled" : true
},
"debit" : {
"enabled" : true ,
"auto_apply" : false ,
"strategy_channel" : " REWARDS" "cart" : {
"delivery_charges" : {
"enabled" : true ,
"charges" : [
{
"threshold" : 1000 ,
"charges" : 49
},
{
"threshold" : 200000 ,
"charges" : 79
}
]
},
"enabled" : true ,
"max_cart_items" : 0 ,
"min_cart_value" : 120 ,
"bulk_coupons" : true ,
"revenue_engine_coupon" : false
},
"payment" : {
"callback_url" : {
"app" : " " "web" : " " "methods" : {
"PL" : {
"enabled" : true
},
"CARD" : {
"enabled" : true
},
"NB" : {
"enabled" : true
},
"WL" : {
"enabled" : true
},
"PS" : {
"enabled" : true
},
"UPI" : {
"enabled" : true
},
"QR" : {
"enabled" : true
},
"COD" : {
"enabled" : true
},
"PP" : {
"enabled" : true
},
"JP" : {
"enabled" : false
},
"PAC" : {
"enabled" : false
},
"FC" : {
"enabled" : false
},
"JIOPP" : {
"enabled" : false
},
"STRIPEPG" : {
"enabled" : true
},
"JUSPAYPG" : {
"enabled" : false
},
"PAYUBIZPG" : {
"enabled" : true
},
"PAYUMONEYPG" : {
"enabled" : true
},
"RUPIFIPG" : {
"enabled" : false
},
"SIMPL" : {
"enabled" : true
}
},
"payment_selection_lock" : {
"enabled" : false ,
"default_options" : " " "payment_identifier" : " " "mode_of_payment" : " UNIKET_B2B" "source" : " UNIKET" "enabled" : true ,
"cod_amount_limit" : 100000 ,
"cod_charges" : 1500
},
"order" : {
"enabled" : true ,
"force_reassignment" : false
},
"logistics" : {
"logistics_by_seller" : false ,
"serviceability_check" : true ,
"same_day_delivery" : true ,
"dp_assignment" : true
},
"business" : " retail" "comms_enabled" : true ,
"communication" : {
"email" : {
"enabled" : false
},
"sms" : {
"enabled" : false
},
"voice" : {
"enabled" : false
}
},
"platforms" : [
" uniket_wholesale" "_id" : " 5e04c76b8dd8c003577fdd0a" "loyalty_points" : {
"enabled" : true ,
"auto_apply" : false
},
"app" : " 000000000000000000000004" "created_at" : " 2019-12-26T14:44:59.835Z" "modified_at" : " 2021-03-09T15:40:29.208Z" "__v" : 3 ,
"modified_by" : " 5e199eed98cfe16dc61385de"
Get currencies supported in the application
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppCurrencyConfig ( ) { ( response, error) in
// Use response
} Get a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application.
Returned Response:
AppSupportedCurrency
Success
Example: {
"_id" : " 5ec7a85965c3893857538d93" "supported_currency" : [
" 5ec75d11f7bfb5a7d38f3524" " 5ec75d11f7bfb54d798f3516" " 5ec75d11f7bfb553b88f355f" " 5ec75d11f7bfb559d08f34d5" " 5ec75d11f7bfb5d1e98f34da" "application" : " 000000000000000000000004" "default_currency" : {
"ref" : " 5ec75d11f7bfb54d798f3516" "code" : " USD" "created_at" : " 2020-05-22T10:24:25.984Z" "modified_at" : " 2021-03-09T10:47:32.664Z"
Update initial sales channel supported currency
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateAppCurrencyConfig ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
AppSupportedCurrency
yes
Request body
Use this API to add and edit the currencies supported in the application. Initially, INR will be enabled by default.
Returned Response:
AppSupportedCurrency
Success
Example: {
"_id" : " 5ec7a85965c3893857538d93" "supported_currency" : [
" 5ec75d11f7bfb5a7d38f3524" " 5ec75d11f7bfb54d798f3516" " 5ec75d11f7bfb553b88f355f" " 5ec75d11f7bfb559d08f34d5" " 5ec75d11f7bfb5d1e98f34da" "application" : " 000000000000000000000004" "default_currency" : {
"ref" : " 5ec75d11f7bfb54d798f3516" "code" : " USD" "created_at" : " 2020-05-22T10:24:25.984Z" "modified_at" : " 2021-03-09T10:47:32.664Z"
Get currencies enabled in the application
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getAppSupportedCurrency ( ) { ( response, error) in
// Use response
} Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
Returned Response:
AppCurrencyResponse
Success. Check the example shown below or refer AppCurrencyResponse for more details.
Example: {
"application" : " 000000000000000000000001" "default_currency" : {
"ref" : " 5ecf6122d953d4242c044907" "code" : " INR" "supported_currency" : [
{
"_id" : " 5ecf6122d953d4242c044907" "is_active" : true ,
"name" : " Indian Rupee" "code" : " INR" "decimal_digits" : 2 ,
"symbol" : " ₹" "created_at" : " 2020-05-28T06:58:42.532Z" "modified_at" : " 2021-04-05T16:44:14.358Z"
getOrderingStoresByFilter Get ordering store by filter
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getOrderingStoresByFilter ( pageNo: pageNo, pageSize: pageSize, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
body
FilterOrderingStoreRequest
yes
Request body
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).
Returned Response:
OrderingStores
Success
Example: {
"page" : {
"type" : " number" "size" : 10 ,
"current" : 1 ,
"has_next" : true ,
"item_total" : 583
},
"items" : [
{
"address" : {
"state" : " MAHARASHTRA" "address1" : " SAGAR TECH PLAZA, SAKINAKA" "lat_long" : {
"type" : " Point" "coordinates" : [
1 ,
1
]
},
"pincode" : 400070 ,
"country" : " INDIA" "city" : " MUMBAI" "_id" : " 5f586563f509dd000145c02d" "store_type" : " high_street" "uid" : 11016 ,
"store_code" : " HS-0c532" "display_name" : " Brand Company Store 11" "name" : " Brand Company Store 11" "pincode" : 400070 ,
"code" : " HS-0c532" "address" : {
"state" : " MAHARASHTRA" "address1" : " UNNAMED ROAD, VASAI EAST SALT PLANT" "lat_long" : {
"type" : " Point" "coordinates" : [
72.84293219999999 ,
19.3805675
]
},
"address2" : " VASAI EAST SALT PLANT, VASAI EAST, " "pincode" : 401208 ,
"country" : " INDIA" "city" : " VIRAR" "landmark" : " " "_id" : " 5f585934f509dd000145c025" "store_type" : " high_street" "uid" : 11567 ,
"store_code" : " 123456" "display_name" : " 2nd Store" "name" : " 2nd Store" "pincode" : 401208 ,
"code" : " 123456" "address" : {
"state" : " GUJARAT" "address1" : " 32, AANAND SHOPPING CENTRE " "lat_long" : {
"type" : " Point" "coordinates" : [
1 ,
1
]
},
"pincode" : 380001 ,
"country" : " INDIA" "city" : " AHMEDABAD" "_id" : " 5f587b5ef509dd000145c02f" "store_type" : " high_street" "uid" : 11568 ,
"store_code" : " 12345" "display_name" : " 3rd " "name" : " 3rd " "pincode" : 380001 ,
"code" : " 12345"
updateOrderingStoreConfig Add/Update ordering store config
platformClient. application ( " <APPLICATION_ID> " ) . configuration. updateOrderingStoreConfig ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
OrderingStoreConfig
yes
Request body
Use this API to edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders)
Returned Response:
DeploymentMeta
Success
Example: {
"deployment_meta" : {
"deployed_stores" : [
1 ,
10
],
"all_stores" : false ,
"enabled" : true ,
"type" : " hard" "_id" : " 5e7e5e4d6b5f3b4b54c95f9c" "app" : " 000000000000000000000004" "__v" : 6
},
"deployed_stores" : [
1 ,
10
],
"all_stores" : false ,
"enabled" : true ,
"type" : " hard" "_id" : " 5e7e5e4d6b5f3b4b54c95f9c" "app" : " 000000000000000000000004" "__v" : 6
}
Get ordering store config
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getOrderingStoreConfig ( ) { ( response, error) in
// Use response
} Fetch the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
Returned Response:
OrderingStoreConfig
Success
Example: {
"deployment_meta" : {
"deployed_stores" : [
1 ,
10
],
"all_stores" : false ,
"enabled" : true ,
"type" : " hard" "_id" : " 5e7e5e4d6b5f3b4b54c95f9c" "app" : " 000000000000000000000004" "__v" : 6
}
}
Get deployment stores
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getStaffOrderingStores ( pageNo: pageNo, pageSize: pageSize, q: q) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
q
String?
no
Store code or name of the ordering store.
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).
Returned Response:
OrderingStoresResponse
Success. Check the example shown below or refer OrderingStoresResponse for more details.
Example:
Get an Ordering Store signed cookie on selection of ordering store.
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getOrderingStoreCookie ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
OrderingStoreSelectRequest
yes
Request body
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.
Returned Response:
SuccessMessageResponse
Success
Example:
removeOrderingStoreCookie Unset the Ordering Store signed cookie.
platformClient. application ( " <APPLICATION_ID> " ) . configuration. removeOrderingStoreCookie ( ) { ( response, error) in
// Use response
} Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
Returned Response:
SuccessMessageResponse
Success
Example:
Fetch all the domains added to an application (sales channel website), including pre-defined domain (free domain) or custom domain (owned by the brand). Know the verification status of each domain name, and find out which one is the primary domain, short link domain, or both.
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getDomains ( ) { ( response, error) in
// Use response
} Get list of domains
Returned Response:
DomainsResponse
Success
Example: {
"domains" : [
{
"_id" : " 5eb1177748312a3bd55d0f1e" "verified" : true ,
"name" : " uniket.hostx0.de" "is_primary" : true ,
"is_shortlink" : false ,
"is_predefined" : true
},
{
"verified" : true ,
"is_primary" : false ,
"is_shortlink" : true ,
"_id" : " 5f0858c5f86e00cd42dccc8d" "name" : " jd.hostx0.de" "is_predefined" : true
},
{
"verified" : true ,
"is_primary" : false ,
"is_shortlink" : false ,
"_id" : " 6048497e87f5730423149190" "name" : " testdm.hostx0.de" "is_predefined" : true
}
]
}
Add new domain to current sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. addDomain ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
DomainAddRequest
yes
Request body
Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand)
Returned Response:
Domain
Success
Example: {
"name" : " testdm.hostx0.de" "verified" : true ,
"txtRecords" : [],
"message" : " New domain added successfully" "is_primary" : false ,
"is_shortlink" : false ,
"_id" : " 6048497e87f5730423149190"
Remove attached domain from current sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. removeDomainById ( id: id) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
The unique identifier (24-digit Mongo Object ID) of the domain
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.
Returned Response:
SuccessMessageResponse
Success
Example: {
"message" : " Domain removed successfully"
Change the type of domain in the current sales channel
platformClient. application ( " <APPLICATION_ID> " ) . configuration. changeDomainType ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
UpdateDomainTypeRequest
yes
Request body
Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain.
Returned Response:
DomainsResponse
Success
Example: {
"domains" : [
{
"_id" : " 5eb1177748312a3bd55d0f1e" "verified" : true ,
"name" : " uniket.hostx0.de" "is_primary" : true ,
"is_shortlink" : false
},
{
"verified" : true ,
"is_primary" : false ,
"is_shortlink" : true ,
"_id" : " 5f0858c5f86e00cd42dccc8d" "name" : " jd.hostx0.de" "verified" : true ,
"is_primary" : false ,
"is_shortlink" : false ,
"_id" : " 6048497e87f5730423149190" "name" : " testdm.hostx0.de"
Get the status of connected domain
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getDomainStatus ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
DomainStatusRequest
yes
Request body
Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.
Returned Response:
DomainStatusResponse
Success
Example: {
"connected" : true ,
"status" : [
{
"display" : " Domain TXT record entry 5d65089e031f9029f8e8dc2f" "status" : true
},
{
"display" : " Domain pointing to 18.217.232.69 A record" "status" : true
},
{
"display" : " Domain pointing to 18.188.115.251 A record" "status" : true
}
]
}
Create a new sales channel
platformClient. configuration. createApplication ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
CreateApplicationRequest
yes
Request body
Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company.
Returned Response:
CreateAppResponse
Success
Example:
Get list of registered sales channels under company
platformClient. configuration. getApplications ( pageNo: pageNo, pageSize: pageSize, q: q) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
pageSize
Int?
no
q
String?
no
Search param by name or domain
Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.
Returned Response:
ApplicationsResponse
Success
Example:
Get sales channel data by ID
platformClient. application ( " <APPLICATION_ID> " ) . configuration. getApplicationById ( ) { ( response, error) in
// Use response
} Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
Returned Response:
Application
Success
Example:
Get all currencies
platformClient. configuration. getCurrencies ( ) { ( response, error) in
// Use response
} Use this API to get a list of currencies allowed in the company. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
Returned Response:
CurrenciesResponse
Currencies Success response
Example: {
"items" : [
{
"_id" : " 5ec75d11f7bfb54d798f3516" "is_active" : true ,
"name" : " United States Dollar" "code" : " USD" "created_at" : " 2020-05-22T05:03:13.354Z" "modified_at" : " 2020-06-05T09:12:04.248Z" "decimal_digits" : 2 ,
"symbol" : " $"
Check domain availability before linking to application
platformClient. configuration. getDomainAvailibility ( body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
body
DomainSuggestionsRequest
yes
Request body
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.
Returned Response:
DomainSuggestionsResponse
Success
Examples:
Suggestions for fynd domains {
"value" : {
"domains" : [
{
"name" : " test.hostx1.de" "is_available" : false
},
{
"name" : " testhive.hostx1.de" "is_available" : true
}
]
}
}
Suggestions for custom domains {
"value" : {
"domains" : [
{
"name" : " test25.in" "unsupported" : false ,
"is_available" : false
},
{
"name" : " try25.in" "unsupported" : false ,
"is_available" : true ,
"price" : 14.99 ,
"currency" : " USD"
Get integration data by its ID
platformClient. configuration. getIntegrationById ( id: id) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
Int
yes
Integration id
Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID
Returned Response:
Integration
Success
Example: {
"_id" : " 5ec376ce848a005189acb312" "validators" : {
"company" : {
"browser_script" : " " "json_schema" : [
{
"type" : " object" "required" : [
" ip_address" " icode" " gds_entity_id" " auth_key" "properties" : null ,
"gds_entity_id" : {
"type" : " string" "title" : " GDS Entity ID" "minLength" : 3 ,
"maxLength" : 10 ,
"pattern" : " ^[a-zA-Z0-9]+$" "description" : " GDS Entity ID is a unique identifier provided by Ginesys to you." "ip_address" : {
"type" : " string" "title" : " IP Address" "pattern" : " (\\ d{1,3}\\ .){3}\\ d{1,3}" "description" : " Enter IP address provided by Ginesys for your POS server" "auth_key" : {
"title" : " Auth Key" "type" : " string" "maxLength" : 500 ,
"description" : " Provide authentication token provided by Ginesys to you." "icode" : {
"title" : " ICODE" "type" : " string" "enum" : [
" ean" " upc" " alu" " sku_code" "description" : " Please select the correct SKU identifier that you use to provide inventory to Fynd." "store" : {
"browser_script" : " " "json_schema" : [
{
"type" : " object" "properties" : null ,
"location_id" : {
"type" : " string" "title" : " Location ID" "description" : " Provide site code as per POS/SAP." "ip_address" : {
"type" : " string" "title" : " IP Address" "pattern" : " (\\ d{1,3}\\ .){3}\\ d{1,3}" "description" : " Enter IP address provided by Ginesys for your POS server" "description" : " Sap Integration west ELM brands" "constants" : {},
"name" : " SAP RBL Integration" "meta" : [
{
"public" : true ,
"_id" : " 5ee3e246129be17ce0b59ef4" "name" : " price_level" "value" : " store" "icon" : " https://res.cloudinary.com/dwzm9bysq/image/upload/v1589868232/addsale/platform/integrations/icon/z3kj9p8nidx4zzmdutdu.svg" "owner" : " 5e60e43dcd08cf01069eb23e" "created_at" : " 2020-05-19T06:03:58.757Z" "modified_at" : " 2020-06-15T12:00:42.598Z" "token" : " qk60vXqk-" "secret" : " Gp0dYInpUV" "__v" : 13 ,
"description_html" : " "
Get all available integration opt-ins
platformClient. configuration. getAvailableOptIns ( pageNo: pageNo, pageSize: pageSize) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
Use this API to get a list of all available integrations in a company
Returned Response:
GetIntegrationsOptInsResponse
Success
Example: {
"items" : [
{
"validators" : {
"company" : {
"json_schema" : [
{
"display" : " Host" "key" : " host" "type" : " text" "tooltip" : " Enter host address" "browser_script" : " " "store" : {
"json_schema" : [],
"browser_script" : " " "inventory" : {
"json_schema" : [],
"browser_script" : " " "order" : {
"json_schema" : [],
"browser_script" : " " "description" : " awesome integration" "description_html" : " " "constants" : " {\" mop_mapping\" :{\" FYND\" :\" FYND\" }}" "companies" : [],
"support" : [
" inventory" " order" "_id" : " 5e56089f4265cf2846d1e58c" "name" : " x0-1" "meta" : [
{
"public" : true ,
"_id" : " 5e56089f4265cf81e1d1e58e" "name" : " wow" "value" : " 1" "icon" : " https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696589/addsale/platform/integrations/icon/jihgcoibfmdttgiukwg0.png" "owner" : " 5e55fe074bda3c392ed9eab2" "created_at" : " 2020-02-26T05:56:47.214Z" "modified_at" : " 2021-03-02T12:29:03.554Z" "token" : " fKoHRW5H" "secret" : " d1E85CTmf" "__v" : 12
},
{
"validators" : {
"company" : {
"json_schema" : [],
"browser_script" : " " "store" : {
"json_schema" : [],
"browser_script" : " " "inventory" : {
"json_schema" : [],
"browser_script" : " " "order" : {
"json_schema" : [],
"browser_script" : " " "description" : " jabardast" "description_html" : " " "constants" : " {\" mop_mapping\" :{\" FYND\" :\" FYND\" }}" "companies" : [],
"support" : [
" inventory" " order" "_id" : " 5e5608bf4265cf7198d1e58f" "name" : " x0-2" "meta" : [
{
"public" : false ,
"_id" : " 5e5608bf4265cf813fd1e590" "name" : " wow" "value" : " 1" "icon" : " https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696633/addsale/platform/integrations/icon/cstvvkgjgip1ja56gq4x.png" "owner" : " 5e55fe074bda3c392ed9eab2" "created_at" : " 2020-02-26T05:57:19.875Z" "modified_at" : " 2021-02-15T05:23:55.962Z" "token" : " 3h3_mnzp" "secret" : " dgGHrIlFG" "__v" : 7
}
],
"page" : {
"type" : " number" "current" : 1 ,
"size" : 50 ,
"item_total" : 24 ,
"has_next" : false
}
}
Get company/store level integration opt-ins
platformClient. configuration. getSelectedOptIns ( level: level, uid: uid, pageNo: pageNo, pageSize: pageSize) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
level
String
yes
store or company
uid
Int
yes
Unique identifier of the selected integration level.
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
Use this API to get the store-level/company-level integrations configured in a company
Returned Response:
GetIntegrationsOptInsResponse
Success
Example: {
"items" : [
{
"validators" : {
"company" : {
"json_schema" : [
{
"display" : " Host" "key" : " host" "type" : " text" "tooltip" : " Enter host address" "browser_script" : " " "store" : {
"json_schema" : [],
"browser_script" : " " "inventory" : {
"json_schema" : [],
"browser_script" : " " "order" : {
"json_schema" : [],
"browser_script" : " " "description" : " awesome integration" "description_html" : " " "constants" : " {\" mop_mapping\" :{\" FYND\" :\" FYND\" }}" "companies" : [],
"support" : [
" inventory" " order" "_id" : " 5e56089f4265cf2846d1e58c" "name" : " x0-1" "meta" : [
{
"public" : true ,
"_id" : " 5e56089f4265cf81e1d1e58e" "name" : " wow" "value" : " 1" "icon" : " https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696589/addsale/platform/integrations/icon/jihgcoibfmdttgiukwg0.png" "owner" : " 5e55fe074bda3c392ed9eab2" "created_at" : " 2020-02-26T05:56:47.214Z" "modified_at" : " 2021-03-02T12:29:03.554Z" "token" : " fKoHRW5H" "secret" : " d1E85CTmf" "__v" : 12
},
{
"validators" : {
"company" : {
"json_schema" : [],
"browser_script" : " " "store" : {
"json_schema" : [],
"browser_script" : " " "inventory" : {
"json_schema" : [],
"browser_script" : " " "order" : {
"json_schema" : [],
"browser_script" : " " "description" : " jabardast" "description_html" : " " "constants" : " {\" mop_mapping\" :{\" FYND\" :\" FYND\" }}" "companies" : [],
"support" : [
" inventory" " order" "_id" : " 5e5608bf4265cf7198d1e58f" "name" : " x0-2" "meta" : [
{
"public" : false ,
"_id" : " 5e5608bf4265cf813fd1e590" "name" : " wow" "value" : " 1" "icon" : " https://res.cloudinary.com/dwzm9bysq/image/upload/v1582696633/addsale/platform/integrations/icon/cstvvkgjgip1ja56gq4x.png" "owner" : " 5e55fe074bda3c392ed9eab2" "created_at" : " 2020-02-26T05:57:19.875Z" "modified_at" : " 2021-02-15T05:23:55.962Z" "token" : " 3h3_mnzp" "secret" : " dgGHrIlFG" "__v" : 7
}
],
"page" : {
"type" : " number" "current" : 1 ,
"size" : 50 ,
"item_total" : 24 ,
"has_next" : false
}
}
getIntegrationLevelConfig Get integration level config
platformClient. configuration. getIntegrationLevelConfig ( id: id, level: level, opted: opted, checkPermission: checkPermission) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Integration ID (24-digit Mongo Object ID)
level
String
yes
store or company
opted
Bool?
no
True means get the opted stores. False means get the stores that aren't opted.
checkPermission
Bool?
no
Filter on if permissions (for inventory/order) are present
Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc.
Returned Response:
IntegrationConfigResponse
Success
Example: {
"items" : [
{
"opted" : false ,
"permissions" : [],
"last_patch" : [],
"_id" : " 5ec377f2848a0073feacb31b" "integration" : " 5ec376ce848a005189acb312" "level" : " store" "uid" : 1 ,
"meta" : [],
"token" : " 1RuGX0Fyp" "created_at" : " 2020-05-19T06:08:50.199Z" "modified_at" : " 2020-08-17T07:54:01.809Z" "__v" : 14 ,
"data" : {
"location_id" : " 09876" "ip_address" : " 1.2.3.4"
Update a store level integration you opted
platformClient. configuration. updateLevelIntegration ( id: id, level: level, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Integration ID (24-digit Mongo Object ID)
level
String
yes
Integration level, store or company
body
UpdateIntegrationLevelRequest
yes
Request body
Use this API to update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
Returned Response:
IntegrationLevel
Success
Example: {
"opted" : false ,
"permissions" : [],
"last_patch" : [],
"_id" : " 5ec377f2848a0073feacb31b" "integration" : " 5ec376ce848a005189acb312" "level" : " store" "uid" : 1 ,
"meta" : [],
"token" : " 1RuGX0Fyp" "created_at" : " 2020-05-19T06:08:50.199Z" "modified_at" : " 2020-08-17T07:54:01.809Z" "__v" : 14 ,
"data" : {
"location_id" : " 09876" "ip_address" : " 1.2.3.4"
Get integration config at a particular level (store/company)
platformClient. configuration. getIntegrationByLevelId ( id: id, level: level, uid: uid) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Integration ID (24-digit Mongo Object ID)
level
String
yes
Integration level, store or company
uid
Int
yes
Unique identifier of integration level (store/company)
Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
Returned Response:
IntegrationLevel
Success
Example: {
"opted" : false ,
"permissions" : [],
"last_patch" : [],
"_id" : " 5ec377f2848a0073feacb31b" "integration" : " 5ec376ce848a005189acb312" "level" : " store" "uid" : 1 ,
"meta" : [],
"token" : " 1RuGX0Fyp" "created_at" : " 2020-05-19T06:08:50.199Z" "modified_at" : " 2020-08-17T07:54:01.809Z" "__v" : 14 ,
"data" : {
"location_id" : " 09876" "ip_address" : " 1.2.3.4"
updateLevelUidIntegration Update integration level by store UID
platformClient. configuration. updateLevelUidIntegration ( id: id, level: level, uid: uid, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Integration ID (24-digit Mongo Object ID)
level
String
yes
Integration level, store or company
uid
Int
yes
Unique identifier of integration level (store/company)
body
IntegrationLevel
yes
Request body
Update the level of integration by store UID
Returned Response:
IntegrationLevel
Success
Example: {
"opted" : false ,
"permissions" : [],
"last_patch" : [],
"_id" : " 5ec377f2848a0073feacb31b" "integration" : " 5ec376ce848a005189acb312" "level" : " store" "uid" : 1 ,
"meta" : [],
"token" : " 1RuGX0Fyp" "created_at" : " 2020-05-19T06:08:50.199Z" "modified_at" : " 2020-08-17T07:54:01.809Z" "__v" : 14 ,
"data" : {
"location_id" : " 09876" "ip_address" : " 1.2.3.4"
getLevelActiveIntegrations Check active integration at store
platformClient. configuration. getLevelActiveIntegrations ( id: id, level: level, uid: uid) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Integration ID (24-digit Mongo Object ID)
level
String
yes
Integration level, store or company
uid
Int
yes
Unique identifier of integration level (store/company)
Use this API to check if a store is already opted-in for any integration
Returned Response:
OptedStoreIntegration
Success
Example: {
"opted" : false ,
"permissions" : [],
"last_patch" : [],
"_id" : " 5ec377f2848a0073feacb31b" "integration" : " 5ec376ce848a005189acb312" "level" : " store" "uid" : 1 ,
"meta" : [],
"token" : " 1RuGX0Fyp" "created_at" : " 2020-05-19T06:08:50.199Z" "modified_at" : " 2020-08-17T07:54:01.809Z" "__v" : 14 ,
"data" : {
"location_id" : " 09876" "ip_address" : " 1.2.3.4"
Get brands by company.
platformClient. configuration. getBrandsByCompany ( q: q) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
q
String?
no
Search text for brand name
Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image.
Returned Response:
BrandsByCompanyResponse
Success
Example: {
"brands" : {
"name" : " 5th Avenue" "value" : 476 ,
"brand_logo_url" : " https://hdn-1.addsale.com/x0/seller/pictures/logo/original/--unnamed--/1595615012186.jpeg" "brand_banner_url" : " https://hdn-1.addsale.com/x0/seller/pictures/landscape-banner/original/--unnamed--/1595615012724.jpeg" "brand_banner_portrait_url" : " https://hdn-1.addsale.com/x0/seller/pictures/portrait-banner/original/--unnamed--/1595615013203.jpeg"
Get company by brand uids
platformClient. configuration. getCompanyByBrands ( pageNo: pageNo, pageSize: pageSize, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
body
CompanyByBrandsRequest
yes
Request body
Use this API to get a list of companies by the brands they deal
Returned Response:
CompanyByBrandsResponse
Success
Example: {
"items" : [
{
"company_name" : " RELIANCE RETAIL LTD" "company_id" : 1
},
{
"company_name" : " SARASUOLE PRIVATE LIMITED" "company_id" : 3
},
{
"company_name" : " Lloyd Palek" "company_id" : 4
}
],
"page" : {
"type" : " number" "current" : 1 ,
"size" : 200 ,
"item_total" : 171 ,
"has_next" : false
}
}
Get stores by brand uids for the current company
platformClient. configuration. getStoreByBrands ( pageNo: pageNo, pageSize: pageSize, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
body
StoreByBrandsRequest
yes
Request body
Use this API to get a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail.
Returned Response:
StoreByBrandsResponse
Success
Example: {
"items" : [
{
"store_name" : " RRL01" "store_id" : 1 ,
"store_type" : " warehouse" "store_code" : " WH_8513" "store_address" : {
"state" : " MAHARASHTRA" "address1" : " SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR," "lat_long" : {
"type" : " Point" "coordinates" : [
72.8691788 ,
19.1174114
]
},
"address2" : " KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069" "pincode" : 400059 ,
"country" : " INDIA" "city" : " MUMBAI" "company" : {
"uid" : 1 ,
"name" : " RELIANCE RETAIL LTD" "store_name" : " RUOSH WAREHOUSE" "store_id" : 2 ,
"store_type" : " warehouse" "store_code" : " RUOSH43" "store_address" : {
"state" : " MAHARASHTRA" "address1" : " RAUNAK CITY SECTOR 4 D10, SAPAD GAON" "lat_long" : {
"type" : " Point" "coordinates" : [
73.121952 ,
19.2645048
]
},
"address2" : " SAPAD GAON, KHADAKPADA, " "pincode" : 421301 ,
"country" : " INDIA" "city" : " THANE" "landmark" : " near taj" "company" : {
"uid" : 3 ,
"name" : " SARASUOLE PRIVATE LIMITED" "page" : {
"type" : " number" "current" : 1 ,
"size" : 200 ,
"item_total" : 762 ,
"has_next" : true
}
}
getOtherSellerApplications Get other seller sales channels
platformClient. configuration. getOtherSellerApplications ( pageNo: pageNo, pageSize: pageSize) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
pageNo
Int?
no
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int?
no
The number of items to retrieve in each page. Default value is 10.
Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
Returned Response:
OtherSellerApplications
Success
Example: {
"items" : [
{
"name" : " intent 2" "description" : " " "_id" : " 5f030880f019afd636889afc" "domain" : " intent.hostx0.de" "company" : {
"uid" : 94 ,
"name" : " DummyImran" "opt_type" : " store" "name" : " new application imran" "description" : " " "_id" : " 5f03f5d17692029e2d1a50a5" "domain" : " imranstore.hostx0.de" "company" : {
"uid" : 94 ,
"name" : " DummyImran" "opt_type" : " store" "name" : " helo" "description" : " " "_id" : " 5f03f63b769202170c1a50a9" "domain" : " helo.hostx0.de" "company" : {
"uid" : 7 ,
"name" : " Zack Burgdorf" "opt_type" : " store" "page" : {
"type" : " number" "current" : 1 ,
"size" : 10 ,
"item_total" : 20 ,
"has_next" : true
}
}
getOtherSellerApplicationById Get other seller's sales channel by ID
platformClient. configuration. getOtherSellerApplicationById ( id: id) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Application Id
Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory
Returned Response:
OptedApplicationResponse
Success
Example: {
"name" : " intent 2" "description" : " " "_id" : " 5f030880f019afd636889afc" "domain" : " intent.hostx0.de" "company" : {
"uid" : 94 ,
"name" : " DummyImran" "opted_inventory" : {
"opt_type" : {
"key" : " store" "display" : " Store" "items" : {
"name" : " RRL01" "id" : 1 ,
"store_code" : " WH_8513" "_id" : " 5ec2c0b168fc2800017112f5" "modified_on" : " 2020-09-09T04:25:55.843Z" "uid" : 1
},
"address" : {
"state" : " MAHARASHTRA" "address1" : " SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED 1ST FLOOR WEWORK VIJAY DIAMOND, CROSS RD B, AJIT NAGAR," "lat_long" : {
"type" : " Point" "coordinates" : [
72.8691788 ,
19.1174114
]
},
"address2" : " KONDIVITA, ANDHERI EAST, MUMBAI, MAHARASHTRA 400069" "pincode" : 400059 ,
"country" : " INDIA" "city" : " MUMBAI" "display_name" : " RRL01" "store_type" : " warehouse" "company_id" : 1 ,
"opt_out_inventory" : {
"store" : [],
"company" : []
}
}
Opt-out company or store from other seller application
platformClient. configuration. optOutFromApplication ( id: id, body: body) { ( response, error) in
// Use response
}
Argument
Type
Required
Description
id
String
yes
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
body
OptOutInventory
yes
Request body
Use this API to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store.
Returned Response:
SuccessMessageResponse
Success
Example: {
"message" : " Updated opt out data"
Properties
Type
Nullable
Description
inventory
AppInventoryConfig ?yes
authentication
AuthenticationConfig ?yes
articleAssignment
ArticleAssignmentConfig ?yes
rewardPoints
RewardPointsConfig ?yes
cart
AppCartConfig ?yes
payment
AppPaymentConfig ?yes
order
AppOrderConfig ?yes
logistics
AppLogisticsConfig ?yes
business
String?
yes
Indicates the business type for sales channel e.g. retail or wholesale
commsEnabled
Bool?
yes
Shows communication(comms) is enabled or not for sales channel inventory
communication
CommunicationConfig ?yes
platforms
[String]?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyaltyPoints
LoyaltyPointsConfig ?yes
app
String?
yes
Current sales channel ID
createdAt
String?
yes
ISO 8601 timestamp of sales channel inventory creation
updatedAt
String?
yes
ISO 8601 timestamp of sales channel inventory updation
modifiedBy
String?
yes
User ID of the person who made the latest changes in the sales channel inventory
Properties
Type
Nullable
Description
brand
InventoryBrand ?yes
store
InventoryStore ?yes
category
InventoryCategory ?yes
price
InventoryPrice ?yes
discount
InventoryDiscount ?yes
outOfStock
Bool?
yes
Indicates whether out of stock products are allowed to show up on the website
onlyVerifiedProducts
Bool?
yes
Show only verified products (the ones whose data has been verified by the admin)
franchiseEnabled
Bool?
yes
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
excludeCategory
[[String: Any]]?
yes
List of excluded brands category
image
[String]?
yes
companyStore
[[String: Any]]?
yes
List of selling locations whose inventory is available to the sales channel for displaying on the website
Properties
Type
Nullable
Description
criteria
String?
yes
All brands or specific (explicit) brands to be shown on the website
brands
[[String: Any]]?
yes
List of brands
Properties
Type
Nullable
Description
criteria
String?
yes
All stores or specific (explicit) stores to be shown on the website
stores
[[String: Any]]?
yes
List of stores
rules
[AppStoreRules ]?
yes
Rules to show which brands or companies products should be listed on sales channel.
Properties
Type
Nullable
Description
companies
[Int]?
yes
List of companies whose inventory is available to the sales channel for displaying on the website
brands
[[String: Any]]?
yes
List of brands whose products will be shown on the website
Properties
Type
Nullable
Description
criteria
String?
yes
categories
[[String: Any]]?
yes
List of categories whose products will be shown on the website
Properties
Type
Nullable
Description
min
Double?
yes
Minimum inventory price
max
Double?
yes
Maximum inventory price
Properties
Type
Nullable
Description
min
Double?
yes
Minimum inventory discount
max
Double?
yes
Maximum inventory discount
Properties
Type
Nullable
Description
required
Bool?
yes
Shows sales channel inventory authentication is required or not
provider
String?
yes
Shows inventory authentication provider
Properties
Type
Nullable
Description
rules
ArticleAssignmentRules ?yes
postOrderReassignment
Bool?
yes
Allow post order reassigment of article
Properties
Type
Nullable
Description
storePriority
StorePriority ?yes
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows store priority is enabled or disabled for assignment of article
storetypeOrder
[[String: Any]]?
yes
List of store types for article assignment e.g. warehouse, mall, highstreet
Properties
Type
Nullable
Description
deliveryCharges
DeliveryCharges ?yes
enabled
Bool?
yes
Shows whether cart configuration is enabled or not
maxCartItems
Int?
yes
Maximum number of items that can be added to cart by the customer
minCartValue
Double?
yes
Minimum cart value below which customer cannot place an order
bulkCoupons
Bool?
yes
Allow creation of bulk coupons
revenueEngineCoupon
Bool?
yes
Allow coupon apply and credits together. Default value is false.
panCard
PanCardConfig ?yes
Properties
Type
Nullable
Description
enabled
Bool?
yes
Allow delivery charges
charges
[Charges ]?
yes
Holds values for delivery charges.
Properties
Type
Nullable
Description
threshold
Double?
yes
The order value below which an extra delivery fee will be applicable
charges
Double?
yes
Delivery amount to be charged when order value is below the defined threshold value
Properties
Type
Nullable
Description
callbackUrl
CallbackUrl ?yes
methods
Methods ?yes
paymentSelectionLock
PaymentSelectionLock ?yes
modeOfPayment
String?
yes
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
String?
yes
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
Bool?
yes
Allow payment option within sales channel
codAmountLimit
Double?
yes
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
codCharges
Double?
yes
Extra charge applicable for COD orders
anonymousCod
Bool?
yes
Allow cash on delivery for anonymous user
Properties
Type
Nullable
Description
app
String?
yes
Payment callback url for app
web
String?
yes
Payment callback url for web
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
defaultOptions
String?
yes
Shows default payment method, e.g. COD
paymentIdentifier
String?
yes
Payment method chosen from default options, e.g. COD
Properties
Type
Nullable
Description
enabled
Bool?
yes
Allow orders to be accepted from the sales channel
forceReassignment
Bool?
yes
Allow force reassigning of an order
message
String?
yes
Reason for reassigning an order
Properties
Type
Nullable
Description
logisticsBySeller
Bool?
yes
serviceabilityCheck
Bool?
yes
sameDayDelivery
Bool?
yes
dpAssignment
Bool?
yes
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows loyalty points is enabled or not enabled
autoApply
Bool?
yes
Allow auto apply of loyalty points
Properties
Type
Nullable
Description
companyName
String?
yes
Name of the company dealing with the brand
companyId
Int?
yes
Numeric ID allotted to a business account
Properties
Type
Nullable
Description
brands
Int
no
Brand UID
searchText
String?
yes
A search field for finding a company by its name
Properties
Type
Nullable
Description
companyId
Int?
yes
Current company ID for current company stores only. Don't send in case cross-selling (franchise) is enabled.
brands
Int
no
Brand UID
searchText
String?
yes
Search store by its name or store code
Properties
Type
Nullable
Description
storeName
String?
yes
Name of the selling location (store)
storeId
Int?
yes
The unique identifier of the selling location (store)
storeType
String?
yes
Store type of the brand like warehouse, high_street, mall
storeCode
String?
yes
Store code of the brand. It is unique for every brand store.
storeAddress
OptedStoreAddress ?yes
company
OptedCompany ?yes
Properties
Type
Nullable
Description
name
String?
yes
Brand name, e.g. Raymonds
value
Int?
yes
Brand UID for identifying the brand
brandLogoUrl
String?
yes
Hosted URL of the brand's logo
brandBannerUrl
String?
yes
Hosted URL of the brand's banner image
brandBannerPortraitUrl
String?
yes
Hosted URL of the brand's portrait banner
Properties
Type
Nullable
Description
message
String?
yes
Response message for failed validation
Properties
Type
Nullable
Description
message
String?
yes
Response message for not found
Properties
Type
Nullable
Description
enabled
Bool?
yes
Check current communication channel is enabled
Properties
Type
Nullable
Description
enabled
Bool?
yes
If pan card accepting is enabled on cart
codThresholdAmount
Double?
yes
On which COD order amount pan card number is expected from customer for order
onlineThresholdAmount
Double?
yes
On which online payment order amount pan card number is expected from customer for order
Properties
Type
Nullable
Description
items
[Application ]?
yes
page
Page ?yes
Properties
Type
Nullable
Description
isActive
Bool?
yes
Indicates the availability of the mobile build
id
String?
yes
The unique identifier (24-digit Mongo Object ID) for mobile application configuration
appName
String?
yes
Name of the mobile app
landingImage
LandingImage ?yes
splashImage
SplashImage ?yes
application
String?
yes
Application ID of the current sales channel
platformType
String?
yes
Device platform for which the mobile app was built, e.g. android, ios.
createdAt
String?
yes
ISO 8601 timestamp of application configuration creation
updatedAt
String?
yes
ISO 8601 timestamp of last known modifications to the app build
v
Int?
yes
Version key for tracking revisions. Default value is zero.
packageName
String?
yes
Shows bundle identifier if device platform is iOS, and directory of the app if device platform is Android
Properties
Type
Nullable
Description
aspectRatio
String?
yes
Width-to-height ratio of landing image
secureUrl
String?
yes
URL where the landing image is hosted
Properties
Type
Nullable
Description
aspectRatio
String?
yes
Width-to-height ratio of splash image
secureUrl
String?
yes
URL where the splash image is hosted
Properties
Type
Nullable
Description
appName
String?
yes
Name of the mobile app
landingImage
LandingImage ?yes
splashImage
SplashImage ?yes
isActive
Bool?
yes
shows update in mobile app config is active or not
Properties
Type
Nullable
Description
versions
BuildVersion ?yes
latestAvailableVersionName
String?
yes
Latest version number of the mobile build, in dot-decimal notation
Properties
Type
Nullable
Description
id
String?
yes
24-digit Mongo Object ID
application
String?
yes
Application ID of the sales channel
platformType
String?
yes
Device platform for which the mobile app was built, e.g. android, ios.
buildStatus
String?
yes
Current progress of the mobile build, e.g. pending, cancelled, failed, success
versionName
String?
yes
Version number of the mobile build, in dot-decimal notation
versionCode
Int?
yes
A positive integer used as an internal version number
createdAt
String?
yes
ISO 8601 timestamp of app creation
updatedAt
String?
yes
ISO 8601 timestamp of last known modifications to the app build
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supportedCurrency
[String]?
yes
application
String?
yes
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
defaultCurrency
DefaultCurrency ?yes
createdAt
String?
yes
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
updatedAt
String?
yes
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Properties
Type
Nullable
Description
ref
String?
yes
The unique identifier (24-digit Mongo Object ID) of the default currency
code
String?
yes
3-character code of the default currency, e.g. INR, EUR, USD
Properties
Type
Nullable
Description
name
String?
yes
Full domain name, e.g. uniket.hostx0.de
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the domain
verified
Bool?
yes
Domain is verified or not (indicates if A records and TXT records are correct)
isPrimary
Bool?
yes
Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)
isShortlink
Bool?
yes
Indicates if the domain is a short link domain (short URL e.g. bitly)
message
String?
yes
Shows the message shown after adding a domain successfully, e.g. 'New domain added successfully'
txtRecords
[String]?
yes
Properties
Type
Nullable
Description
domain
DomainAdd ?yes
Properties
Type
Nullable
Description
name
String?
yes
Full domain name, e.g. newton.com
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
Bool?
yes
Domain is verified or not. TXT and A records should propagate correctly.
isPrimary
Bool?
yes
Domain is primary or not. Primary domain is the default/main domain.
isShortlink
Bool?
yes
Shortlink is present or not for the domain
isPredefined
Bool?
yes
Domain is hosting domain or not.
Properties
Type
Nullable
Description
domains
[Domain ]?
yes
Properties
Type
Nullable
Description
name
String?
yes
Full domain name, e.g. zenz.com
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the domain
verified
Bool?
yes
Domain is verified or not (indicates if A records and TXT records are correct)
isPrimary
Bool?
yes
Domain is primary or not (indicates if the domain has been made the main URL of the sales channel)
isShortlink
Bool?
yes
Indicates if the domain is a short link domain (short URL e.g. bit.ly)
Properties
Type
Nullable
Description
domain
UpdateDomain ?yes
action
String?
yes
Shows domain is made primary domain for the sales channel or shorlink is created for the sales channel domain
Properties
Type
Nullable
Description
domainUrl
String?
yes
URL of the domain, e.g. uniket.hostx0.de
Properties
Type
Nullable
Description
display
String?
yes
Shows TXT record and A records for the domain
status
Bool?
yes
Shows whether TXT record or A records for the domain are correctly propagating via DNS servers
Properties
Type
Nullable
Description
connected
Bool?
yes
Check if domain is live and mapped to appropriate IP of Fynd Servers
status
[DomainStatus ]?
yes
Properties
Type
Nullable
Description
domainUrl
String?
yes
Domain url
custom
Bool?
yes
Get suggestions for custom domains or Fynd domains
Properties
Type
Nullable
Description
name
String
no
URL of the custom domain
unsupported
Bool?
yes
Shows whether TLD domain is supported or not
isAvailable
Bool
no
Shows whether the custom domain of your choice is available or not available
price
Double?
yes
Cost of purchasing a custom domain. Not present for Fynd domains.
currency
String?
yes
Custom domain currency. Not present for Fynd domains.
Properties
Type
Nullable
Description
success
Bool?
yes
Shows whether domain was deleted successfully
message
String?
yes
Success message shown to the user (in a string format)
Properties
Type
Nullable
Description
validators
Validators ?yes
description
String?
yes
Basic description about the opted integration
descriptionHtml
String?
yes
Basic HTML description about the opted integration
constants
String?
yes
companies
[[String: Any]]?
yes
support
[String]?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the opted integration
name
String?
yes
Nmae of the opted integration, e.g. SAP RBL Integration
meta
[IntegrationMeta ]?
yes
icon
String?
yes
Hosted URL of the icon image
owner
String?
yes
The unique identifier (24-digit Mongo Object ID) of the user who created the integration
createdAt
String?
yes
ISO 8601 timestamp of integration creation
updatedAt
String?
yes
ISO 8601 timestamp of integration updation
token
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
secret
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
jsonSchema
[JsonSchema ]?
yes
browserScript
String?
yes
Browser script for the company validator
Properties
Type
Nullable
Description
display
String?
yes
Display text of the validator JSON schema. It will show in the UI.
key
String?
yes
Key related to the display text of the validator JSON schema
type
String?
yes
Indicates the type of form field, e.g. Text, Dropdown.
tooltip
String?
yes
Tooltip text for the UI of the validator JSON schema. It will show in the UI.
Properties
Type
Nullable
Description
jsonSchema
[JsonSchema ]?
yes
browserScript
String?
yes
Browser script for the store validator
Properties
Type
Nullable
Description
jsonSchema
[JsonSchema ]?
yes
browserScript
String?
yes
Browser script for the inventory validator
Properties
Type
Nullable
Description
jsonSchema
[JsonSchema ]?
yes
browserScript
String?
yes
Browser script for the order validator
Properties
Type
Nullable
Description
isPublic
Bool?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the integration meta
name
String?
yes
Nmae of integration meta, e.g. price_level
value
String?
yes
Value related to integration meta name, e.g. store
Properties
Type
Nullable
Description
validators
Validators ?yes
description
String?
yes
Basic description about the integration
descriptionHtml
String?
yes
Basic HTML description about the integration
constants
[String: Any]?
yes
companies
[[String: Any]]?
yes
support
[String]?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the integration
name
String?
yes
Name of the integration, e.g. SAP RBL Integration
meta
[IntegrationMeta ]?
yes
icon
String?
yes
Hosted URL of the icon image
owner
String?
yes
The unique identifier (24-digit Mongo Object ID) of the user who created the integration
createdAt
String?
yes
ISO 8601 timestamp of integration creation
updatedAt
String?
yes
ISO 8601 timestamp of integration updation
token
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
secret
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
opted
Bool?
yes
Shows this integration is opted or not opted for the current company
permissions
[[String: Any]]?
yes
lastPatch
[LastPatch ]?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the integration config
integration
String?
yes
Integration id. Shows which integration you are enabling.
level
String?
yes
Shows for what level the integration is set up. It can be company level or store level.
uid
Int?
yes
It can be store uid or company uid. Depends on the level of integration.
meta
[IntegrationMeta ]?
yes
token
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
createdAt
String?
yes
ISO 8601 timestamp of integration config creation
updatedAt
String?
yes
ISO 8601 timestamp of integration config updation
v
Int?
yes
Version key for tracking revisions. Default value is zero.
data
[String: Any]?
yes
Schema data of the integration stored in key-value pairs
Properties
Type
Nullable
Description
otherOpted
Bool?
yes
Allow user to opt same store in other integration
otherIntegration
IntegrationOptIn ?yes
otherEntity
OtherEntity ?yes
Properties
Type
Nullable
Description
opted
Bool?
yes
Allow other entity opted in integration
permissions
[String]?
yes
lastPatch
[LastPatch ]?
yes
id
String?
yes
The unique identifier of the other entity for opted store integration
integration
String?
yes
Integration ID. Shows which integration you are enabling.
level
String?
yes
Indicates integration level. It can be company level or store level.
uid
Int?
yes
It can be store uid or company uid. Depends on the level of integration.
data
OtherEntityData ?yes
meta
[[String: Any]]?
yes
token
String?
yes
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
createdAt
String?
yes
ISO 8601 timestamp of other entity creation for opted store integration
updatedAt
String?
yes
ISO 8601 timestamp of other entity updation for opted store integration
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
op
String?
yes
path
String?
yes
value
String?
yes
It can be inventory level or order level
Properties
Type
Nullable
Description
articleIdentifier
String?
yes
Properties
Type
Nullable
Description
companyId
String?
yes
Numeric ID allotted to a business account on Fynd Platform.
channelType
String?
yes
It indicates different channel types like store, website-and-mobile-apps. Default value is store
auth
ApplicationAuth ?yes
name
String?
yes
User-friendly name for sales channel, e.g. Zenz Fashion
desc
String?
yes
Detailed description about the sales channel
Properties
Type
Nullable
Description
brand
InventoryBrandRule ?yes
store
InventoryStoreRule ?yes
image
[String]?
yes
franchiseEnabled
Bool?
yes
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
outOfStock
Bool?
yes
Indicates whether out of stock products are allowed to show up on the website.
onlyVerifiedProducts
Bool?
yes
Show only verified products (the ones whose data have been verified by the admin)
payment
InventoryPaymentConfig ?yes
articleAssignment
InventoryArticleAssignment ?yes
Properties
Type
Nullable
Description
name
String?
yes
Domain URL of current sales channel, e.g. zenz.com
Properties
Type
Nullable
Description
uid
Int?
yes
UID of the company, e.g. 108
name
String?
yes
Name of the company, e.g. Newton Traders
companyType
String?
yes
Indicates the type of the company, e.g. franchisee, distributor, etc.
Properties
Type
Nullable
Description
id
String?
yes
The unique identifier of the store (24-digit Mongo Object ID) in the sales channel inventory
modifiedOn
String?
yes
ISO 8601 timestamp of last known updation to the stores in sales channel inventory
uid
Int?
yes
Sales channel inventory store UID
name
String?
yes
Name of the store in the sales channel inventory, e.g. Reebok Mumbai
displayName
String?
yes
Display name of the sales channel inventory store (can be different than the actual store name), e.g. Reebok MUM
storeType
String?
yes
Store type of the sales channel inventory store, such as mall, warehouse, high_street
storeCode
String?
yes
Store code of the enabled inventory store, e.g. HS-c9bac. It is unique for every store.
companyId
Int?
yes
Company ID of the selling location (store) added to the sales channel's inventory
Properties
Type
Nullable
Description
allStores
Bool?
yes
Allow all stores from the ordering stores
deployedStores
[Int]?
yes
q
String?
yes
Store code or name of the ordering store
Properties
Type
Nullable
Description
deployedStores
[Int]?
yes
allStores
Bool?
yes
Allow all stores from the ordering store
enabled
Bool?
yes
Allow ordering stores for current sales channel
type
String?
yes
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the ordering stores
app
String?
yes
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Properties
Type
Nullable
Description
deploymentMeta
DeploymentMeta ?yes
Properties
Type
Nullable
Description
uid
Int
no
Ordering store unique uid. It is required.
Properties
Type
Nullable
Description
uid
Int?
yes
Uid of the seller company
name
String?
yes
Name of the seller company
Properties
Type
Nullable
Description
name
String?
yes
Name of the other seller's sales channel
description
String?
yes
Basic details about the other seller's sales channel
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel
domain
String?
yes
Domain URL of the other seller's sales channel
company
OtherSellerCompany ?yes
optType
String?
yes
Inventory opted by the other seller's sales channel. It can be the current company or stores in the current company.
Properties
Type
Nullable
Description
name
String?
yes
Name of the other seller's sales channel
description
String?
yes
Basic details about the other seller's sales channel
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel
domain
String?
yes
Domain URL of the other seller's sales channel
company
OptedCompany ?yes
optedInventory
OptedInventory ?yes
optOutInventory
OptOutInventory ?yes
Properties
Type
Nullable
Description
uid
Int?
yes
Company UID opted by the other seller's sales channel in its inventory. It has unique value for the company.
name
String?
yes
Name of the company opted by the other seller's sales channel in its inventory
Properties
Type
Nullable
Description
optType
OptType ?yes
items
[String: Any]?
yes
Properties
Type
Nullable
Description
key
String?
yes
Opted type of inventory store. It can be store or company.
display
String?
yes
Display text of opted type for inventory store
Properties
Type
Nullable
Description
name
String?
yes
Name of the inventory store opted by other seller's application
storeCode
String?
yes
Store code of the opted inventory store. It is unique for every store.
id
String?
yes
The unique identifier of the opted inventory store
modifiedOn
String?
yes
ISO 8601 timestamp of opted inventory store creation
uid
Int?
yes
UID of opted inventory store
address
OptedStoreAddress ?yes
displayName
String?
yes
Display name of the opted inventory store
storeType
String?
yes
Store type of the opted inventory store like warehouse, high_street, mall.
companyId
Int?
yes
Company ID of the opted inventory store
Properties
Type
Nullable
Description
store
[Int]
no
List of selling locations (stores) opted out from the inventory of other seller's application
company
[Int]
no
List of companies opted out from the inventory of other seller's application
Properties
Type
Nullable
Description
tokens
Tokens ?yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the token
application
String?
yes
Alphanumeric ID allotted to the current application created within the current business account
createdAt
String?
yes
ISO 8601 timestamp of token creation
updatedAt
String?
yes
ISO 8601 timestamp of token updation
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
credentials
Credentials ?yes
enabled
Bool?
yes
Shows whether Firebase integration is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
ios
Ios ?yes
android
Android ?yes
projectId
String?
yes
Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console.
gcmSenderId
String?
yes
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.
applicationId
String?
yes
Alphanumeric ID allotted to the current application created within the current business account
apiKey
String?
yes
An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase.
Properties
Type
Nullable
Description
applicationId
String?
yes
Alphanumeric ID allotted to a sales channel application created within a business account
apiKey
String?
yes
Firebase secret credential API key for IOS
Properties
Type
Nullable
Description
applicationId
String?
yes
Alphanumeric ID allotted to a sales channel application created within a business account
apiKey
String?
yes
Firebase secret credential API key for Android
Properties
Type
Nullable
Description
credentials
MoengageCredentials ?yes
enabled
Bool?
yes
Shows whether MoEngage integation is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
appId
String?
yes
APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard.
Properties
Type
Nullable
Description
credentials
SegmentCredentials ?yes
enabled
Bool?
yes
Shows whether Segment integration is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
writeKey
String?
yes
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.
Properties
Type
Nullable
Description
credentials
GtmCredentials ?yes
enabled
Bool?
yes
Shows whether GTM integration is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
apiKey
String?
yes
Secret credential API key for GTM
Properties
Type
Nullable
Description
credentials
FreshchatCredentials ?yes
enabled
Bool?
yes
Shows whether Freshchat integration is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
appId
String?
yes
The unique app_id of your Freshchat account for integrating Freshchat with your sales channel
appKey
String?
yes
The unique app_key of your Freshchat account for integrating Freshchat with your sales channel
webToken
String?
yes
Web token used for accessing the Freshchat APIs
Properties
Type
Nullable
Description
credentials
SafetynetCredentials ?yes
enabled
Bool?
yes
Shows whether Safetynet integration is enabled or disabled for the sales channel
Properties
Type
Nullable
Description
apiKey
String?
yes
Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs.
Properties
Type
Nullable
Description
publicKey
String?
yes
Public key for integrating with Fynd rewards.
Properties
Type
Nullable
Description
apiKey
String?
yes
Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API.
Properties
Type
Nullable
Description
credit
Credit ?yes
debit
Debit ?yes
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether reward points should be credited
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether reward points are available for debit
autoApply
Bool?
yes
Allow automatic debit of reward points
strategyChannel
String?
yes
Strategy channel for debiting reward points
Properties
Type
Nullable
Description
similar
[String]?
yes
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
sellerSelection
Bool?
yes
Shows whether the customers can choose the seller on PDP
updateProductMeta
Bool?
yes
Allow user to update product meta. Default value is true.
requestProduct
Bool?
yes
Indicates whether customers can request for a product. Default value is false.
Properties
Type
Nullable
Description
pageType
String?
yes
Type of the launch page
params
[String: Any]?
yes
Launch page params. It can be nullable.
query
[String: Any]?
yes
Query related to launch page. It can be nullable.
Properties
Type
Nullable
Description
launchPage
LaunchPage ?yes
continueAsGuest
Bool?
yes
Shows whether a guest can checkout from cart without logging in
loginBtnText
String?
yes
Shows the text displayed over the login button
showDomainTextbox
Bool?
yes
Shows whether a textbox for entering domain is available
showRegisterBtn
Bool?
yes
Shows whether register button is available in the login/landing page
Properties
Type
Nullable
Description
askStoreAddress
Bool?
yes
Shows whether a form to collect the address of the store, should be displayed upon visiting the website
Properties
Type
Nullable
Description
productDetail
ProductDetailFeature ?yes
landingPage
LandingPageFeature ?yes
registrationPage
RegistrationPageFeature ?yes
homePage
HomePageFeature ?yes
common
CommonFeature ?yes
cart
CartFeature ?yes
qr
QrFeature ?yes
pcr
PcrFeature ?yes
order
OrderFeature ?yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
String?
yes
Application ID of the sales channel
createdAt
String?
yes
ISO 8601 timestamp showing the date when the features were configured
updatedAt
String?
yes
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
v
Int?
yes
Version key for tracking revisions. Default value is zero
Properties
Type
Nullable
Description
orderProcessing
Bool?
yes
Shows whether order processing is enabled or not enabled
Properties
Type
Nullable
Description
visibility
Bool?
yes
Shows whether WhatsApp communication is enabled
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether selection of store (for deploying the application) is permitted
type
String?
yes
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Properties
Type
Nullable
Description
value
String?
yes
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?
yes
Sorting of listing price with min or max value. Default value is min.
Properties
Type
Nullable
Description
value
[String]?
yes
3-letter currency code
type
String?
yes
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
defaultCurrency
String?
yes
3-letter code of the default currency used in the application. Default vaule is 'INR'.
Properties
Type
Nullable
Description
enabled
Bool?
yes
Enable revenue engine. Default value is false.
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether customer feedback is enabled on PDP. Default value is false.
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether product comparison feature is enabled on PDP
Properties
Type
Nullable
Description
gstInput
Bool?
yes
Shows whether customer is allowed to enter GST on the cart page for claiming input credits
staffSelection
Bool?
yes
Shows whether staff selection is enabled on cart page
placingForCustomer
Bool?
yes
Shows whether the staff is placing order on behalf of customer. Default value is true.
googleMap
Bool?
yes
Allow adding of Google Maps. Default value is true.
revenueEngineCoupon
Bool?
yes
Allow coupon apply and credits, together. Default value is false.
Properties
Type
Nullable
Description
application
Bool?
yes
Shows whether sharing of mobile app via QR code is allowed. Default value is false.
products
Bool?
yes
Shows whether sharing product via QR code is allowed. Default value is false.
collections
Bool?
yes
Shows whether sharing collection via QR code is allowed. Default value is false.
Properties
Type
Nullable
Description
staffSelection
Bool?
yes
Allow staff selection. Default value is false.
Properties
Type
Nullable
Description
buyAgain
Bool?
yes
Allow buy again option for order. Default value is false.
Properties
Type
Nullable
Description
feature
AppFeature ?yes
Properties
Type
Nullable
Description
feature
AppFeature ?yes
Properties
Type
Nullable
Description
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
isActive
Bool?
yes
Shows currency is enabled or not in current sales channel
name
String?
yes
Name of the currency, e.g Indian Rupee
code
String?
yes
3-character currency code, e.g. INR, USD, EUR.
createdAt
String?
yes
ISO 8601 timestamp of sales channel support currency creation
updatedAt
String?
yes
ISO 8601 timestamp of sales channel support currency updation
decimalDigits
Int?
yes
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?
yes
Unique symbol for identifying the currency, e.g. ₹
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows whether sales channel website URL is enabled or not
basepath
String?
yes
Base path for the current sales channel website
Properties
Type
Nullable
Description
domains
[String]?
yes
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows sales channel auth is enabled or not enabled.
Properties
Type
Nullable
Description
redirectFrom
String?
yes
Old domain url of the sales channel
redirectTo
String?
yes
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
String?
yes
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Properties
Type
Nullable
Description
name
String?
yes
Indicates to name of application meta
value
String?
yes
Value related to application meta name
Properties
Type
Nullable
Description
secureUrl
String?
yes
Hosted URL of the image
Properties
Type
Nullable
Description
website
ApplicationWebsite ?yes
cors
ApplicationCors ?yes
auth
ApplicationAuth ?yes
description
String?
yes
It contains detailed information about the sales channel.
channelType
String?
yes
It indicates different channel types like store, website-and-mobile-apps. Default value is store
cacheTtl
Int?
yes
An integer value that specifies the number of seconds until the key expires
isInternal
Bool?
yes
Indicates whether a sales channel is internal or not
isActive
Bool?
yes
Indicates sales channel is active or not active
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
String?
yes
Name of the sales channel, e.g. Zenz Fashion
owner
String?
yes
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
companyId
Int?
yes
Numeric ID allotted to a business account where the sales channel exists
token
String?
yes
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
[ApplicationRedirections ]?
yes
meta
[ApplicationMeta ]?
yes
createdAt
String?
yes
ISO 8601 timestamp of sales channel creation
updatedAt
String?
yes
ISO 8601 timestamp of sales channel updation
v
Int?
yes
Version key for tracking revisions. Default value is zero.
banner
SecureUrl ?yes
logo
SecureUrl ?yes
favicon
SecureUrl ?yes
domains
[Domain ]?
yes
appType
String?
yes
It shows application is live or in development mode.
mobileLogo
SecureUrl ?yes
domain
Domain ?yes
slug
String?
yes
Properties
Type
Nullable
Description
message
String?
yes
Error message when request body payload is improper
Properties
Type
Nullable
Description
criteria
String?
yes
Whether all brands are enabled, or explicitly few brands in the inventory
brands
[Int]?
yes
Properties
Type
Nullable
Description
companies
[Int]?
yes
List of company UID
brands
[Int]?
yes
List of brand UID
Properties
Type
Nullable
Description
criteria
String?
yes
Whether all stores are enabled, or explicitly few stores in the inventory, or use brands and company filter.
rules
[StoreCriteriaRule ]?
yes
List of rules with company and brands uids. Used when critera is filter.
stores
[Int]?
yes
List of store uids. Used when critera is explicit.
Properties
Type
Nullable
Description
modeOfPayment
String?
yes
Mode of payment for the inventory of sales channel. It is required and default value is null.
source
String?
yes
Source of the payment mode for the inventory payment of sales channel. Default value is FYND.
Properties
Type
Nullable
Description
enabled
Bool?
yes
Shows store priority is enabled or not enabled for the article assignment.
storetypeOrder
[String]?
yes
Properties
Type
Nullable
Description
postOrderReassignment
Bool?
yes
Allow post order reassigment of article
rules
ArticleAssignmentRule ?yes
Properties
Type
Nullable
Description
type
String
no
Page type
size
Int?
yes
The number of items to retrieve in each page. Default value is 10.
current
Int?
yes
Current page number
hasNext
Bool?
yes
Next page is present or not
itemTotal
Int?
yes
Total number of items to retrieve
nextId
String?
yes
Next page ID
hasPrevious
Bool?
yes
Previous page is present or not
Properties
Type
Nullable
Description
address
InformationAddress ?yes
support
InformationSupport ?yes
socialLinks
SocialLinks ?yes
links
[Links ]?
yes
copyrightText
String?
yes
Copyright statement usually seen at the site's footer
id
String?
yes
Unique identifier (24-digit Mongo Object ID) of the application information
businessHighlights
BusinessHighlights ?yes
application
String?
yes
Alphanumeric ID allotted to a sales channel application created within a business account
createdAt
String?
yes
ISO 8601 timestamp of creation of the application information
updatedAt
String?
yes
ISO 8601 timestamp of updation of the application information
v
Int?
yes
Version key for tracking revisions. Default value is zero.
Properties
Type
Nullable
Description
loc
String?
yes
Co-ordinates of the location
addressLine
[String]?
yes
Contact address of the sales channel
phone
[InformationPhone ]?
yes
city
String?
yes
Name of the city, e.g. Mumbai
country
String?
yes
Name of the country, e.g. India
pincode
Int?
yes
6-digit PIN Code of the city, e.g. 400001
Properties
Type
Nullable
Description
code
String?
yes
Country code for contact number, e.g. +91 (for India)
number
String?
yes
10-digit mobile number
Properties
Type
Nullable
Description
phone
[String]?
yes
email
[String]?
yes
timing
String?
yes
Working hours of support team, e.g. 9 AM to 9 PM
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. Facebook
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Facebook page
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. Instagram
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Instagram page
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. Twitter
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Twitter account
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. Pinterest
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Pinterest page
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. Google+
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Google+ account
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. YouTube
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's YouTube channel
Properties
Type
Nullable
Description
title
String?
yes
Name of the social media platform, e.g. LinkedIn
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's LinkedIn channel
Properties
Type
Nullable
Description
title
String?
yes
Name of the video hosting platform, e.g. Vimeo
icon
String?
yes
Hosted URL of social icon image shown on the website
link
String?
yes
Web URL of brand's Vimeo channel
Properties
Type
Nullable
Description
title
String?
yes
Name of the brand's blog page
icon
String?
yes
Hosted URL of icon image shown on the website
link
String?
yes
Web URL of brand's blog page
Properties
Type
Nullable
Description
title
String?
yes
Name of the related page or link
link
String?
yes
Web URL for redirecting to a related page
Properties
Type
Nullable
Description
id
String?
yes
Unique identifier (24-digit Mongo Object ID) of the related business
title
String?
yes
Title of the business highlight, e.g. Superfast Delivery
icon
String?
yes
Hosted URL of icon image representing the business highlight
subTitle
String?
yes
Detailed information about the highlight
Properties
Type
Nullable
Description
name
String
no
Name of the sales channel. It is required.
description
String?
yes
It gives a detailed information about the sales channel. It is required.
logo
SecureUrl ?yes
mobileLogo
SecureUrl ?yes
favicon
SecureUrl ?yes
banner
SecureUrl ?yes
domain
Domain ?yes
domains
[Domain ]?
yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) for the sales channel details
Properties
Type
Nullable
Description
items
[Currency ]?
yes
Properties
Type
Nullable
Description
application
String?
yes
Alphanumeric ID allotted to an application (sales channel website) created within a business account
defaultCurrency
DefaultCurrency ?yes
supportedCurrency
[Currency ]?
yes
Properties
Type
Nullable
Description
type
String?
yes
Coordinates type of the opted store
coordinates
[Double]?
yes
Properties
Type
Nullable
Description
state
String?
yes
State of the opted store, e.g. Maharashtra
address1
String?
yes
Address of the opted store
latLong
StoreLatLong ?yes
address2
String?
yes
Address of the opted store
pincode
Int?
yes
6-digit PIN code of the opted store location
country
String?
yes
Country of the opted store, e.g. India
city
String?
yes
City of the opted store, e.g. Mumbai
Properties
Type
Nullable
Description
address
OptedStoreAddress ?yes
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the ordering store
uid
Int?
yes
Ordering store UID
name
String?
yes
Store name of the ordering store
displayName
String?
yes
Display name of the ordering store
storeType
String?
yes
Store type of the ordering store, e.g. high_street, mall, warehouse
storeCode
String?
yes
Store code of the ordering store, e.g. MUM-102
pincode
Int?
yes
6-digit PIN Code of the ordering store, e.g. 400001
code
String?
yes
Code of the ordering store (usually same as Store Code)
Properties
Type
Nullable
Description
page
Page ?yes
items
[OrderingStore ]?
yes
deployedStores
[Int]?
yes
allStores
Bool?
yes
Allow all stores of the ordering stores
enabled
Bool?
yes
Allow ordering stores for current sales channel
type
String?
yes
For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
id
String?
yes
The unique identifier (24-digit Mongo Object ID) of the ordering store
app
String?
yes
Alphanumeric ID allotted to an application (sales channel website) created within a business account
v
Int?
yes
Version key for tracking ordering stores. Default value is zero.