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 by uid
GETList company department
GETGet department by uid
GETList Inventory
GETList product tags
GETList inventory by size
GETList product size
DELDelete product size
POSTCreate Inventory
GETList inventory by size
GETGet variants
GETList product HSN codes
GETGet product HSN code
POSTUpdate inventories
GETList inventory export jobs
POSTCreate inventory export
GETList products
POSTCreate product
PUTUpdate a product
PATCHPatch a product
DELDelete product
GETGet a product
DELDelete an inventory
POSTUpdate an inventory
POSTUpdate an Article Price
POSTUpdate an Article Quantity
GETList product attributes
GETGet attribute detail by slug
GETList product templates
GETList product template categories
GETValidate product template
GETList size guides
POSTCreate size guide
GETGet size guide
PUTUpdate size guide
POSTCreate Tax Rule
GETGet all tax rules of a company
PUTUpdate Tax Rule
DELDelete a tax rule
GETGet tax versions for a tax rule
POSTCreate a tax version
DELDelete a tax version
PUTUpdate a tax version
GETGet HS/SAC codes
POSTCreate HS/SAC code
POSTCreate tax component name
GETGet component names
GETGet a brand
PUTupdate brand
POSTCreate brand
GETlist company brands
GETGet company profile
PATCHUpdate company profile
POSTCreate company stores
GETGet company stores
PUTUpdate company stores
POSTBulk create company stores
GETGet company store tags
GETList currencies
GETGet currency exchange rates
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
DELdelete custom fields of given 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
POSTBulk custom object entries upload
GETInitiate download for bulk custom object entries
GETDownload sample for custom object bulk entry
GETList discounts
POSTCreate discount
GETGet discount
PUTUpdate discount
POSTValidate discount file
POSTGet discount file
GETList validation job discount
DELdeletel validation job discount
GETList discount download job
DELdelete discount download job
POSTUpsert discount items
POSTCopy files.
GETBrowse files.
POSTStart file upload.
POSTComplete file upload.
POSTGet signed URLs.
GETProxy file access.
POSTCreate channel account
GETGet channel accounts list
GETGet channel account details
PUTUpdate account
GETList bag cancellation reasons
GETGet bag
GETList bags
GETGet channel configuration
POSTCreate channel configuration
POSTAttach order to a user
POSTCreate Order
GETGet order
GETList orders
POSTAllows esm config updation
GETRetrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
PUTUpdate payment details for an order, its shipments and its bags.
POSTReassign location
POSTUpdate a shipment lock
PUTUpdate shipment address
PUTUpdate a shipment's status
GETGet a shipment's history
POSTCreate shipment history
POSTUpdate packaging dimensions
POSTSend user mobile OTP
POSTVerify mobile OTP
POSTRetry E-invoice
GETTrack shipment
POSTUpdate shipment tracking
POSTGenerate and attach invoice Id
GETGet shipment packages
POSTCreate shipment packages
PUTUpdate shipment packages
POSTManually request a courier partner for a shipment.
POSTSave courier partner preference for a shipment.
GETList shipments
GETGet shipment details
GETGet all countries and associated data
POSTCreate courier account
GETList courier accounts
PUTUpdate courier account
GETGet courier account
PUTUpdate delivery configuration
GETGet delivery configuration
POSTLocality TAT import or export
GETLocality TAT change history
POSTBulk update serviceability of localities
GETBulk update history
GETFetching of Package Material Rules from database.
GETGet self-ship details
PATCHUpdate self-ship details
POSTGet available company courier partners
POSTCreate Scheme for courier partner extension
GETGet created Schemes for courier partner
PUTUpdate Scheme for courier partner extension
GETGet Scheme for courier partner extension by Id
POSTSample File Download
GETGet Serviceability TAT sample files generator status
POSTCreate packaging material
GETGet packaging materials
POSTCreate packaging rule
GETGet packaging material rule
PATCHUpdate packaging rule
PATCHUpdate packaging material
GETGet packaging material
POSTRegister Subscriber.
PUTUpdate Subscriber.
GETList subscribers by company
PUTRegister Subscriber.
GETGet a subscriber
GETList subscribers by extension ID
POSTCheck cart serviceability
GETGet abandoned carts
GETGet abandoned cart details
POSTAdd items to cart
PUTUpdate cart items
POSTShare cart link
GETList shared cart items
POSTUpdate shared cart items
GETList of carts
PUTUpdate user of a cart
GETGet a cart
POSTAdd items to cart
PUTUpdate cart items
PATCHUpdate cart breakup values
PUTDelete a cart
GETGet a cart items count
PUTUpdate cart metadata
PUTUpdate cart meta
GETGet cart meta
POSTCreate a new cart meta
POSTGet and validate cart items
POSTHeadless Checkout
POSTUpdate cart checkout
POSTCheckout cart
GETList of coupons
POSTCreate a coupon
GETGet a coupon
PUTUpdate a coupon
DELDelete a coupon which is in draft state
GETCheck coupon code exists
GETList of coupons
POSTApply coupon
DELRemove coupon
GETValidate applied coupon
GETGet a list of addresses for a customer
POSTCreates a new address 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
GETList of offers
POSTCreate an offer
GETGet a specific offer
PUTUpdate existing offer
PATCHPartially update offer
DELDelete draft offer
PUTSelect payment mode
PUTSelect payment mode (latest)
PUTUpdate price adjustments
DELRemove price adjustments
POSTCreate price adjustments
GETGet a list of all price adjustments associated with a cart
GETList of promotions
POSTCreate a promotion
GETGet a specific promotion
PUTUpdate a promotion
DELDelete a promotion which is in draft state
GETGet promotion and coupon type
GETCheck promotion code exists
GETList of all available promotion offers
GETFetch available promotions payment offers
POSTRedeem loyalty points.
GETGet Store Address
GETGet shipments details
PUTUpdate shipments
GETGet delivery modes
GETList sales channel brands
PATCHUpdate sales channel brand
GETList brands
GETList categories
GETList sales channel categories
PATCHUpdate sales channel category
GETList collections
POSTCreate a collection
DELDelete a collection
PUTUpdate a collection
POSTCreate items in a collection
GETList items of collection
GETGet a collection
DELUnfollow a Specific Product by ID
GETList sales channel departments
PATCHUpdate sales channel department
GETList departments
GETRetrieve Price Factories for an Application
POSTCreate a Price Factory for an Application
GETRetrieve a Specific Price Factory Configuration
PATCHUpdate an Existing Price Factory Configuration
DELDelete a Price Factory Configuration
GETGet Products associated with a Price Factory
GETUpdate marketplace optin
PATCHPartially update price factory product configuration
GETList sales channel inventory
GETGet discounted inventory
GETGet product details
GETRetrieve followed products by user
PUTFollow a Specific Product by ID
PATCHUpdate sales channel location
GETGet collection query filters
POSTUpdate default sorting
GETGet listing configurations
POSTCreate listing configuration
GETGet group configurations
POSTCreate group configuration
DELDelete group configuration
PUTUpdate group configuration
DELDelete listing configuration
PUTUpdate listing configuration
GETGet configuration metadata
GETGet sales channel product
PATCHUpdate sales channel product
GETList sales channel products
GETList sales channel products
GETGet prices for specific raw product items
GETRetrieve stores for a sales channel
GETList domains
GETGet inventory configuration
POSTCreate blog
GETList blogs
PUTUpdate a blog
DELDelete a blog
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
PUTUpdate page preview
GETGet pages
GETGet page by slug
GETGet support information
POSTUpdate Customer Support Information
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
GETGet all HTML tags
PUTCreate HTML tag
PUTRemove HTML tag
PUTUpdate HTML tag
GETGet Script Tags Templates
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
GETGet navigation by slug
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
PUTGet SEO Markup Schema
DELDelete SEO Markup Schema
GETApplication browse files.
POSTBrowse Files
POSTApplication start upload.
POSTApplication complete upload.
GETGet ordering source config for a given company and application.
PUTUpdate ordering source config for a given company and application.
GETList ordering sources for a given company and application.
POSTList of RMA rules based on the given input conditions.
GETRetrieve Reasons for Cancellation and Return journey
GETList sales channel shipments
GETTrack shipment
GETList shipment cancellation reasons
POSTCreate extension proxy
DELRemove extension proxy
POSTSave token details for a payment aggregator
POSTPayment confirmation
POSTVerify payment customer and show credit summary
GETGet payment session
PUTUpdate payment session
PUTUpdate order metadata
GETList all transactions for an order
GETGet payment link
POSTCreate 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
PUTUpdate courier rule
GETGet courier rule
POSTCreate courier rule
GETGet courier rules
GETGet delivery configuration
PATCHTo patch any config which can be applied to application
PUTUpdate courier partner rule priority
POSTServiceable Courier Partners
POSTGet available application courier partners
POSTCreate zone
GETGet zones
GETGet zone details
PATCHUpdate details of a Zone to enable or disable
DELDelete a Specific Zone
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
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
GETDownload geoarea sample file
GETDownload zone products bulk patch sample file
POSTCreate bulk zone products patch job
GETGet bulk zone products patch job status
POSTAtomically add or remove products on zones (concurrency-safe)
POSTCreate a new fulfillment option
GETRetrieve fulfillment options with optional filters.
GETGet fulfillment options
DELDelete fulfillment options
PUTUpdate an existing fulfillment option
GETGet products for a specific fulfillment option.
GETGet stores for a specific fulfillment option.
POSTUpload bulk fulfillment options.
POSTValidate bulk fulfillment options.
GETValidate bulk fulfillment options.
GETGet store rule configuration
POSTCreate store rule configuration
PUTUpdate store rules configuration
GETGet store rules
POSTCreate store rule
GETGet store rule
PUTUpdate store rule
PUTUpdate Store Rule priority
POSTUpdate pincode COD support
POSTBulk update pincode COD support
POSTGet COD enabled pincodes
POSTGet audit trail
POSTCreate polygon-based serviceability for stores
GETGet polygon-based serviceability for stores
PATCHUpdate polygon-based serviceability for stores
POSTCreate and return shipments
POSTCreate short link
GETGet short links
GETGet short link by hash
PATCHUpdate short link
GETGet extension sections
PATCHUpdate theme name
GETGet applied theme
PUTUpdate a page
GETGet a List of Users
GETSearch an Existing Users
POSTCreate User
PUTBlock/Unblock Users
PUTRestore Deleted User
GETGet Deleted User Timeline
PUTUpdate User Details
PUTArchive User
POSTBulk import storefront customers using CSV and XLSX files.
GETGet Bulk User's Import Lists for a specific Application.
POSTBulk export storefront customers using CSV and XLSX files.
GETGet Bulk User's Export Lists for a specific Application.
GETRetrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
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
POSTCreate Or Update User Attribute
DELDelete User Attribute Values in Bulk
GETGet User Attribute
POSTFilter Users by Attribute Conditions
POSTCreate User Group
GETGet User Groups
PUTUpdate User Group
GETGet User Group
PATCHModify User Group
DELDelete User Group
POSTCreate User Session
DELDelete User Session
GETGet User Active Sessions
DELDelete User Active Sessions
GETGet Platform Config
POSTUpdate Platform Config

