Platform REST API
Introduction
Change Log
GETObtain charge details
GETRetrieve subscription charge details
POSTCancel the extension subscription
POSTGenerate a one-time charge
POSTInitiate subscription billing
GETList categories.
GETGet category data.
GETGet tags associated with locations for a company.
POSTAdd, update or remove holiday for a location
GETList data export jobs
POSTCreate data export job
GETGet data export job status
GETGet company metrics.
GETGet support representative's associated to a company
GETGet company verification status
GETGet company product count
GETGet seller insights.
POSTCreate a product bundle.
GETRetrieve product bundles.
GETGet product bundle details.
PUTUpdate a product bundle.
GETRetrieve inventories.
GETRetrieve inventory bulk upload history.
POSTCreate bulk inventory upload job.
DELDelete inventory bulk upload job.
POSTCreate bulk inventory.
POSTCreate inventory export job.
GETRetrieve inventory export data.
PATCHEdit notification_emails and status of export job.
GETGet Detail Product export detail.
PUTEdit notification_emails and status of export job.
GETGet Detail Product export detail.
GETExport inventory configuration.
GETGet product attributes.
GETRetrieve product assets in bulk.
POSTCreate product assets in bulk.
GETList HSN codes.
GETGet product tags.
GETGet product validation.
GETGet inventory by size identifier.
GETGet product size details.
DELDelete product size.
GETGet inventory by size.
GETGet variants of products.
GETGet company verification status
GETGet the verification detail of a product
GETGet variant type list
GETGet all product HSN codes.
GETGet single product HSN code.
GETList inventory exports.
POSTCreate inventory export.
GETRetrieve products.
POSTCreate a product.
POSTUpload bulk products.
GETRetrieve product export jobs.
POSTCreate product export job.
GETGet all product sizes.
DELDelete realtime inventory.
POSTUpdate realtime inventory.
GETRetrieve product bulk upload history.
POSTCreate a Bulk product to upload job.
DELDelete product bulk upload job.
POSTCreate products in bulk.
GETGet product details.
PUTEdit a product.
DELDelete a product.
GETValidate product template
GETValidate product template
GETList department data.
GETGet department data.
GETList template brand type values.
GETDownload inventory template view.
GETValidate product template schema.
GETList product templates.
GETList product template categories.
GETDownload product template views.
GETUpdate marketplace optin
POSTCreate a size guide.
GETRetrieve size guides.
GETGet size guide details.
PUTUpdate a size guide.
GETGet attribute detail by slug
GETGet the Company Brand details of Optin.
GETGet the Company details.
GETGet the Store details.
GETList all marketplaces
PUTUpdate marketplace optin
POSTUpdate marketplace optin
GETGet system notifications.
GETGet company profile
PATCHEdit company profile
GETGet a single company brand.
PUTEdit a brand.
POSTCreate a Brand.
GETGet brands associated to a company
POSTCreate a location associated to a company.
GETGet details of a specific location.
PUTEdit a location asscoiated to a company.
POSTCreate a location asscoiated to a company in bulk.
GETGet tags associated with locations for a company.
POSTCreate application.
GETGet applications.
GETGet brands by company.
POSTGet company by brands.
POSTGet stores by brand uids for the current company
GETGet countries, states, cities
GETGet stores by company
GETGet currencies.
POSTGet currencies.
GETGet currencies.
PUTGet currencies.
GETGet currency exchange rates
POSTGet domain availability.
GETGet domain options
GETGet other seller applications.
GETGet other seller application by ID.
PUTOpt out from an application.
GETGet custom field types
GETGet resources
GETGet custom fields definitions
GETGet custom fields definitions for a given resource type
POSTCreate custom field definition for a given resource type
GETGet custom fields definition by resource, slug and namespace
PUTUpdate custom field definition
DELDelete custom fields definition
GETGet list of custom fields of given resource and resource slug
PUTUpdate custom field entries for gives resource and resource slug
POSTCreate custom object definition
GETGet custom object definitions
GETGet custom object definition
PUTUpdate custom object definition
DELDelete custom object definition
GETGet list of custom objects under a certain custom object definition
POSTCreate custom object entries
GETGet custom object details
DELDelete custom object
PUTUpdate custom object details
GETGet bulk import and export job list
POSTBulk custom object entries upload
GETInitiate download for bulk custom object entries
GETDownload sample for custom object bulk entry
GETDownload discount sample file (V2).
POSTUpload discount file (V2).
GETGet discount file job (V2).
DELCancel discount file job (V2).
GETGet discount file jobs (V2).
PATCHUpdate discount job items (V2).
POSTCreate discount (V2).
GETGet discounts (V2).
GETGet discount by ID (V2).
PUTUpdate discount (V2).
PUTBulk update discount jobs (V2).
GETBrowse files.
POSTCopy files.
POSTStart file upload.
POSTComplete file upload.
POSTGet signed URLs.
POSTUpdate inventories.
GETGet general configuration
GETList tickets
POSTCreate ticket
GETGet a ticket
PUTUpdate a ticket
POSTCreate ticket history
GETGet ticket history
GETGet reasons behind full or partial cancellation of a shipment
GETget Manifest Filters.
GETGet announcements.
PUTUpdate an order
GETGet failed order logs according to the filter provided
GETGet failed order logs according to the filter provided
GETGet role-based actions.
POSTVerify the current status of an order.
POSTCreate order.
PUTEnables the updating of various order properties, including tax_details, meta, and more, providing flexibility and precision in order adjustments.
GETGet order by ID.
GETGet lane configuration.
GETGet orders.
PUTUpdate User view(Parent view and child view) position
GETGet custom view for every unique user cross company pair.
POSTAdd custom view for every unique user cross company pair.
PUTUpdate custom view for every unique user cross company pair.
DELDelete custom view for every unique user cross company pair.
GETGet global filters for populating filter listing and powering views api.
GETGet filters.
GETGet the Order Configuration for the application.
POSTUpdate/Insert the Order Configuration for the application.
GETGet total count.
POSTCreate Order Replacement
POSTAllows esm config updation
GETRetrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
POSTConfigure refund state rules by category path and payment type.
GETGet refund configuration by app and payment type
GETRefund State Configurationb
POSTrefund configuration.
GETrefund configuration.
GETRetrieve refund options with amount breakup for specific shipment and bags.
POSTFetch credit balance detail.
POSTFetch refund mode config.
POSTReassign location.
GETClick to call.
PUTUpdate shipment status.
GETGet shipment history.
POSTPost shipment history.
POSTSend SMS via Ninja.
POSTUpdate packaging dimensions.
GETGet state transition map.
POSTAttach order user.
POSTSend user mobile OTP.
POSTVerify Mobile OTP
POSTDownloads lanes shipment/orders.
GETFetches details for the job of the provided batch_id
GETGet the file download URL used for performing bulk operation
POSTRetry e-invoice after failure
GETRetrieve courier partner tracking details for a given shipment id or awb no.
POSTUpdate shipment tracking.
POSTUpdate shipment lock.
PUTUpdate shipment status.
POSTConsolidates multiple shipments into a single shipment, optimizing logistics and delivery handling.
GETList shipments
GETGet shipment details
GETGet bulk shipment Excel file.
GETGet bulk action template.
GETDownload bulk action template.
GETGenerate POS receipt by order ID.
GETGets All the allowed Templates to perform Bulk Operations.
GETGet the Excel or CSV file URL for the Template.
PUTUpdate payout.
PATCHActivate/Deactivate payout.
DELDelete payout.
GETGet All Payouts
POSTSave Payout
GETList Payment Method Configs
GETGet Localities by Name Prefix
GETGet Locality API
GETGet Localities.
GETGet single country and associated data.
GETGet all countries and associated data.
POSTValidate given address wrt template
POSTServiceability Import or Export
GETGet Region Serviceability Bulk History
POSTSample File Download
GETGet Serviceability TAT sample files generator status
POSTRegion TAT Import or Export
GETGet region tat bulk history
PATCHUpdate Company Self Ship
GETUpdate Company Self Ship
POSTCreate Scheme for courier partner extension
PUTUpdate Scheme for courier partner extension
POSTCreate courier account
GETList courier accounts
PUTUpdate courier account
GETGet courier account
PUTUpdate delivery configuration
GETGet delivery configuration
GETFetching of Package Material Rules from database.
POSTCreate packaging material
GETGet packaging materials
POSTCreate packaging rule
GETFetching of Package Material Rule from database.
GETFetching of Package Material Rules from database.
GETGet packaging material rule
PATCHUpdate packaging rule
DELDelete packaging material rule
PATCHUpdate packaging material
GETGet packaging material
DELDelete packaging material
POSTDisable recommendation for a category.
GETList categories with recommendation disabled.
POSTRe-enable recommendation for a category.
PUTSet order history retention period.
GETGet order history retention period.
POSTCreate size chart data record.
GETList size chart data records.
GETGet form schema for a category.
GETGet measurement type configs for a category.
GETGet fit type configs for a category.
GETGet attribute configs for a category.
POSTDownload bulk upload template.
GETValidate bulk upload template columns.
POSTSubmit bulk upload job.
GETList bulk jobs for size chart data.
GETGet bulk job error file.
GETGet bulk job status.
POSTDownload bulk delete template.
POSTSubmit bulk delete job.
GETGet size chart data record.
PATCHUpdate size chart data record.
DELDelete size chart data record.
POSTCreate template config.
GETList template configs.
GETValidate template config bulk upload columns.
POSTDownload template config bulk upload template.
PUTBulk update template config status.
DELBulk delete template configs.
POSTSubmit template config bulk upload job.
GETList template config bulk jobs.
GETGet template config bulk job error file.
GETGet template config bulk job status.
DELCancel template config bulk job.
GETGet template config by ID.
PUTUpdate template config.
DELDelete template config.
GETGet default marketplace theme.
POSTRegister Subscriber.
PUTUpdate Subscriber.
GETList subscribers by company
PUTRegister Subscriber.
GETGet a subscriber
GETList subscribers by extension ID
GETList attribute definitions
POSTCreate attribute definition
GETGet attribute definition
PUTUpdate attribute definition
DELDelete attribute definition
PATCHBulk update attributes
GETList user attributes
GETGet user attribute by definition
PUTCreate or update user attribute
DELDelete user attribute
GETList group tags
GETList group categories
GETList groups by category
GETList groups
POSTCreate group
GETGet group by id
PUTUpdate group (full replace)
PATCHPatch group
DELDelete group
GETList users in group
POSTRefresh total users
GETGet promotion and coupon type
GETGet cart meta configuration by id
PUTUpdate cart metadata configuration.
DELDelete cart meta configuration
GETFetch cart meta configuration
POSTCreate new cart meta configuration
GETGet abandoned carts
POSTShare cart link
GETGet details of a shared cart
POSTUpdate shared cart items
GETGet cart list for store os user
PUTUpdate cart user details.
GETCount items in the customer's cart
POSTAdd items to cart
PUTUpdate cart items
PUTDelete a cart
GETList coupons
POSTApply a coupon to the cart.
PUTUpdate cart metadata
GETGet cart configuration
PUTUpdate cart configuration
POSTGet and validate cart items
POSTCheck cart serviceability
POSTCheckout cart
GETGet abandoned cart details
POSTAdd items to abandoned cart
PUTUpdate cart items
POSTCreate Fynd order with overriding cart details
GETFetch all items added to the customer cart using cart id
POSTCheckout cart
POSTCart checkout (latest)
POSTCreate a new coupon.
GETRetrieve available coupons.
GETGet a list of all coupon tags associated with a application.
GETGet coupon details by ID
PUTUpdate a coupon
GETCheck if coupon is already created with coupon code
DELRemove Applied Coupon for platform pos user
GETValidate applied coupon
POSTCreate a coupon
GETList coupons
GETGet coupon details by ID
PUTUpdate a coupon
POSTCreate a serial coupon
GETList serial coupons
GETGet serial coupon details by ID
PUTUpdate a serial coupon
DELDelete a serial coupon which is in draft state
GETGet export of serial coupons
POSTResume a failed or partially completed serial coupon generation job
GETList coupon groups
POSTCreate a coupon group
GETGet a coupon group
PUTUpdate a coupon group
DELDelete a coupon group
POSTAdd address to an account
GETGet a list of addresses for a customer
GETGet details for a single customer address
PUTUpdates an existing customer address
DELRemoves an address from a customer's address list
POSTSelect customer address for order processing
PUTSelect payment mode
PUTSelect payment mode (latest)
POSTCreate new price adjustment
GETGet a list of all price adjustments associated with a cart
PUTUpdate price adjustments.
DELRemove price adjustments.
POSTCreate price adjustments in Bulk
PUTUpdate price adjustments in Bulk
DELRemove price adjustments in bulk.
GETList product threshold rules
POSTCreate a product threshold rule
GETGet a product threshold rule
PUTUpdate a product threshold rule
PATCHPartially update a product threshold rule
DELDelete a product threshold rule
GETGet product threshold rule history
POSTBulk import product threshold rules from a CSV or XLSX file
GETDownload a sample CSV or XLSX file for bulk import
GETGet a list of all Promotion tags associated with a application.
GETList promotions
POSTCreate a promotion
GETGet a promotion
PUTUpdate a promotion
GETCheck if promotion is already created with promotion code
GETList promotion groups
POSTCreate a promotion group
GETGet a promotion group
PUTUpdate a promotion group
DELDelete a promotion group
GETGet Store Address
GETGet shipments details
PUTUpdate shipments
GETGet delivery modes
GETGet values of the selected value for the filter options.
GETGet filters keys of the filter options.
GETGet filter details for application
GETRetrieve application product data.
PATCHUpdate application product data.
GETGet Return configuration level set for an application
POSTCreate Return configuration level set for an application
PUTUpdate Return configuration level set for an application
DELDelete Category level Application Return Configuration setttings
GETGet all category level configuration level set for an application
POSTCreate Category level Application Return Configuration setttings
PUTUpdate Category level Application Return Configuration setttings
POSTCreate price factory
GETGet price factory
GETGet price factory
PUTEdit a price factory
POSTAdd products in price factory in bulk
GETPoll bulk job for adding products in price factory.
POSTValidate bulk job for adding products in price factory.
POSTProcess bulk job for adding products in price factory.
POSTExport products of price factory.
GETpoll job for adding products in price factory
GETGet product prices
POSTUpload application bulk job data
GETList application bulk upload jobs
GETDownload application bulk job template
GETGet application bulk job status
GETGet application brand listing.
PATCHUpdate application brand.
GETGet application brands.
GETGet categories.
GETGet application category listing.
PATCHUpdate application category.
GETGet application department listing.
PATCHUpdate application department.
GETGet departments.
GETGet application inventory.
GETGet application locations.
GETGet application products.
GETGet product details by slug.
GETGet application products.
PATCHUpdate application location.
POSTCreate custom autocomplete rules.
GETGet autocomplete configuration.
GETGet autocomplete keyword details.
PUTUpdate autocomplete keywords.
DELDelete autocomplete keywords.
POSTCreate search rerank for an application
GETGet search rerank for an application
GETGet search rerank for an application
PUTUpdate search rerank for an application
DELDelete search rerank configuration for an application
POSTCreate search configuration
GETGet Search Configuration
PUTUpdate search configuration for an application
DELDelete Search Configuration
POSTCreate custom search keywords.
GETGet all search keywords.
GETRetrieve search keywords.
PUTUpdate search keywords.
DELDelete search keywords.
POSTCreate autocomplete settings config for an application
GETGet autocomplete settings config for an application
PUTUpdate autocomplete settings config for an application
GETGet autocomplete suggestions as per config for an application
POSTCreate Merchandising Rule's action details
PUTUpdate Merchandising Rule's action details
GETGet Merchandising Rule's action details
POSTCreate Merchandising Rule's Hide action details
PUTUpdate Merchandising Rule's Hide action details
GETGet Merchandising Rule's Hide action details
POSTCreate Merchandising Rule's Boost action details
PUTUpdate Merchandising Rule's Boost action details
GETGet Merchandising Rule's Boost action details
POSTGet Merchandising Rule's Bury action details
PUTUpdate Merchandising Rule's Bury action details
GETGet Merchandising Rule's Bury action details
POSTCreate a Merchandising Rule's query
GETGet Merchandising Rule's query details
PUTUpdate a Merchandising Rule's query
POSTSave a Merchandising Rule
DELDelete a Merchandising Rule
GETGet list of all Merchandising Rule's details
DELDelete a Merchandising Rule's preview
GETGet live preview of a Merchandising Rule
GETList search synonyms for an application
POSTcreate oneway/ twoway search synonyms for an application
PUTUpdate synonym attributes for an application
DELDelete synonym for an application.
POSTExport synonym for an application.
GETGet sample file for bulk synonyms upload
POSTUpload csv/xls/xlsx file with synonyms
POSTValidate csv/xls/xlsx file with synonyms
POSTprocess csv/xls/xlsx file with synonyms and insert onto db
GETpoll a particular synonym bulk job for status
POSTAdd a Collection
GETRetrieve all collections.
GETGet the items for a collection
DELClear priorities set for collection items.
POSTAdd items to a collection
GETGet collection details.
PUTUpdate a collection
DELDelete a collection.
GETGet catalog insights.
GETGet discounted inventory by size identifier.
GETGet pricing of a product
GETRetrieve query filters.
GETRetrieve configurations.
POSTCreate configuration for product listing.
GETRetrieve catalog configuration.
GETRetrieve configuration by type.
POSTCreate configuration by type.
POSTUpdate 'Allow Single' setting.
POSTUpdate default sorting.
POSTCreate listing configuration.
GETRetrieve listing configurations.
POSTCreate group configuration.
GETRetrieve group configurations.
PUTUpdate group configuration.
DELDelete group configuration.
PUTUpdate listing configuration.
DELDelete listing configuration.
GETRetrieve configuration metadata.
POSTSend communication asynchronously.
GETGet audiences.
POSTCreate audience.
GETGet audience by ID.
POSTGet N sample records from CSV.
POSTTrigger campaign job.
GETGet jobs.
GETGet job logs.
GETGet campaigns.
POSTCreate campaign.
GETGet campaign by ID.
PUTUpdate campaign by ID.
GETGet campaign statistics by ID.
GETGet email templates.
POSTCreate email template.
GETGet email template by ID.
PUTUpdate email template by ID.
DELDelete email template by ID.
GETGet system email templates.
GETGet subscribed email templates.
GETGet event subscriptions.
POSTCreate event subscriptions by bulk
GETGet global variables.
POSTPost global variables.
POSTSend OTP.
POSTVerify OTP.
GETGet otp-configuration, if not present in db then return default settings
PUTUpdate/insert otp configurations
GETGet email providers.
POSTCreate email provider.
GETGet email provider by ID.
PUTUpdate email provider by ID.
GETGet app providers.
GETGet SMS providers.
POSTCreate SMS provider.
GETGet SMS provider by ID.
PUTUpdate SMS provider by ID.
GETGet default SMS providers.
POSTUpdate application providers.
GETGet application providers.
GETGet global providers.
GETGet communication logs.
GETGet SMS templates.
POSTCreate SMS template.
GETGet SMS template by ID.
PUTUpdate SMS template by ID.
DELDelete SMS template by ID.
GETGet system SMS templates.
GETGet subscribed SMS templates.
POSTSend communication synchronously.
GETGet application API tokens.
POSTUpdate application API tokens.
POSTCreate tokens for application
DELDelete tokens for application
POSTToggle store-in-store feature.
GETGet store-in-store entries.
POSTCreate store-in-store entry.
GETGet primary store catalog configuration.
PUTUpsert primary store catalog configuration.
DELDelete primary store catalog configuration.
GETGet a single store-in-store entry.
PUTUpdate store-in-store entry.
DELDelete store-in-store entry.
GETGet application features.
POSTUpdate application features.
PATCHModify application features.
GETGet application basic details.
PUTUpdate application basic details.
GETGet URL redirections
POSTCreate a URL redirection
GETGet URL redirections
PUTUpdate a URL redirection
DELDelete a URL redirection
GETGet application by ID.
PUTGet application by ID.
PUTUpdate Application Version
GETGet application companies.
GETGet application stores.
GETGet application contact information.
PUTUpdate application contact information.
GETGet application currency configuration.
POSTUpdate application currency configuration.
PUTUpdate application currency configuration.
GETGet supported currencies.
POSTGet domain availability.
GETGet domains.
POSTAdd domain.
DELRemove domain by ID.
POSTChange domain type.
POSTGet domain status.
POSTGet ordering store by filter
POSTUpdate ordering store configuration.
GETGet ordering store configuration.
GETGet deployment stores
POSTGet an Ordering Store signed cookie on selection of ordering store.
DELUnset the Ordering Store signed cookie.
GETGet ordering store details
GETGet all deployment stores
GETGet inventory configuration.
PUTUpdate inventory configuration.
PATCHPartially update inventory configuration.
GETGet Application configuration.
GETList announcements
POSTCreate announcement
GETGet announcement
PUTUpdate announcement
PATCHUpdate announcement schedule
DELDelete an announcement
POSTCreate blog
GETList blogs
PUTUpdate a blog
DELDelete a blog
GETGet component
GETGet blog by slug.
GETGet custom field types
GETGet resources
GETGet custom fields definitions
GETGet custom fields definitions for a given resource type
POSTCreate custom field definition for a given resource type
GETGet custom fields definition by resource, slug and namespace
PUTUpdate custom field definition
DELDelete custom fields definition
GETGet list of custom fields of given resource and resource slug
PUTCreate custom field entries for gives resource and resource slug
POSTCreate custom object definition
GETGet custom object definitions
GETGet custom object definition
PUTUpdate custom object definition
DELDelete custom object definition
GETGet list of custom objects
POSTCreate custom object entries
GETGet custom object details
DELDelete custom object
PUTUpdate custom object details
GETGet bulk import and export job list
POSTBulk custom object entries upload
GETInitiate download for bulk custom object entries
GETDownload sample for custom object bulk entry
GETGet page meta
GETGet page specification
POSTCreate page preview
PUTUpdate page preview
DELDelete page
POSTCreate page
GETGet pages.
PUTUpdate page
GETGet page by slug
GETGet support information
POSTUpdate Customer Support Information
POSTCreate data loader
GETList data loaders
GETGet data loaders api specs.
DELDelete a data loader
PUTUpdate a data loader
GETList all data loaders
PUTSelect a data loader
PUTReset a data loader
GETGet Dynamic FAQ channels
GETGet Dynamic FAQ order statuses
GETGet Dynamic FAQ import schema
GETGet Dynamic FAQ config
PUTUpsert Dynamic FAQ config
GETList Dynamic FAQ mappings
POSTCreate Dynamic FAQ mapping
DELDelete all Dynamic FAQ mappings
POSTBulk upload Dynamic FAQ mappings
GETGet Dynamic FAQ mapping
PUTUpdate Dynamic FAQ mapping
DELDelete Dynamic FAQ mapping
GETList experimental features
POSTCreate experimental feature
GETGet experimental feature by slug
PUTUpdate experimental feature
DELDelete experimental feature
GETList FAQ Categories
GETGet FAQ category
POSTCreate FAQ Category
PUTUpdate FAQ category
DELDelete FAQ category
GETList FAQs
POSTCreate FAQ
PUTUpdate FAQ
DELDelete FAQ
GETGet FAQ or slug
PUTCreate HTML tag
PUTRemove HTML tag
PUTUpdate HTML tag
POSTCreate HTML tags
PUTUpdate HTML Tags
DELDelete HTML tags in application
GETGet all the tags in an application
GETGet landing pages
POSTCreate landing page
PUTUpdate landing page
DELDelete landing page
GETGet Legal Pages
POSTUpdate Legal Pages
GETGet navigation items
POSTCreate navigation items
GETGet default navigations
POSTSubmit navigation for review
GETGet navigation by id
PUTUpdate navigation
DELDelete navigation
POSTCreate path redirection rules
GETList Path Redirection Rules
GETGet Path Redirection Rule
PUTUpdate path redirection rule
DELDelete path redirection rule
POSTGenerate SEO title
GETGet sales channel SEO
POSTUpdate sales channel SEO information
GETList default SEO Markup Schemas
GETList default SEO Markup Schemas
POSTCreate SEO Markup Schema
GETGet SEO Markup Schema
PUTEdit SEO Markup Schema
DELDelete SEO Markup Schema
GETGet default sitemap configuration
PUTUpdate default sitemap configuration
GETList sitemap configurations
POSTCreate a new sitemap configuration
GETGet a specific sitemap configuration
PUTUpdate a specific sitemap configuration
DELDelete a specific sitemap configuration
GETApplication browse files.
POSTBrowse Files
POSTApplication copy files.
POSTApplication start upload.
POSTApplication complete upload.
GETGet all the supported invoice pdf types
GETGet the pdf types of by id
GETGet default PDF data.
GETGet default PDF data.
GETUpdate html template for invoice or label
PUTUpdate HTML Template
DELDelete a PDF generator configuration
GETGet html template for sales channel
POSTSave HTML template.
GETGet default PDF template.
POSTGenerate payment receipt.
GETget default html template for invoice or label
GETGet custom form
PUTUpdate custom form
DELDelete a custom form
GETGet custom forms
POSTCreate custom form
GETList sales channel tickets
GETGet Ticket Details
PUTUpdate Ticket Details
POSTCreate ticket history interaction
GETGet ticket history interaction
GETGet addresses
POSTCreate address
GETGet address by ID
PUTUpdate address
DELDelete address
GETList hook scripts.
GETList orchestration plans.
POSTCreate orchestration plan.
GETGet orchestration plan.
PUTReplace orchestration plan.
DELDelete orchestration plan.
POSTTest-execute an orchestration plan.
GETList available services.
GETGet all questions of that cluster
GETRetrieve rule lane configurations
POSTCreate a new rule
GETGet a specific rule by ID
PUTUpdate a specific rule by ID
DELDelete a specific rule by ID
POSTUpdate the position of a rule
GETGet available rule parameters
POSTGet a list of rules
GETRetrieve Reasons for Cancellation and Return journey
GETGet cross selling platform shipments
GETTrack shipment
GETUse this API to retrieve the issues that led to the cancellation of bags within a shipment.
POSTCreate extension proxy
DELRemove extension proxy
GETGet merchant refund priority
GETAPI to get merchant refund priority
POSTUpdate Aggregator Credentials
PATCHCopy aggregator config of onc device to another.
GETLists the beneficiary of a refund
POSTValidate UPI ID and IFSC code
POSTSet a default beneficiary for a refund
GETget beneficiary details
POSTPayment confirmation
GETGet payment session
PUTUpdate payment session.
GETFetch COD Refund Aggregator configuration
POSTAdd/Update COD Refund Aggregator configuration
GETGet payment link
POSTCreate payment link.
GETGet payment link
GETPoll status of payment link
POSTResend payment link
POSTCancel payment link.
GETGet bank account details
POSTCreate refund account
GETGet user order beneficiaries
GETGet user beneficiaries.
PUTUpdate refund session
POSTSave bank details for cancelled/returned order
PATCHDelete saved beneficiary details of customers
POSTSave refund source against shipment and order
GETget the selected refund options for shipment id
GETpennydrop validation
POSTupdate penny drop validation for application ID
GETGet details for the active inactive payment modes for merchant
PATCHUpdate sequencing of payment modes for the merchant
GETGet all business units and it's devices.
PATCHCopy payment mode config of onc device to another.
GETRetrieve transaction history by user or order
POSTAdd products to price factory
GETGet products listed in price factory
POSTValidate courier rules bulk file
GETGet courier rules bulk validation batch
POSTImport courier rules from validation batch
GETGet courier rules bulk import batch
POSTExport courier rules in bulk
GETGet courier rules bulk export batch
GETDownload courier rules bulk sample
GETGet courier rules bulk history
POSTImport courier rules priority in bulk
GETGet courier rules bulk priority import batch
GETGet courier rules bulk priority history
GETDownload courier rules bulk priority sample
POSTCreate courier rule
GETGet courier rules
PUTUpdate courier rule
GETGet courier rule
DELDelete courier rule
PUTApply configuration to an application
GETGet delivery configuration
PATCHTo patch any config which can be applied to application.
PUTUpdate courier partner rule priority
GETGet courier rule
POSTCreate zone
GETGet zones
GETGet zone details
PATCHUpdate details of a Zone to enable or disable.
DELDelete a Specific Zone
POSTApprove or reject a zone pending review
GETGet details of a delivery zone
POSTCreate bulk zones.
GETGet bulk zones.
POSTCreate Bulk Export of Zones
GETGet Bulk Export of Zones
POSTCreation of GeoArea
GETGet all geoareas in the current application.
GETGet details of the specific geoarea
PUTUpdate the details of existing GeoArea
DELDelete a Price GeoArea
POSTBulk Creation of GeoArea Regions
GETGet status of GeoAreas created in bulk
PUTUpdate geoareas and their associated regions in bulk.
POSTCreate job for exporting Geoarea regions
GETGet status of Geoarea export job
POSTCreate Bulk Export of Price GeoAreas
POSTBulk Creation of GeoAreas
POSTValidate bulk geoareas.
GETGet bulk geoarea validation status.
POSTImport validated bulk geoareas.
GETGet imported status of validated geoarea.
PATCHBulk Geoarea Override.
GETZone conflict override status.
GETGet history of the geoarea in bulk job processed
GETGet sample file of a Price Zone
GETGet history of the geoarea in bulk job processed
GETDownload geoarea sample file.
GETDownload Sample Delivery Zone Product Type file.
POSTValidate bulk zones.
GETGet bulk zone validation status.
POSTImport validated bulk zones.
PATCHResolves Given Zone Conflicts.
GETZone conflict override status.
PATCHBulk Zone Override.
GETBulk Zone Override Status.
POSTApprove or reject a geoarea pending review
GETGet store rule configuration
POSTCreate store rule configuration
PUTUpdate store rules configuration
POSTValidate store rules bulk file
GETGet store rules bulk validation batch
POSTImport store rules from validation batch
GETGet store rules bulk import batch
POSTExport store rules in bulk
GETGet store rules bulk export batch
GETDownload store rules bulk sample
GETGet store rules bulk history
POSTImport store rules priority in bulk
GETGet store rules bulk priority import batch
GETGet store rules bulk priority history
GETDownload store rules bulk priority sample
GETGet store rules
POSTCreate store rule
PUTUpdate Store Rule priority
GETGet store rule
PUTUpdate store rule
DELDelete store rule
GETGet store rule Details
POSTUpdate pincode COD support
POSTBulk update pincode COD support
POSTGet COD enabled pincodes
POSTGet audit trail
GETList QC products configuration
POSTUpdate QC product configuration
POSTCreate short link.
GETGet short links.
GETGet short link by hash.
PATCHUpdate short link by ID.
PUTCreate or update A/B experiment tags
GETGet all experimental tag data
GETGet category tags by position
GETGet all active tag positions
PUTUpload tag bucket JSON file
GETDownload tag bucket file
GETClear tag bucket cache
PUTUpdate runtime configuration
GETGet all application configurations
GETRefresh configuration cache
GETGet tags by option codes
GETGet tags V2 with service and tenant support
GETGet tag metadata by tag name
GETGet tag metadata audit history
POSTCreate or update tag metadata
GETGet priority hierarchy for a service
GETFilter tag metadata with pagination
GETRefresh tag metadata cache
POSTPublish tags to PLP via Kafka
GETGet extension sections
GETList global sections for a theme
PUTApprove global section
PUTReject global section
GETGet Page Mapper Configuration
PUTUpdate Page Mapper Configuration
GETGet unified sections for a theme
GETList theme fonts
PATCHUpdate theme name
POSTGet Create theme
GETGet applied theme
GETGet latest version of theme by slug.
POSTCreate a new global section
PUTUpdate global section by ID
POSTBulk create sections
PUTBulk update sections
POSTCreate a Page Mapping
PUTUpdate a Page Mapping
DELDelete a Page Mapping
GETGet a List of Users
GETSearch an Existing Users
POSTCreate User
PUTBlock/Unblock Users
PUTRestore Deleted User
PUTUpdate User Details
PUTArchive User
GETGet users belonging to user group by Id
POSTCreate a User Attribute Definition
GETGet User Attribute Definitions
PUTUpdate User Attribute Definition
DELDelete User Attribute Definition
GETGet User Attribute Definition
PUTUpdate Or Create User Attribute
GETGet User Attribute
DELDelete User Attribute
GETGet All Customer Attributes
GETGet User Attribute
PUTBulk Update User Attributes
PUTBulk Update Different Attributes Per User
POSTCreate User Group
GETGet User Groups
GETGet User Group Categories
PUTUpdate User Group
GETGet User Group
PATCHModify User Group
GETGet Categorised User Groups
GETGet User Group Tags
POSTRefresh User Group Total Users
GETCheck if user belongs to specified user groups
POSTCreate User Session
DELDelete User Session
GETGet User Active Sessions
DELDelete User Active Sessions
POSTCreate user session with separate access and refresh tokens
GETGet Platform Config
POSTUpdate Platform Config
GETGet membership audit trail
GETList membership plans
GETGet membership plan details
PUTUpdate a membership plan
POSTSubmit plan for approval
POSTApprove a membership plan
POSTDisable a membership plan
POSTReject a membership plan
POSTRequest changes on a plan

