Configuration
The Configuration service handles settings for currency, sales channels, application stores, languages, staff users, brands, build configurations, and more, offering comprehensive customization options for the platform.
The product listing configuration oversees the management of product configuration tasks within the sales channel. It empowers users to define multiple aspects, such as determining the availability of products from specific brands, stores, or companies for sale. Product Listing Configurstion can also choose to list only in-stock products and set criteria for including products with images in the sales channel promotions offerings.
Operations
GET
# Get inventory configuration
Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_id
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
Response
200
404
Success
ApplicationInventory
search
object (SearchConfig)
SearchConfig
fst_identification
object (FstIdentification)
FstIdentification
enabled
boolean
Indicates whether FST identification is enabled for the application.
Default Value : false
query_suggestions
object (QuerySuggestions)
QuerySuggestions
enabled
boolean
Indicates whether query suggestions are enabled.
Default Value : false
max_limit
integer
Specifies the maximum number of query suggestions that can be returned.
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 Undefined Type
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 Undefined Type
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
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 object
List of excluded brands category
image
array of string
Enum
company_store
array of Undefined Type
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 Undefined Type
List of store types for article assignment e.g. warehouse, mall, highstreet
post_order_reassignment
boolean
Allow post order reassigment of article
enforced_stores
array of integer
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit
auto_apply
boolean
Allow automatic debit of reward points
strategy_channel
string
Strategy channel for debiting reward points
cart
object (AppCartConfig)
AppCartConfig
delivery_charges
object (DeliveryCharges)
DeliveryCharges
enabled
boolean
Allow delivery charges
charges
array of object (Charges)
Holds values for delivery charges.
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
international_delivery_charges
object (InternationalDeliveryCharges)
InternationalDeliveryCharges
enabled
boolean
Allow international delivery charges
charges
array of object (Charges)
Array of Charges
threshold
number
| float
The order value below which an extra delivery fee will be applicable
charges
number
| float
Delivery amount to be charged when order value is below the defined threshold value
enabled
boolean
Shows whether cart configuration is enabled or not
max_cart_items
integer
| int32
Maximum number of items that can be added to cart by the customer
min_cart_value
number
| float
Minimum cart value below which customer cannot place an order
bulk_coupons
boolean
Allow creation of bulk coupons
revenue_engine_coupon
boolean
Allow coupon apply and credits together. Default value is false.
pan_card
object (PanCardConfig)
PanCardConfig
enabled
boolean
If pan card accepting is enabled on cart
cod_threshold_amount
number
On which COD order amount pan card number is expected from customer for order
online_threshold_amount
number
On which online payment order amount pan card number is expected from customer for order
payment
object (AppPaymentConfig)
AppPaymentConfig
callback_url
object (CallbackUrl)
CallbackUrl
app
string
Payment callback url for app
web
string
Payment callback url for web
methods
object (Methods)
Methods
pl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
card
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
nb
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
wl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
ps
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
upi
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
qr
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
cod
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
pac
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
fc
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
jiopp
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
stripepg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
juspaypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payubizpg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payumoneypg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
rupifipg
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
simpl
object (PaymentModeConfig)
PaymentModeConfig
enabled
boolean
Shows if a given payment method is enabled or not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Shows whether payment mode is restricted to a specific option, e.g. 'HDFC Netbanking'
default_options
string
Shows default payment method, e.g. COD
payment_identifier
string
Payment method chosen from default options, e.g. COD
mode_of_payment
string
Mode of payment for sales channel payment, e.g. 'ECOMM'.
source
string
Source of the payment mode, e.g. 'ECOMM'. Default value is FYND.
enabled
boolean
Allow payment option within sales channel
cod_amount_limit
number
| float
Maximum amount allowed for COD order. Beyond this, customer cannot opt for COD.
cod_charges
number
| float
Extra charge applicable for COD orders
anonymous_cod
boolean
Allow cash on delivery for anonymous user
user_cod_limit
number
| float
order
object (AppOrderConfig)
AppOrderConfig
enabled
boolean
Allow orders to be accepted from the sales channel
force_reassignment
boolean
Allow force reassigning of an order
message
string
Reason for reassigning an order
logistics
object (AppLogisticsConfig)
AppLogisticsConfig
logistics_by_seller
boolean
serviceability_check
boolean
same_day_delivery
boolean
dp_assignment
boolean
pii_masking
object (PiiMasking)
PiiMasking
enabled
boolean
Default Value : false
tags
array of string
__v
integer
business
string
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
CommunicationConfig
email
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
sms
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
voice
object (CommsConfig)
CommsConfig
enabled
boolean
Check current communication channel is enabled
platforms
array of string
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
LoyaltyPointsConfig
enabled
boolean
Shows loyalty points is enabled or not enabled
auto_apply
boolean
Allow auto apply of loyalty points
app
string
Current sales channel ID
created_at
string
| date-time
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
| date-time
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response