Fynd Platform v2.12.3 Change Logs

Compatible FDK Client Versions - v3.28.0

Cart

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property cart.loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property cart.loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CheckCart in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema SharedCart in response with status code 200

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 404

    • [Added] property cart.ship_to_gst_details of schema SharedCart in response with status code 404

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema SharedCart in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema UserCartMappingResult in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property cart.loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property cart.loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 201

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 201

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 201

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 201

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 201

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 201

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema PlatformCartShipmentsResult in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema PlatformCartShipmentsResult in response with status code 200

  • What's New

    • [Added] property ship_to_gst_details of schema PlatformCartMetaCreation in request body

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property cart.breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property cart.ship_to_gst_details of schema CheckCart in response with status code 200

  • What's New

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

  • What's New

    • [Added] property meta of schema RedeemLoyaltyPoints in request body

    • [Added] property breakup_values.loyalty_points.meta of schema LoyaltyPoints in response with status code 200

    • [Added] property ship_to_gst_details of schema CartDetailResult in response with status code 200

    • [Added] property loyalty_meta of schema CartDetailResult in response with status code 200

Catalog

  • What's New

    • [Added] property transaction_type of schema InventoryRequestSchema in request body

    • [Added] property transaction of schema InventoryRequestSchema in request body

  • What's New

    • [Added] property payload[].price_cost of schema InventoryPayload in request body

    • [Added] property payload[].transaction_type of schema InventoryPayload in request body

    • [Added] property payload[].transaction of schema InventoryPayload in request body

    • [Added] property transaction_type of schema InventoryRequestSchemaV2 in request body

    • [Added] property transaction of schema InventoryRequestSchemaV2 in request body

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 400

  • What's New

    • [Added] Possible values ea to property net_quantity.unit of schema NetQuantity in request body

    • [Added] Possible values set to property net_quantity.unit of schema NetQuantity in request body

  • What's New

    • [Added] Possible values ea to property net_quantity.unit of schema NetQuantity in request body

    • [Added] Possible values set to property net_quantity.unit of schema NetQuantity in request body

  • What's New

    • [Added] property payload[].price_cost of schema InventoryPayload in request body

    • [Added] property payload[].transaction_type of schema InventoryPayload in request body

    • [Added] property payload[].transaction of schema InventoryPayload in request body

    • [Added] property transaction_type of schema InventoryRequestSchemaV2 in request body

    • [Added] property transaction of schema InventoryRequestSchemaV2 in request body

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 400

  • What's New

    • [Added] property payload[].price_cost of schema InventoryPayload in request body

    • [Added] property payload[].transaction_type of schema InventoryPayload in request body

    • [Added] property payload[].transaction of schema InventoryPayload in request body

    • [Added] property transaction_type of schema InventoryRequestSchemaV2 in request body

    • [Added] property transaction of schema InventoryRequestSchemaV2 in request body

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 200

    • [Added] property items[].data.price_cost of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction_type of schema InventoryPayload in response with status code 400

    • [Added] property items[].data.transaction of schema InventoryPayload in response with status code 400

  • What's New

    • [Added] property price_cost of schema LocationPriceRequestSchema in request body

    • [Added] property transaction_type of schema LocationPriceRequestSchema in request body

    • [Added] property transaction of schema LocationPriceRequestSchema in request body

  • What's New

    • [Added] property transaction_type of schema LocationQuantityRequestSchema in request body

    • [Added] property transaction of schema LocationQuantityRequestSchema in request body

Serviceability

  • What's New

    • [Added] method patchZoneProductsAtomic

Payment

  • What's New

    • [Added] method updateOrderMeta

  • What's New

    • [Added] method getOrderTransactions


Next
Obtain charge details »