Fynd Platform v1.10.7 Change Logs

Compatible FDK Client Versions (Azure) - v1.10.7-19, v1.10.7-14, v1.10.7-24, v1.10.7-13, v1.10.7-15, v1.10.7-22, v1.10.7-28, v1.10.7-18, v1.10.7-21, v1.10.7-16, v1.10.7-1, v1.10.7-11, v1.10.7-26, v1.10.7-25, v1.10.7-23, v1.10.7-29, v1.10.7-2, v1.10.7-27, v1.10.7-12, v1.10.7-17, v1.10.7-10, v1.10.7-20, v1.10.7-30, v1.10.7-34, v1.10.7-42, v1.10.7-5, v1.10.7-31, v1.10.7-4, v1.10.7-45, v1.10.7-32, v1.10.7-46, v1.10.7-6, v1.10.7-7, v1.10.7-35, v1.10.7-39, v1.10.7-3, v1.10.7-8, v1.10.7-33, v1.10.7-41, v1.10.7-38, v1.10.7-36, v1.10.7-43, v1.10.7-44, v1.10.7-9, v1.10.7-40

Releases

Tag v1.10.7-46 Change Logs

Compared against: v1.10.7-45

  • [Added] Inventory class in platform client

  • [Added] PriceFactory class in platform client

