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.

Domain

A unique string that represents the address of a fynd store on the Internet. Check the availability of a domain name for registration and pre-defined custom domain is supported. Domain resource is responsible for managing all domain-related operations within the sales channel. It includes functionalities such as adding and removing domains, changing domain types, and checking the active status of domains.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
# List domains
GET

List domains

Retrieve a list of existing domains by its sales channel.
Parameters
company_idpath
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_idpath
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
Loading...
Response
200
Success
Hide
domains
array of object (Domain)
Show
Examples
Parameters
company_id:
2
application_id:
"000000000000000000000001"
Response
Loading...

Product Listing Configuration

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
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
# Get inventory configuration
GET

Get inventory configuration

Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
company_idpath
integer
Required
Numeric ID allotted to a business account on Fynd Platform
application_idpath
string
Required
Alphanumeric ID allotted to an application (sales channel website) created within a business account
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
200
404
Success
Hide
search
object (SearchConfig)
Show
inventory
object (AppInventoryConfig)
Show
authentication
object (AuthenticationConfig)
Show
article_assignment
object (ArticleAssignmentConfig)
Show
reward_points
object (RewardPointsConfig)
Show
cart
object (AppCartConfig)
Show
payment
object (AppPaymentConfig)
Show
order
object (AppOrderConfig)
Show
logistics
object (AppLogisticsConfig)
Show
pii_masking
object (PiiMasking)
Show
channel_capabilities
object (ChannelCapabilities)
Show
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)
Show
platforms
array of string
_id
string
The unique identifier of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
Show
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"
Response
Loading...