Configuration
Application configuration apis
Perform various actions related to application management, including creating applications, retrieving application details, and getting a list of applications.
Operations
POST
# Create application.
GET
# Get applications.
Generate and add a new application. Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Request body
app
object (App)
App
company_id
string
Numeric ID allotted to a business account on Fynd Platform.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
name
string
User-friendly name for sales channel, e.g. Zenz Fashion
desc
string
Detailed description about the sales channel
configuration
object (ApplicationInventory)
ApplicationInventory
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
domain
object (AppDomain)
AppDomain
name
string
Domain URL of current sales channel, e.g. zenz.com
Response
200
400
Success
CreateAppResponseSchema
app
object (Application)
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
configuration
object (ApplicationInventory)
ApplicationInventory
inventory
object (AppInventoryConfig)
AppInventoryConfig
brand
object (InventoryBrand)
InventoryBrand
criteria
string
All brands or specific (explicit) brands to be shown on the website
brands
array of integer
List of brands
store
object (InventoryStore)
InventoryStore
criteria
string
All stores or specific (explicit) stores to be shown on the website
stores
array of integer
List of stores
rules
array of object (AppStoreRules)
Rules to show which brands or companies products should be listed on sales channel.
Array of AppStoreRules
companies
array of integer
List of companies whose inventory is available to the sales channel for displaying on the website
brands
array of integer
List of brands whose products will be shown on the website
category
object (InventoryCategory)
InventoryCategory
criteria
string
categories
array of integer
List of categories whose products will be shown on the website
price
object (InventoryPrice)
InventoryPrice
min
number
| float
Minimum inventory price
max
number
| float
Maximum inventory price
discount
object (InventoryDiscount)
InventoryDiscount
min
number
| float
Minimum inventory discount
max
number
| float
Maximum inventory discount
pricing_strategy
object (PricingStrategy)
PricingStrategy
value
string
Indicates the pricing strategy value.
Enum
out_of_stock
boolean
Indicates whether out of stock products are allowed to show up on the website
only_verified_products
boolean
Show only verified products (the ones whose data has been verified by the admin)
franchise_enabled
boolean
Allow other businesses (companies) to consume the current sales channel's inventory and sell products
exclude_category
array of integer
List of excluded brands category
image
array of string
Enum
company_store
array of integer
List of selling locations whose inventory is available to the sales channel for displaying on the website
company_id
integer
authentication
object (AuthenticationConfig)
AuthenticationConfig
required
boolean
Shows sales channel inventory authentication is required or not
provider
string
Shows inventory authentication provider
article_assignment
object (ArticleAssignmentConfig)
ArticleAssignmentConfig
rules
object (ArticleAssignmentRules)
ArticleAssignmentRules
store_priority
object (StorePriority)
StorePriority
enabled
boolean
Shows store priority is enabled or disabled for assignment of article
storetype_order
array of integer
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Create application.
createApplication
Retrieve a list of available applications. 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
page_no
integer
page_size
integer
q
string
Search param by name or domain
Response
200
success
ApplicationsResponseSchema
items
array of object (Application)
Array of Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not
basepath
string
Base path for the current sales channel website
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store
Enum
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Indicates whether a sales channel is internal or not
is_active
boolean
Indicates sales channel is active or not active
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Name of the sales channel, e.g. Zenz Fashion
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
Array of ApplicationMeta
name
string
Indicates to name of application meta
value
string
Value related to application meta name
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domains
array of object (Domain)
Array of Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image
domain
object (Domain)
Domain
name
string
Full domain name, e.g. newton.com
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain
is_predefined
boolean
Domain is hosting domain or not.
message
string
slug
string
mode
string
status
string
tokens
array of object (TokenSchema)
Array of TokenSchema
token
string
created_by
object
created_at
string
| date-time
ISO 8601 timestamp of when token created
secret
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
Was this section helpful?
GET
Response
Get applications.
getApplications
Retrieve brands associated with a company, get the company linked to specific brands, and find stores associated with particular brands.
Operations
GET
# Get brands by company.
POST
# Get company by brands.
POST
# Get stores by brand uids for the current company
Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
q
string
Search text for brand name
Response
200
Success
BrandsByCompanyResponseSchema
brands
array of object (CompanyBrandInfo)
Array of CompanyBrandInfo
name
string
Brand name, e.g. Raymonds
value
integer
| int32
Brand UID for identifying the brand
brand_logo_url
string
Hosted URL of the brand's logo
brand_banner_url
string
Hosted URL of the brand's banner image
brand_banner_portrait_url
string
Hosted URL of the brand's portrait banner
Examples
Parameters
company_id:
2
Was this section helpful?
GET
Response
Get brands by company.
getBrandsByCompany
Retrieve companies associated with specific brands. Retrieve a list of companies by the brands they deal.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Request body
brands
integer
| int32
Required
Brand UID
search_text
string
A search field for finding a company by its name
Response
200
Success
CompanyByBrandsResponseSchema
items
array of object (BrandCompanyInfo)
Array of BrandCompanyInfo
company_name
string
Name of the company dealing with the brand
company_id
integer
| int32
Numeric ID allotted to a business account
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Get company by brands.
getCompanyByBrands
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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Request body
company_id
integer
| int32
Current company ID for current company stores only. Don't send in case cross-selling (franchise) is enabled.
brands
integer
| int32
Required
Brand UID
search_text
string
Search store by its name or store code
Response
200
Success
StoreByBrandsResponseSchema
items
array of object (BrandStoreInfo)
Array of BrandStoreInfo
store_name
string
Name of the selling location (store)
store_id
integer
| int32
The unique identifier of the selling location (store)
store_type
string
Store type of the brand like warehouse, high_street, mall
Enum
store_code
string
Store code of the brand. It is unique for every brand store.
store_address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
company
object (OptedCompany)
OptedCompany
uid
integer
| int32
Company UID opted by the other seller's sales channel in its inventory. It has unique value for the company.
name
string
Name of the company opted by the other seller's sales channel in its inventory
id
integer
The unique identifier of the opted inventory company
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Get stores by brand uids for the current company
getStoreByBrands
Retrieve information about companies and stores associated with your application. Access details such as company profiles and store data for your application's functionality.
Operations
GET
# Get countries, states, cities
GET
# Get stores by company
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
location_type
string
Provide location type to query on. Possible values : country, state, city
Enum
id
string
Field is optional when location_type is country. If querying for state, provide id of country. If querying for city, provide id of state.
Response
200
Success
Locations
items
array of object (LocationCountry)
Array of LocationCountry
capital
string
currency
string
iso2
string
iso3
string
name
string
parent
string
| nullable
phone_code
string
type
string
uid
integer
| int32
__v
integer
| int32
_id
string
default_currency
object (LocationDefaultCurrency)
LocationDefaultCurrency
name
string
symbol
string
code
string
default_language
object (LocationDefaultLanguage)
LocationDefaultLanguage
name
string
code
string
state_code
string
country_code
string
latitude
string
longitude
string
Examples
Parameters
company_id:
2
location_type:
"state"
Was this section helpful?
GET
Response
Get countries, states, cities
getLocations
Retrieves All the stores that belong to a particular company with desired pagination
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
company
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Response
200
Successful response
ListStoreResponseSchemaSchema
stores
array of object (AppInventoryStores)
Array of AppInventoryStores
_id
string
The unique identifier of the store (24-digit Mongo Object ID) in the sales channel inventory
modified_on
string
| date-time
ISO 8601 timestamp of last known updation to the stores in sales channel inventory
uid
integer
| int32
Sales channel inventory store UID
name
string
Name of the store in the sales channel inventory, e.g. Reebok Mumbai
display_name
string
Display name of the sales channel inventory store (can be different than the actual store name), e.g. Reebok MUM
store_type
string
Store type of the sales channel inventory store, such as mall, warehouse, high_street
Enum
store_code
string
Store code of the enabled inventory store, e.g. HS-c9bac. It is unique for every store.
company_id
integer
| int32
Company ID of the selling location (store) added to the sales channel's inventory
address
object
integration_type
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
company:
2
Was this section helpful?
GET
Response
Get stores by company
getStoresForACompany
Operations
GET
# Get currencies.
POST
# Get currencies.
GET
# Get currencies.
PUT
# Get currencies.
GET
# Get currency exchange rates
Retrieve a list of available currencies. 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Response
200
Currencies Success response
CurrenciesResponseSchema
items
array of object (Currency)
Array of Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Examples
Parameters
company_id:
2
Was this section helpful?
GET
Response
Get currencies.
getCurrencies
Retrieve a list of available currencies. 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Request body
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Response
200
Currencies Success response
Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Get currencies.
createCurrency
Retrieve a list of available currencies. 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
id
string
Required
Unique object Id of the curreny
Response
200
Currencies Success response
Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Examples
Parameters
company_id:
2
id:
"5ec75d11f7bfb54d798f3516"
Was this section helpful?
GET
Response
Get currencies.
getCurrency
Retrieve a list of available currencies. 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
id
string
Required
Unique object Id of the curreny
Request body
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Response
200
Currencies Success response
Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Shows currency is enabled or not in current sales channel
name
string
Name of the currency, e.g Indian Rupee
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹
country_name
string
subunit
string
country_code
string
Examples
Parameters
company_id:
2
id:
"5ec75d11f7bfb54d798f3516"
body:
body
Was this section helpful?
PUT
Response
Get currencies.
updateCurrency
Retrieve a list of currency exchange rates, relative to a provided currency.
Parameters
currency_code
string
The 3-letter ISO 4217 code representing the base currency for the exchange rates. Defaults to "INR" if not specified.
Default Value : INR
exchange_currency_code
string
A 3-letter ISO 4217 currency code for which exchange rates against the base currency are requested.
exchange_country_code
string
The country code for which exchange rates against the base currency are requested.
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Response
200
422
Successful response
CurrencyExchangeResponseV2
base
string
The 3-letter ISO 4217 code representing the base currency.
base_currency_name
string
The name of the base currency.
ttl_seconds
integer
Time in seconds for which the exchange rates are valid.
items
array of object (CurrencyExchangeItem)
List of exchange rates and currency details.
Array of CurrencyExchangeItem
currency_code
string
3-letter ISO 4217 exchange currency code.
name
string
Name of the exchange currency
rate
number
| float
Exchange rate of the currency with respect to the base currency.
country_code
string
ISO 3166 country code.
country_name
string
Name of the country using this currency.
subunit
string
The name of the subunit for the currency.
decimal_digits
integer
Number of decimal digits the currency supports.
symbol
string
The symbol of the currency.
total
integer
Total number of currency exchange items.
Examples
Parameters
currency_code:
"INR"
exchange_currency_code:
"AED"
exchange_country_code:
"AE"
company_id:
2
Was this section helpful?
GET
Response
Get currency exchange rates
getCurrencyExchangeRates
Check the availability of a domain name for registration and pre-defined custom domain is supported.
Operations
POST
# Get domain availability.
Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Request body
domain_url
string
Domain url
is_custom_domain
boolean
Get suggestions for custom domains or Fynd domains
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Success
DomainSuggestionsResponseSchema
domains
array of object (DomainSuggestion)
Domain URL
Array of DomainSuggestion
name
string
URL of the custom domain
unsupported
boolean
Shows whether TLD domain is supported or not
is_available
boolean
Shows whether the custom domain of your choice is available or not available
price
number
Cost of purchasing a custom domain. Not present for Fynd domains.
currency
string
Custom domain currency. Not present for Fynd domains.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
Get domain availability.
getDomainAvailibility
Handle domain-related operations, including getting domains, adding domains, removing domains by ID, changing domain types, and checking domain status.
Operations
GET
# Get domain options
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
Response
200
Successful response
DomainOptionsResponseSchema
domain_types
array of object (DomainType)
Array of DomainType
key
string
display
string
values
array of object (DomainValue)
Array of DomainValue
value
string
text
string
network_ips
array of string
network_cnames
array of string
Examples
Parameters
company_id:
2
Was this section helpful?
GET
Response
Get domain options
getDomainOptions
Obtain a list of other seller applications, access details of a specific application, and opt out of using a particular application.
Operations
GET
# Get other seller applications.
GET
# Get other seller application by ID.
PUT
# Opt out from an application.
Retrieve applications from other sellers. Retrieve all other seller applications that were not created within the current company. but have opted for the current company's inventory.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
OtherSellerApplications
items
array of object (OtherSellerApplication)
Array of OtherSellerApplication
name
string
Name of the other seller's sales channel
description
string
Basic details about the other seller's sales channel
_id
string
The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel
domain
string
Domain URL of the other seller's sales channel
company
object (OtherSellerCompany)
OtherSellerCompany
uid
integer
| int32
Uid of the seller company
name
string
Name of the seller company
opt_type
string
Inventory opted by the other seller's sales channel. It can be the current company or stores in the current company.
Enum
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
2
Was this section helpful?
GET
Response
Get other seller applications.
getOtherSellerApplications
Retrieve details of a seller application that was not created within the current company. but has opted for the current company's inventory
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
app_id
string
Required
Application Id
Response
200
404
Success
OptedApplicationResponseSchema
name
string
Name of the other seller's sales channel
description
string
Basic details about the other seller's sales channel
_id
string
The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel
domain
string
Domain URL of the other seller's sales channel
company
object (OptedCompany)
OptedCompany
uid
integer
| int32
Company UID opted by the other seller's sales channel in its inventory. It has unique value for the company.
name
string
Name of the company opted by the other seller's sales channel in its inventory
id
integer
The unique identifier of the opted inventory company
opted_inventory
object (OptedInventory)
OptedInventory
opt_type
object (OptType)
OptType
key
string
Opted type of inventory store. It can be store or company.
display
string
Display text of opted type for inventory store
items
array of object (OptedStore)
oneOf Schema from below
Array of OptedStore
name
string
Name of the inventory store opted by other seller's application
store_code
string
Store code of the opted inventory store. It is unique for every store.
_id
string
The unique identifier of the opted inventory store
modified_on
string
| date-time
ISO 8601 timestamp of opted inventory store creation
uid
integer
| int32
UID of opted inventory store
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra
address1
string
Address of the opted store
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store
coordinates
array of number
address2
string
Address of the opted store
pincode
string
6-digit PIN code of the opted store location
country
string
Country of the opted store, e.g. India
city
string
City of the opted store, e.g. Mumbai
sector
string
Sector for the opted store.
country_code
string
Country code of the selected country
state_code
string
Selected state code
landmark
string
Landmark of the address
display_name
string
Display name of the opted inventory store
store_type
string
Store type of the opted inventory store like warehouse, high_street, mall.
Enum
company_id
integer
| int32
Company ID of the opted inventory store
Array of OptedCompany
uid
integer
| int32
Company UID opted by the other seller's sales channel in its inventory. It has unique value for the company.
name
string
Name of the company opted by the other seller's sales channel in its inventory
id
integer
The unique identifier of the opted inventory company
opt_out_inventory
object (OptOutInventory)
OptOutInventory
store
array of integer
List of selling locations (stores) opted out from the inventory of other seller's application
company
array of integer
List of companies opted out from the inventory of other seller's application
Examples
Parameters
company_id:
2
app_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get other seller application by ID.
getOtherSellerApplicationById
Choose 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.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
app_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
Request body
store
array of integer
Required
List of selling locations (stores) opted out from the inventory of other seller's application
company
array of integer
Required
List of companies opted out from the inventory of other seller's application
Response
200
400
404
Success
SuccessMessageResponseSchema
success
boolean
Shows whether domain was deleted successfully
message
string
Success message shown to the user (in a string format)
Examples
Parameters
company_id:
2
app_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response