Catalog

  • What's New

    • [Added] property query_rules of schema CreateCollection in request body

    • [Added] property query_rules of schema CollectionCreateResponseSchema in response with status code 200

  • What's Deprecated

    • [Breaking] [Deleted] property query of schema CreateCollection in request body

    • [Breaking] [Deleted] property query of schema CollectionCreateResponseSchema in response with status code 200

  • What's New

    • [Added] property items[].query_rules of schema GetCollectionDetailNest in response with status code 200

  • What's Deprecated

    • [Breaking] [Deleted] property items[].query of schema GetCollectionDetailNest in response with status code 200

  • What's New

    • [Added] property query_rules of schema CollectionItemUpdateSchema in request body

  • What's Deprecated

    • [Breaking] [Deleted] property query of schema CollectionItemUpdateSchema in request body

  • What's New

    • [Added] property query_rules of schema GetCollectionDetailResponseSchema in response with status code 200

  • What's Deprecated

    • [Breaking] [Deleted] property query of schema GetCollectionDetailResponseSchema in response with status code 200

  • What's New

    • [Added] property query_rules of schema UpdateCollection in request body

    • [Added] property query_rules of schema UpdateCollection in response with status code 200

  • What's Deprecated

    • [Breaking] [Deleted] property query of schema UpdateCollection in request body

    • [Breaking] [Deleted] property query of schema UpdateCollection in response with status code 200

updateInventories

  • What's Deprecated

    • [Breaking] [Deleted] method updateInventories

addProductsInPriceFactoryByZoneId

  • What's Deprecated

    • [Breaking] [Deleted] method addProductsInPriceFactoryByZoneId

getProductsInPriceFactoryByZoneId

  • What's Deprecated

    • [Breaking] [Deleted] method getProductsInPriceFactoryByZoneId

  • What's New

    • [Added] properties items[].failed_records[].item_code, items[].failed_records[].brand_name, items[].failed_records[].brand_slug, items[].failed_records[].message, items[].failed_records[].seller_identifiers, items[].failed_records[].error, items[].failed_records[].request_payload in response with status code 200

Communication

  • What's New

    • [Added] property payload.conditions of schema SendSyncReq in request body

  • What's New

    • [Added] property payload.conditions of schema SendSyncReq in request body

  • What's New

    • [Added] property items[].template.sms.conditional_templates of schema EventSubscriptionTemplateSmsObj in response with status code 200

    • [Added] property items[].template.email.conditional_templates of schema EventSubscriptionTemplateEmailObj in response with status code 200

    • [Added] property items[].template.pushnotification.conditional_templates of schema EventSubscriptionTemplatePushnotification in response with status code 200

  • What's New

    • [Added] property subscriptions[].template.sms.conditional_templates of schema CommunicationTemplate in request body

    • [Added] property subscriptions[].template.email.conditional_templates of schema CommunicationTemplate in request body

    • [Added] property subscriptions[].template.pushnotification.conditional_templates of schema CommunicationTemplate in request body

    • [Added] property [].template.sms.conditional_templates of schema EventSubscriptionTemplateSms in response with status code 200

    • [Added] property [].template.email.conditional_templates of schema EventSubscriptionTemplateEmail in response with status code 200

    • [Added] property [].template.pushnotification.conditional_templates of schema EventSubscriptionTemplatePushnotification in response with status code 200

  • What's New

    • [Added] property items[].conditional_usages of schema EmailTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema EmailTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema EmailTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema EmailTemplate in response with status code 200

  • What's New

    • [Added] property items[].conditional_usages of schema EmailTemplate in response with status code 200

  • What's New

    • [Added] property items[].conditional_usages of schema SmsTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema SmsTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema SmsTemplate in response with status code 200

  • What's New

    • [Added] property conditional_usages of schema SmsTemplate in response with status code 200

  • What's New

    • [Added] property items[].items[].conditional_usages of schema SmsTemplate in response with status code 200

  • What's New

    • [Added] property items[].conditions of schema Log in response with status code 200

Content

  • What's New

    • [Added] property products of schema DefaultSitemapConfig in response with status code 200

  • What's New

    • [Added] property products of schema DefaultSitemapConfig in request body

    • [Added] property products of schema DefaultSitemapConfig in response with status code 200

  • What's New

    • [Added] property chat.email_address of schema DynamicFaqChatCallbackConfig in request body

    • [Added] property call of schema DynamicFaqConfiguration in request body

    • [Added] property email of schema DynamicFaqConfiguration in request body

    • [Added] property request_callback of schema DynamicFaqConfiguration in request body

    • [Added] property data.chat.email_address of schema DynamicFaqChatCallbackConfig in response with status code 200

    • [Added] property data.call of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Added] property data.email of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Added] property data.request_callback of schema DynamicFaqConfigurationDocument in response with status code 200

  • What's Deprecated

    • [Breaking] [Deleted] property callback of schema DynamicFaqConfiguration in request body

    • [Breaking] [Deleted] property default_faq of schema DynamicFaqConfiguration in request body

    • [Breaking] [Deleted] property cancellation_question_uid of schema DynamicFaqConfiguration in request body

    • [Breaking] [Deleted] property luxury_catalog_ids of schema DynamicFaqConfiguration in request body

    • [Breaking] [Deleted] property mass_catalog_name of schema DynamicFaqConfiguration in request body

    • [Breaking] [Deleted] property data.callback of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Breaking] [Deleted] property data.default_faq of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Breaking] [Deleted] property data.cancellation_question_uid of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Breaking] [Deleted] property data.luxury_catalog_ids of schema DynamicFaqConfigurationDocument in response with status code 200

    • [Breaking] [Deleted] property data.mass_catalog_name of schema DynamicFaqConfigurationDocument in response with status code 200

Order

  • What's New

    • [Added] property products_to_replace[].reasons of schema ShipmentToReplace in request body

  • What's New

    • [Added] property items[].bags[].article.exchange_config of schema Article in response with status code 200

    • [Added] property items[].bags[].can_exchange of schema BagUnit in response with status code 200

  • What's New

    • [Added] property shipments[].bags[].article.exchange_config of schema OrderBagArticle in response with status code 200

    • [Added] property shipments[].bags[].can_exchange of schema OrderBags in response with status code 200

  • What's New

    • [Added] property shipments[].bags[].article.exchange_config of schema OrderBagArticle in response with status code 200

    • [Added] property shipments[].bags[].can_exchange of schema OrderBags in response with status code 200

  • What's New

    • [Added] property items[].shipments[].bags[].article.exchange_config of schema OrderBagArticle in response with status code 200

    • [Added] property items[].shipments[].bags[].can_exchange of schema OrderBags in response with status code 200

  • What's New

    • [Added] property items[].bags[].article.exchange_config of schema Article in response with status code 200

    • [Added] property items[].bags[].can_exchange of schema BagUnit in response with status code 200

User

  • What's New

    • [Added] property items[].ucp_consent of schema UserSearchSchema in response with status code 200

  • What's New

    • [Added] property users[].ucp_consent of schema UserSearchSchema in response with status code 200

  • What's New

    • [Added] property user.ucp_consent of schema UserSchema in response with status code 200

  • What's New

    • [Added] property user.ucp_consent of schema UserSchema in response with status code 200

  • What's New

    • [Added] property items[].ucp_consent of schema UserSearchSchema in response with status code 200

UserSubscription
createMembershipPlan

  • What's Deprecated

    • [Breaking] [Deleted] method createMembershipPlan

  • What's New

    • [Added] query parameter q (type: string)

Major Version

Next
Obtain charge details »