API & Webhook Differences

This page shows the REST API and Webhook differences between platform versions 1.9.4-RC235H and 1.10.5.

REST API Differences

Storefront REST

Storefront REST Change Log

Compared against: 1.9.4-RC235H

Current version: 1.10.5

• [Added] Finance class in application client

Cart

Cart

getCart

• What's New

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

• [Added] properties applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, applied_promo_details[].buy_rules[].cart_conditions.cart_total, applied_promo_details[].buy_rules[].cart_conditions.item_id, applied_promo_details[].buy_rules[].cart_conditions.item_store, applied_promo_details[].buy_rules[].cart_conditions.item_company, applied_promo_details[].buy_rules[].cart_conditions.item_brand, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, applied_promo_details[].buy_rules[].cart_conditions.item_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_department, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, applied_promo_details[].buy_rules[].cart_conditions.available_zones, applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].raw_offer.buy_condition, applied_promo_details[].discount_rules[].raw_offer.discount_type, applied_promo_details[].discount_rules[].raw_offer.offer, applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].offer.max_offer_quantity, applied_promo_details[].discount_rules[].offer.discount_percentage, applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].item_criteria.item_id, applied_promo_details[].discount_rules[].item_criteria.buy_rules, applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties items[].article.gift_card.gift_price, items[].article.gift_card.display_text, items[].article.gift_card.gift_message, items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property items[].article.type of schema ProductArticle in response with status code 200

• [Added] property items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties items[].moq.increment_unit, items[].moq.maximum, items[].moq.minimum in response with status code 200

• [Added] property items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties items[].custom_order.is_custom_order, items[].custom_order.manufacturing_time, items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, items[].promotions_applied[].buy_rules[].cart_conditions.item_id, items[].promotions_applied[].buy_rules[].cart_conditions.item_store, items[].promotions_applied[].buy_rules[].cart_conditions.item_company, items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_department, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, items[].promotions_applied[].discount_rules[].raw_offer.discount_type, items[].promotions_applied[].discount_rules[].raw_offer.offer, items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, items[].promotions_applied[].discount_rules[].offer.discount_percentage, items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].item_criteria.item_id, items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property error_code of schema CartDetailResponseObject in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

addItems

• What's New

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

• [Added] properties items[].article_assignment.level, items[].article_assignment.strategy in request body

• [Added] property items[].price_factory_type_id of schema AddProductCart in request body

• [Added] properties cart.applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, cart.applied_promo_details[].buy_rules[].cart_conditions.cart_total, cart.applied_promo_details[].buy_rules[].cart_conditions.item_id, cart.applied_promo_details[].buy_rules[].cart_conditions.item_store, cart.applied_promo_details[].buy_rules[].cart_conditions.item_company, cart.applied_promo_details[].buy_rules[].cart_conditions.item_brand, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, cart.applied_promo_details[].buy_rules[].cart_conditions.item_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_department, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, cart.applied_promo_details[].buy_rules[].cart_conditions.available_zones, cart.applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].raw_offer.buy_condition, cart.applied_promo_details[].discount_rules[].raw_offer.discount_type, cart.applied_promo_details[].discount_rules[].raw_offer.offer, cart.applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].offer.max_offer_quantity, cart.applied_promo_details[].discount_rules[].offer.discount_percentage, cart.applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].item_criteria.item_id, cart.applied_promo_details[].discount_rules[].item_criteria.buy_rules, cart.applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property cart.pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 200

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 200

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property cart.coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property cart.coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property cart.coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property cart.gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property cart.price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.error_code of schema CartDetailResponseObject in response with status code 200

• [Added] property result of schema AddCartDetailResponseObject in response with status code 200

• [Added] property error_code of schema AddCartDetailResponseObject in response with status code 200

• What's Deprecated

• [Deleted] Possible values from PickAtStore,HomeDelivery from property items[].order_type of schema AddProductCart in request body

• [Breaking] [Deleted] property cart.applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property cart.last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

updateCart

• What's New

• [Added] property items[].price_factory_type_id of schema UpdateProductCart in request body

• [Breaking] [Added] items[].item_index made required in request body

• [Added] properties cart.applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, cart.applied_promo_details[].buy_rules[].cart_conditions.cart_total, cart.applied_promo_details[].buy_rules[].cart_conditions.item_id, cart.applied_promo_details[].buy_rules[].cart_conditions.item_store, cart.applied_promo_details[].buy_rules[].cart_conditions.item_company, cart.applied_promo_details[].buy_rules[].cart_conditions.item_brand, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, cart.applied_promo_details[].buy_rules[].cart_conditions.item_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.applied_promo_details[].buy_rules[].cart_conditions.item_department, cart.applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, cart.applied_promo_details[].buy_rules[].cart_conditions.available_zones, cart.applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].raw_offer.buy_condition, cart.applied_promo_details[].discount_rules[].raw_offer.discount_type, cart.applied_promo_details[].discount_rules[].raw_offer.offer, cart.applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].offer.max_offer_quantity, cart.applied_promo_details[].discount_rules[].offer.discount_percentage, cart.applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.applied_promo_details[].discount_rules[].item_criteria.item_id, cart.applied_promo_details[].discount_rules[].item_criteria.buy_rules, cart.applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property cart.pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 200

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 200

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property cart.coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property cart.coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property cart.coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property cart.gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property cart.price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property cart.error_code of schema CartDetailResponseObject in response with status code 200

• [Added] property result of schema UpdateCartDetailResponseObject in response with status code 200

• [Added] property error_code of schema UpdateCartDetailResponseObject in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property cart.applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property cart.last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

deleteCart

• What's New

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

• [Added] Body content in Request

getCoupons

• What's New

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

• [Breaking] [Added] Value format date-time to property available_coupon_list[].start_date of schema Coupon in response with status code 200

• [Breaking] [Added] Value format date-time to property available_coupon_list[].end_date of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].uid of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].coupon_id of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].priority of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].tags of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].medias of schema Coupon in response with status code 200

• [Added] property available_coupon_list[].custom_content of schema Coupon in response with status code 200

• [Added] Response with status 400

• What's Changed

• [Breaking] [Changed] Value format from float to float32 of property available_coupon_list[].coupon_amount of schema Coupon in response with status code 200

applyCoupon

• What's New

• [Added] Response with status 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 201

removeCoupon

• What's New

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

• [Added] properties applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, applied_promo_details[].buy_rules[].cart_conditions.cart_total, applied_promo_details[].buy_rules[].cart_conditions.item_id, applied_promo_details[].buy_rules[].cart_conditions.item_store, applied_promo_details[].buy_rules[].cart_conditions.item_company, applied_promo_details[].buy_rules[].cart_conditions.item_brand, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, applied_promo_details[].buy_rules[].cart_conditions.item_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_department, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, applied_promo_details[].buy_rules[].cart_conditions.available_zones, applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].raw_offer.buy_condition, applied_promo_details[].discount_rules[].raw_offer.discount_type, applied_promo_details[].discount_rules[].raw_offer.offer, applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].offer.max_offer_quantity, applied_promo_details[].discount_rules[].offer.discount_percentage, applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].item_criteria.item_id, applied_promo_details[].discount_rules[].item_criteria.buy_rules, applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties items[].article.gift_card.gift_price, items[].article.gift_card.display_text, items[].article.gift_card.gift_message, items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property items[].article.type of schema ProductArticle in response with status code 200

• [Added] property items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties items[].moq.increment_unit, items[].moq.maximum, items[].moq.minimum in response with status code 200

• [Added] property items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties items[].custom_order.is_custom_order, items[].custom_order.manufacturing_time, items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, items[].promotions_applied[].buy_rules[].cart_conditions.item_id, items[].promotions_applied[].buy_rules[].cart_conditions.item_store, items[].promotions_applied[].buy_rules[].cart_conditions.item_company, items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_department, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, items[].promotions_applied[].discount_rules[].raw_offer.discount_type, items[].promotions_applied[].discount_rules[].raw_offer.offer, items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, items[].promotions_applied[].discount_rules[].offer.discount_percentage, items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].item_criteria.item_id, items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property error_code of schema CartDetailResponseObject in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

getBulkDiscountOffers

• What's New

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

• [Added] property data[].article_id of schema BulkPriceOffer in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

applyRewardPoints

• What's New

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

• [Added] properties applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, applied_promo_details[].buy_rules[].cart_conditions.cart_total, applied_promo_details[].buy_rules[].cart_conditions.item_id, applied_promo_details[].buy_rules[].cart_conditions.item_store, applied_promo_details[].buy_rules[].cart_conditions.item_company, applied_promo_details[].buy_rules[].cart_conditions.item_brand, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, applied_promo_details[].buy_rules[].cart_conditions.item_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_department, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, applied_promo_details[].buy_rules[].cart_conditions.available_zones, applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].raw_offer.buy_condition, applied_promo_details[].discount_rules[].raw_offer.discount_type, applied_promo_details[].discount_rules[].raw_offer.offer, applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].offer.max_offer_quantity, applied_promo_details[].discount_rules[].offer.discount_percentage, applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].item_criteria.item_id, applied_promo_details[].discount_rules[].item_criteria.buy_rules, applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties items[].article.gift_card.gift_price, items[].article.gift_card.display_text, items[].article.gift_card.gift_message, items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property items[].article.type of schema ProductArticle in response with status code 200

• [Added] property items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties items[].moq.increment_unit, items[].moq.maximum, items[].moq.minimum in response with status code 200

• [Added] property items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties items[].custom_order.is_custom_order, items[].custom_order.manufacturing_time, items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, items[].promotions_applied[].buy_rules[].cart_conditions.item_id, items[].promotions_applied[].buy_rules[].cart_conditions.item_store, items[].promotions_applied[].buy_rules[].cart_conditions.item_company, items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_department, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, items[].promotions_applied[].discount_rules[].raw_offer.discount_type, items[].promotions_applied[].discount_rules[].raw_offer.offer, items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, items[].promotions_applied[].discount_rules[].offer.discount_percentage, items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].item_criteria.item_id, items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property error_code of schema CartDetailResponseObject in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

getAddresses

• What's New

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

• [Added] Possible nullable value true to property address[].email of schema Address in response with status code 200

• [Added] property address[].pincode of schema Address in response with status code 200

• [Added] property address[].cart_id of schema Address in response with status code 200

• [Added] property address[].uid of schema Address in response with status code 200

• [Added] property address[].is_anonymous of schema Address in response with status code 200

• [Added] property address[].app_id of schema Address in response with status code 200

• [Added] property address[].expire_at of schema Address in response with status code 200

• [Added] property address[].address_id of schema Address in response with status code 200

• [Added] property address[].store_name of schema Address in response with status code 200

• [Added] property validation_config of schema GetAddressesResponseObject in response with status code 200

addAddress

• What's New

• [Added] Possible nullable value true to property email of schema Address in request body

• [Added] property pincode of schema Address in request body

• [Added] property cart_id of schema Address in request body

• [Added] property uid of schema Address in request body

• [Added] property is_anonymous of schema Address in request body

• [Added] property app_id of schema Address in request body

• [Added] property expire_at of schema Address in request body

• [Added] property address_id of schema Address in request body

• [Added] property store_name of schema Address in request body

• [Added] property address_id of schema SaveAddressResponseObject in response with status code 200

getAddressById

• What's New

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

• [Added] Possible nullable value true to property email of schema Address in response with status code 200

• [Added] property pincode of schema Address in response with status code 200

• [Added] property cart_id of schema Address in response with status code 200

• [Added] property uid of schema Address in response with status code 200

• [Added] property is_anonymous of schema Address in response with status code 200

• [Added] property app_id of schema Address in response with status code 200

• [Added] property expire_at of schema Address in response with status code 200

• [Added] property address_id of schema Address in response with status code 200

• [Added] property store_name of schema Address in response with status code 200

updateAddress

• What's New

• [Added] Possible nullable value true to property email of schema Address in request body

• [Added] property pincode of schema Address in request body

• [Added] property cart_id of schema Address in request body

• [Added] property uid of schema Address in request body

• [Added] property is_anonymous of schema Address in request body

• [Added] property app_id of schema Address in request body

• [Added] property expire_at of schema Address in request body

• [Added] property address_id of schema Address in request body

• [Added] property store_name of schema Address in request body

• [Added] Response with status 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 201

removeAddress

• What's New

• [Added] Response with status 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 201

selectAddress

• What's New

• [Added] Response with status 200

• [Added] property cart_id of schema SelectAddressResponseError in response with status code 400

• [Added] property id of schema SelectAddressResponseError in response with status code 400

• [Added] property is_valid of schema SelectAddressResponseError in response with status code 400

• [Added] property address of schema SelectAddressResponseError in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 201

• [Breaking] [Deleted] property status of schema in response with status code 400

selectPaymentMode

• What's New

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

• [Added] properties applied_promo_details[].buy_rules[].cart_conditions.cart_quantity, applied_promo_details[].buy_rules[].cart_conditions.cart_total, applied_promo_details[].buy_rules[].cart_conditions.item_id, applied_promo_details[].buy_rules[].cart_conditions.item_store, applied_promo_details[].buy_rules[].cart_conditions.item_company, applied_promo_details[].buy_rules[].cart_conditions.item_brand, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_brand, applied_promo_details[].buy_rules[].cart_conditions.item_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_category, applied_promo_details[].buy_rules[].cart_conditions.item_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l1_category, applied_promo_details[].buy_rules[].cart_conditions.item_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_l2_category, applied_promo_details[].buy_rules[].cart_conditions.item_department, applied_promo_details[].buy_rules[].cart_conditions.item_exclude_id, applied_promo_details[].buy_rules[].cart_conditions.available_zones, applied_promo_details[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property applied_promo_details[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].raw_offer.buy_condition, applied_promo_details[].discount_rules[].raw_offer.discount_type, applied_promo_details[].discount_rules[].raw_offer.offer, applied_promo_details[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].offer.max_offer_quantity, applied_promo_details[].discount_rules[].offer.discount_percentage, applied_promo_details[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties applied_promo_details[].discount_rules[].item_criteria.item_id, applied_promo_details[].discount_rules[].item_criteria.buy_rules, applied_promo_details[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property applied_promo_details[].id of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].discount of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].currency of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property applied_promo_details[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] Possible nullable value true to property pan_no of schema CartDetailResponseObject in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties items[].article.gift_card.gift_price, items[].article.gift_card.display_text, items[].article.gift_card.gift_message, items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property items[].article.type of schema ProductArticle in response with status code 200

• [Added] property items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties items[].moq.increment_unit, items[].moq.maximum, items[].moq.minimum in response with status code 200

• [Added] property items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties items[].custom_order.is_custom_order, items[].custom_order.manufacturing_time, items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, items[].promotions_applied[].buy_rules[].cart_conditions.item_id, items[].promotions_applied[].buy_rules[].cart_conditions.item_store, items[].promotions_applied[].buy_rules[].cart_conditions.item_company, items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, items[].promotions_applied[].buy_rules[].cart_conditions.item_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, items[].promotions_applied[].buy_rules[].cart_conditions.item_department, items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, items[].promotions_applied[].discount_rules[].raw_offer.discount_type, items[].promotions_applied[].discount_rules[].raw_offer.offer, items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, items[].promotions_applied[].discount_rules[].offer.discount_percentage, items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties items[].promotions_applied[].discount_rules[].item_criteria.item_id, items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property coupon.coupon_id of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.medias of schema CartDetailCoupon in response with status code 200

• [Added] property coupon.mrp_coupon of schema CartDetailCoupon in response with status code 200

• [Added] Possible nullable value true to property gstin of schema CartDetailResponseObject in response with status code 200

• [Added] property breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] property price_adjustment_applied of schema CartDetailResponseObject in response with status code 200

• [Added] property custom_cart of schema CartDetailResponseObject in response with status code 200

• [Added] property is_pan_received of schema CartDetailResponseObject in response with status code 200

• [Added] property error_code of schema CartDetailResponseObject in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property applied_promo_details[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] properties items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property last_modified of schema CartDetailResponse in response with status code 200

• [Deleted] Value format from float from property breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

getShipments

• What's New

• [Added] query parameter pick_at_store_uid (type: integer)

• [Added] query parameter ordering_store_id (type: integer)

• [Added] query parameter i (type: boolean)

• [Added] Possible nullable value true to property gstin of schema CartShipments in response with status code 200

• [Added] property breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

• [Added] Possible nullable value true to property shipments[].promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property shipments[].promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property shipments[].promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property shipments[].promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property shipments[].promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property shipments[].promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Breaking] [Added] Possible values pickAtStore,HomeDelivery to property shipments[].order_type of schema ShipmentResponseObject in response with status code 200

• [Added] property shipments[].items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property shipments[].items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties shipments[].items[].article.gift_card.gift_price, shipments[].items[].article.gift_card.display_text, shipments[].items[].article.gift_card.gift_message, shipments[].items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property shipments[].items[].article.type of schema ProductArticle in response with status code 200

• [Added] property shipments[].items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties shipments[].items[].moq.increment_unit, shipments[].items[].moq.maximum, shipments[].items[].moq.minimum in response with status code 200

• [Added] property shipments[].items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property shipments[].items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property shipments[].items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property shipments[].items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property shipments[].items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property shipments[].items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property shipments[].items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties shipments[].items[].custom_order.is_custom_order, shipments[].items[].custom_order.manufacturing_time, shipments[].items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property shipments[].items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property shipments[].items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_id, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_store, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_company, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_department, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, shipments[].items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties shipments[].items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, shipments[].items[].promotions_applied[].discount_rules[].raw_offer.discount_type, shipments[].items[].promotions_applied[].discount_rules[].raw_offer.offer, shipments[].items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties shipments[].items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, shipments[].items[].promotions_applied[].discount_rules[].offer.discount_percentage, shipments[].items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties shipments[].items[].promotions_applied[].discount_rules[].item_criteria.item_id, shipments[].items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, shipments[].items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property shipments[].items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property shipments[].items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] property shipments[].meta of schema ShipmentResponseObject in response with status code 200

• [Added] property shipments[].logistics_meta of schema ShipmentResponseObject in response with status code 200

• [Added] property shipments[].error of schema ShipmentResponseObject in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property error_message of schema CartShipments in response with status code 200

• [Added] property pan_config of schema CartShipments in response with status code 200

• [Added] property items of schema CartShipments in response with status code 200

• [Added] property common_config of schema CartShipments in response with status code 200

• [Added] property coupon of schema CartShipments in response with status code 200

• [Added] property notification of schema CartShipments in response with status code 200

• [Added] property staff_user_id of schema CartShipments in response with status code 200

• [Added] property success of schema CartShipments in response with status code 200

• [Added] property applied_promo_details of schema CartShipments in response with status code 200

• [Added] property pan_no of schema CartShipments in response with status code 200

• [Added] property custom_cart of schema CartShipments in response with status code 200

• [Added] property price_adjustment_applied of schema CartShipments in response with status code 200

• [Added] property is_pan_received of schema CartShipments in response with status code 200

• [Added] property error_code of schema CartShipments in response with status code 200

• What's Deprecated

• [Deleted] Value format from date-time from property last_modified of schema CartShipmentsResponse in response with status code 200

• [Deleted] Value format from float from property breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• [Breaking] [Deleted] Default value from property shipments[].box_type of schema ShipmentResponse in response with status code 200

• [Breaking] [Deleted] Default value from property shipments[].dp_options of schema ShipmentResponse in response with status code 200

• [Breaking] [Deleted] Default value from property shipments[].dp_id of schema ShipmentResponse in response with status code 200

• [Breaking] [Deleted] properties shipments[].items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property shipments[].items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property shipments[].items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

checkoutCart

• What's New

• [Breaking] [Added] Type object to property customer_details of schema CartCheckoutDetailRequestObject in request body

• [Added] Possible nullable value true to property payment_confirm_url of schema CartCheckoutResponseObject in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 200

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 200

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property cart.gstin of schema CheckCart in response with status code 200

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

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

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

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

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

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

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

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

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

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

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

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

• What's Deprecated

• [Breaking] [Deleted] property cart.delivery_charges of schema CheckCart in response with status code 200

• [Breaking] [Deleted] property cart.error_message of schema CheckCart in response with status code 200

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Breaking] [Deleted] property cart.delivery_charge_order_value of schema CheckCart in response with status code 200

• [Breaking] [Deleted] property cart.cod_available of schema CheckCart in response with status code 200

• [Breaking] [Deleted] property cart.store_code of schema CheckCart in response with status code 200

• [Deleted] Value format from date-time from property cart.last_modified of schema CheckCart in response with status code 200

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• [Breaking] [Deleted] property cart.store_emps of schema CheckCart in response with status code 200

• [Breaking] [Deleted] property cart.cod_charges of schema CheckCart in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

updateCartMeta

• What's New

• [Added] Possible nullable value true to property gift_details of schema CartMetaRequestObject in request body

• [Added] property pan_no of schema CartMetaRequestObject in request body

• [Added] property staff_user_id of schema CartMetaRequestObject in request body

• [Added] properties errors.pan_no, errors.gstin, errors.checkout_mode, errors.comment, errors.pick_up_customer_details, errors.gift_details, errors.staff_user_id, errors.delivery_slots, errors.custom_cart_meta in response with status code 400

• [Added] property message of schema CartMetaMissingResponseObject in response with status code 400

• [Added] property success of schema CartMetaMissingResponseObject in response with status code 400

• [Added] property meta of schema CartMetaMissingResponseObject in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] properties gift_details.article_id in request body

• [Breaking] [Deleted] property errors[] of schema CartMetaMissingResponse in response with status code 400

• What's Changed

• [Breaking] [Changed] Type from array to object of property errors of schema CartMetaMissingResponse in response with status code 400

getCartSharedItems

• What's New

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 200

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 200

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property cart.gstin of schema SharedCart in response with status code 200

• [Added] property cart.shared_cart_details.ordering_store of schema SharedCartDetails in response with status code 200

• [Added] property cart.shared_cart_details.selected_staff of schema SharedCartDetails in response with status code 200

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

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

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

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

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

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

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

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

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

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

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

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

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 404

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 404

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 404

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 404

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 404

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 404

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 404

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 404

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 404

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 404

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 404

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 404

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 404

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 404

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 404

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 404

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 404

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 404

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 404

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 404

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 404

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 404

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 404

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 404

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 404

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 404

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 404

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 404

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 404

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 404

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 404

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 404

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 404

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 404

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 404

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 404

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 404

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 404

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 404

• [Added] Possible nullable value true to property cart.gstin of schema SharedCart in response with status code 404

• [Added] property cart.shared_cart_details.ordering_store of schema SharedCartDetails in response with status code 404

• [Added] property cart.shared_cart_details.selected_staff of schema SharedCartDetails in response with status code 404

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 404

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 404

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 404

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 404

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 404

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 404

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 404

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 404

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 404

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

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

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

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

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

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

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

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

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

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

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

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

• What's Deprecated

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property cart.last_modified of schema SharedCart in response with status code 200

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 404

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 404

• [Deleted] Value format from date-time from property cart.last_modified of schema SharedCart in response with status code 404

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 404

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 404

updateCartWithSharedItems

• What's New

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

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] property cart.items[].article.price.base.selling of schema BasePrice in response with status code 200

• [Added] property cart.items[].article.price.converted.selling of schema BasePrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.product_group_tags of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller.name of schema BaseInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.seller_identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.identifier of schema ProductArticle in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.store_code of schema StoreInfo in response with status code 200

• [Added] Possible nullable value true to property cart.items[].article.store.name of schema StoreInfo in response with status code 200

• [Added] properties cart.items[].article.gift_card.gift_price, cart.items[].article.gift_card.display_text, cart.items[].article.gift_card.gift_message, cart.items[].article.gift_card.is_gift_applied in response with status code 200

• [Breaking] [Added] Possible values article to property cart.items[].article.type of schema ProductArticle in response with status code 200

• [Added] property cart.items[].article.variants of schema ProductArticle in response with status code 200

• [Added] properties cart.items[].moq.increment_unit, cart.items[].moq.maximum, cart.items[].moq.minimum in response with status code 200

• [Added] property cart.items[].price.base.selling_price of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price.converted.selling_price of schema ProductPrice in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.max of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.formatted.min of schema PromiseFormatted in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.max of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.timestamp.min of schema PromiseTimestamp in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.max of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].delivery_promise.iso.min of schema PromiseISOFormat in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.brand.name of schema BaseInfo in response with status code 200

• [Added] property cart.items[].product.action.page of schema ProductAction in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.teaser_tag of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.tags of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.type of schema CartProduct in response with status code 200

• [Added] Possible nullable value true to property cart.items[].product.attributes of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l1_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l2_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.l3_categories of schema CartProduct in response with status code 200

• [Added] property cart.items[].product.departments of schema CartProduct in response with status code 200

• [Added] properties cart.items[].custom_order.is_custom_order, cart.items[].custom_order.manufacturing_time, cart.items[].custom_order.manufacturing_time_unit in response with status code 200

• [Added] Possible nullable value true to property cart.items[].is_set of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].price_per_unit.base.selling of schema ProductPrice in response with status code 200

• [Added] property cart.items[].price_per_unit.converted.selling of schema ProductPrice in response with status code 200

• [Added] properties cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_quantity, cart.items[].promotions_applied[].buy_rules[].cart_conditions.cart_total, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_store, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_company, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_brand, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l1_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_l2_category, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_department, cart.items[].promotions_applied[].buy_rules[].cart_conditions.item_exclude_id, cart.items[].promotions_applied[].buy_rules[].cart_conditions.available_zones, cart.items[].promotions_applied[].buy_rules[].cart_conditions.product_tags in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].all_items of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].mrp_promo of schema BuyRules in response with status code 200

• [Added] property cart.items[].promotions_applied[].buy_rules[].slug of schema BuyRules in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].raw_offer.buy_condition, cart.items[].promotions_applied[].discount_rules[].raw_offer.discount_type, cart.items[].promotions_applied[].discount_rules[].raw_offer.offer, cart.items[].promotions_applied[].discount_rules[].raw_offer.item_criteria in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].offer.max_offer_quantity, cart.items[].promotions_applied[].discount_rules[].offer.discount_percentage, cart.items[].promotions_applied[].discount_rules[].offer.discount_amount in response with status code 200

• [Added] properties cart.items[].promotions_applied[].discount_rules[].item_criteria.item_id, cart.items[].promotions_applied[].discount_rules[].item_criteria.buy_rules, cart.items[].promotions_applied[].discount_rules[].item_criteria.all_items in response with status code 200

• [Added] property cart.items[].promotions_applied[].id of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].discount of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].original_article_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].currency of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_label of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].return_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].cancellation_allowed of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].promo_code of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].free_quantity of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].promotions_applied[].offer_description of schema AppliedPromotion in response with status code 200

• [Added] property cart.items[].price_adjustment_applied of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].mrp_promo_price of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].seller_count of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].allow_remove of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].auto_add_to_cart of schema CartProductInfo in response with status code 200

• [Added] property cart.items[].discount_meta of schema CartProductInfo in response with status code 200

• [Added] Possible nullable value true to property cart.gstin of schema SharedCart in response with status code 200

• [Added] property cart.shared_cart_details.ordering_store of schema SharedCartDetails in response with status code 200

• [Added] property cart.shared_cart_details.selected_staff of schema SharedCartDetails in response with status code 200

• [Added] property cart.breakup_values.display[].original of schema DisplayBreakup in response with status code 200

• [Added] property cart.breakup_values.display[].attr of schema DisplayBreakup in response with status code 200

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

• [Added] property cart.breakup_values.raw.promotion of schema RawBreakup in response with status code 200

• [Added] property cart.breakup_values.raw.sub_total of schema RawBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.coupon.uid of schema CouponBreakup in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.total of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.description of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.applicable of schema LoyaltyPoints in response with status code 200

• [Added] Possible nullable value true to property cart.breakup_values.loyalty_points.is_applied of schema LoyaltyPoints in response with status code 200

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

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

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

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

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

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

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

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

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

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

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

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

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] properties cart.items[].product.teaser_tag.tags in response with status code 200

• [Breaking] [Deleted] property cart.items[].promotions_applied[].float_amount of schema AppliedPromotion in response with status code 200

• [Deleted] Value format from date-time from property cart.last_modified of schema SharedCart in response with status code 200

• [Deleted] Value format from float from property cart.breakup_values.display[].preset of schema DisplayBreakup in response with status code 200

• What's Changed

• [Breaking] [Changed] Value format from int32 to int64 of property cart.items[].availability.other_store_quantity of schema ProductAvailability in response with status code 200

getPromotionOffers

• What's New

• [Added] property available_promotions[].tags of schema PromotionOffer in response with status code 200

• [Added] property available_promotions[].medias of schema PromotionOffer in response with status code 200

• [Added] property available_promotions[].is_bank_offer of schema PromotionOffer in response with status code 200

• [Added] property available_promotions[].custom_content of schema PromotionOffer in response with status code 200

• [Added] property error of schema OperationErrorResponseObject in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] query parameter cart_type (type: string)

• [Deleted] Value format from date-time from property available_promotions[].valid_till of schema PromotionOffer in response with status code 200

getLadderOffers

• What's New

• [Added] property available_offers[].promotion_type of schema LadderPriceOffer in response with status code 200

• [Added] property available_offers[].medias of schema LadderPriceOffer in response with status code 200

• [Added] property available_offers[].custom_content of schema LadderPriceOffer in response with status code 200

• [Added] property store_id of schema LadderPriceOffers in response with status code 200

• [Added] property error of schema OperationErrorResponseObject in response with status code 400

• What's Deprecated

• [Deleted] Value format from date-time from property available_offers[].valid_till of schema LadderPriceOffer in response with status code 200

Catalog

Catalog

getProductDetailBySlug

• What's New

• [Added] properties category_map.l1.action.page.query.category, category_map.l1.action.page.query.brand, category_map.l1.action.page.query.department in response with status code 200

• [Added] properties category_map.l1.action.page.params.slug in response with status code 200

• [Added] property category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties category_map.l2.action.page.query.category, category_map.l2.action.page.query.brand, category_map.l2.action.page.query.department in response with status code 200

• [Added] properties category_map.l2.action.page.params.slug in response with status code 200

• [Added] property category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties category_map.l3.action.page.query.category, category_map.l3.action.page.query.brand, category_map.l3.action.page.query.department in response with status code 200

• [Added] properties category_map.l3.action.page.params.slug in response with status code 200

• [Added] property category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property item_type of schema ProductDetail in response with status code 200

• [Added] properties categories[].action.page.query.category, categories[].action.page.query.brand, categories[].action.page.query.department in response with status code 200

• [Added] properties categories[].action.page.params.slug in response with status code 200

• [Added] property categories[].type of schema ProductBrand in response with status code 200

• [Added] property categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties action.page.query.category, action.page.query.brand, action.page.query.department in response with status code 200

• [Added] properties action.page.params.slug in response with status code 200

• [Added] property price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties brand.action.page.query.category, brand.action.page.query.brand, brand.action.page.query.department in response with status code 200

• [Added] properties brand.action.page.params.slug in response with status code 200

• [Added] property brand.type of schema ProductBrand in response with status code 200

• [Added] property brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property sizes of schema ProductDetail in response with status code 200

• [Added] property identifiers of schema ProductDetail in response with status code 200

• [Added] property is_tryout of schema ProductDetail in response with status code 200

• [Added] property channel of schema ProductDetail in response with status code 200

• [Added] property discount_meta of schema ProductDetail in response with status code 200

• [Added] property variants of schema ProductDetail in response with status code 200

• [Added] property promo_meta of schema ProductDetail in response with status code 200

• [Added] property no_of_boxes of schema ProductDetail in response with status code 200

• [Added] property template_tag of schema ProductDetail in response with status code 200

• [Added] property sellable of schema ProductDetail in response with status code 200

• [Added] property country_of_origin of schema ProductDetail in response with status code 200

• [Added] property modified_on of schema ProductDetail in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/{slug}/ To /service/application/catalog/v1.0/products/{slug}

getProductSizesBySlug

• What's New

• [Added] property sizes[].set of schema ProductSize in response with status code 200

• [Added] property moq of schema ProductSizes in response with status code 200

• [Added] property tags of schema ProductSizes in response with status code 200

• [Added] property custom_order of schema ProductSizes in response with status code 200

• [Added] property no_of_boxes of schema ProductSizes in response with status code 200

• [Added] property teaser_tag of schema ProductSizes in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] property sizes[]._custom_json of schema ProductSize in response with status code 200

• [Deleted] Value format from date-time from property discount_meta.start of schema DiscountMeta in response with status code 200

• [Deleted] Value format from date-time from property discount_meta.end of schema DiscountMeta in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/{slug}/sizes/ To /service/application/catalog/v1.0/products/{slug}/sizes

getProductComparisonBySlugs

• What's New

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values standard,composite,set,digital to property items[].item_type of schema ProductCompareDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].template_tag of schema ProductCompareDetail in response with status code 200

• [Added] property items[].sellable of schema ProductCompareDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductCompareDetail in response with status code 200

• [Added] Response with status 404

• What's Deprecated

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

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

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

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

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/compare/ To /service/application/catalog/v1.0/products/compare

getSimilarComparisonProductBySlug

• What's New

• [Added] properties items[].category_map.l1.action.page.query.category, items[].category_map.l1.action.page.query.brand, items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l2.action.page.query.category, items[].category_map.l2.action.page.query.brand, items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l3.action.page.query.category, items[].category_map.l3.action.page.query.brand, items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property items[].item_type of schema ProductDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].sizes of schema ProductDetail in response with status code 200

• [Added] property items[].identifiers of schema ProductDetail in response with status code 200

• [Added] property items[].is_tryout of schema ProductDetail in response with status code 200

• [Added] property items[].channel of schema ProductDetail in response with status code 200

• [Added] property items[].discount_meta of schema ProductDetail in response with status code 200

• [Added] property items[].variants of schema ProductDetail in response with status code 200

• [Added] property items[].promo_meta of schema ProductDetail in response with status code 200

• [Added] property items[].no_of_boxes of schema ProductDetail in response with status code 200

• [Added] property items[].template_tag of schema ProductDetail in response with status code 200

• [Added] property items[].sellable of schema ProductDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductDetail in response with status code 200

• [Added] property items[].modified_on of schema ProductDetail in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/{slug}/similar/compare/ To /service/application/catalog/v1.0/products/{slug}/similar/compare

getComparedFrequentlyProductBySlug

• What's New

• [Added] properties similars.items[].category_map.l1.action.page.query.category, similars.items[].category_map.l1.action.page.query.brand, similars.items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties similars.items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property similars.items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property similars.items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties similars.items[].category_map.l2.action.page.query.category, similars.items[].category_map.l2.action.page.query.brand, similars.items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties similars.items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property similars.items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property similars.items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties similars.items[].category_map.l3.action.page.query.category, similars.items[].category_map.l3.action.page.query.brand, similars.items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties similars.items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property similars.items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property similars.items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property similars.items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property similars.items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property similars.items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property similars.items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property similars.items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property similars.items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property similars.items[].item_type of schema ProductDetail in response with status code 200

• [Added] properties similars.items[].categories[].action.page.query.category, similars.items[].categories[].action.page.query.brand, similars.items[].categories[].action.page.query.department in response with status code 200

• [Added] properties similars.items[].categories[].action.page.params.slug in response with status code 200

• [Added] property similars.items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property similars.items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties similars.items[].action.page.query.category, similars.items[].action.page.query.brand, similars.items[].action.page.query.department in response with status code 200

• [Added] properties similars.items[].action.page.params.slug in response with status code 200

• [Added] property similars.items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties similars.items[].brand.action.page.query.category, similars.items[].brand.action.page.query.brand, similars.items[].brand.action.page.query.department in response with status code 200

• [Added] properties similars.items[].brand.action.page.params.slug in response with status code 200

• [Added] property similars.items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property similars.items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property similars.items[].sizes of schema ProductDetail in response with status code 200

• [Added] property similars.items[].identifiers of schema ProductDetail in response with status code 200

• [Added] property similars.items[].is_tryout of schema ProductDetail in response with status code 200

• [Added] property similars.items[].channel of schema ProductDetail in response with status code 200

• [Added] property similars.items[].discount_meta of schema ProductDetail in response with status code 200

• [Added] property similars.items[].variants of schema ProductDetail in response with status code 200

• [Added] property similars.items[].promo_meta of schema ProductDetail in response with status code 200

• [Added] property similars.items[].no_of_boxes of schema ProductDetail in response with status code 200

• [Added] property similars.items[].template_tag of schema ProductDetail in response with status code 200

• [Added] property similars.items[].sellable of schema ProductDetail in response with status code 200

• [Added] property similars.items[].country_of_origin of schema ProductDetail in response with status code 200

• [Added] property similars.items[].modified_on of schema ProductDetail in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property similars.items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/{slug}/similar/compared-frequently/ To /service/application/catalog/v1.0/products/{slug}/similar/compared-frequently

getProductVariantsBySlug

• What's New

• [Added] properties variants[].items[].action.page.query.category, variants[].items[].action.page.query.brand, variants[].items[].action.page.query.department in response with status code 200

• [Added] properties variants[].items[].action.page.params.slug in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/{slug}/variants/ To /service/application/catalog/v1.0/products/{slug}/variants

getProductStockByIds

• What's New

• [Added] properties items[].identifier.ean, items[].identifier.alu, items[].identifier.upc, items[].identifier.sku_code in response with status code 200

• [Added] property items[].brand of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].seller_identifier of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_effective of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_selling of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_marked of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].discount_meta of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].discount_applied of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].company_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].brand_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].store_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].currency of schema ProductStockStatusItem in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/stock-status/ To /service/application/catalog/v1.0/products/stock-status

getProductStockForTimeByIds

• What's New

• [Added] properties items[].identifier.ean, items[].identifier.alu, items[].identifier.upc, items[].identifier.sku_code in response with status code 200

• [Added] property items[].brand of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].seller_identifier of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_effective of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_selling of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].price_marked of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].discount_meta of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].discount_applied of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].company_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].brand_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].store_id of schema ProductStockStatusItem in response with status code 200

• [Added] property items[].currency of schema ProductStockStatusItem in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/stock-status/poll/ To /service/application/catalog/v1.0/products/stock-status/poll

getProducts

• What's New

• [Added] properties items[].category_map.l1.action.page.query.category, items[].category_map.l1.action.page.query.brand, items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l2.action.page.query.category, items[].category_map.l2.action.page.query.brand, items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l3.action.page.query.category, items[].category_map.l3.action.page.query.brand, items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property items[].item_type of schema ProductListingDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].variants[].items[].action.page.query.category, items[].variants[].items[].action.page.query.brand, items[].variants[].items[].action.page.query.department in response with status code 200

• [Added] properties items[].variants[].items[].action.page.params.slug in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].discount_meta of schema ProductListingDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductListingDetail in response with status code 200

• [Added] property items[].is_tryout of schema ProductListingDetail in response with status code 200

• [Added] property items[].channel of schema ProductListingDetail in response with status code 200

• [Added] property items[].modified_on of schema ProductListingDetail in response with status code 200

• [Added] property filters[].values[].logo of schema ProductFiltersValue in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/products/ To /service/application/catalog/v1.0/products

getBrands

• What's New

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].id of schema BrandItem in response with status code 200

• [Added] property items[].seo of schema BrandItem in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/brands/ To /service/application/catalog/v1.0/brands

getBrandDetailBySlug

• What's New

• [Added] property slug of schema BrandDetailResponseSchema in response with status code 200

• [Added] property _app of schema BrandDetailResponseSchema in response with status code 200

• [Added] property seo of schema BrandDetailResponseSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/brands/{slug}/ To /service/application/catalog/v1.0/brands/{slug}

getCategories

• What's New

• [Added] properties data[].items[].childs[].childs[].childs[].action.page.query.category, data[].items[].childs[].childs[].childs[].action.page.query.brand, data[].items[].childs[].childs[].childs[].action.page.query.department in response with status code 200

• [Added] properties data[].items[].childs[].childs[].childs[].action.page.params.slug in response with status code 200

• [Added] property data[].items[].childs[].childs[].childs[].priority of schema ThirdLevelChild in response with status code 200

• [Added] properties data[].items[].childs[].childs[].action.page.query.category, data[].items[].childs[].childs[].action.page.query.brand, data[].items[].childs[].childs[].action.page.query.department in response with status code 200

• [Added] properties data[].items[].childs[].childs[].action.page.params.slug in response with status code 200

• [Added] property data[].items[].childs[].childs[].priority of schema SecondLevelChild in response with status code 200

• [Added] properties data[].items[].childs[].action.page.query.category, data[].items[].childs[].action.page.query.brand, data[].items[].childs[].action.page.query.department in response with status code 200

• [Added] properties data[].items[].childs[].action.page.params.slug in response with status code 200

• [Added] property data[].items[].childs[].priority of schema Child in response with status code 200

• [Added] properties data[].items[].action.page.query.category, data[].items[].action.page.query.brand, data[].items[].action.page.query.department in response with status code 200

• [Added] properties data[].items[].action.page.params.slug in response with status code 200

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

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

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/categories/ To /service/application/catalog/v1.0/categories

getCategoryDetailBySlug

• What's New

• [Added] property _app of schema CategoryMetaResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/categories/{slug}/ To /service/application/catalog/v1.0/categories/{slug}

getHomeProducts

• What's New

• [Added] properties items[].category_map.l1.action.page.query.category, items[].category_map.l1.action.page.query.brand, items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l2.action.page.query.category, items[].category_map.l2.action.page.query.brand, items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l3.action.page.query.category, items[].category_map.l3.action.page.query.brand, items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property items[].item_type of schema ProductListingDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].variants[].items[].action.page.query.category, items[].variants[].items[].action.page.query.brand, items[].variants[].items[].action.page.query.department in response with status code 200

• [Added] properties items[].variants[].items[].action.page.params.slug in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].discount_meta of schema ProductListingDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductListingDetail in response with status code 200

• [Added] property items[].is_tryout of schema ProductListingDetail in response with status code 200

• [Added] property items[].channel of schema ProductListingDetail in response with status code 200

• [Added] property items[].modified_on of schema ProductListingDetail in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property sort_on of schema HomeListingResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/home/listing/ To /service/application/catalog/v1.0/home/listing

getDepartments

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/departments/ To /service/application/catalog/v1.0/departments

getSearchResults

• What's New

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/auto-complete/ To /service/application/catalog/v1.0/auto-complete

getCollections

• What's New

• [Added] properties items[]._schedule.cron, items[]._schedule.next_schedule, items[]._schedule.duration, items[]._schedule.start, items[]._schedule.end, items[]._schedule.metadata in response with status code 200

• [Breaking] [Added] Type string to property items[].query[].value[] of schema CollectionQuery in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

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

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

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

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

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

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

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 404

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/collections/ To /service/application/catalog/v1.0/collections

getCollectionItemsBySlug

• What's New

• [Added] properties items[].category_map.l1.action.page.query.category, items[].category_map.l1.action.page.query.brand, items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l2.action.page.query.category, items[].category_map.l2.action.page.query.brand, items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l3.action.page.query.category, items[].category_map.l3.action.page.query.brand, items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property items[].item_type of schema ProductListingDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].variants[].items[].action.page.query.category, items[].variants[].items[].action.page.query.brand, items[].variants[].items[].action.page.query.department in response with status code 200

• [Added] properties items[].variants[].items[].action.page.params.slug in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].discount_meta of schema ProductListingDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductListingDetail in response with status code 200

• [Added] property items[].is_tryout of schema ProductListingDetail in response with status code 200

• [Added] property items[].channel of schema ProductListingDetail in response with status code 200

• [Added] property items[].modified_on of schema ProductListingDetail in response with status code 200

• [Added] property filters[].values[].logo of schema ProductFiltersValue in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/collections/{slug}/items/ To /service/application/catalog/v1.0/collections/{slug}/items

getCollectionDetailBySlug

• What's New

• [Added] properties _schedule.cron, _schedule.next_schedule, _schedule.duration, _schedule.start, _schedule.end, _schedule.metadata in response with status code 200

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in response with status code 200

• [Added] property uid of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property published of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property tags of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property _locale_language of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property seo of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property action of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property modified_on of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property _id of schema CollectionDetailResponseSchema in response with status code 200

• [Added] property is_visible of schema CollectionDetailResponseSchema in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/collections/{slug}/ To /service/application/catalog/v1.0/collections/{slug}

getFollowedListing

• What's New

• [Added] properties items[].category_map.l1.action.page.query.category, items[].category_map.l1.action.page.query.brand, items[].category_map.l1.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l1.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l1.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l1._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l2.action.page.query.category, items[].category_map.l2.action.page.query.brand, items[].category_map.l2.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l2.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l2.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l2._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].category_map.l3.action.page.query.category, items[].category_map.l3.action.page.query.brand, items[].category_map.l3.action.page.query.department in response with status code 200

• [Added] properties items[].category_map.l3.action.page.params.slug in response with status code 200

• [Added] property items[].category_map.l3.type of schema ProductBrand in response with status code 200

• [Added] property items[].category_map.l3._custom_json of schema ProductBrand in response with status code 200

• [Breaking] [Added] Type string to property items[].net_quantity.unit of schema NetQuantity in response with status code 200

• [Breaking] [Added] Type string to property items[].seo.description of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.sitemap of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.meta_tags of schema ApplicationItemSEO in response with status code 200

• [Added] property items[].seo.canonical_url of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Added] Possible values set,standard,composite,digital to property items[].item_type of schema ProductListingDetail in response with status code 200

• [Added] properties items[].categories[].action.page.query.category, items[].categories[].action.page.query.brand, items[].categories[].action.page.query.department in response with status code 200

• [Added] properties items[].categories[].action.page.params.slug in response with status code 200

• [Added] property items[].categories[].type of schema ProductBrand in response with status code 200

• [Added] property items[].categories[]._custom_json of schema ProductBrand in response with status code 200

• [Added] properties items[].variants[].items[].action.page.query.category, items[].variants[].items[].action.page.query.brand, items[].variants[].items[].action.page.query.department in response with status code 200

• [Added] properties items[].variants[].items[].action.page.params.slug in response with status code 200

• [Added] properties items[].action.page.query.category, items[].action.page.query.brand, items[].action.page.query.department in response with status code 200

• [Added] properties items[].action.page.params.slug in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].brand.action.page.query.category, items[].brand.action.page.query.brand, items[].brand.action.page.query.department in response with status code 200

• [Added] properties items[].brand.action.page.params.slug in response with status code 200

• [Added] property items[].brand.type of schema ProductBrand in response with status code 200

• [Added] property items[].brand._custom_json of schema ProductBrand in response with status code 200

• [Added] property items[].discount_meta of schema ProductListingDetail in response with status code 200

• [Added] property items[].country_of_origin of schema ProductListingDetail in response with status code 200

• [Added] property items[].is_tryout of schema ProductListingDetail in response with status code 200

• [Added] property items[].channel of schema ProductListingDetail in response with status code 200

• [Added] property items[].modified_on of schema ProductListingDetail in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.title of schema ApplicationItemSEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/follow/{collection_type}/ To /service/application/catalog/v1.0/follow/{collection_type}

unfollowById

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/ To /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}

followById

• What's New

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/ To /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}

getFollowerCountById

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count/ To /service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count

getFollowIds

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/follow/ids/ To /service/application/catalog/v1.0/follow/ids

getStores

• What's New

• [Added] property items[].manager_contact of schema Store in response with status code 200

• [Added] property items[].contacts of schema Store in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].pincode of schema Store in response with status code 200

• [Changed] Path From /service/application/catalog/v1.0/locations/ To /service/application/catalog/v2.0/locations

getInStockLocations

• What's New

• [Added] properties filters[].slug, filters[].uid, filters[].is_active, filters[].priority_order, filters[].name, filters[].logo, filters[].modified_by, filters[].modified_on in response with status code 200

• [Added] properties items[].departments[].logo.url, items[].departments[].logo.type, items[].departments[].logo.meta, items[].departments[].logo.alt in response with status code 200

• [Added] property items[].departments[].is_active of schema AppStoreDepartment in response with status code 200

• [Added] property items[].address.lat_long of schema StoreAddressSchema in response with status code 200

• [Added] property items[].address.country_code of schema StoreAddressSchema in response with status code 200

• [Added] property items[].address.address_meta of schema StoreAddressSchema in response with status code 200

• [Added] property items[]._custom_json of schema AppStore in response with status code 200

• [Added] property items[].additional_contacts of schema AppStore in response with status code 200

• [Added] property items[].company_id of schema AppStore in response with status code 200

• [Added] property items[].display_name of schema AppStore in response with status code 200

• [Added] property items[].store_type of schema AppStore in response with status code 200

• [Added] property items[].auto_invoice of schema AppStore in response with status code 200

• [Added] property items[].credit_note of schema AppStore in response with status code 200

• [Added] property items[].stage of schema AppStore in response with status code 200

• [Added] property items[].gst_credentials of schema AppStore in response with status code 200

• [Added] property items[].product_return_config of schema AppStore in response with status code 200

• [Added] property items[].avg_order_processing_time of schema AppStore in response with status code 200

• [Added] property items[].bulk_shipment of schema AppStore in response with status code 200

• [Added] property items[].default_order_acceptance_timing of schema AppStore in response with status code 200

• [Added] property items[].order_acceptance_timing of schema AppStore in response with status code 200

• [Added] property items[].auto_assign_courier_partner of schema AppStore in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Deleted] Value format from email from property items[].manager.email of schema StoreManagerSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].address.pincode of schema StoreAddressSerializer in response with status code 200

• [Changed] Path From /service/application/catalog/v1.0/in-stock/locations/ To /service/application/catalog/v2.0/in-stock/locations

getLocationDetailsById

• What's New

• [Added] property address.lat_long of schema StoreAddressSchema in response with status code 200

• [Added] property address.country_code of schema StoreAddressSchema in response with status code 200

• [Added] property address.address_meta of schema StoreAddressSchema in response with status code 200

• [Added] property additional_contacts of schema StoreDetails in response with status code 200

• [Added] property company_id of schema StoreDetails in response with status code 200

• [Added] property display_name of schema StoreDetails in response with status code 200

• [Added] property store_type of schema StoreDetails in response with status code 200

• [Added] property auto_invoice of schema StoreDetails in response with status code 200

• [Added] property credit_note of schema StoreDetails in response with status code 200

• [Added] property stage of schema StoreDetails in response with status code 200

• [Added] property gst_credentials of schema StoreDetails in response with status code 200

• [Added] property product_return_config of schema StoreDetails in response with status code 200

• [Added] property avg_order_processing_time of schema StoreDetails in response with status code 200

• [Added] property bulk_shipment of schema StoreDetails in response with status code 200

• [Added] property default_order_acceptance_timing of schema StoreDetails in response with status code 200

• [Added] property order_acceptance_timing of schema StoreDetails in response with status code 200

• [Added] property auto_assign_courier_partner of schema StoreDetails in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Deleted] Value format from email from property manager.email of schema StoreManagerSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property address.pincode of schema StoreAddressSerializer in response with status code 200

• [Changed] Path From /service/application/catalog/v1.0/locations/{location_id}/ To /service/application/catalog/v2.0/locations/{location_id}

getProductBundlesBySlug

• What's New

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

• [Added] query parameter seller_id (type: integer)

• [Breaking] [Added] Type object to property items[].verified_by of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type string to property items[].page_visibility[] of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type object to property items[].created_by of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type object to property items[].modified_by of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type string to property items[].products[].sizes[].value of schema Size in response with status code 200

• [Breaking] [Added] Type string to property items[].products[].sizes[].display of schema Size in response with status code 200

• [Breaking] [Added] Type object to property items[].products[].price of schema ProductGroupPrice in response with status code 200

• [Added] properties items[].products[].price.effective, items[].products[].price.marked, items[].products[].price.selling, items[].products[].price.currency in response with status code 200

• [Breaking] [Added] Type object to property items[].products[].product_details of schema ProductInGroup in response with status code 200

• [Breaking] [Added] Type string to property items[]._id of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type string to property items[].name of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type string to property items[].choice of schema ProductGroupingModel in response with status code 200

• [Breaking] [Added] Type string to property items[].slug of schema ProductGroupingModel in response with status code 200

• [Added] property items[].allow_remove of schema ProductGroupingModel in response with status code 200

• [Added] property items[].auto_add_to_cart of schema ProductGroupingModel in response with status code 200

• [Added] property items[].auto_select of schema ProductGroupingModel in response with status code 200

• [Added] property items[].allow_individual_cancel of schema ProductGroupingModel in response with status code 200

• [Added] property items[].allow_individual_return of schema ProductGroupingModel in response with status code 200

• [Added] property items[].prefer_single_shipment of schema ProductGroupingModel in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property items[].products[].auto_add_to_cart of schema ProductInGroup in response with status code 200

• [Breaking] [Deleted] property items[].products[].auto_select of schema ProductInGroup in response with status code 200

• [Deleted] Value format from date-time from property items[].verified_on of schema ProductGroupingModel in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v1.0/product-grouping/ To /service/application/catalog/v2.0/product-grouping

getProductPriceBySlug

• What's New

• [Added] property items of schema ProductSizePriceResponseV1 in response with status code 200

• [Added] Response with status 400

• [Added] Body content in Request

• What's Deprecated

• [Breaking] [Deleted] Required path parameter slug (type: string) , [Deleted] Required path parameter size (type: string) , [Deleted] query parameter store_id (type: integer) , [Deleted] query parameter moq (type: integer)

• [Breaking] [Deleted] property store of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property article_assignment of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property is_cod of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property strategy_wise_listing of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property quantity of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property item_type of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property grouped_attributes of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property return_config of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property article_id of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property is_gift of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property set of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property seller_count of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property price_per_piece of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property discount_meta of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property discount of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property long_lat of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property special_badge of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property price of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property price_per_unit of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property pincode of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property marketplace_attributes of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property seller of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property delivery_promise of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property trader of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property _custom_json of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property tags of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property inventory_updated_on of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] property is_serviceable of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/catalog/v3.0/products/{slug}/sizes/{size}/price/ To /service/application/catalog/v1.0/products/sizes/price

• [Changed] http method type from get To post

getProductsServiceability

• What's Deprecated

• [Breaking] [Deleted] method getProductsServiceability

getProductSellersBySlug

• What's New

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

• [Breaking] [Added] Possible values composite,digital,packaging,set,standard to property items[].item_type of schema ProductSizePriceResponseV4 in response with status code 200

• [Added] property items[].product_name of schema ProductSizePriceResponseV4 in response with status code 200

• [Added] property items[].error of schema ProductSizePriceResponseV4 in response with status code 200

• [Added] property items[].slug of schema ProductSizePriceResponseV4 in response with status code 200

• [Added] property items[].size of schema ProductSizePriceResponseV4 in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• What's Deprecated

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

• [Deleted] Value format from date-time from property items[].discount_meta.start of schema DiscountMeta in response with status code 200

• [Deleted] Value format from date-time from property items[].discount_meta.end of schema DiscountMeta in response with status code 200

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

• [Breaking] [Deleted] properties items[].trader[].key, items[].trader[].value in response with status code 200

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

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].strategy_wise_listing[].pincode of schema StrategyWiseListingSchemaV3 in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].pincode of schema ProductSizePriceResponseV3 in response with status code 200

• [Breaking] [Changed] Type from object to string of property items[].trader[] of schema Trader in response with status code 200

• [Changed] Path From /service/application/catalog/v3.0/products/{slug}/sizes/{size}/sellers/ To /service/application/catalog/v4.0/products/{slug}/sizes/{size}/sellers

Common

Common

searchApplication

• What's New

• [Breaking] [Added] Possible values website-and-mobile-apps,store to property application.channel_type of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property application.created_at of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property application.updated_at of schema Application in response with status code 200

• [Added] property application.is_sis_enabled of schema Application in response with status code 200

Communication

Communication

upsertCommunicationConsent

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

upsertAppPushtoken

• What's Deprecated

• [Breaking] [Deleted] method upsertAppPushtoken

getCurrentCommunicationConsent

• What's New

• [Added] method getCurrentCommunicationConsent

upsertCurrentCommunicationConsent

• What's New

• [Added] method upsertCurrentCommunicationConsent

getOtpConfiguration

• What's New

• [Added] method getOtpConfiguration

Configuration

Configuration

getApplication

• What's New

• [Added] property redirections[]._id of schema ApplicationRedirections in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema Application in response with status code 200

• [Added] property domains[].display_name of schema Domain in response with status code 200

• [Added] property domain.display_name of schema Domain in response with status code 200

• [Breaking] [Added] Value format date-time to property tokens[].created_at of schema TokenSchema in response with status code 200

• [Added] property is_sis_enabled of schema Application in response with status code 200

• [Added] property company_created_on of schema Application in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from object to string of property tokens[].created_by of schema TokenSchema in response with status code 200

getOwnerInfo

• What's New

• [Breaking] [Added] Value format date-time to property application_info.company_info.created_on of schema CompanyInfo in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property application_info.company_info.addresses[].address_type of schema CompanyAboutAddress in response with status code 200

• [Added] property application_info.domain.display_name of schema Domain in response with status code 200

• [Breaking] [Added] Value format date-time to property application_info.created_at of schema ApplicationInfo in response with status code 200

• [Breaking] [Added] Value format date-time to property application_info.tokens[].created_at of schema TokenSchema in response with status code 200

• [Added] property application_info.domains[].display_name of schema Domain in response with status code 200

• What's Deprecated

• [Deleted] Value format from int32 from property application_info.company_info.addresses[].pincode of schema CompanyAboutAddress in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from integer to string of property application_info.company_info.addresses[].pincode of schema CompanyAboutAddress in response with status code 200

• [Breaking] [Changed] Type from object to string of property application_info.tokens[].created_by of schema TokenSchema in response with status code 200

• [Changed] Path From /service/application/configuration/v1.0/about To /service/application/configuration/v2.0/about

getBasicDetails

• What's New

• [Added] property domain.display_name of schema Domain in response with status code 200

• [Added] property domains[].display_name of schema Domain in response with status code 200

getIntegrationTokens

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AppTokenResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AppTokenResponseSchema in response with status code 200

getOrderingStores

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Deleted] Value format from int32 from property items[].address.pincode of schema OptedStoreAddress in response with status code 200

• [Deleted] Value format from int32 from property items[].pincode of schema OrderingStore in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].address.pincode of schema OptedStoreAddress in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].pincode of schema OrderingStore in response with status code 200

• [Changed] Path From /service/application/configuration/v1.0/ordering-store/stores To /service/application/configuration/v2.0/ordering-store/stores

getStoreDetailById

• What's Deprecated

• [Deleted] Value format from int32 from property address.pincode of schema OptedStoreAddress in response with status code 200

• [Deleted] Value format from int32 from property pincode of schema OrderingStore in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from integer to string of property address.pincode of schema OptedStoreAddress in response with status code 200

• [Breaking] [Changed] Type from integer to string of property pincode of schema OrderingStore in response with status code 200

• [Changed] Path From /service/application/configuration/v1.0/ordering-store/stores/{store_id} To /service/application/configuration/v2.0/ordering-store/stores/{store_id}

getFeatures

• What's New

• [Breaking] [Added] Value format date-time to property feature.created_at of schema AppFeature in response with status code 200

• [Breaking] [Added] Value format date-time to property feature.modified_at of schema AppFeature in response with status code 200

• [Added] property feature.buybox of schema AppFeature in response with status code 200

• [Added] property feature.pricing_strategy of schema AppFeature in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

getContactInfo

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInformation in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInformation in response with status code 200

getCurrencies

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Currency in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].modified_at of schema Currency in response with status code 200

• [Added] property items[].subunit of schema Currency in response with status code 200

getCurrencyById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Currency in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema Currency in response with status code 200

• [Added] property subunit of schema Currency in response with status code 200

getAppCurrencies

• What's New

• [Breaking] [Added] Value format date-time to property supported_currency[].created_at of schema Currency in response with status code 200

• [Breaking] [Added] Value format date-time to property supported_currency[].modified_at of schema Currency in response with status code 200

• [Added] property supported_currency[].subunit of schema Currency in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AppCurrencyResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AppCurrencyResponseSchema in response with status code 200

getAppStaffList

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getAppStaffs

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

Content

Content

getAnnouncements

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getBlog

• What's New

• [Breaking] [Added] Value format date-time to property publish_date of schema BlogSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getBlogs

• What's New

• [Breaking] [Added] Value format date-time to property items[].publish_date of schema BlogSchema in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/application/content/v1.0/blogs/ To /service/application/content/v1.0/blogs

getDataLoaders

• What's New

• [Added] property items[].is_selected of schema DataLoaderSchema in response with status code 200

• [Added] property items[].created_at of schema DataLoaderSchema in response with status code 200

• [Added] property items[].modified_at of schema DataLoaderSchema in response with status code 200

• [Added] property items[].company of schema DataLoaderSchema in response with status code 200

• [Added] property items[].application of schema DataLoaderSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqs

• What's New

• [Added] property faqs[].__v of schema FaqSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqCategories

• What's New

• [Added] property categories[].__v of schema CategorySchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqBySlug

• What's New

• [Added] property __v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqCategoryBySlug

• What's New

• [Added] property category.__v of schema FAQCategorySchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqsByCategorySlug

• What's New

• [Added] property faqs[].__v of schema FaqSchema in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getLandingPage

• What's New

• [Added] Possible values internl to property action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property action.popup.type of schema PageType in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property __v of schema LandingPageSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getLegalInformation

• What's New

• [Added] property __v of schema ApplicationLegal in response with status code 200

• [Breaking] [Added] Type object to property of schema ApplicationLegal in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getNavigations

• What's New

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] Possible values internl to property items[].navigation[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property items[].navigation[].action.popup.type of schema PageType in response with status code 200

• [Added] property items[].__v of schema NavigationSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/application/content/v1.0/navigations/ To /service/application/content/v2.0/navigations

getSEOConfiguration

• What's New

• [Breaking] [Added] Type object to property seo.custom_meta_tags[] of schema CustomMetaTag in response with status code 200

• [Breaking] [Added] Value format date-time to property seo.created_at of schema SeoSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property seo.updated_at of schema SeoSchema in response with status code 200

• [Added] property seo.additional_sitemap of schema SeoSchema in response with status code 200

• [Added] property seo.sitemap of schema SeoSchema in response with status code 200

• [Added] property seo.__v of schema SeoSchema in response with status code 200

• [Breaking] [Added] Type object to property seo of schema SeoSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema SeoComponent in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property seo.additonal_sitemap of schema SeoSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getSEOMarkupSchemas

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property items[].page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property items[]._id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property items[].target_json of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property items[].__v of schema SEOSchemaMarkupTemplate in response with status code 200

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getSlideshows

• What's Deprecated

• [Breaking] [Deleted] method getSlideshows

getSlideshow

• What's Deprecated

• [Breaking] [Deleted] method getSlideshow

getSupportInformation

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Support in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Support in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getTags

• What's New

• [Added] property tags[].compatible_engines of schema TagSchema in response with status code 200

• [Added] property company of schema TagsSchema in response with status code 200

• [Added] property __v of schema TagsSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPage

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPages

• What's New

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property items[].__v of schema PageSchema in response with status code 200

• [Added] property items[].sanitized_content of schema PageSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/application/content/v2.0/pages/ To /service/application/content/v2.0/pages

getCustomObject

• What's Deprecated

• [Breaking] [Deleted] method getCustomObject

getCustomFields

• What's Deprecated

• [Breaking] [Deleted] method getCustomFields

getDefaultSitemapConfig

• What's New

• [Added] method getDefaultSitemapConfig

getSitemaps

• What's New

• [Added] method getSitemaps

getSitemap

• What's New

• [Added] method getSitemap

getCustomObjectBySlug

• What's New

• [Added] method getCustomObjectBySlug

getCustomFieldsByResourceId

• What's New

• [Added] method getCustomFieldsByResourceId

getWellKnownUrl

• What's New

• [Added] method getWellKnownUrl

FileStorage

FileStorage

startUpload

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] cdn made optional in response with status code 200

• [Changed] Path From /service/application/assets/v1.0/namespaces/{namespace}/upload/start To /service/application/assets/v2.0/namespaces/{namespace}/upload/start

completeUpload

• What's New

• [Breaking] [Added] Value format date-time to property created_on of schema FileUploadComplete in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_on of schema FileUploadComplete in response with status code 200

• [Added] property created_by.user_id of schema CreatedBy in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in request body

• What's Changed

• [Breaking] [Changed] cdn made optional in request body

• [Changed] Path From /service/application/assets/v1.0/namespaces/{namespace}/upload/complete To /service/application/assets/v2.0/namespaces/{namespace}/upload/complete

Lead

Lead

getTicket

• What's New

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Added] property video_room_id of schema Ticket in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] property attachments of schema Ticket in response with status code 200

• [Added] Response with status 404

createHistory

• What's New

• [Added] Possible values diff to property type of schema TicketHistoryPayload in request body

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Added] property __v of schema TicketHistory in response with status code 200

• [Added] Response with status 400

• What's Changed

• [Breaking] [Changed] Type from object to string of property created_by of schema TicketHistory in response with status code 200

createTicket

• What's New

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Added] property video_room_id of schema Ticket in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] property attachments of schema Ticket in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Deleted] Possible values from low,medium,high,urgent from property priority of schema PriorityEnum in request body

• What's Changed

• [Changed] Path From /service/application/lead/v1.0/ticket/ To /service/application/lead/v1.0/ticket

getCustomForm

• What's New

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Added] property available_assignees of schema CustomForm in response with status code 200

• [Added] property created_at of schema CustomForm in response with status code 200

• [Added] property updated_at of schema CustomForm in response with status code 200

• [Added] property __v of schema CustomForm in response with status code 200

• [Added] property created_by of schema CustomForm in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property priority of schema CustomForm in response with status code 200

• What's Changed

• [Breaking] [Changed] priority made optional in response with status code 200

submitCustomForm

• What's New

• [Added] property ticket.created_on.platform of schema CreatedOn in response with status code 200

• [Added] property ticket.video_room_id of schema Ticket in response with status code 200

• [Added] property ticket.subscribers of schema Ticket in response with status code 200

• [Added] property ticket.additional_info of schema Ticket in response with status code 200

• [Added] property ticket.__v of schema Ticket in response with status code 200

• [Added] property ticket.attachments of schema Ticket in response with status code 200

• [Added] property response.created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type object to property response.response[] of schema FormResponseSchema in response with status code 200

• [Added] property response.created_by of schema FormResponseSchema in response with status code 200

• [Added] property response.created_at of schema FormResponseSchema in response with status code 200

• [Added] property response.updated_at of schema FormResponseSchema in response with status code 200

• [Breaking] [Added] Type object to property response of schema FormResponseSchema in response with status code 200

• [Added] property notified_to of schema SubmitCustomFormResponseSchema in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] properties response.response[].key in response with status code 200

Logistic

Logistic

getPincodeCity

• What's New

• [Added] property data[].meta_code.iso2 of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.iso3 of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.currency of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.phone_code of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.parent_id of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.zone of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.deliverables of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.hierarchy of schema CountryMetaResponseSchema in response with status code 200

• [Added] property data[].meta_code.logistics of schema CountryMetaResponseSchema in response with status code 200

• [Added] property request_uuid of schema PincodeApiResponseSchema in response with status code 200

• [Added] property stormbreaker_uuid of schema PincodeApiResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property data[].meta_code.country_code of schema CountryMetaResponse in response with status code 200

• [Breaking] [Deleted] property data[].meta_code.isd_code of schema CountryMetaResponse in response with status code 200

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Breaking] [Changed] Type from string to number of property data[].lat_long.coordinates[] of schema PincodeLatLongData in response with status code 200

getTatProduct

• What's Deprecated

• [Breaking] [Deleted] method getTatProduct

getAllCountries

• What's New

• [Added] property results[].meta.iso2 of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.iso3 of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.currency of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.phone_code of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.parent_id of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.zone of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.deliverables of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.hierarchy of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].meta.logistics of schema CountryMetaResponseSchema in response with status code 200

• [Added] property results[].lat_long of schema CountryEntityResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property results[].meta.country_code of schema CountryMetaResponse in response with status code 200

• [Breaking] [Deleted] property results[].meta.isd_code of schema CountryMetaResponse in response with status code 200

• [Breaking] [Deleted] property results[].type of schema CountryEntityResponse in response with status code 200

• [Breaking] [Deleted] Response with status 400

getPincodeZones

• What's Deprecated

• [Breaking] [Deleted] method getPincodeZones

getOptimalLocations

• What's Deprecated

• [Breaking] [Deleted] method getOptimalLocations

getLocations

• What's Deprecated

• [Breaking] [Deleted] method getLocations

getCountries

• What's New

• [Breaking] [Deleted] query parameter onboarding (type: boolean), [Added] query parameter onboard (type: boolean)

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

• [Added] property items[].hierarchy[].display_name of schema CountryHierarchy in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] property items[].hierarchy[].name of schema CountryHierarchy in response with status code 200

getCountry

• What's New

• [Added] property hierarchy[].display_name of schema CountryHierarchy in response with status code 200

• [Added] property fields.address[].values.get_one.params.path.type of schema GetOneOrAllPath in response with status code 200

• [Added] property fields.address[].values.get_one.params.path.value of schema GetOneOrAllPath in response with status code 200

• [Added] property fields.address[].values.get_all.params.path.type of schema GetOneOrAllPath in response with status code 200

• [Added] property fields.address[].values.get_all.params.path.value of schema GetOneOrAllPath in response with status code 200

• [Added] property fields.address[].pre_fill of schema GetCountryFieldsAddress in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property hierarchy[].name of schema CountryHierarchy in response with status code 200

• [Breaking] [Deleted] property fields.address[].values.get_one.params.path.locality_type of schema GetOneOrAllPath in response with status code 200

• [Breaking] [Deleted] property fields.address[].values.get_one.params.path.locality_value of schema GetOneOrAllPath in response with status code 200

• [Breaking] [Deleted] property fields.address[].values.get_all.params.path.locality_type of schema GetOneOrAllPath in response with status code 200

• [Breaking] [Deleted] property fields.address[].values.get_all.params.path.locality_value of schema GetOneOrAllPath in response with status code 200

• [Breaking] [Deleted] property error of schema ErrorResponse in response with status code 400

getLocalities

• What's New

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

• [Added] Possible nullable value true to property items[].localities[].parent_ids of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].meta of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].serviceability of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].parent_uid of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].code of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].iso2 of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].iso3 of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].currency of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].phone_code of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].hierarchy of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].latitude of schema LocalityParent in response with status code 200

• [Added] property items[].localities[].longitude of schema LocalityParent in response with status code 200

• [Added] property items[].meta of schema Localities in response with status code 200

• [Added] property items[].lat_long of schema Localities in response with status code 200

• [Added] property items[].parent_uid of schema Localities in response with status code 200

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

• [Added] property items[].iso2 of schema Localities in response with status code 200

• [Added] property items[].iso3 of schema Localities in response with status code 200

• [Added] property items[].currency of schema Localities in response with status code 200

• [Added] property items[].phone_code of schema Localities in response with status code 200

• [Added] property items[].hierarchy of schema Localities in response with status code 200

• [Added] property items[].latitude of schema Localities in response with status code 200

• [Added] property items[].longitude of schema Localities in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

getLocality

• What's New

• [Added] Possible nullable value true to property parent_ids of schema GetLocality in response with status code 200

• [Added] Possible nullable value true to property localities[].parent_ids of schema LocalityParent in response with status code 200

• [Added] property localities[].meta of schema LocalityParent in response with status code 200

• [Added] property localities[].serviceability of schema LocalityParent in response with status code 200

• [Added] property localities[].parent_uid of schema LocalityParent in response with status code 200

• [Added] property localities[].code of schema LocalityParent in response with status code 200

• [Added] property localities[].iso2 of schema LocalityParent in response with status code 200

• [Added] property localities[].iso3 of schema LocalityParent in response with status code 200

• [Added] property localities[].currency of schema LocalityParent in response with status code 200

• [Added] property localities[].phone_code of schema LocalityParent in response with status code 200

• [Added] property localities[].hierarchy of schema LocalityParent in response with status code 200

• [Added] property localities[].latitude of schema LocalityParent in response with status code 200

• [Added] property localities[].longitude of schema LocalityParent in response with status code 200

• [Added] property meta of schema GetLocality in response with status code 200

• [Added] property parent_uid of schema GetLocality in response with status code 200

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

validateAddress

• What's New

• [Added] Possible nullable value true to property name of schema ValidateAddressRequestSchema in request body

• [Added] Possible nullable value true to property phone of schema ValidateAddressRequestSchema in request body

• [Added] Possible nullable value true to property email of schema ValidateAddressRequestSchema in request body

• [Added] property country_iso_code of schema ValidateAddressRequestSchema in request body

• [Added] Possible nullable value true to property name of schema ValidateAddressRequestSchema in response with status code 200

• [Added] Possible nullable value true to property phone of schema ValidateAddressRequestSchema in response with status code 200

• [Added] Possible nullable value true to property email of schema ValidateAddressRequestSchema in response with status code 200

• [Added] property country_iso_code of schema ValidateAddressRequestSchema in response with status code 200

• [Added] properties error.type, error.value, error.message in response with status code 400

• [Added] property success of schema ErrorResponseV3 in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] property message of schema ErrorResponse in response with status code 400

• What's Changed

• [Breaking] [Changed] Type from string to object of property error of schema ErrorResponse in response with status code 400

getZones

• What's New

• [Added] method getZones

getGeoAreas

• What's New

• [Added] method getGeoAreas

getLocalitiesByPrefix

• What's New

• [Added] method getLocalitiesByPrefix

createShipments

• What's New

• [Added] method createShipments

getDeliveryPromise

• What's New

• [Added] method getDeliveryPromise

getQCPromise

• What's New

• [Added] method getQCPromise

Order

Order

getOrders

• What's New

• [Added] property items[].user_info.user_id of schema UserInfo in response with status code 200

• [Breaking] [Added] Possible values HomeDelivery,PickAtStore,Digital, to property items[].shipments[].order_type of schema Shipments in response with status code 200

• [Added] property items[].shipments[].user_info.user_id of schema ShipmentUserInfo in response with status code 200

• [Added] property items[].shipments[].fulfilling_store.tags of schema FulfillingStore in response with status code 200

• [Added] property items[].shipments[].invoice.store_invoice_id of schema Invoice in response with status code 200

• [Added] property items[].shipments[].promise.timestamp.dp_promise of schema TimeStampData in response with status code 200

• [Added] property items[].shipments[].prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property items[].shipments[].prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property items[].shipments[].prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].returnable_date of schema Shipments in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].bags[].delivery_date of schema Bags in response with status code 200

• [Added] property items[].shipments[].bags[].item.variants of schema Item in response with status code 200

• [Breaking] [Added] Possible values percentage,amount,fixed_price,bogo,contract_price,shipping_price,ladder_price,bundle_price_percentage,bundle_price_amount,bundle_amount_percentage,custom,free_gift_items,free_non_sellable_items to property items[].shipments[].bags[].applied_promos[].promotion_type of schema AppliedPromos in response with status code 200

• [Added] property items[].shipments[].bags[].prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property items[].shipments[].bags[].prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property items[].shipments[].bags[].prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].bags[].returnable_date of schema Bags in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].bags[].current_status.updated_at of schema CurrentStatus in response with status code 200

• [Breaking] [Added] Possible values return,forward, to property items[].shipments[].bags[].current_status.journey_type of schema CurrentStatus in response with status code 200

• [Added] Possible nullable value true to property items[].shipments[].bags[].article.tags of schema Article in response with status code 200

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

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

• [Breaking] [Added] Possible values home,office,store to property items[].shipments[].delivery_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].delivery_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property items[].shipments[].delivery_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].delivery_address.updated_at of schema Address in response with status code 200

• [Added] property items[].shipments[].delivery_address.area_code of schema Address in response with status code 200

• [Added] property items[].shipments[].delivery_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Possible values home,office,store to property items[].shipments[].billing_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].billing_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property items[].shipments[].billing_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].billing_address.updated_at of schema Address in response with status code 200

• [Added] property items[].shipments[].billing_address.area_code of schema Address in response with status code 200

• [Added] property items[].shipments[].billing_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].shipments[].delivery_date of schema Shipments in response with status code 200

• [Added] property items[].shipments[].order.external_order_id of schema OrderRequestSchema in response with status code 200

• [Added] property items[].shipments[].advance_payment_config of schema Shipments in response with status code 200

• [Added] property items[].shipments[].multi_mop_payments of schema Shipments in response with status code 200

• [Added] property items[].shipments[].multi_mop_payments_list of schema Shipments in response with status code 200

• [Added] property items[].shipments[].is_validated of schema Shipments in response with status code 200

• [Added] property items[].shipments[].is_active of schema Shipments in response with status code 200

• [Added] property items[].shipments[].refund_information of schema Shipments in response with status code 200

• [Added] property items[].shipments[].currency of schema Shipments in response with status code 200

• [Added] property items[].shipments[].currency_info of schema Shipments in response with status code 200

• [Added] property items[].shipments[].coupon_details of schema Shipments in response with status code 200

• [Added] property items[].shipments[].can_pay_remaining_amount of schema Shipments in response with status code 200

• [Added] property items[].shipments[].charges of schema Shipments in response with status code 200

• [Added] property items[].shipments[].external_shipment_id of schema Shipments in response with status code 200

• [Added] property items[].shipments[].previous_shipment_id of schema Shipments in response with status code 200

• [Added] property items[].shipments[].is_refund_initiated of schema Shipments in response with status code 200

• [Added] property items[].shipments[].meta of schema Shipments in response with status code 200

• [Added] property items[].coupon_details of schema OrderSchema in response with status code 200

• [Added] property items[].custom_cart_meta of schema OrderSchema in response with status code 200

• [Added] property items[].charges of schema OrderSchema in response with status code 200

• [Added] property items[].custom_meta of schema OrderSchema in response with status code 200

• [Added] property items[].currency_info of schema OrderSchema in response with status code 200

• [Added] property items[].is_validated of schema OrderSchema in response with status code 200

• [Added] property items[].external_order_id of schema OrderSchema in response with status code 200

• [Added] property items[].payment_info of schema OrderSchema in response with status code 200

• [Added] property items[].currency of schema OrderSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] query parameter allow_inactive (type: boolean)

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from integer to number of property items[].shipments[].bags[].quantity of schema Bags in response with status code 200

getOrderById

• What's New

• [Added] property order.user_info.user_id of schema UserInfo in response with status code 200

• [Breaking] [Added] Possible values HomeDelivery,PickAtStore,Digital, to property order.shipments[].order_type of schema Shipments in response with status code 200

• [Added] property order.shipments[].user_info.user_id of schema ShipmentUserInfo in response with status code 200

• [Added] property order.shipments[].fulfilling_store.tags of schema FulfillingStore in response with status code 200

• [Added] property order.shipments[].invoice.store_invoice_id of schema Invoice in response with status code 200

• [Added] property order.shipments[].promise.timestamp.dp_promise of schema TimeStampData in response with status code 200

• [Added] property order.shipments[].prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property order.shipments[].prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property order.shipments[].prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].returnable_date of schema Shipments in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].bags[].delivery_date of schema Bags in response with status code 200

• [Added] property order.shipments[].bags[].item.variants of schema Item in response with status code 200

• [Breaking] [Added] Possible values percentage,amount,fixed_price,bogo,contract_price,shipping_price,ladder_price,bundle_price_percentage,bundle_price_amount,bundle_amount_percentage,custom,free_gift_items,free_non_sellable_items to property order.shipments[].bags[].applied_promos[].promotion_type of schema AppliedPromos in response with status code 200

• [Added] property order.shipments[].bags[].prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property order.shipments[].bags[].prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property order.shipments[].bags[].prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].bags[].returnable_date of schema Bags in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].bags[].current_status.updated_at of schema CurrentStatus in response with status code 200

• [Breaking] [Added] Possible values return,forward, to property order.shipments[].bags[].current_status.journey_type of schema CurrentStatus in response with status code 200

• [Added] Possible nullable value true to property order.shipments[].bags[].article.tags of schema Article in response with status code 200

• [Added] property order.shipments[].bags[].article.variants of schema Article in response with status code 200

• [Added] property order.shipments[].bags[].charges of schema Bags in response with status code 200

• [Breaking] [Added] Possible values home,office,store to property order.shipments[].delivery_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].delivery_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property order.shipments[].delivery_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].delivery_address.updated_at of schema Address in response with status code 200

• [Added] property order.shipments[].delivery_address.area_code of schema Address in response with status code 200

• [Added] property order.shipments[].delivery_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Possible values home,office,store to property order.shipments[].billing_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].billing_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property order.shipments[].billing_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].billing_address.updated_at of schema Address in response with status code 200

• [Added] property order.shipments[].billing_address.area_code of schema Address in response with status code 200

• [Added] property order.shipments[].billing_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property order.shipments[].delivery_date of schema Shipments in response with status code 200

• [Added] property order.shipments[].order.external_order_id of schema OrderRequestSchema in response with status code 200

• [Added] property order.shipments[].advance_payment_config of schema Shipments in response with status code 200

• [Added] property order.shipments[].multi_mop_payments of schema Shipments in response with status code 200

• [Added] property order.shipments[].multi_mop_payments_list of schema Shipments in response with status code 200

• [Added] property order.shipments[].is_validated of schema Shipments in response with status code 200

• [Added] property order.shipments[].is_active of schema Shipments in response with status code 200

• [Added] property order.shipments[].refund_information of schema Shipments in response with status code 200

• [Added] property order.shipments[].currency of schema Shipments in response with status code 200

• [Added] property order.shipments[].currency_info of schema Shipments in response with status code 200

• [Added] property order.shipments[].coupon_details of schema Shipments in response with status code 200

• [Added] property order.shipments[].can_pay_remaining_amount of schema Shipments in response with status code 200

• [Added] property order.shipments[].charges of schema Shipments in response with status code 200

• [Added] property order.shipments[].external_shipment_id of schema Shipments in response with status code 200

• [Added] property order.shipments[].previous_shipment_id of schema Shipments in response with status code 200

• [Added] property order.shipments[].is_refund_initiated of schema Shipments in response with status code 200

• [Added] property order.shipments[].meta of schema Shipments in response with status code 200

• [Added] property order.coupon_details of schema OrderSchema in response with status code 200

• [Added] property order.custom_cart_meta of schema OrderSchema in response with status code 200

• [Added] property order.charges of schema OrderSchema in response with status code 200

• [Added] property order.custom_meta of schema OrderSchema in response with status code 200

• [Added] property order.currency_info of schema OrderSchema in response with status code 200

• [Added] property order.is_validated of schema OrderSchema in response with status code 200

• [Added] property order.external_order_id of schema OrderSchema in response with status code 200

• [Added] property order.payment_info of schema OrderSchema in response with status code 200

• [Added] property order.currency of schema OrderSchema in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from integer to number of property order.shipments[].bags[].quantity of schema Bags in response with status code 200

getShipmentById

• What's New

• [Breaking] [Added] Possible values HomeDelivery,PickAtStore,Digital, to property shipment.order_type of schema Shipments in response with status code 200

• [Added] property shipment.user_info.user_id of schema ShipmentUserInfo in response with status code 200

• [Added] property shipment.fulfilling_store.tags of schema FulfillingStore in response with status code 200

• [Added] property shipment.invoice.store_invoice_id of schema Invoice in response with status code 200

• [Added] property shipment.promise.timestamp.dp_promise of schema TimeStampData in response with status code 200

• [Added] property shipment.prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property shipment.prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property shipment.prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.returnable_date of schema Shipments in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.bags[].delivery_date of schema Bags in response with status code 200

• [Added] property shipment.bags[].item.variants of schema Item in response with status code 200

• [Breaking] [Added] Possible values percentage,amount,fixed_price,bogo,contract_price,shipping_price,ladder_price,bundle_price_percentage,bundle_price_amount,bundle_amount_percentage,custom,free_gift_items,free_non_sellable_items to property shipment.bags[].applied_promos[].promotion_type of schema AppliedPromos in response with status code 200

• [Added] property shipment.bags[].prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property shipment.bags[].prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property shipment.bags[].prices.gift_price of schema Prices in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.bags[].returnable_date of schema Bags in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.bags[].current_status.updated_at of schema CurrentStatus in response with status code 200

• [Breaking] [Added] Possible values return,forward, to property shipment.bags[].current_status.journey_type of schema CurrentStatus in response with status code 200

• [Added] Possible nullable value true to property shipment.bags[].article.tags of schema Article in response with status code 200

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

• [Added] property shipment.bags[].charges of schema Bags in response with status code 200

• [Breaking] [Added] Possible values home,office,store to property shipment.delivery_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.delivery_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property shipment.delivery_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.delivery_address.updated_at of schema Address in response with status code 200

• [Added] property shipment.delivery_address.area_code of schema Address in response with status code 200

• [Added] property shipment.delivery_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Possible values home,office,store to property shipment.billing_address.address_type of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.billing_address.created_at of schema Address in response with status code 200

• [Breaking] [Added] Possible values store,delivery,billing to property shipment.billing_address.address_category of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.billing_address.updated_at of schema Address in response with status code 200

• [Added] property shipment.billing_address.area_code of schema Address in response with status code 200

• [Added] property shipment.billing_address.area_code_slug of schema Address in response with status code 200

• [Breaking] [Added] Value format date-time to property shipment.delivery_date of schema Shipments in response with status code 200

• [Added] property shipment.order.external_order_id of schema OrderRequestSchema in response with status code 200

• [Added] property shipment.advance_payment_config of schema Shipments in response with status code 200

• [Added] property shipment.multi_mop_payments of schema Shipments in response with status code 200

• [Added] property shipment.multi_mop_payments_list of schema Shipments in response with status code 200

• [Added] property shipment.is_validated of schema Shipments in response with status code 200

• [Added] property shipment.is_active of schema Shipments in response with status code 200

• [Added] property shipment.refund_information of schema Shipments in response with status code 200

• [Added] property shipment.currency of schema Shipments in response with status code 200

• [Added] property shipment.currency_info of schema Shipments in response with status code 200

• [Added] property shipment.coupon_details of schema Shipments in response with status code 200

• [Added] property shipment.can_pay_remaining_amount of schema Shipments in response with status code 200

• [Added] property shipment.charges of schema Shipments in response with status code 200

• [Added] property shipment.external_shipment_id of schema Shipments in response with status code 200

• [Added] property shipment.previous_shipment_id of schema Shipments in response with status code 200

• [Added] property shipment.is_refund_initiated of schema Shipments in response with status code 200

• [Added] property shipment.meta of schema Shipments in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from integer to number of property shipment.bags[].quantity of schema Bags in response with status code 200

getInvoiceByShipmentId

• What's New

• [Breaking] [Added] Possible values GET,PUT to property presigned_type of schema ResponseGetInvoiceShipment in response with status code 200

• [Added] property entity_id of schema ResponseGetInvoiceShipment in response with status code 200

• [Added] property expires_in of schema ResponseGetInvoiceShipment in response with status code 200

• [Added] property url of schema ResponseGetInvoiceShipment in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

trackShipment

• What's New

• [Breaking] [Added] Possible values forward,reverse,rto to property results[].shipment_type of schema Track in response with status code 200

• [Breaking] [Added] Value format date-time to property results[].updated_at of schema Track in response with status code 200

• [Added] property results[].raw_status of schema Track in response with status code 200

• [Added] property results[].meta of schema Track in response with status code 200

• [Added] property success of schema ShipmentTrack in response with status code 200

• [Added] property meta of schema ShipmentTrack in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getCustomerDetailsByShipmentId

• What's New

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

sendOtpToShipmentCustomer

• What's New

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

verifyOtpShipmentCustomer

• What's New

• [Added] property message of schema VerifyOtpResponseSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getShipmentBagReasons

• What's New

• [Added] Possible nullable value to property reasons of schema ShipmentBagReasons in response with status code 200

• [Added] Possible nullable value to property success of schema ShipmentBagReasons in response with status code 200

• [Added] property rule_id of schema ShipmentBagReasons in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getShipmentReasons

• What's New

• [Breaking] [Added] Possible values bag,order to property reasons[].feedback_type of schema ShipmentReason in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateShipmentStatus

• What's New

• [Breaking] [Added] Value format int32 to property statuses[].shipments[].products[].line_number of schema Products in request body

• [Breaking] [Added] Value format float to property statuses[].shipments[].products[].quantity of schema Products in request body

• [Breaking] [Added] Value format int32 to property statuses[].shipments[].data_updates.products[].filters[].line_number of schema ProductsDataUpdatesFilters in request body

• [Added] property statuses[].shipments[].data_updates.products[].filters[].quantity of schema ProductsDataUpdatesFilters in request body

• [Breaking] [Added] statuses[].shipments[].products made required in request body

• [Breaking] [Added] statuses[].shipments, statuses[].status made required in request body

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getShipmentRefundSummary

• What's New

• [Added] method getShipmentRefundSummary

getRefundOptions

• What's New

• [Added] method getRefundOptions

groupValidator

• What's New

• [Added] method groupValidator

getPosOrderById

• What's New

• [Added] method getPosOrderById

Payment

Payment

getAggregatorsConfig

• What's New

• [Breaking] [Added] Possible values self,fynd to property razorpay.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property razorpay.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property juspay.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property juspay.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property simpl.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property simpl.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property payumoney.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property payumoney.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property rupifi.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property rupifi.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property mswipe.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property mswipe.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property stripe.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property stripe.is_active of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Added] Possible values self,fynd to property ccavenue.config_type of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.webhook_username of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.webhook_password of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.signature_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.merchant_salt of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.checkout_formpost_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.refund_api_domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.non_trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.trxn_url of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.webhook_secret of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.is_sub_fynd_account of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.vpa of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.api_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.secret_key of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.product_id of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.domain of schema AggregatorConfigDetail in response with status code 200

• [Added] property ccavenue.is_active of schema AggregatorConfigDetail in response with status code 200

• [Added] property ajiodhan of schema AggregatorsConfigDetail in response with status code 200

• [Added] property potlee of schema AggregatorsConfigDetail in response with status code 200

• [Added] property qr_refund_jiopay of schema AggregatorsConfigDetail in response with status code 200

• [Added] property offerxone of schema AggregatorsConfigDetail in response with status code 200

• What's Deprecated

• [Deleted] Type from string from property razorpay.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property razorpay.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property juspay.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property juspay.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property simpl.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property simpl.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property payumoney.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property payumoney.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property rupifi.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property rupifi.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property mswipe.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property mswipe.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property stripe.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property stripe.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Deleted] Type from string from property ccavenue.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property ccavenue.merchant_id of schema AggregatorConfigDetail in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] razorpay.config_type, razorpay.key, razorpay.secret made optional in response with status code 200

• [Breaking] [Changed] juspay.config_type, juspay.key, juspay.secret made optional in response with status code 200

• [Breaking] [Changed] simpl.config_type, simpl.key, simpl.secret made optional in response with status code 200

• [Breaking] [Changed] payumoney.config_type, payumoney.key, payumoney.secret made optional in response with status code 200

• [Breaking] [Changed] rupifi.config_type, rupifi.key, rupifi.secret made optional in response with status code 200

• [Breaking] [Changed] mswipe.config_type, mswipe.key, mswipe.secret made optional in response with status code 200

• [Breaking] [Changed] stripe.config_type, stripe.key, stripe.secret made optional in response with status code 200

• [Breaking] [Changed] ccavenue.config_type, ccavenue.key, ccavenue.secret made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

attachCardToCustomer

• What's New

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

• [Breaking] [Added] property of schema in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property card_id of schema AttachCardRequest in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data made optional in response with status code 200

getActiveCardAggregator

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

getActiveUserCards

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

deleteUserCard

• What's New

• [Breaking] [Added] Required status to Request body content

• [Added] Possible nullable value true to property success of schema DeleteCardsDetails in response with status code 200

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

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property card_id of schema DeletehCardRequest in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

verifyCustomerForPayment

• What's New

• [Added] properties data.data, data.aggregator, data.api_version in response with status code 200

• [Added] property error of schema ValidateCustomerDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

verifyAndChargePayment

• What's New

• [Added] property cart_id[] of schema ChargeCustomerDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema ChargeCustomerRequest in request body

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] order_id made optional in request body

• [Breaking] [Changed] Type from string to array of property cart_id of schema ChargeCustomerResponse in response with status code 200

initialisePayment

• What's New

• [Added] property merchant_transaction_id of schema PaymentInitialization in request body

• [Added] property unique_link_id of schema PaymentInitialization in request body

• [Added] property merchant_transaction_id of schema PaymentInitializationDetails in response with status code 200

• [Added] property unique_link_id of schema PaymentInitializationDetails in response with status code 200

• [Added] property status_code of schema PaymentInitializationDetails in response with status code 200

• [Added] property error.order_id of schema PaymentError in response with status code 400

• [Added] property error.order_type of schema PaymentError in response with status code 400

• [Added] property error.transaction_amount_in_paise of schema PaymentError in response with status code 400

• [Added] property error_msg of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property status of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property message of schema PaymentErrorCodeAndMessage in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentInitializationRequest in request body

• [Deleted] Value format from email from property email of schema PaymentInitializationRequest in request body

• [Breaking] [Deleted] property error.code of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] property error.description of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] aggregator made optional in request body

• [Changed] amount made optional in request body

• [Changed] contact made optional in request body

• [Changed] currency made optional in request body

• [Changed] email made optional in request body

• [Changed] order_id made optional in request body

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] success made optional in response with status code 400

checkAndUpdatePaymentStatus

• What's New

• [Added] property aggregator_order_id of schema PaymentStatusUpdate in request body

• [Added] property unique_link_id of schema PaymentStatusUpdate in request body

• [Added] property razorpay_payment_id of schema PaymentStatusUpdate in request body

• [Added] property merchant_url of schema PaymentStatusUpdate in request body

• [Breaking] [Added] method made required in request body

• [Breaking] [Added] order_id made required in request body

• [Breaking] [Added] status made required in request body

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentStatusUpdateRequest in request body

• [Deleted] Value format from email from property email of schema PaymentStatusUpdateRequest in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] retry made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

getPaymentModeRoutes

• What's New

• [Breaking] [Added] Required status to query parameter card_reference

• [Breaking] [Added] Required status to query parameter user_details

• [Breaking] [Added] Required status to query parameter display_split

• [Breaking] [Added] Required status to query parameter advance_payment

• [Added] property payment_options.payment_option[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].payment_mode_id of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].logo_url of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].version of schema RootPaymentMode in response with status code 200

• [Added] properties payment_options.payment_flows.bqr_razorpay.data.gateway, payment_options.payment_flows.bqr_razorpay.data.payment_flow_data, payment_options.payment_flows.bqr_razorpay.data.data, payment_options.payment_flows.bqr_razorpay.data.payment_flow, payment_options.payment_flows.bqr_razorpay.data.api_link, payment_options.payment_flows.bqr_razorpay.data.route, payment_options.payment_flows.bqr_razorpay.data.entity, payment_options.payment_flows.bqr_razorpay.data.is_customer_validation_required, payment_options.payment_flows.bqr_razorpay.data.cust_validation_url, payment_options.payment_flows.bqr_razorpay.data.sdk, payment_options.payment_flows.bqr_razorpay.data.return_url, payment_options.payment_flows.bqr_razorpay.data.user_email, payment_options.payment_flows.bqr_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.bqr_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.bqr_razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.fynd.data.gateway, payment_options.payment_flows.fynd.data.payment_flow_data, payment_options.payment_flows.fynd.data.data, payment_options.payment_flows.fynd.data.payment_flow, payment_options.payment_flows.fynd.data.api_link, payment_options.payment_flows.fynd.data.route, payment_options.payment_flows.fynd.data.entity, payment_options.payment_flows.fynd.data.is_customer_validation_required, payment_options.payment_flows.fynd.data.cust_validation_url, payment_options.payment_flows.fynd.data.sdk, payment_options.payment_flows.fynd.data.return_url, payment_options.payment_flows.fynd.data.user_email, payment_options.payment_flows.fynd.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.fynd.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.fynd of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.epaylater.data.gateway, payment_options.payment_flows.epaylater.data.payment_flow_data, payment_options.payment_flows.epaylater.data.data, payment_options.payment_flows.epaylater.data.payment_flow, payment_options.payment_flows.epaylater.data.api_link, payment_options.payment_flows.epaylater.data.route, payment_options.payment_flows.epaylater.data.entity, payment_options.payment_flows.epaylater.data.is_customer_validation_required, payment_options.payment_flows.epaylater.data.cust_validation_url, payment_options.payment_flows.epaylater.data.sdk, payment_options.payment_flows.epaylater.data.return_url, payment_options.payment_flows.epaylater.data.user_email, payment_options.payment_flows.epaylater.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.epaylater.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.epaylater of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.razorpay.data.gateway, payment_options.payment_flows.razorpay.data.payment_flow_data, payment_options.payment_flows.razorpay.data.data, payment_options.payment_flows.razorpay.data.payment_flow, payment_options.payment_flows.razorpay.data.api_link, payment_options.payment_flows.razorpay.data.route, payment_options.payment_flows.razorpay.data.entity, payment_options.payment_flows.razorpay.data.is_customer_validation_required, payment_options.payment_flows.razorpay.data.cust_validation_url, payment_options.payment_flows.razorpay.data.sdk, payment_options.payment_flows.razorpay.data.return_url, payment_options.payment_flows.razorpay.data.user_email, payment_options.payment_flows.razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.juspay.data.gateway, payment_options.payment_flows.juspay.data.payment_flow_data, payment_options.payment_flows.juspay.data.data, payment_options.payment_flows.juspay.data.payment_flow, payment_options.payment_flows.juspay.data.api_link, payment_options.payment_flows.juspay.data.route, payment_options.payment_flows.juspay.data.entity, payment_options.payment_flows.juspay.data.is_customer_validation_required, payment_options.payment_flows.juspay.data.cust_validation_url, payment_options.payment_flows.juspay.data.sdk, payment_options.payment_flows.juspay.data.return_url, payment_options.payment_flows.juspay.data.user_email, payment_options.payment_flows.juspay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.juspay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.juspay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ajiodhan.data.gateway, payment_options.payment_flows.ajiodhan.data.payment_flow_data, payment_options.payment_flows.ajiodhan.data.data, payment_options.payment_flows.ajiodhan.data.payment_flow, payment_options.payment_flows.ajiodhan.data.api_link, payment_options.payment_flows.ajiodhan.data.route, payment_options.payment_flows.ajiodhan.data.entity, payment_options.payment_flows.ajiodhan.data.is_customer_validation_required, payment_options.payment_flows.ajiodhan.data.cust_validation_url, payment_options.payment_flows.ajiodhan.data.sdk, payment_options.payment_flows.ajiodhan.data.return_url, payment_options.payment_flows.ajiodhan.data.user_email, payment_options.payment_flows.ajiodhan.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ajiodhan.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ajiodhan of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.simpl.data.gateway, payment_options.payment_flows.simpl.data.payment_flow_data, payment_options.payment_flows.simpl.data.data, payment_options.payment_flows.simpl.data.payment_flow, payment_options.payment_flows.simpl.data.api_link, payment_options.payment_flows.simpl.data.route, payment_options.payment_flows.simpl.data.entity, payment_options.payment_flows.simpl.data.is_customer_validation_required, payment_options.payment_flows.simpl.data.cust_validation_url, payment_options.payment_flows.simpl.data.sdk, payment_options.payment_flows.simpl.data.return_url, payment_options.payment_flows.simpl.data.user_email, payment_options.payment_flows.simpl.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.simpl.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.simpl of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.rupifi.data.gateway, payment_options.payment_flows.rupifi.data.payment_flow_data, payment_options.payment_flows.rupifi.data.data, payment_options.payment_flows.rupifi.data.payment_flow, payment_options.payment_flows.rupifi.data.api_link, payment_options.payment_flows.rupifi.data.route, payment_options.payment_flows.rupifi.data.entity, payment_options.payment_flows.rupifi.data.is_customer_validation_required, payment_options.payment_flows.rupifi.data.cust_validation_url, payment_options.payment_flows.rupifi.data.sdk, payment_options.payment_flows.rupifi.data.return_url, payment_options.payment_flows.rupifi.data.user_email, payment_options.payment_flows.rupifi.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.rupifi.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.rupifi of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.mswipe.data.gateway, payment_options.payment_flows.mswipe.data.payment_flow_data, payment_options.payment_flows.mswipe.data.data, payment_options.payment_flows.mswipe.data.payment_flow, payment_options.payment_flows.mswipe.data.api_link, payment_options.payment_flows.mswipe.data.route, payment_options.payment_flows.mswipe.data.entity, payment_options.payment_flows.mswipe.data.is_customer_validation_required, payment_options.payment_flows.mswipe.data.cust_validation_url, payment_options.payment_flows.mswipe.data.sdk, payment_options.payment_flows.mswipe.data.return_url, payment_options.payment_flows.mswipe.data.user_email, payment_options.payment_flows.mswipe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.mswipe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.mswipe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.stripe.data.gateway, payment_options.payment_flows.stripe.data.payment_flow_data, payment_options.payment_flows.stripe.data.data, payment_options.payment_flows.stripe.data.payment_flow, payment_options.payment_flows.stripe.data.api_link, payment_options.payment_flows.stripe.data.route, payment_options.payment_flows.stripe.data.entity, payment_options.payment_flows.stripe.data.is_customer_validation_required, payment_options.payment_flows.stripe.data.cust_validation_url, payment_options.payment_flows.stripe.data.sdk, payment_options.payment_flows.stripe.data.return_url, payment_options.payment_flows.stripe.data.user_email, payment_options.payment_flows.stripe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.stripe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.stripe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ccavenue.data.gateway, payment_options.payment_flows.ccavenue.data.payment_flow_data, payment_options.payment_flows.ccavenue.data.data, payment_options.payment_flows.ccavenue.data.payment_flow, payment_options.payment_flows.ccavenue.data.api_link, payment_options.payment_flows.ccavenue.data.route, payment_options.payment_flows.ccavenue.data.entity, payment_options.payment_flows.ccavenue.data.is_customer_validation_required, payment_options.payment_flows.ccavenue.data.cust_validation_url, payment_options.payment_flows.ccavenue.data.sdk, payment_options.payment_flows.ccavenue.data.return_url, payment_options.payment_flows.ccavenue.data.user_email, payment_options.payment_flows.ccavenue.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ccavenue.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ccavenue of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.payubiz.data.gateway, payment_options.payment_flows.payubiz.data.payment_flow_data, payment_options.payment_flows.payubiz.data.data, payment_options.payment_flows.payubiz.data.payment_flow, payment_options.payment_flows.payubiz.data.api_link, payment_options.payment_flows.payubiz.data.route, payment_options.payment_flows.payubiz.data.entity, payment_options.payment_flows.payubiz.data.is_customer_validation_required, payment_options.payment_flows.payubiz.data.cust_validation_url, payment_options.payment_flows.payubiz.data.sdk, payment_options.payment_flows.payubiz.data.return_url, payment_options.payment_flows.payubiz.data.user_email, payment_options.payment_flows.payubiz.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.payubiz.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.payubiz of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.jiopay.data.gateway, payment_options.payment_flows.jiopay.data.payment_flow_data, payment_options.payment_flows.jiopay.data.data, payment_options.payment_flows.jiopay.data.payment_flow, payment_options.payment_flows.jiopay.data.api_link, payment_options.payment_flows.jiopay.data.route, payment_options.payment_flows.jiopay.data.entity, payment_options.payment_flows.jiopay.data.is_customer_validation_required, payment_options.payment_flows.jiopay.data.cust_validation_url, payment_options.payment_flows.jiopay.data.sdk, payment_options.payment_flows.jiopay.data.return_url, payment_options.payment_flows.jiopay.data.user_email, payment_options.payment_flows.jiopay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.jiopay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.jiopay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.upi_razorpay.data.gateway, payment_options.payment_flows.upi_razorpay.data.payment_flow_data, payment_options.payment_flows.upi_razorpay.data.data, payment_options.payment_flows.upi_razorpay.data.payment_flow, payment_options.payment_flows.upi_razorpay.data.api_link, payment_options.payment_flows.upi_razorpay.data.route, payment_options.payment_flows.upi_razorpay.data.entity, payment_options.payment_flows.upi_razorpay.data.is_customer_validation_required, payment_options.payment_flows.upi_razorpay.data.cust_validation_url, payment_options.payment_flows.upi_razorpay.data.sdk, payment_options.payment_flows.upi_razorpay.data.return_url, payment_options.payment_flows.upi_razorpay.data.user_email, payment_options.payment_flows.upi_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.upi_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.upi_razorpay of schema AggregatorRoute in response with status code 200

• [Added] property payment_options.payment_flows.jio of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.payumoney of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.openapi of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.potlee of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.creditnote of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.pinelabs of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.checkout of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.cashfree of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.jio_extension of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.offerxone of schema PaymentFlow in response with status code 200

• [Added] property advance_payment[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].advance.all_cancellation_type of schema AdvanceObject in response with status code 200

• [Added] property advance_payment[].version of schema AdvancePaymentObject in response with status code 200

• [Added] property meta of schema PaymentModeRouteDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property payment_options.payment_default_selection of schema PaymentOptionAndFlow in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Required status of query parameter cart_id

• [Breaking] [Changed] error.code made optional in response with status code 400

getPosPaymentModeRoutes

• What's New

• [Breaking] [Added] Required status to query parameter card_reference

• [Breaking] [Added] Required status to query parameter user_details

• [Added] property payment_options.payment_option[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].payment_mode_id of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].logo_url of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].version of schema RootPaymentMode in response with status code 200

• [Added] properties payment_options.payment_flows.bqr_razorpay.data.gateway, payment_options.payment_flows.bqr_razorpay.data.payment_flow_data, payment_options.payment_flows.bqr_razorpay.data.data, payment_options.payment_flows.bqr_razorpay.data.payment_flow, payment_options.payment_flows.bqr_razorpay.data.api_link, payment_options.payment_flows.bqr_razorpay.data.route, payment_options.payment_flows.bqr_razorpay.data.entity, payment_options.payment_flows.bqr_razorpay.data.is_customer_validation_required, payment_options.payment_flows.bqr_razorpay.data.cust_validation_url, payment_options.payment_flows.bqr_razorpay.data.sdk, payment_options.payment_flows.bqr_razorpay.data.return_url, payment_options.payment_flows.bqr_razorpay.data.user_email, payment_options.payment_flows.bqr_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.bqr_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.bqr_razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.fynd.data.gateway, payment_options.payment_flows.fynd.data.payment_flow_data, payment_options.payment_flows.fynd.data.data, payment_options.payment_flows.fynd.data.payment_flow, payment_options.payment_flows.fynd.data.api_link, payment_options.payment_flows.fynd.data.route, payment_options.payment_flows.fynd.data.entity, payment_options.payment_flows.fynd.data.is_customer_validation_required, payment_options.payment_flows.fynd.data.cust_validation_url, payment_options.payment_flows.fynd.data.sdk, payment_options.payment_flows.fynd.data.return_url, payment_options.payment_flows.fynd.data.user_email, payment_options.payment_flows.fynd.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.fynd.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.fynd of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.epaylater.data.gateway, payment_options.payment_flows.epaylater.data.payment_flow_data, payment_options.payment_flows.epaylater.data.data, payment_options.payment_flows.epaylater.data.payment_flow, payment_options.payment_flows.epaylater.data.api_link, payment_options.payment_flows.epaylater.data.route, payment_options.payment_flows.epaylater.data.entity, payment_options.payment_flows.epaylater.data.is_customer_validation_required, payment_options.payment_flows.epaylater.data.cust_validation_url, payment_options.payment_flows.epaylater.data.sdk, payment_options.payment_flows.epaylater.data.return_url, payment_options.payment_flows.epaylater.data.user_email, payment_options.payment_flows.epaylater.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.epaylater.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.epaylater of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.razorpay.data.gateway, payment_options.payment_flows.razorpay.data.payment_flow_data, payment_options.payment_flows.razorpay.data.data, payment_options.payment_flows.razorpay.data.payment_flow, payment_options.payment_flows.razorpay.data.api_link, payment_options.payment_flows.razorpay.data.route, payment_options.payment_flows.razorpay.data.entity, payment_options.payment_flows.razorpay.data.is_customer_validation_required, payment_options.payment_flows.razorpay.data.cust_validation_url, payment_options.payment_flows.razorpay.data.sdk, payment_options.payment_flows.razorpay.data.return_url, payment_options.payment_flows.razorpay.data.user_email, payment_options.payment_flows.razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.juspay.data.gateway, payment_options.payment_flows.juspay.data.payment_flow_data, payment_options.payment_flows.juspay.data.data, payment_options.payment_flows.juspay.data.payment_flow, payment_options.payment_flows.juspay.data.api_link, payment_options.payment_flows.juspay.data.route, payment_options.payment_flows.juspay.data.entity, payment_options.payment_flows.juspay.data.is_customer_validation_required, payment_options.payment_flows.juspay.data.cust_validation_url, payment_options.payment_flows.juspay.data.sdk, payment_options.payment_flows.juspay.data.return_url, payment_options.payment_flows.juspay.data.user_email, payment_options.payment_flows.juspay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.juspay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.juspay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ajiodhan.data.gateway, payment_options.payment_flows.ajiodhan.data.payment_flow_data, payment_options.payment_flows.ajiodhan.data.data, payment_options.payment_flows.ajiodhan.data.payment_flow, payment_options.payment_flows.ajiodhan.data.api_link, payment_options.payment_flows.ajiodhan.data.route, payment_options.payment_flows.ajiodhan.data.entity, payment_options.payment_flows.ajiodhan.data.is_customer_validation_required, payment_options.payment_flows.ajiodhan.data.cust_validation_url, payment_options.payment_flows.ajiodhan.data.sdk, payment_options.payment_flows.ajiodhan.data.return_url, payment_options.payment_flows.ajiodhan.data.user_email, payment_options.payment_flows.ajiodhan.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ajiodhan.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ajiodhan of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.simpl.data.gateway, payment_options.payment_flows.simpl.data.payment_flow_data, payment_options.payment_flows.simpl.data.data, payment_options.payment_flows.simpl.data.payment_flow, payment_options.payment_flows.simpl.data.api_link, payment_options.payment_flows.simpl.data.route, payment_options.payment_flows.simpl.data.entity, payment_options.payment_flows.simpl.data.is_customer_validation_required, payment_options.payment_flows.simpl.data.cust_validation_url, payment_options.payment_flows.simpl.data.sdk, payment_options.payment_flows.simpl.data.return_url, payment_options.payment_flows.simpl.data.user_email, payment_options.payment_flows.simpl.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.simpl.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.simpl of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.rupifi.data.gateway, payment_options.payment_flows.rupifi.data.payment_flow_data, payment_options.payment_flows.rupifi.data.data, payment_options.payment_flows.rupifi.data.payment_flow, payment_options.payment_flows.rupifi.data.api_link, payment_options.payment_flows.rupifi.data.route, payment_options.payment_flows.rupifi.data.entity, payment_options.payment_flows.rupifi.data.is_customer_validation_required, payment_options.payment_flows.rupifi.data.cust_validation_url, payment_options.payment_flows.rupifi.data.sdk, payment_options.payment_flows.rupifi.data.return_url, payment_options.payment_flows.rupifi.data.user_email, payment_options.payment_flows.rupifi.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.rupifi.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.rupifi of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.mswipe.data.gateway, payment_options.payment_flows.mswipe.data.payment_flow_data, payment_options.payment_flows.mswipe.data.data, payment_options.payment_flows.mswipe.data.payment_flow, payment_options.payment_flows.mswipe.data.api_link, payment_options.payment_flows.mswipe.data.route, payment_options.payment_flows.mswipe.data.entity, payment_options.payment_flows.mswipe.data.is_customer_validation_required, payment_options.payment_flows.mswipe.data.cust_validation_url, payment_options.payment_flows.mswipe.data.sdk, payment_options.payment_flows.mswipe.data.return_url, payment_options.payment_flows.mswipe.data.user_email, payment_options.payment_flows.mswipe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.mswipe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.mswipe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.stripe.data.gateway, payment_options.payment_flows.stripe.data.payment_flow_data, payment_options.payment_flows.stripe.data.data, payment_options.payment_flows.stripe.data.payment_flow, payment_options.payment_flows.stripe.data.api_link, payment_options.payment_flows.stripe.data.route, payment_options.payment_flows.stripe.data.entity, payment_options.payment_flows.stripe.data.is_customer_validation_required, payment_options.payment_flows.stripe.data.cust_validation_url, payment_options.payment_flows.stripe.data.sdk, payment_options.payment_flows.stripe.data.return_url, payment_options.payment_flows.stripe.data.user_email, payment_options.payment_flows.stripe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.stripe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.stripe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ccavenue.data.gateway, payment_options.payment_flows.ccavenue.data.payment_flow_data, payment_options.payment_flows.ccavenue.data.data, payment_options.payment_flows.ccavenue.data.payment_flow, payment_options.payment_flows.ccavenue.data.api_link, payment_options.payment_flows.ccavenue.data.route, payment_options.payment_flows.ccavenue.data.entity, payment_options.payment_flows.ccavenue.data.is_customer_validation_required, payment_options.payment_flows.ccavenue.data.cust_validation_url, payment_options.payment_flows.ccavenue.data.sdk, payment_options.payment_flows.ccavenue.data.return_url, payment_options.payment_flows.ccavenue.data.user_email, payment_options.payment_flows.ccavenue.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ccavenue.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ccavenue of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.payubiz.data.gateway, payment_options.payment_flows.payubiz.data.payment_flow_data, payment_options.payment_flows.payubiz.data.data, payment_options.payment_flows.payubiz.data.payment_flow, payment_options.payment_flows.payubiz.data.api_link, payment_options.payment_flows.payubiz.data.route, payment_options.payment_flows.payubiz.data.entity, payment_options.payment_flows.payubiz.data.is_customer_validation_required, payment_options.payment_flows.payubiz.data.cust_validation_url, payment_options.payment_flows.payubiz.data.sdk, payment_options.payment_flows.payubiz.data.return_url, payment_options.payment_flows.payubiz.data.user_email, payment_options.payment_flows.payubiz.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.payubiz.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.payubiz of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.jiopay.data.gateway, payment_options.payment_flows.jiopay.data.payment_flow_data, payment_options.payment_flows.jiopay.data.data, payment_options.payment_flows.jiopay.data.payment_flow, payment_options.payment_flows.jiopay.data.api_link, payment_options.payment_flows.jiopay.data.route, payment_options.payment_flows.jiopay.data.entity, payment_options.payment_flows.jiopay.data.is_customer_validation_required, payment_options.payment_flows.jiopay.data.cust_validation_url, payment_options.payment_flows.jiopay.data.sdk, payment_options.payment_flows.jiopay.data.return_url, payment_options.payment_flows.jiopay.data.user_email, payment_options.payment_flows.jiopay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.jiopay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.jiopay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.upi_razorpay.data.gateway, payment_options.payment_flows.upi_razorpay.data.payment_flow_data, payment_options.payment_flows.upi_razorpay.data.data, payment_options.payment_flows.upi_razorpay.data.payment_flow, payment_options.payment_flows.upi_razorpay.data.api_link, payment_options.payment_flows.upi_razorpay.data.route, payment_options.payment_flows.upi_razorpay.data.entity, payment_options.payment_flows.upi_razorpay.data.is_customer_validation_required, payment_options.payment_flows.upi_razorpay.data.cust_validation_url, payment_options.payment_flows.upi_razorpay.data.sdk, payment_options.payment_flows.upi_razorpay.data.return_url, payment_options.payment_flows.upi_razorpay.data.user_email, payment_options.payment_flows.upi_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.upi_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.upi_razorpay of schema AggregatorRoute in response with status code 200

• [Added] property payment_options.payment_flows.jio of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.payumoney of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.openapi of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.potlee of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.creditnote of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.pinelabs of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.checkout of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.cashfree of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.jio_extension of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.offerxone of schema PaymentFlow in response with status code 200

• [Added] property advance_payment[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].advance.all_cancellation_type of schema AdvanceObject in response with status code 200

• [Added] property advance_payment[].version of schema AdvancePaymentObject in response with status code 200

• [Added] property meta of schema PaymentModeRouteDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property payment_options.payment_default_selection of schema PaymentOptionAndFlow in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Required status of query parameter cart_id

• [Breaking] [Changed] error.code made optional in response with status code 400

walletLinkInitiate

• What's New

• [Added] properties data.message, data.reason, data.link_token in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Changed] aggregator made optional in request body

linkWallet

• What's New

• [Added] properties data.message, data.reason, data.link_token in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Changed] aggregator made optional in request body

delinkWallet

• What's New

• [Added] property wallet_id of schema WalletDelinkRequestSchema in request body

• [Added] properties data.message, data.reason, data.link_token in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Changed] aggregator made optional in request body

getRupifiBannerDetails

• What's New

• [Added] Possible nullable value true to property data of schema RupifiBannerData in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

getEpaylaterBannerDetails

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

resendOrCancelPayment

• What's New

• [Breaking] [Added] Possible values resend,cancel to property request_type of schema ResendOrCancelPayment in request body

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data.message made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

renderHTML

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/html/render/ To /service/application/payment/v1.0/payment/html/render

validateVPA

• What's New

• [Added] Possible nullable value true to property data.customer_name of schema ValidateUPI in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from string to boolean of property data.status of schema ValidateUPI in response with status code 200

• [Breaking] [Changed] data.customer_name made optional in response with status code 200

cardDetails

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property data.bank_code of schema CardDetails in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property data.card_sub_type of schema CardDetails in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

getActiveRefundTransferModes

• What's New

• [Added] Possible nullable value true to property data[].items[] of schema TransferItemsDetails in response with status code 200

• [Added] data[].items made required in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

enableOrDisableRefundTransferMode

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getUserBeneficiariesDetail

• What's New

• [Breaking] [Added] pattern validator for beneficiaries[].modified_on in response with status code 200

• [Breaking] [Added] pattern validator for beneficiaries[].created_on in response with status code 200

• [Added] property beneficiaries[].aggregator_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].is_verified of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].status of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].txn_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].meta of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].default_beneficiary of schema OrderBeneficiaryDetails in response with status code 200

• [Added] beneficiaries[].transfer_mode made required in response with status code 200

• [Added] beneficiaries[].title made required in response with status code 200

• [Added] beneficiaries[].subtitle made required in response with status code 200

• [Added] property bank of schema OrderBeneficiaryFetchDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

verifyIfscCode

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] bank_name, branch_name made optional in response with status code 200

getOrderBeneficiariesDetail

• What's New

• [Breaking] [Added] pattern validator for beneficiaries[].modified_on in response with status code 200

• [Breaking] [Added] pattern validator for beneficiaries[].created_on in response with status code 200

• [Added] property beneficiaries[].aggregator_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].is_verified of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].status of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].txn_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].meta of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].default_beneficiary of schema OrderBeneficiaryDetails in response with status code 200

• [Added] beneficiaries[].transfer_mode made required in response with status code 200

• [Added] beneficiaries[].title made required in response with status code 200

• [Added] beneficiaries[].subtitle made required in response with status code 200

• [Added] property bank of schema OrderBeneficiaryFetchDetails in response with status code 200

• [Added] property message of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property data of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property error of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property errors of schema RefundErrorCodeAndMessage in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] property code of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] property description of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] code made optional in response with status code 400

• [Breaking] [Changed] description made optional in response with status code 400

verifyOtpAndAddBeneficiaryForBank

• What's New

• [Added] property message of schema WrongOtpError in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 200

• [Breaking] [Changed] Type from string to boolean of property success of schema WrongOtpError in response with status code 400

• [Breaking] [Changed] description made optional in response with status code 400

• [Breaking] [Changed] is_verified_flag made optional in response with status code 400

addBeneficiaryDetails

• What's New

• [Added] Possible nullable value true to property details.email of schema BeneficiaryModeDetails in request body

• [Added] property details.beneficiary_id of schema BeneficiaryModeDetails in request body

• [Added] Possible nullable value true to property data of schema RefundData in response with status code 200

• [Added] properties data.bene_name_mismatch, data.status, data.subcode, data.hash_key, data.message, data.mobile, data.request_id, data.beneficiary_id, data.account_no, data.account_holder, data.bank_name, data.branch_name, data.ifsc_code in response with status code 200

• [Added] property message of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property data of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property error of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property errors of schema RefundErrorCodeAndMessage in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property details.vpa of schema BeneficiaryModeDetails in request body

• [Breaking] [Deleted] property otp of schema AddBeneficiaryDetailsRequest in request body

• [Breaking] [Deleted] property request_id of schema AddBeneficiaryDetailsRequest in request body

• [Breaking] [Deleted] property code of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] property description of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] details.account_holder, details.account_no, details.bank_name, details.branch_name, details.email, details.ifsc_code, details.mobile made optional in request body

• [Changed] delights made optional in request body

• [Changed] shipment_id made optional in request body

• [Changed] transfer_mode made optional in request body

• [Breaking] [Changed] code made optional in response with status code 400

• [Breaking] [Changed] description made optional in response with status code 400

addRefundBankAccountUsingOTP

• What's New

• [Added] property details.email of schema BankDetailsForOTP in request body

• [Added] property details.beneficiary_id of schema BankDetailsForOTP in request body

• [Added] property details.address of schema BankDetailsForOTP in request body

• [Added] property details.mobile of schema BankDetailsForOTP in request body

• [Added] property details.comment of schema BankDetailsForOTP in request body

• [Added] property request_hash of schema AddBeneficiaryDetailsOTP in request body

• [Added] Possible nullable value true to property data of schema RefundData in response with status code 200

• [Added] properties data.bene_name_mismatch, data.status, data.subcode, data.hash_key, data.message, data.mobile, data.request_id, data.beneficiary_id, data.account_no, data.account_holder, data.bank_name, data.branch_name, data.ifsc_code in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

verifyOtpAndAddBeneficiaryForWallet

• What's New

• [Added] Possible nullable value true to property request_id of schema WalletOtpDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from string to boolean of property is_verified_flag of schema WalletOtpResponse in response with status code 200

• [Breaking] [Changed] request_id made optional in response with status code 200

updateDefaultBeneficiary

• What's New

• [Added] property shipment_id of schema SetDefaultBeneficiary in request body

• [Added] property merchant_shipment_id of schema SetDefaultBeneficiary in request body

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getPaymentLink

• What's New

• [Added] property currency of schema GetPaymentLinkDetails in response with status code 200

• [Added] property error of schema GetPaymentLinkDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/create-payment-link/ To /service/application/payment/v1.0/create-payment-link

createPaymentLink

• What's New

• [Added] property meta.pincode of schema CreatePaymentLinkMeta in request body

• [Added] property country_phone_code of schema CreatePaymentLink in request body

• [Added] property success_redirection_url of schema CreatePaymentLink in request body

• [Added] property failure_redirection_url of schema CreatePaymentLink in request body

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/create-payment-link/ To /service/application/payment/v1.0/create-payment-link

resendPaymentLink

• What's New

• [Added] property error of schema ResendPaymentLinkDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/resend-payment-link/ To /service/application/payment/v1.0/resend-payment-link

cancelPaymentLink

• What's New

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/cancel-payment-link/ To /service/application/payment/v1.0/cancel-payment-link

getPaymentModeRoutesPaymentLink

• What's New

• [Added] property payment_options.payment_option[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].payment_mode_id of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].logo_url of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].version of schema RootPaymentMode in response with status code 200

• [Added] properties payment_options.payment_flows.bqr_razorpay.data.gateway, payment_options.payment_flows.bqr_razorpay.data.payment_flow_data, payment_options.payment_flows.bqr_razorpay.data.data, payment_options.payment_flows.bqr_razorpay.data.payment_flow, payment_options.payment_flows.bqr_razorpay.data.api_link, payment_options.payment_flows.bqr_razorpay.data.route, payment_options.payment_flows.bqr_razorpay.data.entity, payment_options.payment_flows.bqr_razorpay.data.is_customer_validation_required, payment_options.payment_flows.bqr_razorpay.data.cust_validation_url, payment_options.payment_flows.bqr_razorpay.data.sdk, payment_options.payment_flows.bqr_razorpay.data.return_url, payment_options.payment_flows.bqr_razorpay.data.user_email, payment_options.payment_flows.bqr_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.bqr_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.bqr_razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.fynd.data.gateway, payment_options.payment_flows.fynd.data.payment_flow_data, payment_options.payment_flows.fynd.data.data, payment_options.payment_flows.fynd.data.payment_flow, payment_options.payment_flows.fynd.data.api_link, payment_options.payment_flows.fynd.data.route, payment_options.payment_flows.fynd.data.entity, payment_options.payment_flows.fynd.data.is_customer_validation_required, payment_options.payment_flows.fynd.data.cust_validation_url, payment_options.payment_flows.fynd.data.sdk, payment_options.payment_flows.fynd.data.return_url, payment_options.payment_flows.fynd.data.user_email, payment_options.payment_flows.fynd.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.fynd.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.fynd of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.epaylater.data.gateway, payment_options.payment_flows.epaylater.data.payment_flow_data, payment_options.payment_flows.epaylater.data.data, payment_options.payment_flows.epaylater.data.payment_flow, payment_options.payment_flows.epaylater.data.api_link, payment_options.payment_flows.epaylater.data.route, payment_options.payment_flows.epaylater.data.entity, payment_options.payment_flows.epaylater.data.is_customer_validation_required, payment_options.payment_flows.epaylater.data.cust_validation_url, payment_options.payment_flows.epaylater.data.sdk, payment_options.payment_flows.epaylater.data.return_url, payment_options.payment_flows.epaylater.data.user_email, payment_options.payment_flows.epaylater.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.epaylater.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.epaylater of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.razorpay.data.gateway, payment_options.payment_flows.razorpay.data.payment_flow_data, payment_options.payment_flows.razorpay.data.data, payment_options.payment_flows.razorpay.data.payment_flow, payment_options.payment_flows.razorpay.data.api_link, payment_options.payment_flows.razorpay.data.route, payment_options.payment_flows.razorpay.data.entity, payment_options.payment_flows.razorpay.data.is_customer_validation_required, payment_options.payment_flows.razorpay.data.cust_validation_url, payment_options.payment_flows.razorpay.data.sdk, payment_options.payment_flows.razorpay.data.return_url, payment_options.payment_flows.razorpay.data.user_email, payment_options.payment_flows.razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.razorpay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.juspay.data.gateway, payment_options.payment_flows.juspay.data.payment_flow_data, payment_options.payment_flows.juspay.data.data, payment_options.payment_flows.juspay.data.payment_flow, payment_options.payment_flows.juspay.data.api_link, payment_options.payment_flows.juspay.data.route, payment_options.payment_flows.juspay.data.entity, payment_options.payment_flows.juspay.data.is_customer_validation_required, payment_options.payment_flows.juspay.data.cust_validation_url, payment_options.payment_flows.juspay.data.sdk, payment_options.payment_flows.juspay.data.return_url, payment_options.payment_flows.juspay.data.user_email, payment_options.payment_flows.juspay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.juspay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.juspay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ajiodhan.data.gateway, payment_options.payment_flows.ajiodhan.data.payment_flow_data, payment_options.payment_flows.ajiodhan.data.data, payment_options.payment_flows.ajiodhan.data.payment_flow, payment_options.payment_flows.ajiodhan.data.api_link, payment_options.payment_flows.ajiodhan.data.route, payment_options.payment_flows.ajiodhan.data.entity, payment_options.payment_flows.ajiodhan.data.is_customer_validation_required, payment_options.payment_flows.ajiodhan.data.cust_validation_url, payment_options.payment_flows.ajiodhan.data.sdk, payment_options.payment_flows.ajiodhan.data.return_url, payment_options.payment_flows.ajiodhan.data.user_email, payment_options.payment_flows.ajiodhan.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ajiodhan.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ajiodhan of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.simpl.data.gateway, payment_options.payment_flows.simpl.data.payment_flow_data, payment_options.payment_flows.simpl.data.data, payment_options.payment_flows.simpl.data.payment_flow, payment_options.payment_flows.simpl.data.api_link, payment_options.payment_flows.simpl.data.route, payment_options.payment_flows.simpl.data.entity, payment_options.payment_flows.simpl.data.is_customer_validation_required, payment_options.payment_flows.simpl.data.cust_validation_url, payment_options.payment_flows.simpl.data.sdk, payment_options.payment_flows.simpl.data.return_url, payment_options.payment_flows.simpl.data.user_email, payment_options.payment_flows.simpl.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.simpl.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.simpl of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.rupifi.data.gateway, payment_options.payment_flows.rupifi.data.payment_flow_data, payment_options.payment_flows.rupifi.data.data, payment_options.payment_flows.rupifi.data.payment_flow, payment_options.payment_flows.rupifi.data.api_link, payment_options.payment_flows.rupifi.data.route, payment_options.payment_flows.rupifi.data.entity, payment_options.payment_flows.rupifi.data.is_customer_validation_required, payment_options.payment_flows.rupifi.data.cust_validation_url, payment_options.payment_flows.rupifi.data.sdk, payment_options.payment_flows.rupifi.data.return_url, payment_options.payment_flows.rupifi.data.user_email, payment_options.payment_flows.rupifi.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.rupifi.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.rupifi of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.mswipe.data.gateway, payment_options.payment_flows.mswipe.data.payment_flow_data, payment_options.payment_flows.mswipe.data.data, payment_options.payment_flows.mswipe.data.payment_flow, payment_options.payment_flows.mswipe.data.api_link, payment_options.payment_flows.mswipe.data.route, payment_options.payment_flows.mswipe.data.entity, payment_options.payment_flows.mswipe.data.is_customer_validation_required, payment_options.payment_flows.mswipe.data.cust_validation_url, payment_options.payment_flows.mswipe.data.sdk, payment_options.payment_flows.mswipe.data.return_url, payment_options.payment_flows.mswipe.data.user_email, payment_options.payment_flows.mswipe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.mswipe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.mswipe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.stripe.data.gateway, payment_options.payment_flows.stripe.data.payment_flow_data, payment_options.payment_flows.stripe.data.data, payment_options.payment_flows.stripe.data.payment_flow, payment_options.payment_flows.stripe.data.api_link, payment_options.payment_flows.stripe.data.route, payment_options.payment_flows.stripe.data.entity, payment_options.payment_flows.stripe.data.is_customer_validation_required, payment_options.payment_flows.stripe.data.cust_validation_url, payment_options.payment_flows.stripe.data.sdk, payment_options.payment_flows.stripe.data.return_url, payment_options.payment_flows.stripe.data.user_email, payment_options.payment_flows.stripe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.stripe.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.stripe of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ccavenue.data.gateway, payment_options.payment_flows.ccavenue.data.payment_flow_data, payment_options.payment_flows.ccavenue.data.data, payment_options.payment_flows.ccavenue.data.payment_flow, payment_options.payment_flows.ccavenue.data.api_link, payment_options.payment_flows.ccavenue.data.route, payment_options.payment_flows.ccavenue.data.entity, payment_options.payment_flows.ccavenue.data.is_customer_validation_required, payment_options.payment_flows.ccavenue.data.cust_validation_url, payment_options.payment_flows.ccavenue.data.sdk, payment_options.payment_flows.ccavenue.data.return_url, payment_options.payment_flows.ccavenue.data.user_email, payment_options.payment_flows.ccavenue.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ccavenue.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.ccavenue of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.payubiz.data.gateway, payment_options.payment_flows.payubiz.data.payment_flow_data, payment_options.payment_flows.payubiz.data.data, payment_options.payment_flows.payubiz.data.payment_flow, payment_options.payment_flows.payubiz.data.api_link, payment_options.payment_flows.payubiz.data.route, payment_options.payment_flows.payubiz.data.entity, payment_options.payment_flows.payubiz.data.is_customer_validation_required, payment_options.payment_flows.payubiz.data.cust_validation_url, payment_options.payment_flows.payubiz.data.sdk, payment_options.payment_flows.payubiz.data.return_url, payment_options.payment_flows.payubiz.data.user_email, payment_options.payment_flows.payubiz.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.payubiz.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.payubiz of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.jiopay.data.gateway, payment_options.payment_flows.jiopay.data.payment_flow_data, payment_options.payment_flows.jiopay.data.data, payment_options.payment_flows.jiopay.data.payment_flow, payment_options.payment_flows.jiopay.data.api_link, payment_options.payment_flows.jiopay.data.route, payment_options.payment_flows.jiopay.data.entity, payment_options.payment_flows.jiopay.data.is_customer_validation_required, payment_options.payment_flows.jiopay.data.cust_validation_url, payment_options.payment_flows.jiopay.data.sdk, payment_options.payment_flows.jiopay.data.return_url, payment_options.payment_flows.jiopay.data.user_email, payment_options.payment_flows.jiopay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.jiopay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.jiopay of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.upi_razorpay.data.gateway, payment_options.payment_flows.upi_razorpay.data.payment_flow_data, payment_options.payment_flows.upi_razorpay.data.data, payment_options.payment_flows.upi_razorpay.data.payment_flow, payment_options.payment_flows.upi_razorpay.data.api_link, payment_options.payment_flows.upi_razorpay.data.route, payment_options.payment_flows.upi_razorpay.data.entity, payment_options.payment_flows.upi_razorpay.data.is_customer_validation_required, payment_options.payment_flows.upi_razorpay.data.cust_validation_url, payment_options.payment_flows.upi_razorpay.data.sdk, payment_options.payment_flows.upi_razorpay.data.return_url, payment_options.payment_flows.upi_razorpay.data.user_email, payment_options.payment_flows.upi_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.upi_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows.upi_razorpay of schema AggregatorRoute in response with status code 200

• [Added] property payment_options.payment_flows.jio of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.payumoney of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.openapi of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.potlee of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.creditnote of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.pinelabs of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.checkout of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.cashfree of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.jio_extension of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.offerxone of schema PaymentFlow in response with status code 200

• [Added] property advance_payment[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].cod_charges of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].product_cod_data of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].advance.all_cancellation_type of schema AdvanceObject in response with status code 200

• [Added] property advance_payment[].version of schema AdvancePaymentObject in response with status code 200

• [Added] property meta of schema PaymentModeRouteDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] property payment_options.payment_default_selection of schema PaymentOptionAndFlow in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/options/link/ To /service/application/payment/v1.0/payment/options/link

pollingPaymentLink

• What's New

• [Breaking] [Added] Required status to query parameter payment_link_id

• What's Deprecated

• [Breaking] [Deleted] properties error.payment_transaction_id, error.expired, error.merchant_order_id, error.merchant_name, error.msg, error.cancelled, error.amount, error.invalid_id in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from object to string of property error of schema ErrorDescription in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/polling-payment-link/ To /service/application/payment/v1.0/polling-payment-link

createOrderHandlerPaymentLink

• What's New

• [Added] property data.base64_html of schema CreateOrderUserData in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] status_code made optional in response with status code 200

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/create-order/link/ To /service/application/payment/v1.0/create-order/link

initialisePaymentPaymentLink

• What's New

• [Added] property merchant_transaction_id of schema PaymentInitialization in request body

• [Added] property unique_link_id of schema PaymentInitialization in request body

• [Added] property merchant_transaction_id of schema PaymentInitializationDetails in response with status code 200

• [Added] property unique_link_id of schema PaymentInitializationDetails in response with status code 200

• [Added] property status_code of schema PaymentInitializationDetails in response with status code 200

• [Added] property error.order_id of schema PaymentError in response with status code 400

• [Added] property error.order_type of schema PaymentError in response with status code 400

• [Added] property error.transaction_amount_in_paise of schema PaymentError in response with status code 400

• [Added] property error_msg of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property status of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property message of schema PaymentErrorCodeAndMessage in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentInitializationRequest in request body

• [Deleted] Value format from email from property email of schema PaymentInitializationRequest in request body

• [Breaking] [Deleted] property error.code of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] property error.description of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] aggregator made optional in request body

• [Changed] amount made optional in request body

• [Changed] contact made optional in request body

• [Changed] currency made optional in request body

• [Changed] email made optional in request body

• [Changed] order_id made optional in request body

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] success made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/request/link/ To /service/application/payment/v1.0/payment/request/link

checkAndUpdatePaymentStatusPaymentLink

• What's New

• [Added] property aggregator_order_id of schema PaymentStatusUpdate in request body

• [Added] property unique_link_id of schema PaymentStatusUpdate in request body

• [Added] property razorpay_payment_id of schema PaymentStatusUpdate in request body

• [Added] property merchant_url of schema PaymentStatusUpdate in request body

• [Breaking] [Added] method made required in request body

• [Breaking] [Added] order_id made required in request body

• [Breaking] [Added] status made required in request body

• [Added] property error.order_id of schema PaymentError in response with status code 400

• [Added] property error.order_type of schema PaymentError in response with status code 400

• [Added] property error.transaction_amount_in_paise of schema PaymentError in response with status code 400

• [Added] property error_msg of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property status of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property message of schema PaymentErrorCodeAndMessage in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentStatusUpdateRequest in request body

• [Deleted] Value format from email from property email of schema PaymentStatusUpdateRequest in request body

• [Breaking] [Deleted] property error.code of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] property error.description of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] retry made optional in response with status code 200

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] success made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/confirm/polling/link/ To /service/application/payment/v1.0/payment/confirm/polling/link

customerCreditSummary

• What's New

• [Breaking] [Added] Value format date-time to property data.due_date of schema CreditSummary in response with status code 200

• [Added] property message of schema CustomerCreditSummaryDetails in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/credit-summary/ To /service/application/payment/v1.0/payment/credit-summary

redirectToAggregator

• What's New

• [Breaking] [Added] Required status to query parameter aggregator

• [Added] property data.redirect_url of schema RedirectURL in response with status code 200

• [Added] property data.extra of schema RedirectURL in response with status code 200

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/redirect-to-aggregator/ To /service/application/payment/v1.0/payment/redirect-to-aggregator

checkCredit

• What's New

• [Breaking] [Added] Required status to query parameter aggregator

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

• [Added] property data.available_credit of schema CreditDetail in response with status code 200

• [Added] property data.token of schema CreditDetail in response with status code 200

• [Added] property data.linked of schema CreditDetail in response with status code 200

• [Added] property data.id of schema CreditDetail in response with status code 200

• [Added] property data.metadata of schema CreditDetail in response with status code 200

• [Added] property data.current_balance of schema CreditDetail in response with status code 200

• [Added] property data.wallet of schema CreditDetail in response with status code 200

• [Added] property data.gateway_reference_id of schema CreditDetail in response with status code 200

• [Added] property data.last_refreshed of schema CreditDetail in response with status code 200

• [Added] property data.juspay_bank_code of schema CreditDetail in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data.signup_url made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/check-credits/ To /service/application/payment/v1.0/check-credits

customerOnboard

• What's New

• [Added] property business_info.state of schema BusinessDetails in request body

• [Added] property data.type of schema OnboardSummary in response with status code 200

• [Added] property data.reason of schema OnboardSummary in response with status code 200

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

• [Added] property data.message of schema OnboardSummary in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property personal_info.dob of schema UserPersonalInfoInDetails in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/credit-onboard/ To /service/application/payment/v1.0/credit-onboard

outstandingOrderDetails

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/application/payment/v1.0/payment/outstanding-orders/ To /service/application/payment/v1.0/payment/outstanding-orders

paidOrderDetails

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Changed] Path From /service/application/payment/v1.0/payment/paid-orders/ To /service/application/payment/v1.0/payment/paid-orders

createPaymentOrder

• What's New

• [Added] property payment_methods[].meta.payment_extra_identifiers of schema PaymentMethodsMetaOrder in request body

• [Added] property payment_methods[].meta.logo_url of schema PaymentMethodsMetaOrder in request body

• [Added] property customer_details of schema PaymentOrder in request body

• [Added] property data.bank of schema PaymentOrderData in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] payment_methods[].meta.merchant_code made optional in request body

• [Changed] payment_methods[].meta.payment_identifier made optional in request body

• [Breaking] [Changed] status_code made optional in response with status code 200

• [Changed] Path From /service/application/payment/v1.0/payment-orders/ To /service/application/payment/v1.0/payment-orders

updateUserCard

• What's New

• [Added] method updateUserCard

updateActiveCards

• What's New

• [Added] method updateActiveCards

getOutagesData

• What's New

• [Added] method getOutagesData

deleteBeneficiaryDetails

• What's New

• [Added] method deleteBeneficiaryDetails

getotpOrderBeneficiariesDetail

• What's New

• [Added] method getotpOrderBeneficiariesDetail

getBenficiaryOrder

• What's New

• [Added] method getBenficiaryOrder

getPaymentLinkId

• What's New

• [Added] method getPaymentLinkId

setRefundOptionforShipment

• What's New

• [Added] method setRefundOptionforShipment

getSelectedRefundOption

• What's New

• [Added] method getSelectedRefundOption

getUserBeneficiariesDetailV2

• What's New

• [Added] method getUserBeneficiariesDetailV2

validateBeneficiaryAddress

• What's New

• [Added] method validateBeneficiaryAddress

confirmPayment

• What's New

• [Added] method confirmPayment

Rewards

Rewards

getOfferByName

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Offer in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Offer in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

catalogueOrder

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getUserPointsHistory

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema PointsHistory in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema PointsHistory in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getUserPoints

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getUserReferralDetails

• What's New

• [Breaking] [Added] Value format date-time to property referral.created_at of schema Offer in response with status code 200

• [Breaking] [Added] Value format date-time to property referral.updated_at of schema Offer in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getOrderDiscount

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

redeemReferralCode

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

Share

Share

getApplicationQRCode

• What's Changed

• [Changed] Path From /service/application/share/v1.0/qr/ To /service/application/share/v1.0/qr

getProductQRCodeBySlug

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/share/v1.0/qr/products/{slug}/ To /service/application/share/v1.0/qr/products/{slug}

getCollectionQRCodeBySlug

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/share/v1.0/qr/collection/{slug}/ To /service/application/share/v1.0/qr/collection/{slug}

getUrlQRCode

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/application/share/v1.0/qr/url/ To /service/application/share/v1.0/qr/url

createShortLink

• What's New

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkReq in request body

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in request body

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/application/share/v1.0/links/short-link/ To /service/application/share/v1.0/links/short-link

getShortLinkByHash

• What's New

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/application/share/v1.0/links/short-link/{hash}/ To /service/application/share/v1.0/links/short-link/{hash}

getOriginalShortLinkByHash

• What's New

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/application/share/v1.0/links/short-link/{hash}/original/ To /service/application/share/v1.0/links/short-link/{hash}/original

Theme

Theme

getAllPages

• What's New

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].assets of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property pages[].updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].created_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].__v of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getPage

• What's New

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

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].assets of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property created_at of schema AvailablePageSchema in response with status code 200

• [Added] property __v of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getAppliedTheme

• What's New

• [Added] properties config.global_schema.props[].type, config.global_schema.props[].category, config.global_schema.props[].id, config.global_schema.props[].label, config.global_schema.props[].info in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Added] property assets.umd_js.link of schema UMDJs in response with status code 200

• [Added] property assets.css.link of schema CSS in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property src of schema ThemesSchema in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] query parameter filters (type: boolean)

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getThemeForPreview

• What's New

• [Added] query parameter filters (type: boolean)

• [Added] properties config.global_schema.props[].type, config.global_schema.props[].category, config.global_schema.props[].id, config.global_schema.props[].label, config.global_schema.props[].info in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Added] property assets.umd_js.link of schema UMDJs in response with status code 200

• [Added] property assets.css.link of schema CSS in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property src of schema ThemesSchema in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getAppliedThemeV1

• What's New

• [Added] method getAppliedThemeV1

getThemeForPreviewV1

• What's New

• [Added] method getThemeForPreviewV1

User

User

loginWithFacebook

• What's New

• [Breaking] [Added] oauth2.access_token made required in request body

• [Breaking] [Added] oauth2, profile made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

loginWithGoogle

• What's New

• [Breaking] [Added] oauth2.access_token made required in request body

• [Breaking] [Added] oauth2, profile made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

loginWithGoogleAndroid

• What's New

• [Breaking] [Added] oauth2.access_token made required in request body

• [Breaking] [Added] oauth2, profile made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

loginWithGoogleIOS

• What's New

• [Breaking] [Added] oauth2.access_token made required in request body

• [Breaking] [Added] oauth2, profile made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

loginWithAppleIOS

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

loginWithOTP

• What's New

• [Added] property ci of schema SendOtpRequestSchema in request body

• [Breaking] [Added] country_code, mobile made required in request body

• What's Deprecated

• [Breaking] [Deleted] property encrypt_otp of schema SendOtpRequestSchema in request body

loginWithEmailAndPassword

• What's New

• [Breaking] [Added] password, username made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

sendResetPasswordEmail

• What's New

• [Breaking] [Added] email made required in request body

sendResetPasswordMobile

• What's Deprecated

• [Breaking] [Deleted] method sendResetPasswordMobile

sendResetToken

• What's New

• [Breaking] [Added] code made required in request body

forgotPassword

• What's New

• [Breaking] [Added] code, password made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

resetForgotPassword

• What's New

• [Breaking] [Added] code, password made required in request body

loginWithToken

• What's New

• [Breaking] [Added] token made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Header parameters Set-Cookie in Response 200

registerWithForm

• What's New

• [Added] property email_otp of schema RegisterFormSuccess in response with status code 200

verifyEmail

• What's New

• [Breaking] [Added] code made required in request body

verifyMobile

• What's New

• [Breaking] [Added] code made required in request body

updatePassword

• What's New

• [Breaking] [Added] old_password, new_password made required in request body

sendOTPOnMobile

• What's New

• [Added] property ci of schema SendMobileOtpRequestSchema in request body

• [Breaking] [Added] action, mobile, country_code made required in request body

• What's Deprecated

• [Breaking] [Deleted] property encrypt_otp of schema SendMobileOtpRequestSchema in request body

sendForgotOTPOnMobile

• What's New

• [Breaking] [Added] action, mobile, country_code made required in request body

verifyMobileOTP

• What's New

• [Added] property action of schema VerifyOtpRequestSchema in request body

• [Breaking] [Added] request_id, otp made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] property verify_mobile_link of schema VerifyOtpSuccess in response with status code 200

• [Added] Header parameters Set-Cookie in Response 200

verifyMobileForgotOTP

• What's New

• [Breaking] [Added] request_id, otp made required in request body

sendOTPOnEmail

• What's New

• [Breaking] [Added] email, action made required in request body

• [Added] property email_otp of schema EmailOtpSuccess in response with status code 200

sendForgotOTPOnEmail

• What's New

• [Breaking] [Added] email, action made required in request body

• [Added] property email_otp of schema EmailOtpSuccess in response with status code 200

verifyEmailOTP

• What's New

• [Added] property request_id of schema VerifyEmailOtpRequestSchema in request body

• [Breaking] [Added] email, otp, action made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] property verify_mobile_link of schema VerifyOtpSuccess in response with status code 200

• [Added] Header parameters Set-Cookie in Response 200

verifyEmailForgotOTP

• What's New

• [Added] property request_id of schema VerifyEmailForgotOtpRequestSchema in request body

• [Breaking] [Added] email, otp made required in request body

getLoggedInUser

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

getPlatformConfig

• What's New

• [Breaking] [Added] Value format date-time to property updated_at of schema PlatformSchema in response with status code 200

• [Added] property login.via of schema Login in response with status code 200

• [Added] property social.truecaller of schema Social in response with status code 200

• [Added] property required_fields.password of schema RequiredFields in response with status code 200

• [Added] property register_required_fields.password of schema RegisterRequiredFields in response with status code 200

• [Added] property social_tokens.facebook.app_secret of schema Facebook in response with status code 200

• [Added] property social_tokens.accountkit.app_secret of schema Accountkit in response with status code 200

• [Added] property social_tokens.google.app_secret of schema Google in response with status code 200

• [Added] property social_tokens.truecaller of schema SocialTokens in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property mobile_image of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property desktop_image of schema PlatformSchema in response with status code 200

• [Added] property account_lockout of schema PlatformSchema in response with status code 200

• [Added] property password_settings of schema PlatformSchema in response with status code 200

• [Added] property jwt_config of schema PlatformSchema in response with status code 200

• [Added] property auth_method of schema PlatformSchema in response with status code 200

• [Added] property retail_account of schema PlatformSchema in response with status code 200

• [Added] property phone_number_limit of schema PlatformSchema in response with status code 200

• [Added] property email_id_limit of schema PlatformSchema in response with status code 200

updateProfile

• What's New

• [Added] property ci of schema EditProfileRequestSchema in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] property email_otp of schema ProfileEditSuccess in response with status code 200

• [Added] Header parameters Set-Cookie in Response 200

• What's Deprecated

• [Breaking] [Deleted] property encrypt_otp of schema EditProfileRequestSchema in request body

addMobileNumber

• What's New

• [Breaking] [Added] country_code, phone made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

deleteMobileNumber

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

setMobileNumberAsPrimary

• What's New

• [Breaking] [Added] country_code, phone made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

sendVerificationLinkToMobile

• What's New

• [Breaking] [Added] country_code, phone made required in request body

• [Added] property user of schema SendMobileVerifyLinkSuccess in response with status code 200

addEmail

• What's New

• [Breaking] [Added] email made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

deleteEmail

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

setEmailAsPrimary

• What's New

• [Breaking] [Added] email made required in request body

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values user,programmatic to property user.account_type of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

sendVerificationLinkToEmail

• What's New

• [Breaking] [Added] email made required in request body

deleteUser

• What's New

• [Breaking] [Added] user_id, otp, reason, reason_id made required in request body

getUserAttributes

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

updateUserAttributes

• What's New

• [Added] Security in Request

truecallerCallback

• What's New

• [Added] method truecallerCallback

truecallerVerify

• What's New

• [Added] method truecallerVerify

loginWithTruecaller

• What's New

• [Added] method loginWithTruecaller

refreshToken

• What's New

• [Added] method refreshToken

getUserGroupsForUser

• What's New

• [Added] method getUserGroupsForUser

Webhook

Webhook

saveClickEvent

• What's New

• [Added] property sent_at of schema ClickEventPayload in request body

Platform REST

Platform REST Change Log

Compared against: 1.9.4-RC235H

Current version: 1.10.5

• [Breaking] [Removed] Finance class from platform client

Analytics

Analytics

executeJobForProvidedParametersV2

• What's New

• [Breaking] [Added] Possible values number,cursor to property page.type of schema Page in request body

• [Added] property page.next_cursor of schema Page in request body

• [Added] property page.previous_cursor of schema Page in request body

• [Added] property pagination_type of schema JobExecute in request body

• [Added] property limit of schema JobExecute in request body

• [Added] property cursor of schema JobExecute in request body

• [Added] properties rows, page in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property page.next_id of schema Page in request body

• What's Changed

• [Changed] page.type made optional in request body

startDownloadForQueryV2

• What's New

• [Added] Security in Request

checkJobStatusByNameV2

• What's New

• [Added] properties start_date, end_date, status, message, file_metadata in response with status code 200

• [Added] Security in Request

AuditTrail

AuditTrail

getAuditLogs

• What's Deprecated

• [Breaking] [Deleted] method getAuditLogs

createAuditLog

• What's New

• [Added] property log_meta.sessions of schema LogMetaObj in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/audit-trail/v1.0/company/{company_id}/logs To /service/platform/webhook/v1.0/company/{company_id}/audit/logs/create

getAuditLog

• What's Deprecated

• [Breaking] [Deleted] method getAuditLog

getEntityTypes

• What's Deprecated

• [Breaking] [Deleted] method getEntityTypes

Billing

Billing

getChargeDetails

• What's New

• [Breaking] [Added] Type integer to property code of schema ResourceNotFound in response with status code 404

• [Breaking] [Added] Type boolean to property success of schema ResourceNotFound in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible values from day from property recurring.interval of schema ChargeRecurring in response with status code 200

• [Breaking] [Deleted] Possible values from week from property recurring.interval of schema ChargeRecurring in response with status code 200

getSubscriptionCharge

• What's New

• [Breaking] [Added] Possible values extension,theme,subscription to property entity_type of schema SubscriptionChargeRes in response with status code 200

• [Breaking] [Added] Possible values pending,expired,declined,active,frozen,cancelled,no_renew,success,failed to property status of schema SubscriptionChargeRes in response with status code 200

• [Breaking] [Added] Type integer to property code of schema ResourceNotFound in response with status code 404

• [Breaking] [Added] Type boolean to property success of schema ResourceNotFound in response with status code 404

• [Added] Security in Request

cancelSubscriptionCharge

• What's New

• [Breaking] [Added] Possible values extension,theme,subscription to property entity_type of schema SubscriptionChargeRes in response with status code 200

• [Breaking] [Added] Possible values pending,expired,declined,active,frozen,cancelled,no_renew,success,failed to property status of schema SubscriptionChargeRes in response with status code 200

• [Breaking] [Added] Type integer to property code of schema ResourceNotFound in response with status code 404

• [Breaking] [Added] Type boolean to property success of schema ResourceNotFound in response with status code 404

• [Added] Security in Request

createOneTimeCharge

• What's New

• [Breaking] [Added] Possible values subscription,extension,standalone to property charge.final_charge.charge_type of schema OneTimeChargeEntity in response with status code 200

• [Breaking] [Added] Possible values pending,expired,declined,active,frozen,cancelled,no_renew,success,failed to property charge.final_charge.status of schema OneTimeChargeEntity in response with status code 200

• [Breaking] [Added] Possible values extension,theme to property charge.final_charge.entity_type of schema OneTimeChargeEntity in response with status code 200

• [Added] Security in Request

createSubscriptionCharge

• What's New

• [Breaking] [Added] Possible values extension,theme to property subscription.entity_type of schema EntitySubscription in response with status code 200

• [Breaking] [Added] Possible values pending,expired,declined,active,frozen,cancelled,no_renew,success,failed to property subscription.status of schema EntitySubscription in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from int32 from property trial_days of schema CreateSubscriptionCharge in request body

• [Deleted] Value format from int32 from property line_items[].trial_days of schema ChargeLineItem in request body

• [Breaking] [Deleted] Possible values from day from property subscription.line_items[].recurring.interval of schema ChargeRecurring in response with status code 200

• [Breaking] [Deleted] Possible values from week from property subscription.line_items[].recurring.interval of schema ChargeRecurring in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from integer to number of property trial_days of schema CreateSubscriptionCharge in request body

• [Breaking] [Changed] Type from integer to number of property line_items[].trial_days of schema ChargeLineItem in request body

Cart

Cart

getCoupons

• What's New

• [Added] property items[].date_meta.approved_on of schema CouponDateMeta in response with status code 200

• [Added] property items[].date_meta.rejected_on of schema CouponDateMeta in response with status code 200

• [Added] property items[].date_meta.reviewed_on of schema CouponDateMeta in response with status code 200

• [Added] property items[].author.approved_by of schema CouponAuthor in response with status code 200

• [Added] property items[].author.reviewed_by of schema CouponAuthor in response with status code 200

• [Added] property items[].author.rejected_by of schema CouponAuthor in response with status code 200

• [Added] property items[].state.is_active of schema State in response with status code 200

• [Added] properties items[]._schedule.next_schedule[].start, items[]._schedule.next_schedule[].end in response with status code 200

• [Added] property items[]._schedule.status of schema CouponSchedule in response with status code 200

• [Added] Possible values exclude_category_id to property items[].rule_definition.scope[] of schema RuleDefinition in response with status code 200

• [Added] Possible values tags to property items[].rule_definition.scope[] of schema RuleDefinition in response with status code 200

• [Added] property items[].draft of schema CouponObj in response with status code 200

• [Added] property items[].review of schema CouponObj in response with status code 200

• [Added] property items[].rejected of schema CouponObj in response with status code 200

• [Added] property items[].approved of schema CouponObj in response with status code 200

• [Added] property items[].medias of schema CouponObj in response with status code 200

• [Added] property items[].is_archived of schema CouponObj in response with status code 200

• [Added] property page.page of schema Page in response with status code 200

• [Added] property page.last_id of schema Page in response with status code 200

• [Added] property draft of schema CouponsResponseObject in response with status code 200

• [Added] property review of schema CouponsResponseObject in response with status code 200

• [Added] property rejected of schema CouponsResponseObject in response with status code 200

• [Added] property approved of schema CouponsResponseObject in response with status code 200

• [Added] property success of schema CouponsResponseObject in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

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

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

• [Deleted] Value format from date-time from property items[]._schedule.end of schema CouponSchedule in response with status code 200

• [Breaking] [Deleted] Default value from property items[]._schedule.end of schema CouponSchedule in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[]._schedule.end of schema CouponSchedule in response with status code 200

• [Deleted] Value format from date-time from property items[]._schedule.start of schema CouponSchedule in response with status code 200

• What's Changed

• [Breaking] [Changed] items[].rule_definition.calculate_on made optional in response with status code 200

• [Breaking] [Changed] items[].rule_definition.value_type made optional in response with status code 200

• [Breaking] [Changed] items[].identifiers made optional in response with status code 200

• [Breaking] [Changed] items[].rule made optional in response with status code 200

• [Breaking] [Changed] items[].validity made optional in response with status code 200

createCoupon

• What's New

• [Added] property date_meta.approved_on of schema CouponDateMeta in request body

• [Added] property date_meta.rejected_on of schema CouponDateMeta in request body

• [Added] property date_meta.reviewed_on of schema CouponDateMeta in request body

• [Added] property author.approved_by of schema CouponAuthor in request body

• [Added] property author.reviewed_by of schema CouponAuthor in request body

• [Added] property author.rejected_by of schema CouponAuthor in request body

• [Added] property state.is_active of schema State in request body

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in request body

• [Added] property _schedule.status of schema CouponSchedule in request body

• [Added] Possible values exclude_category_id to property rule_definition.scope[] of schema RuleDefinition in request body

• [Added] Possible values tags to property rule_definition.scope[] of schema RuleDefinition in request body

• [Added] property data of schema CouponDetailResponseObject in response with status code 201

• [Added] property errors of schema OperationErrorResponseObject in response with status code 400

• [Added] property meta of schema OperationErrorResponseObject in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Default value from property _schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Possible nullable value from true from property _schedule.end of schema CouponSchedule in request body

• [Deleted] Value format from date-time from property _schedule.start of schema CouponSchedule in request body

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 400

• What's Changed

• [Breaking] [Changed] rule_definition.calculate_on made optional in request body

• [Breaking] [Changed] rule_definition.value_type made optional in request body

getCouponById

• What's New

• [Added] property date_meta.approved_on of schema CouponDateMeta in response with status code 200

• [Added] property date_meta.rejected_on of schema CouponDateMeta in response with status code 200

• [Added] property date_meta.reviewed_on of schema CouponDateMeta in response with status code 200

• [Added] property author.approved_by of schema CouponAuthor in response with status code 200

• [Added] property author.reviewed_by of schema CouponAuthor in response with status code 200

• [Added] property author.rejected_by of schema CouponAuthor in response with status code 200

• [Added] property state.is_active of schema State in response with status code 200

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in response with status code 200

• [Added] property _schedule.status of schema CouponSchedule in response with status code 200

• [Added] Possible values exclude_category_id to property rule_definition.scope[] of schema RuleDefinition in response with status code 200

• [Added] Possible values tags to property rule_definition.scope[] of schema RuleDefinition in response with status code 200

• [Added] property coupon_type of schema CouponUpdate in response with status code 200

• [Added] property coupon_prefix of schema CouponUpdate in response with status code 200

• [Added] property coupon_counts of schema CouponUpdate in response with status code 200

• [Added] property medias of schema CouponUpdate in response with status code 200

• [Added] property _id of schema CouponUpdate in response with status code 200

• [Added] property is_archived of schema CouponUpdate in response with status code 200

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.end of schema CouponSchedule in response with status code 200

• [Breaking] [Deleted] Default value from property _schedule.end of schema CouponSchedule in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property _schedule.end of schema CouponSchedule in response with status code 200

• [Deleted] Value format from date-time from property _schedule.start of schema CouponSchedule in response with status code 200

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

• What's Changed

• [Breaking] [Changed] rule_definition.calculate_on made optional in response with status code 200

• [Breaking] [Changed] rule_definition.value_type made optional in response with status code 200

updateCoupon

• What's New

• [Added] property date_meta.approved_on of schema CouponDateMeta in request body

• [Added] property date_meta.rejected_on of schema CouponDateMeta in request body

• [Added] property date_meta.reviewed_on of schema CouponDateMeta in request body

• [Added] property author.approved_by of schema CouponAuthor in request body

• [Added] property author.reviewed_by of schema CouponAuthor in request body

• [Added] property author.rejected_by of schema CouponAuthor in request body

• [Added] property state.is_active of schema State in request body

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in request body

• [Added] property _schedule.status of schema CouponSchedule in request body

• [Added] Possible values exclude_category_id to property rule_definition.scope[] of schema RuleDefinition in request body

• [Added] Possible values tags to property rule_definition.scope[] of schema RuleDefinition in request body

• [Added] property coupon_type of schema CouponUpdate in request body

• [Added] property coupon_prefix of schema CouponUpdate in request body

• [Added] property coupon_counts of schema CouponUpdate in request body

• [Added] property medias of schema CouponUpdate in request body

• [Added] property _id of schema CouponUpdate in request body

• [Added] property is_archived of schema CouponUpdate in request body

• [Added] property data of schema CouponDetailResponseObject in response with status code 200

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Default value from property _schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Possible nullable value from true from property _schedule.end of schema CouponSchedule in request body

• [Deleted] Value format from date-time from property _schedule.start of schema CouponSchedule in request body

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

• What's Changed

• [Breaking] [Changed] rule_definition.calculate_on made optional in request body

• [Breaking] [Changed] rule_definition.value_type made optional in request body

updateCouponPartially

• What's New

• [Added] properties schedule.next_schedule[].start, schedule.next_schedule[].end in request body

• [Added] property schedule.status of schema CouponSchedule in request body

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Default value from property schedule.end of schema CouponSchedule in request body

• [Breaking] [Deleted] Possible nullable value from true from property schedule.end of schema CouponSchedule in request body

• [Deleted] Value format from date-time from property schedule.start of schema CouponSchedule in request body

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

getPromotions

• What's New

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

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

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

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

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

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

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

• [Added] properties items[]._schedule.next_schedule[].start, items[]._schedule.next_schedule[].end in response with status code 200

• [Added] property items[]._schedule.status of schema PromotionSchedule in response with status code 200

• [Added] property items[].author.rejected_by of schema PromotionAuthor in response with status code 200

• [Added] property items[].author.approved_by of schema PromotionAuthor in response with status code 200

• [Added] property items[].author.reviewed_by of schema PromotionAuthor in response with status code 200

• [Added] property items[].date_meta.approved_on of schema PromotionDateMeta in response with status code 200

• [Added] property items[].date_meta.rejected_on of schema PromotionDateMeta in response with status code 200

• [Added] property items[].date_meta.reviewed_on of schema PromotionDateMeta in response with status code 200

• [Added] property items[].draft of schema PromotionListItem in response with status code 200

• [Added] property items[].review of schema PromotionListItem in response with status code 200

• [Added] property items[].rejected of schema PromotionListItem in response with status code 200

• [Added] property items[].approved of schema PromotionListItem in response with status code 200

• [Added] property items[].is_processed of schema PromotionListItem in response with status code 200

• [Added] property items[].is_archived of schema PromotionListItem in response with status code 200

• [Added] property page.page of schema Page in response with status code 200

• [Added] property page.last_id of schema Page in response with status code 200

• [Added] property draft of schema PromotionsResponseObject in response with status code 200

• [Added] property review of schema PromotionsResponseObject in response with status code 200

• [Added] property rejected of schema PromotionsResponseObject in response with status code 200

• [Added] property approved of schema PromotionsResponseObject in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Deleted] Possible values from percentage,amount,fixed_price,bogo,contract_price,shipping_price,ladder_price,bundle_price_percentage,bundle_price_amount,bundle_amount_percentage,custom,free_gift_items,free_non_sellable_items from property items[].promotion_type of schema PromotionListItem in response with status code 200

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

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

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

• [Deleted] Value format from date-time from property items[]._schedule.end of schema PromotionSchedule in response with status code 200

• [Deleted] Value format from date-time from property items[]._schedule.start of schema PromotionSchedule in response with status code 200

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

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

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

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

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

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

• What's Changed

• [Breaking] [Changed] items[].buy_rules made optional in response with status code 200

• [Breaking] [Changed] items[].discount_rules made optional in response with status code 200

• [Breaking] [Changed] items[].mode made optional in response with status code 200

• [Breaking] [Changed] items[].ownership made optional in response with status code 200

• [Breaking] [Changed] items[].promotion_type made optional in response with status code 200

createPromotion

• What's New

• [Added] property restrictions.price_range of schema Restrictions1 in request body

• [Added] property restrictions.cart_min_retention of schema Restrictions1 in request body

• [Added] property restrictions.email_domain of schema Restrictions1 in request body

• [Added] property restrictions.is_plt_bypass of schema Restrictions1 in request body

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in request body

• [Added] property _schedule.status of schema PromotionSchedule in request body

• [Added] Possible nullable value true to property post_order_action.action_type of schema PromotionAction in request body

• [Added] property author.rejected_by of schema PromotionAuthor in request body

• [Added] property author.approved_by of schema PromotionAuthor in request body

• [Added] property author.reviewed_by of schema PromotionAuthor in request body

• [Added] property date_meta.approved_on of schema PromotionDateMeta in request body

• [Added] property date_meta.rejected_on of schema PromotionDateMeta in request body

• [Added] property date_meta.reviewed_on of schema PromotionDateMeta in request body

• [Added] property visibility of schema PromotionAdd in request body

• [Added] property indexed_criteria of schema PromotionAdd in request body

• [Added] property restrictions.price_range of schema Restrictions1 in response with status code 201

• [Added] property restrictions.cart_min_retention of schema Restrictions1 in response with status code 201

• [Added] property restrictions.email_domain of schema Restrictions1 in response with status code 201

• [Added] property restrictions.is_plt_bypass of schema Restrictions1 in response with status code 201

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in response with status code 201

• [Added] property _schedule.status of schema PromotionSchedule in response with status code 201

• [Added] Possible nullable value true to property post_order_action.action_type of schema PromotionAction in response with status code 201

• [Added] property author.rejected_by of schema PromotionAuthor in response with status code 201

• [Added] property author.approved_by of schema PromotionAuthor in response with status code 201

• [Added] property author.reviewed_by of schema PromotionAuthor in response with status code 201

• [Added] property date_meta.approved_on of schema PromotionDateMeta in response with status code 201

• [Added] property date_meta.rejected_on of schema PromotionDateMeta in response with status code 201

• [Added] property date_meta.reviewed_on of schema PromotionDateMeta in response with status code 201

• [Added] property draft of schema PromotionAddResult in response with status code 201

• [Added] property review of schema PromotionAddResult in response with status code 201

• [Added] property rejected of schema PromotionAddResult in response with status code 201

• [Added] property approved of schema PromotionAddResult in response with status code 201

• [Added] property offer_counts of schema PromotionAddResult in response with status code 201

• [Added] property offer_prefix of schema PromotionAddResult in response with status code 201

• [Added] property is_bank_offer of schema PromotionAddResult in response with status code 201

• [Added] property custom_content of schema PromotionAddResult in response with status code 201

• [Added] property medias of schema PromotionAddResult in response with status code 201

• [Added] property offer_type of schema PromotionAddResult in response with status code 201

• [Added] property visibility of schema PromotionAddResult in response with status code 201

• [Added] property is_archived of schema PromotionAddResult in response with status code 201

• [Added] property is_processed of schema PromotionAddResult in response with status code 201

• [Added] property indexed_criteria of schema PromotionAddResult in response with status code 201

• [Added] property _id of schema PromotionAddResult in response with status code 201

• [Added] property errors of schema OperationErrorResponseObject in response with status code 400

• [Added] property meta of schema OperationErrorResponseObject in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from all_user,guest,registered,user_group from property restrictions.user_type of schema Restrictions1 in request body

• [Deleted] Value format from date-time from property _schedule.end of schema PromotionSchedule in request body

• [Deleted] Value format from date-time from property _schedule.start of schema PromotionSchedule in request body

• [Breaking] [Deleted] property visiblility of schema PromotionAdd in request body

• [Deleted] Possible values from all_user,guest,registered,user_group from property restrictions.user_type of schema Restrictions1 in response with status code 201

• [Deleted] Value format from date-time from property _schedule.end of schema PromotionSchedule in response with status code 201

• [Deleted] Value format from date-time from property _schedule.start of schema PromotionSchedule in response with status code 201

• [Breaking] [Deleted] property visiblility of schema PromotionAdd in response with status code 201

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 400

• What's Changed

• [Changed] post_order_action.action_date, post_order_action.action_type made optional in request body

• [Changed] post_order_action.action_date, post_order_action.action_type made optional in response with status code 201

• [Breaking] [Changed] buy_rules made optional in response with status code 201

• [Breaking] [Changed] discount_rules made optional in response with status code 201

• [Breaking] [Changed] display_meta made optional in response with status code 201

• [Breaking] [Changed] ownership made optional in response with status code 201

getPromotionById

• What's New

• [Added] property restrictions.price_range of schema Restrictions1 in response with status code 200

• [Added] property restrictions.cart_min_retention of schema Restrictions1 in response with status code 200

• [Added] property restrictions.email_domain of schema Restrictions1 in response with status code 200

• [Added] property restrictions.is_plt_bypass of schema Restrictions1 in response with status code 200

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in response with status code 200

• [Added] property _schedule.status of schema PromotionSchedule in response with status code 200

• [Added] Possible nullable value true to property post_order_action.action_type of schema PromotionAction in response with status code 200

• [Added] property author.rejected_by of schema PromotionAuthor in response with status code 200

• [Added] property author.approved_by of schema PromotionAuthor in response with status code 200

• [Added] property author.reviewed_by of schema PromotionAuthor in response with status code 200

• [Added] property date_meta.approved_on of schema PromotionDateMeta in response with status code 200

• [Added] property date_meta.rejected_on of schema PromotionDateMeta in response with status code 200

• [Added] property date_meta.reviewed_on of schema PromotionDateMeta in response with status code 200

• [Added] property medias of schema PromotionUpdateResult in response with status code 200

• [Added] property is_archived of schema PromotionUpdateResult in response with status code 200

• [Added] property reason of schema PromotionUpdateResult in response with status code 200

• [Added] property is_processed of schema PromotionUpdateResult in response with status code 200

• [Added] property visibility of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_prefix of schema PromotionUpdateResult in response with status code 200

• [Added] property custom_content of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_counts of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_type of schema PromotionUpdateResult in response with status code 200

• [Added] property is_bank_offer of schema PromotionUpdateResult in response with status code 200

• [Added] property indexed_criteria of schema PromotionUpdateResult in response with status code 200

• [Added] property _id of schema PromotionUpdateResult in response with status code 200

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from all_user,guest,registered,user_group from property restrictions.user_type of schema Restrictions1 in response with status code 200

• [Deleted] Value format from date-time from property _schedule.end of schema PromotionSchedule in response with status code 200

• [Deleted] Value format from date-time from property _schedule.start of schema PromotionSchedule in response with status code 200

• [Breaking] [Deleted] property visiblility of schema PromotionUpdate in response with status code 200

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

• What's Changed

• [Changed] post_order_action.action_date, post_order_action.action_type made optional in response with status code 200

• [Breaking] [Changed] buy_rules made optional in response with status code 200

• [Breaking] [Changed] discount_rules made optional in response with status code 200

• [Breaking] [Changed] display_meta made optional in response with status code 200

• [Breaking] [Changed] ownership made optional in response with status code 200

updatePromotion

• What's New

• [Added] property restrictions.price_range of schema Restrictions1 in request body

• [Added] property restrictions.cart_min_retention of schema Restrictions1 in request body

• [Added] property restrictions.email_domain of schema Restrictions1 in request body

• [Added] property restrictions.is_plt_bypass of schema Restrictions1 in request body

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in request body

• [Added] property _schedule.status of schema PromotionSchedule in request body

• [Added] Possible nullable value true to property post_order_action.action_type of schema PromotionAction in request body

• [Added] property author.rejected_by of schema PromotionAuthor in request body

• [Added] property author.approved_by of schema PromotionAuthor in request body

• [Added] property author.reviewed_by of schema PromotionAuthor in request body

• [Added] property date_meta.approved_on of schema PromotionDateMeta in request body

• [Added] property date_meta.rejected_on of schema PromotionDateMeta in request body

• [Added] property date_meta.reviewed_on of schema PromotionDateMeta in request body

• [Added] property reason of schema PromotionUpdate in request body

• [Added] property visibility of schema PromotionUpdate in request body

• [Added] property restrictions.price_range of schema Restrictions1 in response with status code 200

• [Added] property restrictions.cart_min_retention of schema Restrictions1 in response with status code 200

• [Added] property restrictions.email_domain of schema Restrictions1 in response with status code 200

• [Added] property restrictions.is_plt_bypass of schema Restrictions1 in response with status code 200

• [Added] properties _schedule.next_schedule[].start, _schedule.next_schedule[].end in response with status code 200

• [Added] property _schedule.status of schema PromotionSchedule in response with status code 200

• [Added] Possible nullable value true to property post_order_action.action_type of schema PromotionAction in response with status code 200

• [Added] property author.rejected_by of schema PromotionAuthor in response with status code 200

• [Added] property author.approved_by of schema PromotionAuthor in response with status code 200

• [Added] property author.reviewed_by of schema PromotionAuthor in response with status code 200

• [Added] property date_meta.approved_on of schema PromotionDateMeta in response with status code 200

• [Added] property date_meta.rejected_on of schema PromotionDateMeta in response with status code 200

• [Added] property date_meta.reviewed_on of schema PromotionDateMeta in response with status code 200

• [Added] property medias of schema PromotionUpdateResult in response with status code 200

• [Added] property is_archived of schema PromotionUpdateResult in response with status code 200

• [Added] property reason of schema PromotionUpdateResult in response with status code 200

• [Added] property is_processed of schema PromotionUpdateResult in response with status code 200

• [Added] property visibility of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_prefix of schema PromotionUpdateResult in response with status code 200

• [Added] property custom_content of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_counts of schema PromotionUpdateResult in response with status code 200

• [Added] property offer_type of schema PromotionUpdateResult in response with status code 200

• [Added] property is_bank_offer of schema PromotionUpdateResult in response with status code 200

• [Added] property indexed_criteria of schema PromotionUpdateResult in response with status code 200

• [Added] property _id of schema PromotionUpdateResult in response with status code 200

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from all_user,guest,registered,user_group from property restrictions.user_type of schema Restrictions1 in request body

• [Deleted] Value format from date-time from property _schedule.end of schema PromotionSchedule in request body

• [Deleted] Value format from date-time from property _schedule.start of schema PromotionSchedule in request body

• [Breaking] [Deleted] property visiblility of schema PromotionUpdate in request body

• [Deleted] Possible values from all_user,guest,registered,user_group from property restrictions.user_type of schema Restrictions1 in response with status code 200

• [Deleted] Value format from date-time from property _schedule.end of schema PromotionSchedule in response with status code 200

• [Deleted] Value format from date-time from property _schedule.start of schema PromotionSchedule in response with status code 200

• [Breaking] [Deleted] property visiblility of schema PromotionUpdate in response with status code 200

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

• What's Changed

• [Changed] post_order_action.action_date, post_order_action.action_type made optional in request body

• [Changed] buy_rules made optional in request body

• [Changed] discount_rules made optional in request body

• [Changed] display_meta made optional in request body

• [Changed] ownership made optional in request body

• [Changed] post_order_action.action_date, post_order_action.action_type made optional in response with status code 200

• [Breaking] [Changed] buy_rules made optional in response with status code 200

• [Breaking] [Changed] discount_rules made optional in response with status code 200

• [Breaking] [Changed] display_meta made optional in response with status code 200

• [Breaking] [Changed] ownership made optional in response with status code 200

updatePromotionPartially

• What's New

• [Added] properties schedule.next_schedule[].start, schedule.next_schedule[].end in request body

• [Added] property schedule.status of schema PromotionSchedule in request body

• [Added] property publish of schema PromotionPartialUpdate in request body

• [Added] property errors of schema OperationErrorResponseObject in response with status code 404

• [Added] property meta of schema OperationErrorResponseObject in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property archive of schema PromotionPartialUpdate in request body

• [Deleted] Value format from date-time from property schedule.end of schema PromotionSchedule in request body

• [Deleted] Value format from date-time from property schedule.start of schema PromotionSchedule in request body

• [Breaking] [Deleted] property error of schema OperationErrorResponse in response with status code 404

getPromosCouponConfig

• What's New

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

• [Added] property items of schema ActivePromosResponseObject in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property entity_slug of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property title of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property modified_on of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property example of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property entity_type of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property created_on of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property is_hidden of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property type of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property subtitle of schema ActivePromosResponse in response with status code 200

• [Breaking] [Deleted] property description of schema ActivePromosResponse in response with status code 200

getPromotionOffers

• What's Deprecated

• [Breaking] [Deleted] method getPromotionOffers

getPromotionPaymentOffers

• What's Deprecated

• [Breaking] [Deleted] method getPromotionPaymentOffers

updateCartMetaConfig

• What's New

• [Added] property international_delivery_charges of schema CartMetaConfigUpdate in request body

• [Added] property app_id of schema CartMetaConfigUpdate in request body

• [Added] property is_active of schema CartMetaConfigUpdate in request body

• [Added] property slug of schema CartMetaConfigUpdate in request body

• [Added] property is_universal of schema CartMetaConfigUpdate in request body

• [Added] property company_id of schema CartMetaConfigUpdate in request body

• [Added] property updated_on of schema CartMetaConfigUpdate in request body

• [Added] property last_modified_by of schema CartMetaConfigUpdate in request body

• [Added] property order_placing of schema CartMetaConfigUpdate in request body

• [Added] property name of schema CartMetaConfigUpdate in request body

• [Added] property article_tags of schema CartMetaConfigUpdate in request body

• [Added] property allow_coupon_with_rewards of schema CartMetaConfigUpdate in request body

• [Added] property gst_input of schema CartMetaConfigUpdate in request body

• [Added] property staff_selection of schema CartMetaConfigUpdate in request body

• [Added] property placing_for_customer of schema CartMetaConfigUpdate in request body

• [Added] property pan_card of schema CartMetaConfigUpdate in request body

• [Added] property empty_cart of schema CartMetaConfigUpdate in request body

• [Added] property id of schema CartMetaConfigUpdate in request body

• [Added] property hide_on_storefront of schema CartMetaConfigUpdate in request body

• [Added] property created_on of schema CartMetaConfigUpdate in request body

• [Added] property international_delivery_charges of schema CartMetaConfigUpdate in response with status code 200

• [Added] property app_id of schema CartMetaConfigUpdate in response with status code 200

• [Added] property is_active of schema CartMetaConfigUpdate in response with status code 200

• [Added] property slug of schema CartMetaConfigUpdate in response with status code 200

• [Added] property is_universal of schema CartMetaConfigUpdate in response with status code 200

• [Added] property company_id of schema CartMetaConfigUpdate in response with status code 200

• [Added] property updated_on of schema CartMetaConfigUpdate in response with status code 200

• [Added] property last_modified_by of schema CartMetaConfigUpdate in response with status code 200

• [Added] property order_placing of schema CartMetaConfigUpdate in response with status code 200

• [Added] property name of schema CartMetaConfigUpdate in response with status code 200

• [Added] property article_tags of schema CartMetaConfigUpdate in response with status code 200

• [Added] property allow_coupon_with_rewards of schema CartMetaConfigUpdate in response with status code 200

• [Added] property gst_input of schema CartMetaConfigUpdate in response with status code 200

• [Added] property staff_selection of schema CartMetaConfigUpdate in response with status code 200

• [Added] property placing_for_customer of schema CartMetaConfigUpdate in response with status code 200

• [Added] property pan_card of schema CartMetaConfigUpdate in response with status code 200

• [Added] property empty_cart of schema CartMetaConfigUpdate in response with status code 200

• [Added] property id of schema CartMetaConfigUpdate in response with status code 200

• [Added] property hide_on_storefront of schema CartMetaConfigUpdate in response with status code 200

• [Added] property created_on of schema CartMetaConfigUpdate in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

Catalog

Catalog

getCatalogInsights

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/analytics/insights/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/analytics/insights

getApplicationBrandListing

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] page made required in response with status code 200

• [Breaking] [Added] Type object to property of schema ApplicationBrandListingSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

updateAppBrand

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

getApplicationBrands

• What's New

• [Added] Possible values internl to property items[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property items[].action.popup.type of schema PageType in response with status code 200

• [Breaking] [Added] Type object to property items[].logo of schema BrandLogo in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property modified_on of schema BrandListingResponseSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].logo.aspect_ratio of schema BrandMedia in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from string to integer of property items[].departments[] of schema BrandItem in response with status code 200

getCategories

• What's New

• [Added] Possible values internl to property data[].items[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].action.popup.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].action.popup.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].childs[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].childs[].action.popup.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].childs[].childs[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property data[].items[].childs[].childs[].childs[].action.popup.type of schema PageType in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

getApplicationCategoryListing

• What's New

• [Added] property items[].created_by.email of schema UserInfo in response with status code 200

• [Added] property items[].created_by.uid of schema UserInfo in response with status code 200

• [Breaking] [Added] Type object to property items[].created_by of schema UserInfo in response with status code 200

• [Added] property items[].modified_by.email of schema UserInfo in response with status code 200

• [Added] property items[].modified_by.uid of schema UserInfo in response with status code 200

• [Breaking] [Added] Type object to property items[].modified_by of schema UserInfo in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

updateAppCategory

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

getAllCollections

• What's New

• [Breaking] [Deleted] query parameter tags (type: array), [Added] query parameter tag (type: array)

• [Added] Possible nullable value true to property items[]._schedule.next_schedule[].start of schema NextSchedule in response with status code 200

• [Added] Possible values internl to property items[].action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property items[].action.popup.type of schema PageType in response with status code 200

• [Breaking] [Added] Possible values image,video,3d_model to property items[].logo.type of schema Media in response with status code 200

• [Added] property items[].logo.alt of schema Media in response with status code 200

• [Added] property items[].logo.thumbnail of schema Media in response with status code 200

• [Breaking] [Added] Type string to property items[].query[].value[] of schema CollectionQuery in response with status code 200

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property items[]._schedule.next_schedule[].end of schema NextSchedule in response with status code 200

• [Breaking] [Deleted] properties items[].badge.color, items[].badge.text in response with status code 200

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

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

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

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

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

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

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

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

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections

createCollection

• What's New

• [Added] Possible nullable value true to property _schedule.next_schedule[].start of schema NextSchedule in request body

• [Added] property banners.landscape.secure_url of schema CollectionImage in request body

• [Added] property banners.landscape.type of schema CollectionImage in request body

• [Added] property banners.portrait.secure_url of schema CollectionImage in request body

• [Added] property banners.portrait.type of schema CollectionImage in request body

• [Added] properties created_by.email, created_by.uid, created_by.user_id, created_by.username in request body

• [Breaking] [Added] Type object to property created_by of schema UserInfo in request body

• [Added] property logo.secure_url of schema CollectionImage in request body

• [Added] property logo.type of schema CollectionImage in request body

• [Added] properties modified_by.email, modified_by.uid, modified_by.user_id, modified_by.username in request body

• [Breaking] [Added] Type object to property modified_by of schema UserInfo in request body

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in request body

• [Added] properties seo.sitemap.priority, seo.sitemap.frequency in request body

• [Added] properties seo.breadcrumbs[].action.page, seo.breadcrumbs[].action.type in request body

• [Breaking] [Added] seo.breadcrumbs[].action.type made required in request body

• [Added] property seo.meta_tags[].items[].title of schema ApplicationItemSeoMetaTags in request body

• [Added] property seo.meta_tags[].items[].items of schema ApplicationItemSeoMetaTags in request body

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

• [Added] Possible nullable value true to property _schedule.next_schedule[].start of schema NextSchedule in response with status code 200

• [Added] properties badge.color, badge.text in response with status code 200

• [Added] Default value true to property is_active of schema CollectionCreateResponseSchema in response with status code 200

• [Added] Default value to property meta of schema CollectionCreateResponseSchema in response with status code 200

• [Added] Default value 99999 to property priority of schema CollectionCreateResponseSchema in response with status code 200

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in response with status code 200

• [Added] Default value to property query of schema CollectionCreateResponseSchema in response with status code 200

• [Added] Possible values internl to property action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property action.popup.type of schema PageType in response with status code 200

• [Added] Default value to property _custom_json of schema CollectionCreateResponseSchema in response with status code 200

• [Added] Default value to property _locale_language of schema CollectionCreateResponseSchema in response with status code 200

• [Added] properties seo.sitemap.priority, seo.sitemap.frequency in response with status code 200

• [Added] properties seo.breadcrumbs[].action.page, seo.breadcrumbs[].action.type in response with status code 200

• [Breaking] [Added] seo.breadcrumbs[].action.type made required in response with status code 200

• [Added] property seo.meta_tags[].items[].title of schema ApplicationItemSeoMetaTags in response with status code 200

• [Added] property seo.meta_tags[].items[].items of schema ApplicationItemSeoMetaTags in response with status code 200

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

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

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.next_schedule[].end of schema NextSchedule in request body

• [Breaking] [Deleted] property seo.breadcrumbs[].action[] of schema ApplicationItemSeoBreadcrumbs in request body

• [Breaking] [Deleted] property seo.meta_tags[].items[].key of schema ApplicationItemSeoMetaTagItem in request body

• [Breaking] [Deleted] property seo.meta_tags[].items[].value of schema ApplicationItemSeoMetaTagItem in request body

• [Deleted] Possible values from items,query from property type of schema CreateCollection in request body

• [Deleted] Value format from date-time from property _schedule.next_schedule[].end of schema NextSchedule in response with status code 200

• [Breaking] [Deleted] property banners.landscape.aspect_ratio of schema BannerImage in response with status code 200

• [Deleted] Value format from url from property banners.landscape.url of schema BannerImage in response with status code 200

• [Breaking] [Deleted] property banners.portrait.aspect_ratio of schema BannerImage in response with status code 200

• [Deleted] Value format from url from property banners.portrait.url of schema BannerImage in response with status code 200

• [Breaking] [Deleted] property logo.aspect_ratio of schema BannerImage in response with status code 200

• [Deleted] Value format from url from property logo.url of schema BannerImage in response with status code 200

• [Breaking] [Deleted] property tag of schema CollectionCreateResponse in response with status code 200

• [Breaking] [Deleted] property published of schema CollectionCreateResponse in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumbs[].action[] of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].key of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].value of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] property is_visible of schema CollectionCreateResponse in response with status code 200

• [Breaking] [Deleted] property id of schema CollectionCreateResponse in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] app_id made optional in request body

• [Changed] banners.landscape.aspect_ratio, banners.landscape.url made optional in request body

• [Changed] banners.portrait.aspect_ratio, banners.portrait.url made optional in request body

• [Changed] logo.aspect_ratio, logo.url made optional in request body

• [Breaking] [Changed] Type from array to object of property seo.breadcrumbs[].action of schema ApplicationItemSeoBreadcrumbs in request body

• [Changed] seo.meta_tags[].items[].value made optional in request body

• [Breaking] [Changed] Type from array to object of property seo.breadcrumbs[].action of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Changed] seo.meta_tags[].items[].value made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections

getApplicationFilterValues

• What's New

• [Breaking] [Added] Type string to property values[].value of schema ProductQueryFiltersValue in response with status code 200

• [Added] property values[].logo of schema ProductQueryFiltersValue in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property values[].currency_code of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].currency_symbol of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].display_format of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].max of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].min of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].query_format of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].selected_max of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property values[].selected_min of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] values[].display, values[].is_selected, values[].value made optional in response with status code 200

getApplicationFilterKeys

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] operators made optional in response with status code 200

getQueryFilters

• What's New

• [Breaking] [Added] Type string to property filters[].values[].value of schema CollectionProductFiltersValue in response with status code 200

• [Added] property filters[].values[].logo of schema CollectionProductFiltersValue in response with status code 200

• [Added] property sort_on[].logo of schema CollectionProductSortOn in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property filters[].values[].currency_code of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].currency_symbol of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].display_format of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].max of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].min of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].query_format of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].selected_max of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] property filters[].values[].selected_min of schema ProductFiltersValue in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] filters[].key, filters[].values made optional in response with status code 200

• [Breaking] [Changed] operators made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/query-options/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/query-options

deleteCollection

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}

updateCollection

• What's New

• [Added] Possible nullable value true to property _schedule.next_schedule[].start of schema NextSchedule in request body

• [Added] property banners.landscape.secure_url of schema CollectionImage in request body

• [Added] property banners.landscape.type of schema CollectionImage in request body

• [Added] property banners.portrait.secure_url of schema CollectionImage in request body

• [Added] property banners.portrait.type of schema CollectionImage in request body

• [Added] property logo.secure_url of schema CollectionImage in request body

• [Added] property logo.type of schema CollectionImage in request body

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in request body

• [Added] properties seo.sitemap.priority, seo.sitemap.frequency in request body

• [Added] property seo.meta_tags[].items[].title of schema ApplicationItemSeoMetaTags in request body

• [Added] property seo.meta_tags[].items[].items of schema ApplicationItemSeoMetaTags in request body

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

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

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

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

• [Added] Possible nullable value true to property _schedule.next_schedule[].start of schema NextSchedule in response with status code 200

• [Added] property banners.landscape.secure_url of schema CollectionImage in response with status code 200

• [Added] property banners.landscape.type of schema CollectionImage in response with status code 200

• [Added] property banners.portrait.secure_url of schema CollectionImage in response with status code 200

• [Added] property banners.portrait.type of schema CollectionImage in response with status code 200

• [Added] property logo.secure_url of schema CollectionImage in response with status code 200

• [Added] property logo.type of schema CollectionImage in response with status code 200

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in response with status code 200

• [Added] properties seo.sitemap.priority, seo.sitemap.frequency in response with status code 200

• [Added] property seo.meta_tags[].items[].title of schema ApplicationItemSeoMetaTags in response with status code 200

• [Added] property seo.meta_tags[].items[].items of schema ApplicationItemSeoMetaTags in response with status code 200

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

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

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

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

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.next_schedule[].end of schema NextSchedule in request body

• [Breaking] [Deleted] property seo.meta_tags[].items[].key of schema ApplicationItemSeoMetaTagItem in request body

• [Breaking] [Deleted] property seo.meta_tags[].items[].value of schema ApplicationItemSeoMetaTagItem in request body

• [Deleted] Value format from date-time from property _schedule.next_schedule[].end of schema NextSchedule in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].key of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].value of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] banners.landscape.aspect_ratio, banners.landscape.url made optional in request body

• [Changed] banners.portrait.aspect_ratio, banners.portrait.url made optional in request body

• [Changed] logo.aspect_ratio, logo.url made optional in request body

• [Changed] seo.meta_tags[].items[].value made optional in request body

• [Changed] banners.landscape.aspect_ratio, banners.landscape.url made optional in response with status code 200

• [Changed] banners.portrait.aspect_ratio, banners.portrait.url made optional in response with status code 200

• [Changed] logo.aspect_ratio, logo.url made optional in response with status code 200

• [Changed] seo.meta_tags[].items[].value made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}

getCollectionItems

• What's New

• [Breaking] [Deleted] query parameter page_id (type: string), [Added] query parameter is_pinned (type: boolean)

• [Breaking] [Deleted] query parameter page_type (type: string), [Added] query parameter q (type: string)

• [Added] query parameter is_excluded (type: boolean)

• [Added] Possible values internl to property items[].brand.action.page.type of schema PageType in response with status code 200

• [Added] Possible values internl to property items[].brand.action.popup.type of schema PageType in response with status code 200

• [Breaking] [Added] Possible values image,video,3d_model to property items[].brand.logo.type of schema Media in response with status code 200

• [Added] property items[].brand.logo.alt of schema Media in response with status code 200

• [Added] property items[].brand.logo.thumbnail of schema Media in response with status code 200

• [Breaking] [Added] Possible values default,standard to property items[].image_nature of schema ApplicationProductsSchema in response with status code 200

• [Breaking] [Added] Possible values composite,digital,packaging,set,standard to property items[].item_type of schema ApplicationProductsSchema in response with status code 200

• [Breaking] [Added] Possible values image,video,3d_model to property items[].medias[].type of schema Media in response with status code 200

• [Added] property items[].medias[].alt of schema Media in response with status code 200

• [Added] property items[].medias[].thumbnail of schema Media in response with status code 200

• [Breaking] [Added] Possible values INR,USD,EUR to property items[].price.effective.currency_code of schema CurrencyCodeEnum in response with status code 200

• [Breaking] [Added] Possible values INR,USD,EUR to property items[].price.marked.currency_code of schema CurrencyCodeEnum in response with status code 200

• [Added] property items[].price.selling of schema ProductListingPrice in response with status code 200

• [Added] properties items[].seo.breadcrumbs[].action.page, items[].seo.breadcrumbs[].action.type in response with status code 200

• [Breaking] [Added] items[].seo.breadcrumbs[].action.type made required in response with status code 200

• [Added] property items[].popularity of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].brand_uid of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].category_uid of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].verification_status of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].channel_identifier of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].category_slug of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].size_guide of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].l3_categories of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].store_ids of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].company_ids of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].departments of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].tags of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].l3_category_names of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].sizes of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].product_group_tag of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].multi_size of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].is_gift of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].is_cod of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].is_dependent of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].is_available of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].variants of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].variant_media of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].variant_group of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].multi_categories of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].template_tag of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].net_quantity of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].custom_order of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].country_of_origin of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[]._custom_json of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].identifiers of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].item_id of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[]._custom_meta of schema ApplicationProductsSchema in response with status code 200

• [Added] property items[].discount_percentage of schema ApplicationProductsSchema in response with status code 200

• [Added] items[].is_dependent made required in response with status code 200

• [Added] items[].uid made required in response with status code 200

• [Added] items[].category_uid made required in response with status code 200

• [Added] items[].item_code made required in response with status code 200

• [Added] items[].multi_size made required in response with status code 200

• [Added] items[].brand_uid made required in response with status code 200

• [Added] items[].country_of_origin made required in response with status code 200

• [Added] items[].item_type made required in response with status code 200

• [Added] items[].departments made required in response with status code 200

• [Added] items[].slug made required in response with status code 200

• [Added] items[].image_nature made required in response with status code 200

• [Added] items[].moq made required in response with status code 200

• [Added] items[].seo made required in response with status code 200

• [Added] items[].is_cod made required in response with status code 200

• [Added] items[].is_gift made required in response with status code 200

• [Added] items[].is_available made required in response with status code 200

• [Added] items[].l3_categories made required in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property filters of schema GetCollectionItemsResponse in response with status code 200

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

• [Deleted] Type from object from property items[].price of schema ProductListingPrice in response with status code 200

• [Breaking] [Deleted] property items[].seo.breadcrumbs[].action[] of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from object to string of property items[].teaser_tag of schema ProductListingDetail in response with status code 200

• [Breaking] [Changed] Type from array to object of property items[].seo.breadcrumbs[].action of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/items/ To /service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/collections/{id}/items

addCollectionItems

• What's New

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuerySchemaV2 in request body

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}/items/ To /service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/collections/{id}/items

getCollectionDetail

• What's New

• [Added] Possible nullable value true to property _schedule.next_schedule[].start of schema NextSchedule in response with status code 200

• [Breaking] [Added] Possible values image,video,3d_model to property logo.type of schema Media in response with status code 200

• [Added] property logo.alt of schema Media in response with status code 200

• [Added] property logo.thumbnail of schema Media in response with status code 200

• [Breaking] [Added] Type string to property query[].value[] of schema CollectionQuery in response with status code 200

• [Added] properties seo.sitemap.priority, seo.sitemap.frequency in response with status code 200

• [Added] properties seo.breadcrumbs[].action.page, seo.breadcrumbs[].action.type in response with status code 200

• [Breaking] [Added] seo.breadcrumbs[].action.type made required in response with status code 200

• [Added] property seo.meta_tags[].items[].title of schema ApplicationItemSeoMetaTags in response with status code 200

• [Added] property seo.meta_tags[].items[].items of schema ApplicationItemSeoMetaTags in response with status code 200

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

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

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property _schedule.next_schedule[].end of schema NextSchedule in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumbs[].action[] of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].key of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] property seo.meta_tags[].items[].value of schema ApplicationItemSeoMetaTagItem in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from array to object of property seo.breadcrumbs[].action of schema ApplicationItemSeoBreadcrumbs in response with status code 200

• [Changed] seo.meta_tags[].items[].value made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{slug}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{slug}

getApplicationDepartmentListing

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

updateAppDepartment

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

getDepartments

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

getAppInventory

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/inventory/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/inventory

getAppLocations

• What's New

• [Added] query parameter company_uids (type: array)

• [Added] property items[].company.created_by._id of schema UserSchema in response with status code 200

• [Added] property items[].company.created_by.uid of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].company.created_on of schema GetCompanySchema in response with status code 200

• [Added] property items[].company.modified_by._id of schema UserSchema in response with status code 200

• [Added] property items[].company.modified_by.uid of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].company.modified_on of schema GetCompanySchema in response with status code 200

• [Added] property items[].company.verified_by._id of schema UserSchema in response with status code 200

• [Added] property items[].company.verified_by.uid of schema UserSchema in response with status code 200

• [Added] property items[].created_by._id of schema UserSchema in response with status code 200

• [Added] property items[].created_by.uid of schema UserSchema in response with status code 200

• [Added] property items[].modified_by._id of schema UserSchema in response with status code 200

• [Added] property items[].modified_by.uid of schema UserSchema in response with status code 200

• [Breaking] [Added] Possible values high_street,warehouse,mall to property items[].store_type of schema GetLocationSchema in response with status code 200

• [Added] property items[].verified_by._id of schema UserSchema in response with status code 200

• [Added] property items[].verified_by.uid of schema UserSchema in response with status code 200

• [Added] property items[].store_code of schema GetLocationSchema in response with status code 200

• [Added] property items[].company_id of schema GetLocationSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property filters of schema LocationListSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/locations To /service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/locations

getConfigurations

• What's New

• [Added] property data.product.details_groups of schema ConfigurationProduct in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] data.listing.filter, data.listing.sort made optional in response with status code 200

• [Breaking] [Changed] data.product.similar, data.product.variant made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration

createConfigurationProductListing

• What's New

• [Added] property product.details_groups of schema ConfigurationProduct in request body

• [Added] property data.product.details_groups of schema ConfigurationProduct in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] listing.filter, listing.sort made optional in request body

• [Breaking] [Changed] product.similar, product.variant made optional in request body

• [Breaking] [Changed] data.listing.filter, data.listing.sort made optional in response with status code 200

• [Breaking] [Changed] data.product.similar, data.product.variant made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration

getCatalogConfiguration

• What's New

• [Added] properties product.compare.data in response with status code 200

• [Added] properties product.detail.data, product.detail.values in response with status code 200

• [Added] properties product.similar.data in response with status code 200

• [Added] properties product.variant.data in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/metadata/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/metadata

getConfigurationByType

• What's New

• [Added] properties data.product.compare.data in response with status code 200

• [Added] properties data.product.detail.data, data.product.detail.values in response with status code 200

• [Added] properties data.product.similar.data in response with status code 200

• [Added] properties data.product.variant.data in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] data.app_id, data.config_type made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}

createConfigurationByType

• What's New

• [Added] property product.details_groups of schema ConfigurationProduct in request body

• [Added] property data.product.details_groups of schema ConfigurationProduct in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] listing.filter, listing.sort made optional in request body

• [Breaking] [Changed] product.similar, product.variant made optional in request body

• [Breaking] [Changed] data.listing.filter, data.listing.sort made optional in response with status code 200

• [Breaking] [Changed] data.product.similar, data.product.variant made optional in response with status code 200

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}

getAppProduct

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}

updateAppProduct

• What's New

• [Added] properties moq.increment_unit, moq.maximum, moq.minimum in request body

• [Breaking] [Added] Type object to property moq of schema ApplicationItemMOQ in request body

• [Added] properties seo.description, seo.title, seo.sitemap, seo.breadcrumbs, seo.meta_tags, seo.canonical_url in request body

• [Breaking] [Added] Type object to property seo of schema ApplicationItemSEO in request body

• [Added] properties size_promotion_threshold.threshold_type, size_promotion_threshold.threshold_value in request body

• [Breaking] [Added] Type object to property size_promotion_threshold of schema SizePromotionThreshold in request body

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}/ To /service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}

Common

Common

searchApplication

• What's New

• [Breaking] [Added] Possible values store,website-and-mobile-apps to property application.channel_type of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property application.created_at of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property application.updated_at of schema Application in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ApplicationResponseSchema in response with status code 200

Communication

Communication

getAppProviders

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AppProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AppProvider in response with status code 200

• [Added] Security in Request

updateAppProviders

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AppProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AppProvider in response with status code 200

• [Added] Security in Request

getGlobalProviders

• What's New

• [Added] Security in Request

getEmailProviders

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema EmailProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema EmailProvider in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

createEmailProvider

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getEmailProviderById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

updateEmailProviderById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailProvider in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

deleteEmailProviderById

• What's Deprecated

• [Breaking] [Deleted] method deleteEmailProviderById

getSmsProviders

• What's New

• [Added] property items of schema SmsProviders in response with status code 200

• [Added] property page of schema SmsProviders in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

createSmsProvider

• What's New

• [Added] property rpt of schema SmsProvider in response with status code 200

• [Added] property type of schema SmsProvider in response with status code 200

• [Added] property provider of schema SmsProvider in response with status code 200

• [Added] property _id of schema SmsProvider in response with status code 200

• [Added] property name of schema SmsProvider in response with status code 200

• [Added] property description of schema SmsProvider in response with status code 200

• [Added] property sender of schema SmsProvider in response with status code 200

• [Added] property username of schema SmsProvider in response with status code 200

• [Added] property authkey of schema SmsProvider in response with status code 200

• [Added] property entity_id of schema SmsProvider in response with status code 200

• [Added] property application of schema SmsProvider in response with status code 200

• [Added] property created_at of schema SmsProvider in response with status code 200

• [Added] property updated_at of schema SmsProvider in response with status code 200

• [Added] property slug of schema SmsProvider in response with status code 200

• [Added] property __v of schema SmsProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property token of schema SmsProviderReq in request body

• [Breaking] [Deleted] Response with status 500

getDefaultSmsProviders

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getSmsProviderById

• What's New

• [Added] property rpt of schema SmsProvider in response with status code 200

• [Added] property type of schema SmsProvider in response with status code 200

• [Added] property provider of schema SmsProvider in response with status code 200

• [Added] property _id of schema SmsProvider in response with status code 200

• [Added] property name of schema SmsProvider in response with status code 200

• [Added] property description of schema SmsProvider in response with status code 200

• [Added] property sender of schema SmsProvider in response with status code 200

• [Added] property username of schema SmsProvider in response with status code 200

• [Added] property authkey of schema SmsProvider in response with status code 200

• [Added] property entity_id of schema SmsProvider in response with status code 200

• [Added] property application of schema SmsProvider in response with status code 200

• [Added] property created_at of schema SmsProvider in response with status code 200

• [Added] property updated_at of schema SmsProvider in response with status code 200

• [Added] property slug of schema SmsProvider in response with status code 200

• [Added] property __v of schema SmsProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

updateSmsProviderById

• What's New

• [Added] property rpt of schema SmsProvider in response with status code 200

• [Added] property type of schema SmsProvider in response with status code 200

• [Added] property provider of schema SmsProvider in response with status code 200

• [Added] property _id of schema SmsProvider in response with status code 200

• [Added] property name of schema SmsProvider in response with status code 200

• [Added] property description of schema SmsProvider in response with status code 200

• [Added] property sender of schema SmsProvider in response with status code 200

• [Added] property username of schema SmsProvider in response with status code 200

• [Added] property authkey of schema SmsProvider in response with status code 200

• [Added] property entity_id of schema SmsProvider in response with status code 200

• [Added] property application of schema SmsProvider in response with status code 200

• [Added] property created_at of schema SmsProvider in response with status code 200

• [Added] property updated_at of schema SmsProvider in response with status code 200

• [Added] property slug of schema SmsProvider in response with status code 200

• [Added] property __v of schema SmsProvider in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property token of schema SmsProviderReq in request body

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

deleteSmsProviderById

• What's Deprecated

• [Breaking] [Deleted] method deleteSmsProviderById

getCampaigns

• What's New

• [Breaking] [Added] Type string to property items[].tags[] of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema Campaign in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

createCampaign

• What's New

• [Added] property recipient_headers of schema CampaignReq in request body

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

• [Added] property datasource of schema CampaignReq in request body

• [Breaking] [Added] Type string to property tags[] of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Campaign in response with status code 200

• [Added] Security in Request

getCampaignById

• What's New

• [Breaking] [Added] Type string to property tags[] of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Campaign in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

updateCampaignById

• What's New

• [Added] property recipient_headers of schema CampaignReq in request body

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

• [Added] property datasource of schema CampaignReq in request body

• [Breaking] [Added] Type string to property tags[] of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema Campaign in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Campaign in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

getStatsOfCampaignById

• What's New

• [Breaking] [Added] Type object to property items[].imported of schema StatsImported in response with status code 200

• [Added] properties items[].imported.count in response with status code 200

• [Breaking] [Added] Type object to property items[].processed of schema StatsProcessed in response with status code 200

• [Added] properties items[].processed.email, items[].processed.sms in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

• [Breaking] [Deleted] Response with status 400

getBigQueryRowCountById

• What's Deprecated

• [Breaking] [Deleted] method getBigQueryRowCountById

createBigQueryRowCount

• What's Deprecated

• [Breaking] [Deleted] method createBigQueryRowCount

getBigQueryHeadersById

• What's Deprecated

• [Breaking] [Deleted] method getBigQueryHeadersById

createBigQueryNCount

• What's Deprecated

• [Breaking] [Deleted] method createBigQueryNCount

createBigQueryHeaders

• What's Deprecated

• [Breaking] [Deleted] method createBigQueryHeaders

getSystemAudiences

• What's Deprecated

• [Breaking] [Deleted] method getSystemAudiences

getAudiences

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Audience in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema Audience in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

createAudience

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Audience in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Audience in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getAudienceById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Audience in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Audience in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

updateAudienceById

• What's Deprecated

• [Breaking] [Deleted] method updateAudienceById

deleteAudienceById

• What's Deprecated

• [Breaking] [Deleted] method deleteAudienceById

getDummyDatasources

• What's Deprecated

• [Breaking] [Deleted] method getDummyDatasources

getDummyDatasourcesMeta

• What's Deprecated

• [Breaking] [Deleted] method getDummyDatasourcesMeta

getNSampleRecordsFromCsvByGet

• What's Deprecated

• [Breaking] [Deleted] method getNSampleRecordsFromCsvByGet

getNSampleRecordsFromCsv

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getEmailTemplates

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema EmailTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema EmailTemplate in response with status code 200

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

createEmailTemplate

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailTemplate in response with status code 200

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getSystemEmailTemplates

• What's New

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties items in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from object to array of property of schema SystemEmailTemplates in response with status code 200

getEmailTemplateById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailTemplate in response with status code 200

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

updateEmailTemplateById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema EmailTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema EmailTemplate in response with status code 200

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

deleteEmailTemplateById

• What's New

• [Added] property deleted_count of schema BasicDelete in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property message of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] property affected of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] property operation of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

getSubscribedEmailTemplates

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema EmailTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema EmailTemplate in response with status code 200

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property page of schema EmailTemplates in response with status code 200

• [Breaking] [Deleted] Response with status 500

getSmsTemplates

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema SmsTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema SmsTemplate in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

createSmsTemplate

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema SmsTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema SmsTemplate in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getSystemSmsTemplates

• What's New

• [Breaking] [Added] Value format date-time to property [].created_at of schema SystemSmsTemplates in response with status code 200

• [Breaking] [Added] Value format date-time to property [].updated_at of schema SystemSmsTemplates in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getSmsTemplateById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema SmsTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema SmsTemplate in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

updateSmsTemplateById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema SmsTemplate in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema SmsTemplate in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

deleteSmsTemplateById

• What's New

• [Added] property deleted_count of schema BasicDelete in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property message of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] property affected of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] property operation of schema GenericDelete in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

getSubscribedSmsTemplates

• What's New

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

• [Added] property items[].page of schema SmsTemplates in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• [Breaking] [Deleted] property page of schema SmsTemplates in response with status code 200

• [Breaking] [Deleted] Response with status 500

sendCommunicationSynchronously

• What's New

• [Added] properties payload.data[].phone_number, payload.data[].country_code, payload.data[].to in request body

• [Added] property payload.email.provider.slug of schema PayloadEmailProviderStructure in request body

• [Added] property payload.sms.provider.slug of schema PayloadSmsProviderStructure in request body

• [Added] property provider of schema SendInstantRes in response with status code 200

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

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property payload.email.provider._id of schema PayloadEmailProviderStructure in request body

• [Breaking] [Deleted] property payload.sms.provider._id of schema PayloadSmsProviderStructure in request body

• [Breaking] [Deleted] property payload.application of schema PayloadStructure in request body

sendCommunicationAsynchronously

• What's New

• [Added] properties payload.data[].phone_number, payload.data[].country_code, payload.data[].to in request body

• [Added] property payload.email.provider.slug of schema PayloadEmailProviderStructure in request body

• [Added] property payload.sms.provider.slug of schema PayloadSmsProviderStructure in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property payload.email.provider._id of schema PayloadEmailProviderStructure in request body

• [Breaking] [Deleted] property payload.sms.provider._id of schema PayloadSmsProviderStructure in request body

• [Breaking] [Deleted] property payload.application of schema PayloadStructure in request body

getEventSubscriptions

• What's New

• [Added] Possible nullable value true to property items[].template.sms.template of schema EventSubscriptionTemplateSmsObj in response with status code 200

• [Added] Possible nullable value true to property items[].template.email.template of schema EventSubscriptionTemplateEmailObj in response with status code 200

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

• [Added] Possible nullable value true to property items[].event of schema EventSubscriptionObj in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema EventSubscriptionObj in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema EventSubscriptionObj in response with status code 200

• [Added] property items[].category of schema EventSubscriptionObj in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from nullable from property items[].template.sms.template of schema EventSubscriptionTemplateSms in response with status code 200

• [Deleted] Type from string from property items[].event of schema EventSubscription in response with status code 200

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from string to object of property items[].template.sms.template of schema EventSubscriptionTemplateSms in response with status code 200

createEventSubscriptions

• What's Deprecated

• [Breaking] [Deleted] method createEventSubscriptions

getEventSubscriptionsById

• What's Deprecated

• [Breaking] [Deleted] method getEventSubscriptionsById

editEventSubscriptions

• What's Deprecated

• [Breaking] [Deleted] method editEventSubscriptions

deleteEventSubscriptionsById

• What's Deprecated

• [Breaking] [Deleted] method deleteEventSubscriptionsById

createEventSubscriptionsByBulk

• What's New

• [Added] property subscriptions[].event of schema SubscriptionsObject in request body

• [Added] property subscriptions[].slug of schema SubscriptionsObject in request body

• [Added] Possible nullable value true to property [].template.sms.template of schema EventSubscriptionTemplateSms in response with status code 200

• [Added] Possible nullable value true to property [].template.email.template of schema EventSubscriptionTemplateEmail in response with status code 200

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

• [Breaking] [Added] Value format date-time to property [].created_at of schema EventSubscriptionsBulkUpdateRes in response with status code 200

• [Breaking] [Added] Value format date-time to property [].updated_at of schema EventSubscriptionsBulkUpdateRes in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from nullable from property [].template.sms.template of schema EventSubscriptionTemplateSms in response with status code 200

• [Breaking] [Deleted] Response with status 404

• [Breaking] [Deleted] Response with status 500

getGlobalVariables

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

postGlobalVariables

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema GlobalVariablesPostRes in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getJobs

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Job in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema Job in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

createJobs

• What's Deprecated

• [Breaking] [Deleted] method createJobs

triggerCampaignJob

• What's New

• [Added] Security in Request

getJobLogs

• What's New

• [Breaking] [Added] Type object to property items[].imported of schema StatsImported in response with status code 200

• [Added] properties items[].imported.count in response with status code 200

• [Breaking] [Added] Type object to property items[].processed of schema StatsProcessed in response with status code 200

• [Added] properties items[].processed.email, items[].processed.sms in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema JobLog in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema JobLog in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

getCommunicationLogs

• What's New

• [Added] property items[].email.provider of schema LogEmail in response with status code 200

• [Added] property items[].email.to of schema LogEmail in response with status code 200

• [Added] property items[].meta.job of schema LogMeta in response with status code 200

• [Added] property items[].meta.campaign of schema LogMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].expire_at of schema Log in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Log in response with status code 200

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

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

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

getSystemNotifications

• What's New

• [Added] property items[].settings.sound of schema SystemNotificationSetting in response with status code 200

• [Added] property items[].settings.priority of schema SystemNotificationSetting in response with status code 200

• [Added] property items[].settings.time_to_live of schema SystemNotificationSetting in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema SystemNotification in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].settings.type of schema SystemNotificationUser in response with status code 200

• [Breaking] [Deleted] property items[].settings.value of schema SystemNotificationUser in response with status code 200

• What's Changed

• [Changed] Path From /service/platform/communication/v1.0/company/{company_id}/notification/system-notifications/ To /service/platform/communication/v1.0/company/{company_id}/notification/system-notifications

sendOtp

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties sms.template.key, sms.template.value in request body

verfiyOtp

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

getOtpConfiguration

• What's New

• [Added] rate_limit made required in response with status code 200

• [Added] property rate_limit of schema OtpConfiguration in response with status code 200

• [Added] Security in Request

updateOtpConfiguration

• What's New

• [Added] rate_limit made required in response with status code 200

• [Added] property rate_limit of schema OtpConfiguration in response with status code 200

• [Added] Body content in Request

• [Added] Security in Request

getDefaultEmailProviders

• What's New

• [Added] method getDefaultEmailProviders

CompanyProfile

CompanyProfile

cbsOnboardGet

• What's New

• [Breaking] [Added] Possible values distributor,franchise,mbo,manufacturer-owner to property company_type of schema GetCompanyProfileSerializerResponseSchema in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property addresses[].address_type of schema GetAddressSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property contact_details.emails[] of schema ContactDetails in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property addresses[].pincode of schema GetAddressSerializer in response with status code 200

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id} To /service/platform/catalog/v2.0/company/{company_id}

updateCompany

• What's New

• [Breaking] [Added] Possible values distributor,franchise,mbo,manufacturer-owner to property company_type of schema UpdateCompany in request body

• [Added] property data of schema ProfileSuccessResponseSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property notification_emails[] of schema UpdateCompany in request body

• [Deleted] Value format from email from property contact_details.emails[] of schema ContactDetails in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] pattern validator for business_info in request body

• [Breaking] [Changed] Type from integer to string of property addresses[].pincode of schema CreateUpdateAddressSerializer in request body

• [Changed] addresses[].pincode made optional in request body

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id} To /service/platform/catalog/v2.0/company/{company_id}

getCompanyMetrics

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/metrics To /service/platform/catalog/v1.0/company/{company_id}/metrics

getBrand

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property verified_on of schema GetBrandResponseSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id} To /service/platform/catalog/v1.0/company/{company_id}/brand/{brand_id}

editBrand

• What's New

• [Added] property slug_key of schema CreateUpdateBrandRequestSchema in request body

• [Added] property data of schema ProfileSuccessResponseSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id} To /service/platform/catalog/v1.0/company/{company_id}/brand/{brand_id}

createBrand

• What's New

• [Added] Response with status 201

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/brand/ To /service/platform/catalog/v1.0/company/{company_id}/brand

getBrands

• What's New

• [Breaking] [Added] Possible values home,registered,office to property items[].company.addresses[].address_type of schema GetAddressSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property items[].brand.verified_on of schema GetBrandResponseSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].company.addresses[].pincode of schema GetAddressSerializer in response with status code 200

• [Breaking] [Changed] items[].company.business_type made optional in response with status code 200

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/company-brand To /service/platform/catalog/v2.0/company/{company_id}/company-brand

createCompanyBrandMapping

• What's New

• [Added] Response with status 201

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/company-brand To /service/platform/catalog/v2.0/company/{company_id}/company-brand

getLocations

• What's New

• [Added] query parameter store_codes (type: array)

• [Breaking] [Added] Possible values distributor,franchise,mbo,manufacturer-owner to property items[].company.company_type of schema GetCompanySchema in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property items[].company.addresses[].address_type of schema GetAddressSchema in response with status code 200

• [Added] property items[].company._custom_json of schema GetCompanySchema in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property items[].address.address_type of schema GetAddressSchema in response with status code 200

• [Breaking] [Added] Possible values high_street,warehouse,mall to property items[].store_type of schema GetLocationSchema in response with status code 200

• [Added] property items[].is_hyperlocal_active of schema GetLocationSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property items[].manager.email of schema LocationManagerSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property items[].company.addresses[].pincode of schema GetAddressSerializer in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].address.pincode of schema GetAddressSerializer in response with status code 200

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location To /service/platform/catalog/v2.0/company/{company_id}/location

createLocation

• What's New

• [Breaking] [Added] Possible values high_street,warehouse,mall to property store_type of schema LocationSchema in request body

• [Added] property is_hyperlocal_active of schema LocationSchema in request body

• [Added] property data of schema ProfileSuccessResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property manager.email of schema LocationManagerSerializer in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property address.pincode of schema AddressSerializer in request body

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location To /service/platform/catalog/v2.0/company/{company_id}/location

getLocationDetail

• What's New

• [Breaking] [Added] Possible values distributor,franchise,mbo,manufacturer-owner to property company.company_type of schema GetCompanySchema in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property company.addresses[].address_type of schema GetAddressSchema in response with status code 200

• [Added] property company._custom_json of schema GetCompanySchema in response with status code 200

• [Breaking] [Added] Possible values home,registered,office to property address.address_type of schema GetAddressSchema in response with status code 200

• [Breaking] [Added] Possible values high_street,warehouse,mall to property store_type of schema GetLocationSchema in response with status code 200

• [Added] property is_hyperlocal_active of schema GetLocationSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property manager.email of schema LocationManagerSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property company.addresses[].pincode of schema GetAddressSerializer in response with status code 200

• [Breaking] [Changed] Type from integer to string of property address.pincode of schema GetAddressSerializer in response with status code 200

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location/{location_id} To /service/platform/catalog/v2.0/company/{company_id}/location/{location_id}

updateLocation

• What's New

• [Breaking] [Added] Possible values high_street,warehouse,mall to property store_type of schema LocationSchema in request body

• [Added] property is_hyperlocal_active of schema LocationSchema in request body

• [Added] property data of schema ProfileSuccessResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property manager.email of schema LocationManagerSerializer in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property address.pincode of schema AddressSerializer in request body

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location/{location_id} To /service/platform/catalog/v2.0/company/{company_id}/location/{location_id}

createLocationBulk

• What's New

• [Breaking] [Added] Possible values high_street,warehouse,mall to property data[].store_type of schema LocationSchema in request body

• [Added] property data[].is_hyperlocal_active of schema LocationSchema in request body

• [Added] property data of schema ProfileSuccessResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property data[].manager.email of schema LocationManagerSerializer in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property data[].address.pincode of schema AddressSerializer in request body

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location/bulk To /service/platform/catalog/v1.0/company/{company_id}/location/bulk

getLocationTags

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Path From /service/platform/company-profile/v1.0/company/{company_id}/location/tags To /service/platform/catalog/v1.0/company/{company_id}/location/tags

Configuration

Configuration

getBuildConfig

• What's Deprecated

• [Breaking] [Deleted] method getBuildConfig

updateBuildConfig

• What's Deprecated

• [Breaking] [Deleted] method updateBuildConfig

getPreviousVersions

• What's Deprecated

• [Breaking] [Deleted] method getPreviousVersions

getAppFeatures

• What's New

• [Breaking] [Added] Value format date-time to property feature.created_at of schema AppFeature in response with status code 200

• [Breaking] [Added] Value format date-time to property feature.modified_at of schema AppFeature in response with status code 200

• [Added] property feature.buybox of schema AppFeature in response with status code 200

• [Added] property feature.pricing_strategy of schema AppFeature in response with status code 200

• [Added] property error of schema NotFound in response with status code 404

• [Added] property code of schema NotFound in response with status code 404

• [Added] Security in Request

updateAppFeatures

• What's New

• [Breaking] [Added] Value format date-time to property feature.created_at of schema AppFeature in request body

• [Breaking] [Added] Value format date-time to property feature.modified_at of schema AppFeature in request body

• [Added] property feature.buybox of schema AppFeature in request body

• [Added] property feature.pricing_strategy of schema AppFeature in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AppFeature in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AppFeature in response with status code 200

• [Added] property buybox of schema AppFeature in response with status code 200

• [Added] property pricing_strategy of schema AppFeature in response with status code 200

• [Added] property domain of schema InvalidPayloadRequestSchema in response with status code 400

• [Added] Security in Request

modifyAppFeatures

• What's New

• [Breaking] [Added] Value format date-time to property feature.created_at of schema AppFeature in request body

• [Breaking] [Added] Value format date-time to property feature.modified_at of schema AppFeature in request body

• [Added] property feature.buybox of schema AppFeature in request body

• [Added] property feature.pricing_strategy of schema AppFeature in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AppFeature in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AppFeature in response with status code 200

• [Added] property buybox of schema AppFeature in response with status code 200

• [Added] property pricing_strategy of schema AppFeature in response with status code 200

• [Added] property domain of schema InvalidPayloadRequestSchema in response with status code 400

• [Added] property error of schema NotFound in response with status code 404

• [Added] property code of schema NotFound in response with status code 404

• [Added] Security in Request

getAppBasicDetails

• What's New

• [Added] property domain.display_name of schema Domain in response with status code 200

• [Added] property domains[].display_name of schema Domain in response with status code 200

• [Added] Security in Request

updateAppBasicDetails

• What's New

• [Added] property domain.display_name of schema Domain in request body

• [Added] property domains[].display_name of schema Domain in request body

• [Added] property domain.display_name of schema Domain in response with status code 200

• [Added] property domains[].display_name of schema Domain in response with status code 200

• [Added] Security in Request

getAppContactInfo

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInformation in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInformation in response with status code 200

• [Added] Security in Request

updateAppContactInfo

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInformation in request body

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInformation in request body

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInformation in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInformation in response with status code 200

• [Added] Security in Request

getAppApiTokens

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema TokenResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema TokenResponseSchema in response with status code 200

• [Added] Security in Request

updateAppApiTokens

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema TokenResponseSchema in request body

• [Breaking] [Added] Value format date-time to property modified_at of schema TokenResponseSchema in request body

• [Breaking] [Added] Value format date-time to property created_at of schema TokenResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema TokenResponseSchema in response with status code 200

• [Added] property domain of schema InvalidPayloadRequestSchema in response with status code 400

• [Added] Security in Request

getAppCompanies

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

getAppStores

• What's New

• [Breaking] [Added] Value format date-time to property items[].modified_on of schema AppInventoryStores in response with status code 200

• [Breaking] [Added] Possible values high_street,warehouse,mall to property items[].store_type of schema AppInventoryStores in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Type from object from property items[] of schema AppInventoryStores in response with status code 200

getInventoryConfig

• What's New

• [Breaking] [Added] Type integer to property inventory.store.stores[] of schema InventoryStore in response with status code 200

• [Breaking] [Added] Type integer to property inventory.category.categories[] of schema InventoryCategory in response with status code 200

• [Breaking] [Added] Type integer to property inventory.exclude_category[] of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property inventory.company_store[] of schema AppInventoryConfig in response with status code 200

• [Added] property inventory.pricing_strategy of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property article_assignment.rules.store_priority.storetype_order[] of schema StorePriority in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInventory in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInventory in response with status code 200

• [Added] property error of schema NotFound in response with status code 404

• [Added] property code of schema NotFound in response with status code 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property inventory.enable_zone_overlapping of schema AppInventoryConfig in response with status code 200

• [Breaking] [Deleted] property inventory.sort_popular_first of schema AppInventoryConfig in response with status code 200

updateInventoryConfig

• What's New

• [Breaking] [Added] Type integer to property inventory.store.stores[] of schema InventoryStore in request body

• [Breaking] [Added] Type integer to property inventory.category.categories[] of schema InventoryCategory in request body

• [Breaking] [Added] Type integer to property inventory.exclude_category[] of schema AppInventoryConfig in request body

• [Breaking] [Added] Type integer to property inventory.company_store[] of schema AppInventoryConfig in request body

• [Added] property inventory.pricing_strategy of schema AppInventoryConfig in request body

• [Breaking] [Added] Type integer to property article_assignment.rules.store_priority.storetype_order[] of schema StorePriority in request body

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInventory in request body

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInventory in request body

• [Breaking] [Added] Type integer to property inventory.store.stores[] of schema InventoryStore in response with status code 200

• [Breaking] [Added] Type integer to property inventory.category.categories[] of schema InventoryCategory in response with status code 200

• [Breaking] [Added] Type integer to property inventory.exclude_category[] of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property inventory.company_store[] of schema AppInventoryConfig in response with status code 200

• [Added] property inventory.pricing_strategy of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property article_assignment.rules.store_priority.storetype_order[] of schema StorePriority in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInventory in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInventory in response with status code 200

• [Added] property domain of schema InvalidPayloadRequestSchema in response with status code 429

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property inventory.enable_zone_overlapping of schema AppInventoryConfig in request body

• [Breaking] [Deleted] property inventory.sort_popular_first of schema AppInventoryConfig in request body

• [Breaking] [Deleted] property inventory.enable_zone_overlapping of schema AppInventoryConfig in response with status code 200

• [Breaking] [Deleted] property inventory.sort_popular_first of schema AppInventoryConfig in response with status code 200

partiallyUpdateInventoryConfig

• What's New

• [Breaking] [Added] Type integer to property inventory.store.stores[] of schema InventoryStore in response with status code 200

• [Breaking] [Added] Type integer to property inventory.category.categories[] of schema InventoryCategory in response with status code 200

• [Breaking] [Added] Type integer to property inventory.exclude_category[] of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property inventory.company_store[] of schema AppInventoryConfig in response with status code 200

• [Added] property inventory.pricing_strategy of schema AppInventoryConfig in response with status code 200

• [Breaking] [Added] Type integer to property article_assignment.rules.store_priority.storetype_order[] of schema StorePriority in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ApplicationInventory in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ApplicationInventory in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property inventory.enable_zone_overlapping of schema AppInventoryConfig in response with status code 200

• [Breaking] [Deleted] property inventory.sort_popular_first of schema AppInventoryConfig in response with status code 200

getAppCurrencyConfig

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AppSupportedCurrency in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AppSupportedCurrency in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 404

Content

Content

getAnnouncementsList

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema AdminAnnouncementSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].modified_at of schema AdminAnnouncementSchema in response with status code 200

• [Added] property items[]._schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createAnnouncement

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AdminAnnouncementSchema in request body

• [Breaking] [Added] Value format date-time to property modified_at of schema AdminAnnouncementSchema in request body

• [Added] property _schedule.published of schema ScheduleSchema in request body

• [Added] Response with status 201

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getAnnouncementById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AdminAnnouncementSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema AdminAnnouncementSchema in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateAnnouncement

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema AdminAnnouncementSchema in request body

• [Breaking] [Added] Value format date-time to property modified_at of schema AdminAnnouncementSchema in request body

• [Added] property _schedule.published of schema ScheduleSchema in request body

• [Breaking] [Added] Value format date-time to property data.created_at of schema AdminAnnouncementSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property data.modified_at of schema AdminAnnouncementSchema in response with status code 200

• [Added] property data._schedule.published of schema ScheduleSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateAnnouncementSchedule

• What's New

• [Added] property published of schema ScheduleSchema in request body

• [Breaking] [Added] Value format date-time to property data.created_at of schema AdminAnnouncementSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property data.modified_at of schema AdminAnnouncementSchema in response with status code 200

• [Added] property data._schedule.published of schema ScheduleSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteAnnouncement

• What's New

• [Breaking] [Added] Value format date-time to property data.created_at of schema AdminAnnouncementSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property data.modified_at of schema AdminAnnouncementSchema in response with status code 200

• [Added] property data._schedule.published of schema ScheduleSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createBlog

• What's New

• [Added] property seo.breadcrumbs of schema SEO in request body

• [Added] property publish_date of schema BlogRequestSchema in request body

• [Breaking] [Added] Value format date-time to property publish_date of schema BlogSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs

getBlogs

• What's New

• [Breaking] [Added] Value format date-time to property items[].publish_date of schema BlogSchema in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/blogs

updateBlog

• What's New

• [Added] property seo.breadcrumbs of schema SEO in request body

• [Added] property publish_date of schema BlogRequestSchema in request body

• [Breaking] [Added] Value format date-time to property publish_date of schema BlogSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteBlog

• What's New

• [Breaking] [Added] Value format date-time to property publish_date of schema BlogSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

addDataLoader

• What's New

• [Added] property created_at of schema DataLoaderSchema in request body

• [Added] property modified_at of schema DataLoaderSchema in request body

• [Added] property application of schema DataLoaderSchema in request body

• [Added] property company of schema DataLoaderSchema in request body

• [Added] property is_selected of schema DataLoaderSchema in request body

• [Added] property created_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property modified_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property __v of schema DataLoaderResponseSchema in response with status code 200

• [Added] property is_selected of schema DataLoaderResponseSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from url,function from property type of schema DataLoaderSchema in request body

• [Breaking] [Deleted] property content of schema DataLoaderSchema in request body

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getDataLoaders

• What's New

• [Added] property items[].created_at of schema DataLoaderSchema in response with status code 200

• [Added] property items[].modified_at of schema DataLoaderSchema in response with status code 200

• [Added] property items[].application of schema DataLoaderSchema in response with status code 200

• [Added] property items[].company of schema DataLoaderSchema in response with status code 200

• [Added] property items[].is_selected of schema DataLoaderSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from url,function from property items[].type of schema DataLoaderSchema in response with status code 200

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteDataLoader

• What's New

• [Added] property created_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property modified_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property __v of schema DataLoaderResponseSchema in response with status code 200

• [Added] property is_selected of schema DataLoaderResponseSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

editDataLoader

• What's New

• [Added] property created_at of schema DataLoaderSchema in request body

• [Added] property modified_at of schema DataLoaderSchema in request body

• [Added] property application of schema DataLoaderSchema in request body

• [Added] property company of schema DataLoaderSchema in request body

• [Added] property is_selected of schema DataLoaderSchema in request body

• [Added] property created_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property modified_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property __v of schema DataLoaderResponseSchema in response with status code 200

• [Added] property is_selected of schema DataLoaderResponseSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Deleted] Possible values from url,function from property type of schema DataLoaderSchema in request body

• [Breaking] [Deleted] property content of schema DataLoaderSchema in request body

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getDataLoadersByService

• What's New

• [Added] property items of schema DataLoaderItemsResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property application of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property company of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property name of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property service of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property operation_id of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property type of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property url of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property content of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] property __source of schema DataLoaderResponseSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

selectDataLoader

• What's New

• [Added] property created_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property modified_at of schema DataLoaderResponseSchema in response with status code 200

• [Added] property __v of schema DataLoaderResponseSchema in response with status code 200

• [Added] property is_selected of schema DataLoaderResponseSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

resetDataLoader

• What's New

• [Added] property resetted of schema DataLoaderResetResponseSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property reset of schema DataLoaderResetResponseSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqCategories

• What's New

• [Added] property categories[].__v of schema CategorySchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqCategoryBySlugOrId

• What's New

• [Breaking] [Added] Value format uri to property category.icon_url of schema FAQCategorySchema in response with status code 200

• [Added] property category.__v of schema FAQCategorySchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property category._custom_json of schema FAQCategorySchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createFaqCategory

• What's New

• [Added] property category.__v of schema CategorySchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateFaqCategory

• What's New

• [Added] property category.__v of schema CategorySchema in request body

• [Added] property category.__v of schema CategorySchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteFaqCategory

• What's New

• [Added] property category of schema CreateFaqCategorySchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property slug of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] property application of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] property question of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] property answer of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] property tags of schema FaqSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqsByCategoryIdOrSlug

• What's New

• [Added] property faqs[].__v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

addFaq

• What's New

• [Added] property faq.__v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateFaq

• What's New

• [Added] property faq.__v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteFaq

• What's New

• [Added] property faq.__v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getFaqByIdOrSlug

• What's New

• [Added] property faq.__v of schema FaqSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

generateSEOTitle

• What's New

• [Breaking] [Added] Type object to property of schema GenerateSEOContent in request body

• [Breaking] [Added] Type object to property of schema GeneratedSEOContent in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getLandingPages

• What's New

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property items[].__v of schema LandingPageSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page

createLandingPage

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in request body

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in request body

• [Added] property __v of schema LandingPageSchema in request body

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property __v of schema LandingPageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property action of schema LandingPageSchema in request body

• [Breaking] [Deleted] property action of schema LandingPageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/landing-page

updateLandingPage

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in request body

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in request body

• [Added] property __v of schema LandingPageSchema in request body

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property __v of schema LandingPageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property action of schema LandingPageSchema in request body

• [Breaking] [Deleted] property action of schema LandingPageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteLandingPage

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property __v of schema LandingPageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property action of schema LandingPageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getLegalInformation

• What's New

• [Added] property __v of schema ApplicationLegal in response with status code 200

• [Breaking] [Added] Type object to property of schema ApplicationLegal in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateLegalInformation

• What's New

• [Added] property __v of schema ApplicationLegal in request body

• [Breaking] [Added] Type object to property of schema ApplicationLegal in request body

• [Added] property __v of schema ApplicationLegal in response with status code 200

• [Breaking] [Added] Type object to property of schema ApplicationLegal in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getNavigations

• What's New

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property items[].assignments of schema NavigationSchema in response with status code 200

• [Added] property items[].domain of schema NavigationSchema in response with status code 200

• [Added] property items[].tags of schema NavigationSchema in response with status code 200

• [Added] property items[].__v of schema NavigationSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations

createNavigation

• What's New

• [Added] property assignments of schema NavigationRequestSchema in request body

• [Added] property domain of schema NavigationRequestSchema in request body

• [Added] property tags of schema NavigationRequestSchema in request body

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property assignments of schema NavigationSchema in response with status code 200

• [Added] property domain of schema NavigationSchema in response with status code 200

• [Added] property tags of schema NavigationSchema in response with status code 200

• [Added] property __v of schema NavigationSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in request body

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/navigations

getDefaultNavigations

• What's New

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property items[].assignments of schema NavigationSchema in response with status code 200

• [Added] property items[].domain of schema NavigationSchema in response with status code 200

• [Added] property items[].tags of schema NavigationSchema in response with status code 200

• [Added] property items[].__v of schema NavigationSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getNavigationBySlug

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property assignments of schema NavigationSchema in response with status code 200

• [Added] property domain of schema NavigationSchema in response with status code 200

• [Added] property tags of schema NavigationSchema in response with status code 200

• [Added] property __v of schema NavigationSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Required status of query parameter device_platform

updateNavigation

• What's New

• [Added] property assignments of schema NavigationRequestSchema in request body

• [Added] property domain of schema NavigationRequestSchema in request body

• [Added] property tags of schema NavigationRequestSchema in request body

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property assignments of schema NavigationSchema in response with status code 200

• [Added] property domain of schema NavigationSchema in response with status code 200

• [Added] property tags of schema NavigationSchema in response with status code 200

• [Added] property __v of schema NavigationSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in request body

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteNavigation

• What's New

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] property assignments of schema NavigationSchema in response with status code 200

• [Added] property domain of schema NavigationSchema in response with status code 200

• [Added] property tags of schema NavigationSchema in response with status code 200

• [Added] property __v of schema NavigationSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property navigation[].action of schema NavigationReference in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPageMeta

• What's New

• [Added] property system_pages[].display of schema SystemPages in response with status code 200

• [Added] property system_pages[].action of schema SystemPages in response with status code 200

• [Added] property system_pages[].page_type of schema SystemPages in response with status code 200

• [Added] property custom_pages[].display of schema CustomePages in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property system_pages[]._id of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].application of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].archived of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].name of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].slug of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].platform of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].created_by of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].date_meta of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].orientation of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].version of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property system_pages[].navigation of schema NavigationSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[]._id of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].application of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].component_ids of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].content of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].content_path of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].created_by of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].date_meta of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].description of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].feature_image of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].page_meta of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[]._schedule of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[]._custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].orientation of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].platform of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].published of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].tags of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].title of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].type of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].seo of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property custom_pages[].archived of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPageSpec

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createPagePreview

• What's New

• [Added] property _schedule.next_schedule of schema CronSchedule in request body

• [Added] properties content[].type, content[].value in request body

• [Added] property seo.breadcrumbs of schema SEO in request body

• [Added] property platform of schema PageRequestSchema in request body

• [Added] property type of schema PageRequestSchema in request body

• [Added] property description of schema PageRequestSchema in request body

• [Added] property visibility of schema PageRequestSchema in request body

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in request body

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/preview/ To /service/platform/content/v1.0/company/{company_id}/application/{application_id}/pages/preview

updatePagePreview

• What's New

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deletePage

• What's New

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

addPathRedirectionRules

• What's New

• [Added] property __v of schema PathMappingSchema in request body

• [Breaking] [Added] Type object to property of schema PathMappingSchema in request body

• [Added] property message of schema CreatePathMappingSchema in response with status code 200

• [Added] property data of schema CreatePathMappingSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema CreatePathMappingSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property __source of schema PathMappingSchema in request body

• [Breaking] [Deleted] property application of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_from of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_to of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property updated_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property created_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property __source of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPathRedirectionRules

• What's New

• [Added] property message of schema GetAllPathMappingSchema in response with status code 200

• [Added] property data of schema GetAllPathMappingSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema GetAllPathMappingSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property application of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_from of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_to of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property updated_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property created_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property __source of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPathRedirectionRule

• What's New

• [Added] property message of schema DeletPathMappingSchema in response with status code 200

• [Added] property data of schema DeletPathMappingSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema DeletPathMappingSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property application of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_from of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_to of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property updated_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property created_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property __source of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updatePathRedirectionRules

• What's New

• [Added] property __v of schema PathMappingSchema in request body

• [Breaking] [Added] Type object to property of schema PathMappingSchema in request body

• [Added] property message of schema CreatePathMappingSchema in response with status code 200

• [Added] property data of schema CreatePathMappingSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema CreatePathMappingSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property __source of schema PathMappingSchema in request body

• [Breaking] [Deleted] property application of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property _id of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_from of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property redirect_to of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property updated_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property created_at of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] property __source of schema PathMappingSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deletePathRedirectionRules

• What's New

• [Added] properties message, data in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getSEOConfiguration

• What's New

• [Breaking] [Added] Value format date-time to property seo.created_at of schema SeoSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property seo.updated_at of schema SeoSchema in response with status code 200

• [Added] property seo.__v of schema SeoSchema in response with status code 200

• [Added] property seo.sitemap of schema SeoSchema in response with status code 200

• [Breaking] [Added] Type object to property seo of schema SeoSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema SeoComponent in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateSEOConfiguration

• What's New

• [Breaking] [Added] Value format date-time to property seo.created_at of schema SeoSchema in request body

• [Breaking] [Added] Value format date-time to property seo.updated_at of schema SeoSchema in request body

• [Added] property seo.__v of schema SeoSchema in request body

• [Added] property seo.sitemap of schema SeoSchema in request body

• [Breaking] [Added] Type object to property seo of schema SeoSchema in request body

• [Breaking] [Added] Type object to property of schema SeoComponent in request body

• [Breaking] [Added] Value format date-time to property created_at of schema SeoSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema SeoSchema in response with status code 200

• [Added] property __v of schema SeoSchema in response with status code 200

• [Added] property sitemap of schema SeoSchema in response with status code 200

• [Breaking] [Added] Type object to property of schema SeoSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getDefaultSEOMarkupSchema

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property items[].page_type of schema DefaultSEOSchemaMarkupTemplate in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getSEOMarkupSchemas

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property items[].page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property items[]._id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property items[].__v of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createSEOMarkupSchema

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplateRequestBody in request body

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property _id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property __v of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property updated_at of schema SEOSchemaMarkupTemplateRequestBody in request body

• [Breaking] [Deleted] property id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getSEOMarkupSchema

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property _id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property __v of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

editSEOMarkupSchema

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplateRequestBody in request body

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property _id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property __v of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property updated_at of schema SEOSchemaMarkupTemplateRequestBody in request body

• [Breaking] [Deleted] property id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

deleteSEOMarkupSchema

• What's New

• [Breaking] [Added] Possible values about-us,addresses,blog,brands,cards,cart,categories,brand,category,collection,collections,contact-us,external,faq,freshchat,home,notification-settings,orders,page,policy,product,product-request,products,profile,profile-order-shipment,profile-basic,profile-company,profile-emails,profile-phones,rate-us,refer-earn,settings,shared-cart,tnc,track-order,wishlist,sections,form,cart-delivery,cart-payment,cart-review,login,register,shipping-policy,return-policy,order-status to property page_type of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property _id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] property __v of schema SEOSchemaMarkupTemplate in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property id of schema SEOSchemaMarkupTemplate in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

getSlideshows

• What's Deprecated

• [Breaking] [Deleted] method getSlideshows

createSlideshow

• What's Deprecated

• [Breaking] [Deleted] method createSlideshow

getSlideshowBySlug

• What's Deprecated

• [Breaking] [Deleted] method getSlideshowBySlug

updateSlideshow

• What's Deprecated

• [Breaking] [Deleted] method updateSlideshow

deleteSlideshow

• What's Deprecated

• [Breaking] [Deleted] method deleteSlideshow

getSupportInformation

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Support in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Support in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateSupportInformation

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Support in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema Support in request body

• [Breaking] [Added] Value format date-time to property created_at of schema Support in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Support in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

updateInjectableTag

• What's New

• [Added] property tags[].compatible_engines of schema TagSchema in response with status code 200

• [Added] property company of schema TagsSchema in response with status code 200

• [Added] property __v of schema TagsSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getInjectableTags

• What's New

• [Added] property tags[].compatible_engines of schema TagSchema in response with status code 200

• [Added] property company of schema TagsSchema in response with status code 200

• [Added] property __v of schema TagsSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] query parameter all (type: boolean)

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

addInjectableTag

• What's New

• [Added] property tags[].compatible_engines of schema TagSchema in response with status code 200

• [Added] property company of schema TagsSchema in response with status code 200

• [Added] property __v of schema TagsSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

removeInjectableTag

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

editInjectableTag

• What's New

• [Breaking] [Added] Possible values inline,external to property tag.sub_type of schema HandpickedTagSchema in request body

• [Added] property tags[].compatible_engines of schema TagSchema in response with status code 200

• [Added] property company of schema TagsSchema in response with status code 200

• [Added] property __v of schema TagsSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getBlogBySlug

• What's New

• [Breaking] [Added] Value format date-time to property publish_date of schema BlogSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

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

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

createPage

• What's New

• [Added] property _schedule.next_schedule of schema CronSchedule in request body

• [Added] properties content[].type, content[].value in request body

• [Added] property seo.breadcrumbs of schema SEO in request body

• [Added] property platform of schema PageRequestSchema in request body

• [Added] property type of schema PageRequestSchema in request body

• [Added] property description of schema PageRequestSchema in request body

• [Added] property visibility of schema PageRequestSchema in request body

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in request body

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages/ To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages

getPages

• What's New

• [Added] properties items[].content[].type, items[].content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties items[].page_meta[].key in response with status code 200

• [Added] property items[]._schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property items[].seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property items[].__v of schema PageSchema in response with status code 200

• [Added] property items[].sanitized_content of schema PageSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] property items[].seo.breadcrumb of schema SEO in response with status code 200

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

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Path From /service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages/ To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/pages

updatePage

• What's New

• [Added] properties content[].type, content[].value in request body

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in request body

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in request body

• [Added] properties page_meta[].key in request body

• [Added] property _schedule.published of schema ScheduleSchema in request body

• [Added] property seo.breadcrumbs of schema SEO in request body

• [Added] property __v of schema PageSchema in request body

• [Added] property sanitized_content of schema PageSchema in request body

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _custom_json of schema PageSchema in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in request body

• [Breaking] [Deleted] property visibility of schema PageSchema in request body

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getPageBySlug

• What's New

• [Added] properties content[].type, content[].value in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.created_on of schema DateMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property date_meta.modified_on of schema DateMeta in response with status code 200

• [Added] properties page_meta[].key in response with status code 200

• [Added] property _schedule.published of schema ScheduleSchema in response with status code 200

• [Added] property seo.breadcrumbs of schema SEO in response with status code 200

• [Added] property __v of schema PageSchema in response with status code 200

• [Added] property sanitized_content of schema PageSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _custom_json of schema PageSchema in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema SEO in response with status code 200

• [Breaking] [Deleted] property visibility of schema PageSchema in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getCustomFieldTypes

• What's New

• [Added] property metafield_types of schema MetafieldTypesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _id of schema CustomObjectByIdSchema in response with status code 200

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

• [Breaking] [Deleted] property display_name of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property definition of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property references of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property fields of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

getResources

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getCustomFieldDefinitions

• What's New

• [Added] property items[].slug of schema FieldDefinitionSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

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

• [Breaking] [Deleted] property items[].validations[].value of schema FieldValidations in response with status code 200

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

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

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

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

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/metafields/definitions To /service/platform/content/v2.0/company/{company_id}/customfields/definition

createCustomFieldDefinition

• What's New

• [Added] property slug of schema CustomFieldDefinitionRequestSchema in request body

• [Added] property creator of schema CustomFieldDefinitionRequestSchema in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property validations[].value of schema FieldValidations in request body

• [Deleted] Value format from integer from property company_id of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/metafields/definitions To /service/platform/content/v2.0/company/{company_id}/customfields/resource/{resource}/definition

getCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method getCustomFieldDefinition

updateCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method updateCustomFieldDefinition

deleteCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method deleteCustomFieldDefinition

getCustomFields

• What's Deprecated

• [Breaking] [Deleted] method getCustomFields

getCustomFieldsByResourceId

• What's Deprecated

• [Breaking] [Deleted] method getCustomFieldsByResourceId

createCustomFieldByResourceId

• What's Deprecated

• [Breaking] [Deleted] method createCustomFieldByResourceId

createCustomObjectDefinition

• What's New

• [Breaking] [Added] Possible values boolean_type,date,datetime,dropdown,duration,file,float_type,html,integer,json,metaobject,product,string_single_line,string_multi_line,url to property field_definitions[].type of schema CustomObjectCustomFieldDefinitions in request body

• [Added] property field_definitions[]._id of schema CustomObjectCustomFieldDefinitions in request body

• [Breaking] [Added] field_definitions[].type made required in request body

• [Added] property slug of schema CustomObjectDefinitionRequestSchema in request body

• [Added] property field_definitions[].application_id of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Added] property field_definitions[].updated_by of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Added] property id of schema CustomObjectDefinitionSlugSchema in response with status code 200

• [Added] property slug of schema CustomObjectDefinitionSlugSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property field_definitions[].id of schema CustomObjectCustomFieldDefinitions in request body

• [Breaking] [Deleted] property field_definitions[].validations[].value of schema FieldValidations in request body

• [Breaking] [Deleted] property _id of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property creator of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property created_by of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property updated_by of schema CustomObjectDefinitionSchema in response with status code 200

• [Deleted] Type from object from property field_definitions[].validations[] of schema FieldValidations in response with status code 200

• [Breaking] [Deleted] properties field_definitions[].validations[].name, field_definitions[].validations[].type, field_definitions[].validations[].value in response with status code 200

• [Breaking] [Deleted] property field_definitions[].metaobject_definition_id of schema CustomObjectCustomFieldDefinitionResSchema in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/metaobjects/definitions To /service/platform/content/v2.0/company/{company_id}/customobjects/definition

getCustomObjectDefinitions

• What's New

• [Added] property items[].slug of schema CustomObjectEntry in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/metaobjects/definitions To /service/platform/content/v2.0/company/{company_id}/customobjects/definition

getCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method getCustomObjectDefinition

updateCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method updateCustomObjectDefinition

deleteCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method deleteCustomObjectDefinition

getCustomObjects

• What's Deprecated

• [Breaking] [Deleted] method getCustomObjects

createCustomObject

• What's Deprecated

• [Breaking] [Deleted] method createCustomObject

getCustomObject

• What's Deprecated

• [Breaking] [Deleted] method getCustomObject

deleteCustomObject

• What's Deprecated

• [Breaking] [Deleted] method deleteCustomObject

updateCustomObject

• What's Deprecated

• [Breaking] [Deleted] method updateCustomObject

getJobs

• What's New

• [Breaking] [Added] Possible values download,upload to property items[].action_type of schema JobSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema JobSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema JobSchema in response with status code 200

• [Added] property items[].application_id of schema JobSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

importCustomObjectEntries

• What's Deprecated

• [Breaking] [Deleted] method importCustomObjectEntries

exportCustomObjectEntries

• What's Deprecated

• [Breaking] [Deleted] method exportCustomObjectEntries

sampleCustomObjectBulkEntry

• What's Deprecated

• [Breaking] [Deleted] method sampleCustomObjectBulkEntry

getAppCustomFieldTypes

• What's New

• [Added] property metafield_types of schema MetafieldTypesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property _id of schema CustomObjectByIdSchema in response with status code 200

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

• [Breaking] [Deleted] property display_name of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property definition of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property references of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property fields of schema CustomObjectByIdSchema in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

getAppResources

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

getAppCustomFieldDefinitions

• What's New

• [Added] property items[].slug of schema FieldDefinitionSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

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

• [Breaking] [Deleted] property items[].validations[].value of schema FieldValidations in response with status code 200

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

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

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

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

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/definitions To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/definition

createAppCustomFieldDefinition

• What's New

• [Added] property slug of schema CustomFieldDefinitionRequestSchema in request body

• [Added] property creator of schema CustomFieldDefinitionRequestSchema in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property validations[].value of schema FieldValidations in request body

• [Deleted] Value format from integer from property company_id of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/metafields/definitions To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/customfields/resource/{resource}/definition

getAppCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomFieldDefinition

updateAppCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method updateAppCustomFieldDefinition

deleteAppCustomFieldDefinition

• What's Deprecated

• [Breaking] [Deleted] method deleteAppCustomFieldDefinition

getAppCustomFields

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomFields

getAppCustomFieldsByResourceId

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomFieldsByResourceId

createAppCustomFieldByResourceId

• What's Deprecated

• [Breaking] [Deleted] method createAppCustomFieldByResourceId

createAppCustomObjectDefinition

• What's New

• [Breaking] [Added] Possible values boolean_type,date,datetime,dropdown,duration,file,float_type,html,integer,json,metaobject,product,string_single_line,string_multi_line,url to property field_definitions[].type of schema CustomObjectCustomFieldDefinitions in request body

• [Added] property field_definitions[]._id of schema CustomObjectCustomFieldDefinitions in request body

• [Breaking] [Added] field_definitions[].type made required in request body

• [Added] property slug of schema CustomObjectDefinitionRequestSchema in request body

• [Added] property field_definitions[].application_id of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Added] property field_definitions[].updated_by of schema CustomFieldDefinitionDetailResSchema in response with status code 200

• [Added] property id of schema CustomObjectDefinitionSlugSchema in response with status code 200

• [Added] property slug of schema CustomObjectDefinitionSlugSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property field_definitions[].id of schema CustomObjectCustomFieldDefinitions in request body

• [Breaking] [Deleted] property field_definitions[].validations[].value of schema FieldValidations in request body

• [Breaking] [Deleted] property _id of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property creator of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property created_by of schema CustomObjectDefinitionSchema in response with status code 200

• [Breaking] [Deleted] property updated_by of schema CustomObjectDefinitionSchema in response with status code 200

• [Deleted] Type from object from property field_definitions[].validations[] of schema FieldValidations in response with status code 200

• [Breaking] [Deleted] properties field_definitions[].validations[].name, field_definitions[].validations[].type, field_definitions[].validations[].value in response with status code 200

• [Breaking] [Deleted] property field_definitions[].metaobject_definition_id of schema CustomObjectCustomFieldDefinitionResSchema in response with status code 200

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/definitions To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/customobjects/definition

getAppCustomObjectDefinitions

• What's New

• [Added] property items[].slug of schema CustomObjectEntry in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/content/v1.0/company/{company_id}/application/{application_id}/metaobjects/definitions To /service/platform/content/v2.0/company/{company_id}/application/{application_id}/customobjects/definition

getAppCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomObjectDefinition

updateAppCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method updateAppCustomObjectDefinition

deleteAppCustomObjectDefinition

• What's Deprecated

• [Breaking] [Deleted] method deleteAppCustomObjectDefinition

getAppCustomObjects

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomObjects

createAppCustomObject

• What's Deprecated

• [Breaking] [Deleted] method createAppCustomObject

getAppCustomObject

• What's Deprecated

• [Breaking] [Deleted] method getAppCustomObject

deleteAppCustomObject

• What's Deprecated

• [Breaking] [Deleted] method deleteAppCustomObject

updateAppCustomObject

• What's Deprecated

• [Breaking] [Deleted] method updateAppCustomObject

getAppJobs

• What's New

• [Breaking] [Added] Possible values download,upload to property items[].action_type of schema JobSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema JobSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema JobSchema in response with status code 200

• [Added] property items[].application_id of schema JobSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] property info of schema ContentAPIError in response with status code 400

• [Breaking] [Deleted] Response with status 500

importAppCustomObjectEntries

• What's Deprecated

• [Breaking] [Deleted] method importAppCustomObjectEntries

exportAppCustomObjectEntries

• What's Deprecated

• [Breaking] [Deleted] method exportAppCustomObjectEntries

sampleAppCustomObjectBulkEntry

• What's Deprecated

• [Breaking] [Deleted] method sampleAppCustomObjectBulkEntry

getComponentById

• What's New

• [Added] method getComponentById

getDataLoaderApiSpecs

• What's New

• [Added] method getDataLoaderApiSpecs

getDefaultSitemapConfig

• What's New

• [Added] method getDefaultSitemapConfig

updateDefaultSitemapConfig

• What's New

• [Added] method updateDefaultSitemapConfig

getSitemaps

• What's New

• [Added] method getSitemaps

createSitemap

• What's New

• [Added] method createSitemap

getSitemap

• What's New

• [Added] method getSitemap

updateSitemap

• What's New

• [Added] method updateSitemap

deleteSitemap

• What's New

• [Added] method deleteSitemap

createInjectableTag

• What's New

• [Added] method createInjectableTag

deleteAllInjectableTags

• What's New

• [Added] method deleteAllInjectableTags

getCustomFieldDefinitionByResource

• What's New

• [Added] method getCustomFieldDefinitionByResource

getCustomFieldDefinitionBySlug

• What's New

• [Added] method getCustomFieldDefinitionBySlug

updateCustomFieldDefinitionBySlug

• What's New

• [Added] method updateCustomFieldDefinitionBySlug

deleteCustomFieldDefinitionBySlug

• What's New

• [Added] method deleteCustomFieldDefinitionBySlug

getCustomFieldsByResourceSlug

• What's New

• [Added] method getCustomFieldsByResourceSlug

updateCustomFieldByResourceSlug

• What's New

• [Added] method updateCustomFieldByResourceSlug

getCustomObjectDefinitionBySlug

• What's New

• [Added] method getCustomObjectDefinitionBySlug

updateCustomObjectDefinitionBySlug

• What's New

• [Added] method updateCustomObjectDefinitionBySlug

deleteCustomObjectDefinitionBySlug

• What's New

• [Added] method deleteCustomObjectDefinitionBySlug

getCustomObjectsBySlug

• What's New

• [Added] method getCustomObjectsBySlug

createCustomObjectBySlug

• What's New

• [Added] method createCustomObjectBySlug

getCustomObjectBySlug

• What's New

• [Added] method getCustomObjectBySlug

deleteCustomObjectBySlug

• What's New

• [Added] method deleteCustomObjectBySlug

updateCustomObjectBySlug

• What's New

• [Added] method updateCustomObjectBySlug

importCustomObjectEntriesBySlug

• What's New

• [Added] method importCustomObjectEntriesBySlug

exportCustomObjectEntriesBySlug

• What's New

• [Added] method exportCustomObjectEntriesBySlug

sampleCustomObjectBulkEntryBySlug

• What's New

• [Added] method sampleCustomObjectBulkEntryBySlug

getAppCustomFieldDefinitionByResource

• What's New

• [Added] method getAppCustomFieldDefinitionByResource

getAppCustomFieldDefinitionBySlug

• What's New

• [Added] method getAppCustomFieldDefinitionBySlug

updateAppCustomFieldDefinitionBySlug

• What's New

• [Added] method updateAppCustomFieldDefinitionBySlug

deleteAppCustomFieldDefinitionBySlug

• What's New

• [Added] method deleteAppCustomFieldDefinitionBySlug

getAppCustomFieldsByResourceSlug

• What's New

• [Added] method getAppCustomFieldsByResourceSlug

updateAppCustomFieldByResourceSlug

• What's New

• [Added] method updateAppCustomFieldByResourceSlug

getAppCustomObjectDefinitionBySlug

• What's New

• [Added] method getAppCustomObjectDefinitionBySlug

updateAppCustomObjectDefinitionBySlug

• What's New

• [Added] method updateAppCustomObjectDefinitionBySlug

deleteAppCustomObjectDefinitionBySlug

• What's New

• [Added] method deleteAppCustomObjectDefinitionBySlug

getAppCustomObjectsBySlug

• What's New

• [Added] method getAppCustomObjectsBySlug

createAppCustomObjectBySlug

• What's New

• [Added] method createAppCustomObjectBySlug

getAppCustomObjectBySlug

• What's New

• [Added] method getAppCustomObjectBySlug

deleteAppCustomObjectBySlug

• What's New

• [Added] method deleteAppCustomObjectBySlug

updateAppCustomObjectBySlug

• What's New

• [Added] method updateAppCustomObjectBySlug

importAppCustomObjectEntriesBySlug

• What's New

• [Added] method importAppCustomObjectEntriesBySlug

exportAppCustomObjectEntriesBySlug

• What's New

• [Added] method exportAppCustomObjectEntriesBySlug

sampleAppCustomObjectBulkEntryBySlug

• What's New

• [Added] method sampleAppCustomObjectBulkEntryBySlug

Discount

Discount

getDiscounts

• What's Deprecated

• [Breaking] [Deleted] method getDiscounts

createDiscount

• What's Deprecated

• [Breaking] [Deleted] method createDiscount

getDiscount

• What's Deprecated

• [Breaking] [Deleted] method getDiscount

updateDiscount

• What's Deprecated

• [Breaking] [Deleted] method updateDiscount

upsertDiscountItems

• What's Deprecated

• [Breaking] [Deleted] method upsertDiscountItems

validateDiscountFile

• What's Deprecated

• [Breaking] [Deleted] method validateDiscountFile

downloadDiscountFile

• What's Deprecated

• [Breaking] [Deleted] method downloadDiscountFile

getValidationJob

• What's Deprecated

• [Breaking] [Deleted] method getValidationJob

cancelValidationJob

• What's Deprecated

• [Breaking] [Deleted] method cancelValidationJob

getDownloadJob

• What's Deprecated

• [Breaking] [Deleted] method getDownloadJob

cancelDownloadJob

• What's Deprecated

• [Breaking] [Deleted] method cancelDownloadJob

createDiscountV2

• What's New

• [Added] method createDiscountV2

getDiscountsV2

• What's New

• [Added] method getDiscountsV2

getDiscountV2

• What's New

• [Added] method getDiscountV2

updateDiscountV2

• What's New

• [Added] method updateDiscountV2

bulkUpdateDiscountJobsV2

• What's New

• [Added] method bulkUpdateDiscountJobsV2

uploadDiscountFileV2

• What's New

• [Added] method uploadDiscountFileV2

getDiscountFileJobV2

• What's New

• [Added] method getDiscountFileJobV2

cancelDiscountFileJobV2

• What's New

• [Added] method cancelDiscountFileJobV2

getDiscountFileJobsV2

• What's New

• [Added] method getDiscountFileJobsV2

downloadDiscountSampleFileV2

• What's New

• [Added] method downloadDiscountSampleFileV2

FileStorage

FileStorage

startUpload

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] cdn made optional in response with status code 200

• [Changed] Path From /service/platform/assets/v1.0/company/{company_id}/namespaces/{namespace}/upload/start To /service/platform/assets/v2.0/company/{company_id}/namespaces/{namespace}/upload/start

completeUpload

• What's New

• [Breaking] [Added] Value format date-time to property created_on of schema FileUploadComplete in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_on of schema FileUploadComplete in response with status code 200

• [Added] property created_by.user_id of schema CreatedBy in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in request body

• What's Changed

• [Breaking] [Changed] cdn made optional in request body

• [Changed] Path From /service/platform/assets/v1.0/company/{company_id}/namespaces/{namespace}/upload/complete To /service/platform/assets/v2.0/company/{company_id}/namespaces/{namespace}/upload/complete

appStartUpload

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] cdn made optional in response with status code 200

• [Changed] Path From /service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start To /service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start

appCompleteUpload

• What's New

• [Breaking] [Added] Value format date-time to property created_on of schema FileUploadComplete in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_on of schema FileUploadComplete in response with status code 200

• [Added] property created_by.user_id of schema CreatedBy in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in request body

• What's Changed

• [Breaking] [Changed] cdn made optional in request body

• [Changed] Path From /service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete To /service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete

getSignUrls

• What's New

• [Added] Security in Request

copyFiles

• What's New

• [Added] Security in Request

appCopyFiles

• What's New

• [Added] Security in Request

browse

• What's New

• [Added] property items[].created_by.user_id of schema in response with status code 200

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

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

• [Added] Security in Request

• What's Deprecated

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

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

appbrowse

• What's New

• [Added] property items[].created_by.user_id of schema in response with status code 200

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

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

• [Added] Security in Request

• What's Deprecated

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

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

browsefiles

• What's New

• [Added] property items[].created_by.user_id of schema in response with status code 200

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

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

• [Added] Security in Request

• What's Deprecated

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

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

getPdfTypes

• What's New

• [Added] data[].store_os made required in response with status code 200

• [Added] property data[].store_os of schema InvoiceTypesData in response with status code 200

• [Added] Security in Request

getDefaultPdfData

• What's New

• [Breaking] [Added] Value format date-time to property data[].payload.current_date of schema PdfPayloadDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property data[].payload.invoice_detail.invoice_date of schema InvoiceDetail in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property data[].payload.shipment_meta of schema DummyTemplateDataPayload in response with status code 200

• [Breaking] [Deleted] property data[].payload.order_meta of schema DummyTemplateDataPayload in response with status code 200

updateHtmlTemplate

• What's New

• [Added] property country_code of schema PdfConfig in request body

• [Added] property default_template of schema PdfConfig in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

Lead

Lead

getPlatformTickets

• What's New

• [Added] property items[].created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property items[].category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property items[].category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] Possible values partner_panel to property items[].source of schema TicketSourceEnum in response with status code 200

• [Added] property items[].video_room_id of schema Ticket in response with status code 200

• [Added] property items[].subscribers of schema Ticket in response with status code 200

• [Added] property items[].additional_info of schema Ticket in response with status code 200

• [Added] property items[].__v of schema Ticket in response with status code 200

• [Added] property items[].attachments of schema Ticket in response with status code 200

• [Breaking] [Added] Type array to property filters.categories[].sub_categories of schema TicketCategory in response with status code 200

• [Added] property filters.categories[].sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property filters.all_categories of schema Filter in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] filters.assignees made optional in response with status code 200

createTicket

• What's New

• [Added] property additional_info of schema AddTicketPayload in request body

• [Added] property subscribers of schema AddTicketPayload in request body

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] Possible values partner_panel to property source of schema TicketSourceEnum in response with status code 200

• [Added] property video_room_id of schema Ticket in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] property attachments of schema Ticket in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

Serviceability

Serviceability

getLocalities

• What's New

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

• [Added] property items[].meta of schema Localities in response with status code 200

• [Added] property items[].lat_long of schema Localities in response with status code 200

• [Added] property items[].parent_uid of schema Localities in response with status code 200

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

• [Added] property items[].localities of schema Localities in response with status code 200

• [Added] property items[].iso2 of schema Localities in response with status code 200

• [Added] property items[].iso3 of schema Localities in response with status code 200

• [Added] property items[].currency of schema Localities in response with status code 200

• [Added] property items[].phone_code of schema Localities in response with status code 200

• [Added] property items[].hierarchy of schema Localities in response with status code 200

• [Added] property items[].latitude of schema Localities in response with status code 200

• [Added] property items[].longitude of schema Localities in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property error of schema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property value of schema ErrorResponse in response with status code 400

• [Breaking] [Deleted] property type of schema ErrorResponse in response with status code 400

• What's Changed

• [Breaking] [Changed] message, type, value made optional in response with status code 400

getZones

• What's New

• [Breaking] [Deleted] query parameter application_ids (type: string), [Breaking] [Added] Required path parameter application_id (type: string)

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

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

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

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

• [Added] query parameter store_uid (type: integer)

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

• [Added] property items[].type of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].access_level of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].geo_areas of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].stores of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].is_opted of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].is_public_opted of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].product of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].application_id of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].created_by of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].created_on of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].modified_by of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].modified_on of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].stage of schema ListViewItemsV2 in response with status code 200

• [Added] property items[].summary of schema ListViewItemsV2 in response with status code 200

• [Added] items[].slug made required in response with status code 200

• [Added] items[].zone_id made required in response with status code 200

• [Added] items[].modified_by made required in response with status code 200

• [Added] items[].modified_on made required in response with status code 200

• [Added] items[].created_by made required in response with status code 200

• [Added] items[].created_on made required in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

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

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

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

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Changed] Path From /service/platform/logistics/v2.0/company/{company_id}/zones To /service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones

createZone

• What's New

• [Added] property product.values of schema ZoneProduct in request body

• [Added] property type of schema CreateZoneV2Data in request body

• [Added] property access_level of schema CreateZoneV2Data in request body

• [Added] property application_id of schema CreateZoneV2Data in request body

• [Added] property geo_areas of schema CreateZoneV2Data in request body

• [Added] property stores of schema CreateZoneV2Data in request body

• [Breaking] [Added] Required path parameter application_id (type: string)

• [Added] property name of schema ZoneResponseV2 in response with status code 200

• [Added] property slug of schema ZoneResponseV2 in response with status code 200

• [Added] property company_id of schema ZoneResponseV2 in response with status code 200

• [Added] property type of schema ZoneResponseV2 in response with status code 200

• [Added] property access_level of schema ZoneResponseV2 in response with status code 200

• [Added] property application_id of schema ZoneResponseV2 in response with status code 200

• [Added] property is_active of schema ZoneResponseV2 in response with status code 200

• [Added] property is_public_opted of schema ZoneResponseV2 in response with status code 200

• [Added] property is_opted of schema ZoneResponseV2 in response with status code 200

• [Added] property geo_areas of schema ZoneResponseV2 in response with status code 200

• [Added] property stores of schema ZoneResponseV2 in response with status code 200

• [Added] property product of schema ZoneResponseV2 in response with status code 200

• [Added] property created_by of schema ZoneResponseV2 in response with status code 200

• [Added] property created_on of schema ZoneResponseV2 in response with status code 200

• [Added] property modified_by of schema ZoneResponseV2 in response with status code 200

• [Added] property modified_on of schema ZoneResponseV2 in response with status code 200

• [Added] property stage of schema ZoneResponseV2 in response with status code 200

• [Added] property summary of schema ZoneResponseV2 in response with status code 200

• [Added] type made required in response with status code 200

• [Added] access_level made required in response with status code 200

• [Added] application_id made required in response with status code 200

• [Added] is_active made required in response with status code 200

• [Added] geo_areas made required in response with status code 200

• [Added] created_by made required in response with status code 200

• [Added] created_on made required in response with status code 200

• [Added] modified_by made required in response with status code 200

• [Added] modified_on made required in response with status code 200

• [Added] zone_id made required in response with status code 200

• [Added] property error of schema ServiceabilityZoneErrorResult in response with status code 400

• [Added] Response with status 403

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property channels of schema CreateZoneData in request body

• [Breaking] [Deleted] property store_ids of schema CreateZoneData in request body

• [Deleted] Possible values from all,explicit from property product.type of schema ZoneProductTypes in request body

• [Breaking] [Deleted] property product.tags of schema ZoneProductTypes in request body

• [Breaking] [Deleted] property region_type of schema CreateZoneData in request body

• [Breaking] [Deleted] property mapping of schema CreateZoneData in request body

• [Breaking] [Deleted] property status_code of schema ZoneResponse in response with status code 200

• [Breaking] [Deleted] property success of schema ZoneResponse in response with status code 200

• [Breaking] [Deleted] property message of schema ServiceabilityErrorResponse in response with status code 400

• [Breaking] [Deleted] property value of schema ServiceabilityErrorResponse in response with status code 400

• [Breaking] [Deleted] property type of schema ServiceabilityErrorResponse in response with status code 400

• What's Changed

• [Changed] store_ids made optional in request body

• [Breaking] [Changed] type made optional in response with status code 400

• [Breaking] [Changed] value made optional in response with status code 400

• [Changed] Path From /service/platform/logistics/v2.0/company/{company_id}/zones To /service/platform/logistics/v2.0/company/{company_id}/application/{application_id}/zones

updateZoneById

• What's Deprecated

• [Breaking] [Deleted] method updateZoneById

getZoneById

• What's Deprecated

• [Breaking] [Deleted] method getZoneById

getAllStores

• What's Deprecated

• [Breaking] [Deleted] method getAllStores

updatePincodeMopView

• What's New

• [Breaking] [Added] Possible values activate,deactivate to property action of schema PincodeMopData in request body

• [Breaking] [Added] Type array to property error of schema MoPCommonError in response with status code 400

• [Added] property error[] of schema MoPCommonError in response with status code 400

• [Added] property batch_id of schema MoPCommonError in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to integer of property status_code of schema CommonError in response with status code 400

• [Breaking] [Changed] Type from string to boolean of property success of schema CommonError in response with status code 400

updatePincodeBulkView

• What's New

• [Breaking] [Added] Type array to property error of schema CommonError in response with status code 400

• [Added] property error[] of schema CommonError in response with status code 400

• [Added] Security in Request

• What's Changed

• [Changed] batch_id made optional in request body

• [Breaking] [Changed] Type from string to integer of property status_code of schema CommonError in response with status code 400

• [Breaking] [Changed] Type from string to boolean of property success of schema CommonError in response with status code 400

updatePincodeCoDListing

• What's New

• [Breaking] [Added] Type object to property data[] of schema PincodeCodDataSchema in response with status code 200

• [Added] properties data[].pincode, data[].active in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

updatePincodeAuditHistory

• What's New

• [Breaking] [Added] Value format date-time to property data[].updated_at of schema PincodeMopUpdateAuditHistoryResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

createCourierPartnerAccount

• What's New

• [Added] property company_id of schema CourierAccount in request body

• [Added] property scheme_rules of schema CourierAccount in request body

• [Added] property company_id of schema CourierAccount in response with status code 200

• [Added] property scheme_rules of schema CourierAccount in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] company_id made optional in response with status code 200

getCourierPartnerAccounts

• What's New

• [Added] query parameter account_ids (type: array)

• [Added] query parameter self_ship (type: boolean)

• [Added] query parameter own_account (type: boolean)

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

• [Added] Possible nullable value true to property items[].scheme_rules.weight of schema ArithmeticOperations in response with status code 200

• [Added] property items[].scheme_rules.name of schema CourierAccountSchemeResponseSchema in response with status code 200

• [Added] property items[].company_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property items[].extension_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Breaking] [Changed] items[].scheme_rules.extension_id, items[].scheme_rules.scheme_id, items[].scheme_rules.weight, items[].scheme_rules.transport_type, items[].scheme_rules.region, items[].scheme_rules.delivery_type, items[].scheme_rules.payment_mode, items[].scheme_rules.stage, items[].scheme_rules.feature made optional in response with status code 200

updateCourierPartnerAccount

• What's New

• [Added] property company_id of schema CourierAccount in request body

• [Added] property scheme_rules of schema CourierAccount in request body

• [Added] property extension_id of schema CourierAccount in response with status code 200

• [Added] property company_id of schema CourierAccount in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties scheme_rules.extension_id, scheme_rules.scheme_id, scheme_rules.weight, scheme_rules.transport_type, scheme_rules.region, scheme_rules.delivery_type, scheme_rules.payment_mode, scheme_rules.stage, scheme_rules.feature in response with status code 200

• What's Changed

• [Breaking] [Changed] company_id made optional in request body

• [Breaking] [Changed] scheme_rules.extension_id, scheme_rules.scheme_id, scheme_rules.weight, scheme_rules.transport_type, scheme_rules.region, scheme_rules.delivery_type, scheme_rules.payment_mode, scheme_rules.stage, scheme_rules.feature made optional in response with status code 200

getCourierPartnerAccount

• What's New

• [Added] Possible nullable value true to property scheme_rules.weight of schema ArithmeticOperations in response with status code 200

• [Added] property scheme_rules.name of schema CourierAccountSchemeResponseSchema in response with status code 200

• [Added] property company_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property extension_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] scheme_rules.extension_id, scheme_rules.scheme_id, scheme_rules.weight, scheme_rules.transport_type, scheme_rules.region, scheme_rules.delivery_type, scheme_rules.payment_mode, scheme_rules.stage, scheme_rules.feature made optional in response with status code 200

updateCourierRule

• What's New

• [Added] property cp_list[].name of schema CourierPartnerList in request body

• [Added] property cp_list[].is_self_ship of schema CourierPartnerList in request body

• [Added] property cp_list[].scheme_rules of schema CourierPartnerList in request body

• [Added] property cp_list[].stage of schema CourierPartnerList in request body

• [Added] property conditions.forward.includes[].parent_id[] of schema LocationRuleValues in request body

• [Added] property conditions.forward.includes[].uid of schema LocationRuleValues in request body

• [Added] property conditions.forward.includes[].parent_uid of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].uid of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].parent_uid of schema LocationRuleValues in request body

• [Added] Possible nullable value true to property conditions.shipment_weight of schema ArithmeticOperations in request body

• [Added] Possible nullable value true to property conditions.shipment_cost of schema ArithmeticOperations in request body

• [Added] Possible nullable value true to property conditions.shipment_volumetric_weight of schema ArithmeticOperations in request body

• [Added] property conditions.company_ids of schema CourierPartnerRuleConditions in request body

• [Added] property conditions.promise_types of schema CourierPartnerRuleConditions in request body

• [Added] property id of schema CourierPartnerRule in request body

• [Added] property application_id of schema CourierPartnerRule in request body

• [Added] property company_id of schema CourierPartnerRule in request body

• [Added] property manual_priority of schema CourierPartnerRule in request body

• [Added] property shipment_adjustment_type of schema CourierPartnerRule in request body

• [Added] property type of schema CourierPartnerRule in request body

• [Added] property conditions.forward.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_weight of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_cost of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_volumetric_weight of schema ArithmeticOperations in response with status code 200

• [Added] property conditions.company_ids of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property conditions.promise_types of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property cp_list[].name of schema CourierPartnerList in response with status code 200

• [Added] property cp_list[].stage of schema CourierPartnerList in response with status code 200

• [Added] property manual_priority of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] property shipment_adjustment_type of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] conditions, is_active, name, sort, type made required in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.forward.includes[].id of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.forward.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.forward.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].id of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] property conditions.forward.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] property created_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_on of schema CourierPartnerRuleResponse in response with status code 200

• What's Changed

• [Changed] cp_list[].account_id, cp_list[].extension_id made optional in request body

• [Breaking] [Changed] Type from string to array of property conditions.forward.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from string to array of property conditions.reverse.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from string to array of property conditions.forward.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.reverse.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

getCourierPartnerRule

• What's New

• [Added] property conditions.forward.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_weight of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_cost of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_volumetric_weight of schema ArithmeticOperations in response with status code 200

• [Added] property conditions.company_ids of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property conditions.promise_types of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property cp_list[].name of schema CourierPartnerList in response with status code 200

• [Added] property cp_list[].stage of schema CourierPartnerList in response with status code 200

• [Added] property manual_priority of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] property shipment_adjustment_type of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] conditions, is_active, name, sort, type made required in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.forward.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] property created_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_on of schema CourierPartnerRuleResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from string to array of property conditions.forward.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.reverse.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

createCourierPartnerRule

• What's New

• [Added] property cp_list[].name of schema CourierPartnerList in request body

• [Added] property cp_list[].is_self_ship of schema CourierPartnerList in request body

• [Added] property cp_list[].scheme_rules of schema CourierPartnerList in request body

• [Added] property cp_list[].stage of schema CourierPartnerList in request body

• [Added] property conditions.forward.includes[].parent_id[] of schema LocationRuleValues in request body

• [Added] property conditions.forward.includes[].uid of schema LocationRuleValues in request body

• [Added] property conditions.forward.includes[].parent_uid of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].uid of schema LocationRuleValues in request body

• [Added] property conditions.reverse.includes[].parent_uid of schema LocationRuleValues in request body

• [Added] Possible nullable value true to property conditions.shipment_weight of schema ArithmeticOperations in request body

• [Added] Possible nullable value true to property conditions.shipment_cost of schema ArithmeticOperations in request body

• [Added] Possible nullable value true to property conditions.shipment_volumetric_weight of schema ArithmeticOperations in request body

• [Added] property conditions.company_ids of schema CourierPartnerRuleConditions in request body

• [Added] property conditions.promise_types of schema CourierPartnerRuleConditions in request body

• [Added] property id of schema CourierPartnerRule in request body

• [Added] property application_id of schema CourierPartnerRule in request body

• [Added] property company_id of schema CourierPartnerRule in request body

• [Added] property manual_priority of schema CourierPartnerRule in request body

• [Added] property shipment_adjustment_type of schema CourierPartnerRule in request body

• [Added] property type of schema CourierPartnerRule in request body

• [Added] property conditions.forward.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.forward.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property conditions.reverse.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_weight of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_cost of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property conditions.shipment_volumetric_weight of schema ArithmeticOperations in response with status code 200

• [Added] property conditions.company_ids of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property conditions.promise_types of schema CourierPartnerRuleResponseConditions in response with status code 200

• [Added] property cp_list[].name of schema CourierPartnerList in response with status code 200

• [Added] property cp_list[].stage of schema CourierPartnerList in response with status code 200

• [Added] property manual_priority of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] property shipment_adjustment_type of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] conditions, is_active, name, sort, type made required in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.forward.includes[].id of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.forward.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.forward.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].id of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.reverse.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] property conditions.forward.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.forward.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.reverse.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] property created_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_by of schema CourierPartnerRuleResponse in response with status code 200

• [Breaking] [Deleted] property modified_on of schema CourierPartnerRuleResponse in response with status code 200

• What's Changed

• [Changed] cp_list[].account_id, cp_list[].extension_id made optional in request body

• [Breaking] [Changed] Type from string to array of property conditions.forward.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from string to array of property conditions.reverse.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from string to array of property conditions.forward.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.reverse.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

getCourierPartnerRules

• What's New

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

• [Added] property items[].conditions.forward.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property items[].conditions.forward.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property items[].conditions.forward.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] property items[].conditions.reverse.includes[].parent_id[] of schema LocationRuleValues in response with status code 200

• [Added] property items[].conditions.reverse.includes[].uid of schema LocationRuleValues in response with status code 200

• [Added] property items[].conditions.reverse.includes[].parent_uid of schema LocationRuleValues in response with status code 200

• [Added] Possible nullable value true to property items[].conditions.shipment_weight of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property items[].conditions.shipment_cost of schema ArithmeticOperations in response with status code 200

• [Added] Possible nullable value true to property items[].conditions.shipment_volumetric_weight of schema ArithmeticOperations in response with status code 200

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

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

• [Added] property items[].cp_list[].name of schema CourierPartnerList in response with status code 200

• [Added] property items[].cp_list[].stage of schema CourierPartnerList in response with status code 200

• [Added] property items[].manual_priority of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] property items[].shipment_adjustment_type of schema CourierPartnerRuleResponseSchema in response with status code 200

• [Added] items[].conditions, items[].is_active, items[].name, items[].sort, items[].type made required in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].conditions.forward.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.forward.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.forward.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.reverse.includes[].id of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.reverse.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.reverse.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

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

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

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

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Breaking] [Changed] Type from string to array of property items[].conditions.forward.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from string to array of property items[].conditions.reverse.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

updateCompanyConfiguration

• What's New

• [Breaking] [Added] Possible values fastest to property sort of schema CompanyConfigurationShema in request body

• [Breaking] [Added] Possible values seller-controlled,admin-controlled,self-ship to property logistics_as_actual of schema CompanyConfig in response with status code 200

• [Added] property company_id of schema CompanyConfig in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property rule_ids of schema CompanyConfig in request body

• [Deleted] Possible values from fastest from property sort[] of schema CompanyConfig in request body

• [Breaking] [Deleted] property logistics_as_actual of schema CompanyConfig in request body

• [Breaking] [Deleted] property rule_ids of schema CompanyConfig in response with status code 200

• What's Changed

• [Changed] rule_ids, sort made optional in request body

• [Breaking] [Changed] Type from boolean to string of property logistics_as_actual of schema CompanyConfig in response with status code 200

• [Breaking] [Changed] rule_ids, sort made optional in response with status code 200

getCompanyConfiguration

• What's New

• [Breaking] [Added] Possible values seller-controlled,admin-controlled,self-ship to property logistics_as_actual of schema CompanyConfig in response with status code 200

• [Added] property company_id of schema CompanyConfig in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property rule_ids of schema CompanyConfig in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from boolean to string of property logistics_as_actual of schema CompanyConfig in response with status code 200

• [Breaking] [Changed] rule_ids, sort made optional in response with status code 200

updateApplicationConfiguration

• What's New

• [Added] Possible values manual_priority to property sort[] of schema ApplicationConfigPutRequestSchema in request body

• [Added] property manual_priority of schema ApplicationConfigPutRequestSchema in request body

• [Added] Possible values manual_priority to property sort[] of schema ApplicationConfigPutResponseSchema in response with status code 200

• [Added] property manual_priority of schema ApplicationConfigPutResponseSchema in response with status code 200

• [Added] property application_id of schema ApplicationConfigPutResponseSchema in response with status code 200

• [Added] property company_id of schema ApplicationConfigPutResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property zones of schema ApplicationConfig in request body

• [Breaking] [Deleted] property zones of schema ApplicationConfig in response with status code 200

getApplicationConfiguration

• What's New

• [Added] property zones.active_count of schema ZoneConfig in response with status code 200

• [Added] property zones.total_count of schema ZoneConfig in response with status code 200

• [Added] property courier_partner_config of schema ApplicationConfigGetResponseSchema in response with status code 200

• [Added] property buybox_rule_config of schema ApplicationConfigGetResponseSchema in response with status code 200

• [Added] property promise_config of schema ApplicationConfigGetResponseSchema in response with status code 200

• [Added] property promise_types of schema ApplicationConfigGetResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property rule_ids of schema ApplicationConfig in response with status code 200

• [Breaking] [Deleted] property sort of schema ApplicationConfig in response with status code 200

bulkTat

• What's Deprecated

• [Breaking] [Deleted] method bulkTat

getBulkTat

• What's Deprecated

• [Breaking] [Deleted] method getBulkTat

patchApplicationServiceabilitySelfShipment

• What's Deprecated

• [Breaking] [Deleted] method patchApplicationServiceabilitySelfShipment

getApplicationServiceabilitySelfShipment

• What's Deprecated

• [Breaking] [Deleted] method getApplicationServiceabilitySelfShipment

getApplicationConfig

• What's New

• [Added] property manual_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property meta_sort_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

insertApplicationConfig

• What's New

• [Added] property manual_priority of schema StoreRuleConfigData in request body

• [Added] property meta_sort_priority of schema StoreRuleConfigData in request body

• [Added] property manual_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property meta_sort_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

updateStoreRulesConfig

• What's New

• [Added] property manual_priority of schema StoreRuleConfigData in request body

• [Added] property meta_sort_priority of schema StoreRuleConfigData in request body

• [Added] property manual_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property meta_sort_priority of schema StoreRuleConfigData in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

getStoreRules

• What's New

• [Added] property items[].conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in response with status code 200

• [Added] property items[].conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in response with status code 200

• [Added] property items[].manual_priority of schema StoreRuleDataSchema in response with status code 200

• [Added] property items[].meta_sort_priority of schema StoreRuleDataSchema in response with status code 200

• [Added] property items[].meta_conditions of schema StoreRuleDataSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].conditions.to_location.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property items[].conditions.to_location.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items[].conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Breaking] [Changed] Type from string to integer of property items[].store_priority[].id of schema StorePrioritySchema in response with status code 200

• [Breaking] [Changed] Type from string to array of property items[].conditions.to_location.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property items[].conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

createStoreRules

• What's New

• [Added] property conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in request body

• [Added] property conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in request body

• [Added] property manual_priority of schema CreateStoreRuleRequestSchema in request body

• [Added] property conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in response with status code 200

• [Added] property conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in response with status code 200

• [Added] property manual_priority of schema StoreRuleResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.to_location.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.to_location.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] property conditions.to_location.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.to_location.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from string to array of property conditions.to_location.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.to_location.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

getStoreRule

• What's New

• [Added] property conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in response with status code 200

• [Added] property conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in response with status code 200

• [Added] property manual_priority of schema StoreRuleDataSchema in response with status code 200

• [Added] property meta_sort_priority of schema StoreRuleDataSchema in response with status code 200

• [Added] property meta_conditions of schema StoreRuleDataSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.to_location.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.to_location.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.to_location.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

updateStoreRules

• What's New

• [Added] property conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in request body

• [Added] property conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in request body

• [Added] property manual_priority of schema CreateStoreRuleRequestSchema in request body

• [Added] property conditions.to_location.includes[].parent_id[] of schema LocationRuleValuesV2 in response with status code 200

• [Added] property conditions.to_location.includes[].parent_uid of schema LocationRuleValuesV2 in response with status code 200

• [Added] property manual_priority of schema StoreRuleUpdateResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] property status_code of schema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property conditions.to_location.includes[].name of schema LocationRuleValues in request body

• [Breaking] [Deleted] property conditions.to_location.includes[].parent_ids of schema LocationRuleValues in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Deleted] property conditions.to_location.includes[].name of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] property conditions.to_location.includes[].parent_ids of schema LocationRuleValues in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from string to array of property conditions.to_location.includes[].parent_id of schema LocationRuleValues in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in request body

• [Breaking] [Changed] Type from string to integer of property store_priority[].id of schema StorePrioritySchema in response with status code 200

• [Breaking] [Changed] Type from string to array of property conditions.to_location.includes[].parent_id of schema LocationRuleValues in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gt of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.lte of schema ArithmeticOperations in response with status code 200

• [Breaking] [Changed] Type from integer to string of property conditions.order_place_date.gte of schema ArithmeticOperations in response with status code 200

bulkServiceability

• What's Deprecated

• [Breaking] [Deleted] method bulkServiceability

getBulkServiceability

• What's Deprecated

• [Breaking] [Deleted] method getBulkServiceability

getServiceability

• What's Deprecated

• [Breaking] [Deleted] method getServiceability

updateServiceability

• What's Deprecated

• [Breaking] [Deleted] method updateServiceability

createPackageMaterial

• What's New

• [Added] property rules[].company_id of schema PackageMaterialRule in request body

• [Added] property rules[].is_active of schema PackageMaterialRule in request body

• [Added] property rules[].type of schema PackageMaterialRule in request body

• [Added] property rules[].name of schema PackageMaterialRule in request body

• [Added] property rules[].id of schema PackageMaterialRule in request body

• [Added] property company_id of schema PackageMaterial in request body

• [Added] property item_id of schema PackageMaterial in request body

• [Added] property id of schema PackageMaterial in request body

• [Added] property mp_stores of schema PackageMaterial in request body

• [Added] property is_active of schema PackageMaterial in request body

• [Added] query parameter page_no (type: integer)

• [Added] property rules[].company_id of schema PackageMaterialRule in response with status code 201

• [Added] property rules[].is_active of schema PackageMaterialRule in response with status code 201

• [Added] property rules[].type of schema PackageMaterialRule in response with status code 201

• [Added] property rules[].name of schema PackageMaterialRule in response with status code 201

• [Added] property rules[].id of schema PackageMaterialRule in response with status code 201

• [Added] property company_id of schema PackageMaterialResponseSchema in response with status code 201

• [Added] property is_active of schema PackageMaterialResponseSchema in response with status code 201

• [Added] property mp_stores of schema PackageMaterialResponseSchema in response with status code 201

• [Added] property error of schema PackageMaterialsErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] minItems validator for store_ids in request body

• [Breaking] [Deleted] property item_id of schema PackageMaterialResponse in response with status code 201

• What's Changed

• [Breaking] [Changed] message, type, value made optional in response with status code 400

getPackageMaterialList

• What's New

• [Added] property items[] of schema PackageMaterialList in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property error of schema PackageMaterialsErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Type from object from property items of schema PackageMaterialResponse in response with status code 200

• [Breaking] [Deleted] properties items.name, items.id, items.item_id, items.width, items.height, items.length, items.rules, items.store_ids, items.weight, items.error_rate, items.package_type, items.size, items.media, items.channels, items.track_inventory, items.status, items.max_weight, items.package_vol_weight, items.auto_calculate in response with status code 200

• What's Changed

• [Breaking] [Changed] items.error_rate, items.height, items.length, items.name, items.weight, items.width, items.channels, items.size, items.package_type, items.store_ids, items.status made optional in response with status code 200

• [Breaking] [Changed] message, type, value made optional in response with status code 400

createPackageMaterialRule

• What's New

• [Added] property department_id of schema PackageRuleRequestSchema in request body

• [Added] property product_attributes of schema PackageRuleRequestSchema in request body

• [Added] property department_id of schema PackageRuleResult in response with status code 201

• [Added] property product_attributes of schema PackageRuleResult in response with status code 201

• [Added] Security in Request

getPackageMaterialRules

• What's Deprecated

• [Breaking] [Deleted] method getPackageMaterialRules

updatePackageMaterialRule

• What's New

• [Added] property department_id of schema PackageRuleRequestSchema in request body

• [Added] property product_attributes of schema PackageRuleRequestSchema in request body

• [Added] property department_id of schema PackageRuleResult in response with status code 200

• [Added] property product_attributes of schema PackageRuleResult in response with status code 200

• [Added] Security in Request

getPackageMaterialRule

• What's New

• [Added] property department_id of schema PackageRuleResult in response with status code 200

• [Added] property product_attributes of schema PackageRuleResult in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

updatePackageMaterials

• What's New

• [Added] property rules[].company_id of schema PackageMaterialRule in request body

• [Added] property rules[].is_active of schema PackageMaterialRule in request body

• [Added] property rules[].type of schema PackageMaterialRule in request body

• [Added] property rules[].name of schema PackageMaterialRule in request body

• [Added] property rules[].id of schema PackageMaterialRule in request body

• [Added] property company_id of schema PackageMaterial in request body

• [Added] property item_id of schema PackageMaterial in request body

• [Added] property id of schema PackageMaterial in request body

• [Added] property mp_stores of schema PackageMaterial in request body

• [Added] property is_active of schema PackageMaterial in request body

• [Added] property rules[].company_id of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].is_active of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].type of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].name of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].id of schema PackageMaterialRule in response with status code 200

• [Added] property company_id of schema PackageMaterialResponseSchema in response with status code 200

• [Added] property is_active of schema PackageMaterialResponseSchema in response with status code 200

• [Added] property mp_stores of schema PackageMaterialResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] minItems validator for store_ids in request body

• [Breaking] [Deleted] property item_id of schema PackageMaterialResponse in response with status code 200

getPackageMaterials

• What's New

• [Added] property rules[].company_id of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].is_active of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].type of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].name of schema PackageMaterialRule in response with status code 200

• [Added] property rules[].id of schema PackageMaterialRule in response with status code 200

• [Added] property company_id of schema PackageMaterialResponseSchema in response with status code 200

• [Added] property is_active of schema PackageMaterialResponseSchema in response with status code 200

• [Added] property mp_stores of schema PackageMaterialResponseSchema in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property item_id of schema PackageMaterialResponse in response with status code 200

• [Breaking] [Deleted] Response with status 400

updateCourierPartnerRulePriority

• What's New

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Breaking] [Added] Type array to property error of schema in response with status code 400

• [Added] Security in Request

getOptimalLocations

• What's New

• [Added] property articles of schema OptimlLocationsRequestSchema in request body

• [Added] property faulty_articles[].error of schema ErrorResponseSchema in response with status code 200

• [Added] property error[].error of schema ErrorResponseSchema in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property article of schema OptimlLocationsRequestSchema in request body

getZone

• What's New

• [Added] method getZone

updateZone

• What's New

• [Added] method updateZone

deleteZone

• What's New

• [Added] method deleteZone

getZoneDetails

• What's New

• [Added] method getZoneDetails

createBulkZone

• What's New

• [Added] method createBulkZone

getBulkZone

• What's New

• [Added] method getBulkZone

createBulkExport

• What's New

• [Added] method createBulkExport

getBulkExport

• What's New

• [Added] method getBulkExport

createGeoArea

• What's New

• [Added] method createGeoArea

getGeoAreas

• What's New

• [Added] method getGeoAreas

getGeoArea

• What's New

• [Added] method getGeoArea

updateGeoArea

• What's New

• [Added] method updateGeoArea

createBulkGeoArea

• What's New

• [Added] method createBulkGeoArea

getBulkGeoArea

• What's New

• [Added] method getBulkGeoArea

updateBulkGeoArea

• What's New

• [Added] method updateBulkGeoArea

createGeoAreaExportJob

• What's New

• [Added] method createGeoAreaExportJob

getGeoAreaExportJobStatus

• What's New

• [Added] method getGeoAreaExportJobStatus

createBulkGeoAreaExport

• What's New

• [Added] method createBulkGeoAreaExport

createBulkGeoAreas

• What's New

• [Added] method createBulkGeoAreas

getBulkGeoAreasHistory

• What's New

• [Added] method getBulkGeoAreasHistory

getBulkGeoAreasSample

• What's New

• [Added] method getBulkGeoAreasSample

getGeoAreasExportStatus

• What's New

• [Added] method getGeoAreasExportStatus

updateCompanySelfShip

• What's New

• [Added] method updateCompanySelfShip

getCompanySelfShip

• What's New

• [Added] method getCompanySelfShip

deleteCourierPartnerRule

• What's New

• [Added] method deleteCourierPartnerRule

patchApplicationConfiguration

• What's New

• [Added] method patchApplicationConfiguration

updateStoreRulePriority

• What's New

• [Added] method updateStoreRulePriority

deleteStoreRule

• What's New

• [Added] method deleteStoreRule

getPackageMaterialRuleDetails

• What's New

• [Added] method getPackageMaterialRuleDetails

getListPackageMaterialRuleDetails

• What's New

• [Added] method getListPackageMaterialRuleDetails

deletePackageMaterialRule

• What's New

• [Added] method deletePackageMaterialRule

deletePackageMaterials

• What's New

• [Added] method deletePackageMaterials

getInstalledCourierPartnerExtensions

• What's New

• [Added] method getInstalledCourierPartnerExtensions

getLocalitiesByPrefix

• What's New

• [Added] method getLocalitiesByPrefix

getLocality

• What's New

• [Added] method getLocality

getCountry

• What's New

• [Added] method getCountry

getCountries

• What's New

• [Added] method getCountries

validateAddress

• What's New

• [Added] method validateAddress

getCourierPartnerRuleDetails

• What's New

• [Added] method getCourierPartnerRuleDetails

getStoreRuleDetails

• What's New

• [Added] method getStoreRuleDetails

downloadGeoareaSampleFile

• What's New

• [Added] method downloadGeoareaSampleFile

downloadZoneSampleFile

• What's New

• [Added] method downloadZoneSampleFile

Order

Order

invalidateShipmentCache

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Security in Request

reassignLocation

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

updateShipmentLock

• What's New

• [Added] property user_id of schema UpdateShipmentLockPayload in request body

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

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

getAnnouncements

• What's New

• [Added] Possible nullable value true to property announcements[].company_id of schema AnnouncementResponseSchema in response with status code 200

• [Added] property message of schema AnnouncementsResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

updateAddress

• What's Deprecated

• [Breaking] [Deleted] method updateAddress

updateShipmentStatus

• What's New

• [Added] property statuses[].shipments[].data_updates.products[].filters[].quantity of schema ProductsDataUpdatesFilters in request body

• [Added] property statuses[].shipments[].data_updates.repriced_products of schema DataUpdates in request body

• [Added] property statuses[].shipments[].data_updates.order of schema DataUpdates in request body

• [Added] property statuses[].shipments[].transition_comments of schema ShipmentsRequestSchema in request body

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to number of property statuses[].shipments[].reasons.products[].filters[].quantity of schema ProductsReasonsFilters in request body

• [Breaking] [Changed] Value format from int32 to float of property statuses[].shipments[].reasons.products[].filters[].quantity of schema ProductsReasonsFilters in request body

• [Breaking] [Changed] Type from integer to number of property statuses[].shipments[].products[].quantity of schema Products in request body

• [Breaking] [Changed] Value format from int32 to float of property statuses[].shipments[].products[].quantity of schema Products in request body

• [Changed] Security in Request

getRoleBasedActions

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Security in Request

getShipmentHistory

• What's New

• [Added] Possible nullable value true to property activity_history[].ticket_url of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l3_detail of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].ticket_id of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l2_detail of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].assigned_agent of schema HistoryDict in response with status code 200

• [Breaking] [Added] Type object to property activity_history[].meta of schema HistoryMeta in response with status code 200

• [Added] properties activity_history[].meta.store_id, activity_history[].meta.status, activity_history[].meta.status1, activity_history[].meta.call_id, activity_history[].meta.starttime, activity_history[].meta.reason, activity_history[].meta.short_link, activity_history[].meta.endtime, activity_history[].meta.store_name, activity_history[].meta.caller, activity_history[].meta.store_code, activity_history[].meta.billsec, activity_history[].meta.recordpath, activity_history[].meta.status2, activity_history[].meta.callerid, activity_history[].meta.duration, activity_history[].meta.channel_type, activity_history[].meta.activity_comment, activity_history[].meta.activity_type, activity_history[].meta.receiver, activity_history[].meta.recipient, activity_history[].meta.slug, activity_history[].meta.message, activity_history[].meta.type, activity_history[].meta.prev_store_name, activity_history[].meta.prev_store_code, activity_history[].meta.prev_store_id, activity_history[].meta.refund_to, activity_history[].meta.refund_information in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l1_detail of schema HistoryDict in response with status code 200

• [Added] property activity_history[].user_details of schema HistoryDict in response with status code 200

• [Added] property activity_history[].activity_type of schema HistoryDict in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Security in Request

postShipmentHistory

• What's New

• [Added] Possible nullable value true to property activity_history[].ticket_url of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l3_detail of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].ticket_id of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l2_detail of schema HistoryDict in response with status code 200

• [Added] Possible nullable value true to property activity_history[].assigned_agent of schema HistoryDict in response with status code 200

• [Breaking] [Added] Type object to property activity_history[].meta of schema HistoryMeta in response with status code 200

• [Added] properties activity_history[].meta.store_id, activity_history[].meta.status, activity_history[].meta.status1, activity_history[].meta.call_id, activity_history[].meta.starttime, activity_history[].meta.reason, activity_history[].meta.short_link, activity_history[].meta.endtime, activity_history[].meta.store_name, activity_history[].meta.caller, activity_history[].meta.store_code, activity_history[].meta.billsec, activity_history[].meta.recordpath, activity_history[].meta.status2, activity_history[].meta.callerid, activity_history[].meta.duration, activity_history[].meta.channel_type, activity_history[].meta.activity_comment, activity_history[].meta.activity_type, activity_history[].meta.receiver, activity_history[].meta.recipient, activity_history[].meta.slug, activity_history[].meta.message, activity_history[].meta.type, activity_history[].meta.prev_store_name, activity_history[].meta.prev_store_code, activity_history[].meta.prev_store_id, activity_history[].meta.refund_to, activity_history[].meta.refund_information in response with status code 200

• [Added] Possible nullable value true to property activity_history[].l1_detail of schema HistoryDict in response with status code 200

• [Added] property activity_history[].user_details of schema HistoryDict in response with status code 200

• [Added] property activity_history[].activity_type of schema HistoryDict in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

sendSmsNinja

• What's New

• [Breaking] [Added] Type object to property data of schema SmsDataPayload in request body

• [Added] properties data.days, data.reason, data.shipment_id, data.phone_number, data.amount_paid, data.order_id, data.payment_mode, data.customer_name, data.brand_name, data.message, data.country_code in request body

• [Breaking] [Added] data.reason, data.days, data.country_code, data.brand_name, data.customer_name, data.message, data.order_id, data.phone_number, data.shipment_id made required in request body

• [Added] success, message made required in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Security in Request

updatePackagingDimensions

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

createOrder

• What's New

• [Added] properties shipments[].line_items[].charges[].tax.amount.ordering_currency, shipments[].line_items[].charges[].tax.amount.base_currency in request body

• [Added] shipments[].line_items[].charges[].tax.amount.ordering_currency, shipments[].line_items[].charges[].tax.amount.base_currency made required in request body

• [Added] shipments[].line_items[].charges made required in request body

• [Breaking] [Added] Value format date-time to property shipments[].processing_dates.pack_by_date of schema ProcessingDates in request body

• [Added] Possible values Digital to property shipments[].order_type of schema Shipment in request body

• [Breaking] [Added] Possible values home,office,other, to property shipments[].billing_address_json.address_type of schema Address in request body

• [Breaking] [Added] Possible values store,delivery,billing, to property shipments[].billing_address_json.address_category of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].billing_address_json.created_at of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].billing_address_json.updated_at of schema Address in request body

• [Added] property shipments[].billing_address_json.address of schema Address in request body

• [Added] property shipments[].billing_address_json.area_code_slug of schema Address in request body

• [Added] property shipments[].billing_address_json.country_code of schema Address in request body

• [Added] property shipments[].billing_address_json.country_iso_code of schema Address in request body

• [Added] property shipments[].billing_address_json.country_phone_code of schema Address in request body

• [Added] property shipments[].billing_address_json.delivery_address_id of schema Address in request body

• [Added] property shipments[].billing_address_json.geo_location of schema Address in request body

• [Added] property shipments[].billing_address_json.name of schema Address in request body

• [Added] property shipments[].billing_address_json.sector of schema Address in request body

• [Added] property shipments[].billing_address_json.state_code of schema Address in request body

• [Added] property shipments[].billing_address_json.uid of schema Address in request body

• [Added] property shipments[].billing_address_json.user_id of schema Address in request body

• [Added] property shipments[].billing_address_json.code of schema Address in request body

• [Added] property shipments[].billing_address_json.store_address_json of schema Address in request body

• [Added] property shipments[].billing_address_json.id of schema Address in request body

• [Added] property shipments[].billing_address_json.location_type of schema Address in request body

• [Added] property shipments[].billing_address_json.company_id of schema Address in request body

• [Added] property shipments[].billing_address_json.store_email of schema Address in request body

• [Breaking] [Added] Possible values home,office,other, to property shipments[].delivery_address_json.address_type of schema Address in request body

• [Breaking] [Added] Possible values store,delivery,billing, to property shipments[].delivery_address_json.address_category of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].delivery_address_json.created_at of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].delivery_address_json.updated_at of schema Address in request body

• [Added] property shipments[].delivery_address_json.address of schema Address in request body

• [Added] property shipments[].delivery_address_json.area_code_slug of schema Address in request body

• [Added] property shipments[].delivery_address_json.country_code of schema Address in request body

• [Added] property shipments[].delivery_address_json.country_iso_code of schema Address in request body

• [Added] property shipments[].delivery_address_json.country_phone_code of schema Address in request body

• [Added] property shipments[].delivery_address_json.delivery_address_id of schema Address in request body

• [Added] property shipments[].delivery_address_json.geo_location of schema Address in request body

• [Added] property shipments[].delivery_address_json.name of schema Address in request body

• [Added] property shipments[].delivery_address_json.sector of schema Address in request body

• [Added] property shipments[].delivery_address_json.state_code of schema Address in request body

• [Added] property shipments[].delivery_address_json.uid of schema Address in request body

• [Added] property shipments[].delivery_address_json.user_id of schema Address in request body

• [Added] property shipments[].delivery_address_json.code of schema Address in request body

• [Added] property shipments[].delivery_address_json.store_address_json of schema Address in request body

• [Added] property shipments[].delivery_address_json.id of schema Address in request body

• [Added] property shipments[].delivery_address_json.location_type of schema Address in request body

• [Added] property shipments[].delivery_address_json.company_id of schema Address in request body

• [Added] property shipments[].delivery_address_json.store_email of schema Address in request body

• [Added] properties shipments[].tags[].slug, shipments[].tags[].display_text in request body

• [Breaking] [Added] Value format date-time to property shipments[].created_at of schema Shipment in request body

• [Breaking] [Added] Possible values home,office,other, to property shipments[].hand_over_contact_json.address_type of schema Address in request body

• [Breaking] [Added] Possible values store,delivery,billing, to property shipments[].hand_over_contact_json.address_category of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].hand_over_contact_json.created_at of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].hand_over_contact_json.updated_at of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.address of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.area_code_slug of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.country_code of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.country_iso_code of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.country_phone_code of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.delivery_address_id of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.geo_location of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.name of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.sector of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.state_code of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.uid of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.user_id of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.code of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.store_address_json of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.id of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.location_type of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.company_id of schema Address in request body

• [Added] property shipments[].hand_over_contact_json.store_email of schema Address in request body

• [Breaking] [Added] Value format date-time to property shipments[].status.status_created_at of schema ShipmentStatusData in request body

• [Added] property shipments[].status.name of schema ShipmentStatusData in request body

• [Added] property shipments[].price.added_to_fynd_cash of schema Prices in request body

• [Added] property shipments[].price.gst_tax_percentage of schema Prices in request body

• [Added] property shipments[].price.tcs_percentage of schema Prices in request body

• [Added] property shipments[].price.cn_refund_amount of schema Prices in request body

• [Added] property shipments[].price.applied_emi_discount of schema Prices in request body

• [Added] property shipments[].price.applied_instant_discount of schema Prices in request body

• [Added] property shipments[].external_location_id of schema Shipment in request body

• [Added] property shipments[].system_messages of schema Shipment in request body

• [Added] property shipments[].process_after_config of schema Shipment in request body

• [Added] properties currency_info.currency, currency_info.order_currency, currency_info.conversion_rate, currency_info.ordering_currency in request body

• [Added] properties charges[].tax.amount.ordering_currency, charges[].tax.amount.base_currency in request body

• [Added] charges[].tax.amount.ordering_currency, charges[].tax.amount.base_currency made required in request body

• [Breaking] [Added] Value format date-time to property external_creation_date of schema CreateOrderAPI in request body

• [Added] property config.lock_state_messages of schema CreateOrderConfig in request body

• [Added] property payment_info.payment_methods[].collected of schema PaymentMethod in request body

• [Added] property payment_info.payment_methods[].display_name of schema PaymentMethod in request body

• [Added] property payment_info.payment_methods[].merchant_transaction_id of schema PaymentMethod in request body

• [Added] payment_info.payment_methods[].collected made required in request body

• [Added] payment_info.payment_methods[].display_name made required in request body

• [Added] payment_info.payment_methods[].merchant_transaction_id made required in request body

• [Added] property user_info.is_authenticated of schema UserInfo in request body

• [Added] property user_info.meta of schema UserInfo in request body

• [Added] user_info.primary_mobile_number made required in request body

• [Added] property status of schema CreateOrderAPI in request body

• [Added] property system_messages of schema CreateOrderAPI in request body

• [Added] property unlock_before_transition of schema CreateOrderAPI in request body

• [Added] property lock_after_transition of schema CreateOrderAPI in request body

• [Added] Security in Request

• What's Deprecated

• [Deleted] Type from object from property shipments[].line_items[].charges[].amount of schema AmountSchema in request body

• [Breaking] [Deleted] properties shipments[].line_items[].charges[].amount.currency, shipments[].line_items[].charges[].amount.value in request body

• [Deleted] Type from object from property charges[].amount of schema AmountSchema in request body

• [Breaking] [Deleted] properties charges[].amount.currency, charges[].amount.value in request body

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

orderUpdate

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] Security in Request

checkOrderStatus

• What's New

• [Added] property start_date of schema OrderStatus in request body

• [Added] property end_date of schema OrderStatus in request body

• [Added] property mobile of schema OrderStatus in request body

• [Breaking] [Added] end_date, mobile, start_date made required in request body

• [Breaking] [Added] Value format date-time to property result[].order_details.affiliate_order_date of schema OrderDetails in response with status code 200

• [Added] property result[].order_details.prices.added_to_fynd_cash of schema Prices in response with status code 200

• [Added] property result[].order_details.prices.gst_tax_percentage of schema Prices in response with status code 200

• [Added] property result[].order_details.prices.tcs_percentage of schema Prices in response with status code 200

• [Added] property result[].order_details.prices.cn_refund_amount of schema Prices in response with status code 200

• [Added] property result[].order_details.prices.applied_emi_discount of schema Prices in response with status code 200

• [Added] property result[].order_details.prices.applied_instant_discount of schema Prices in response with status code 200

• [Added] property result[].order_details.charges of schema OrderDetails in response with status code 200

• [Added] property status_code of schema OrderStatusResult in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from string to boolean of property success of schema OrderStatusResult in response with status code 200

• [Changed] Security in Request

getStateTransitionMap

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

getAllowedStateTransition

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

fetchRefundModeConfig

• What's New

• [Added] property data[].format.manual_refund_data of schema RefundModeInfoFormat in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

attachOrderUser

• What's New

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

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

sendUserMobileOTP

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

verifyMobileOTP

• What's New

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

• [Added] Response with status 400

• What's Deprecated

• [Deleted] Value format from int32 from property otp_data.otp_code of schema VerifyOtpData in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from integer to string of property otp_data.otp_code of schema VerifyOtpData in request body

• [Changed] Security in Request

downloadLanesReport

• What's New

• [Added] property filters of schema BulkReportsDownloadRequestSchema in request body

• [Added] Response with status 400

• What's Deprecated

• [Deleted] Value format from date-time from property start_date of schema BulkReportsDownloadRequest in request body

• [Deleted] Value format from date-time from property end_date of schema BulkReportsDownloadRequest in request body

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

bulkStateTransistion

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

bulkListing

• What's New

• [Breaking] [Added] Possible values a4,a6,pos to property data[].last_selected_invoice_label_type of schema BulkActionListingData in response with status code 200

• [Added] property data[].total_shipments_count of schema BulkActionListingData in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Breaking] [Changed] Type from boolean to string of property data[].status of schema BulkActionListingData in response with status code 200

• [Changed] Security in Request

jobDetails

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

getFileByStatus

• What's New

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

getManifestShipments

• What's Deprecated

• [Breaking] [Deleted] method getManifestShipments

getManifests

• What's Deprecated

• [Breaking] [Deleted] method getManifests

generateProcessManifest

• What's Deprecated

• [Breaking] [Deleted] method generateProcessManifest

getManifestDetails

• What's Deprecated

• [Breaking] [Deleted] method getManifestDetails

dispatchManifests

• What's Deprecated

• [Breaking] [Deleted] method dispatchManifests

uploadConsents

• What's Deprecated

• [Breaking] [Deleted] method uploadConsents

getManifestfilters

• What's New

• [Added] property advance of schema ManifestFiltersResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property advance_filter of schema ManifestFiltersResponse in response with status code 200

• [Breaking] [Deleted] property global_filter of schema ManifestFiltersResponse in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] Security in Request

eInvoiceRetry

• What's New

• [Breaking] [Added] Possible values invoice,credit_note to property shipments_data[].einvoice_type of schema EInvoiceRetryShipmentData in request body

• [Breaking] [Added] Possible values invoice,credit_note to property response_data[].einvoice_type of schema EInvoiceResponseData in response with status code 200

• [Breaking] [Added] Possible values invoice,credit_note to property response_data[].einvoice_type of schema EInvoiceErrorResponseData in response with status code 400

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Security in Request

trackShipment

• What's New

• [Added] Possible values to property page.type of schema PageDetails in response with status code 200

• [Added] property page.total of schema PageDetails in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property items[].dp_status_updated_at of schema CourierPartnerTrackingDetails in response with status code 200

• [Deleted] Value format from date-time from property items[].estimated_delivery_date of schema CourierPartnerTrackingDetails in response with status code 200

• [Deleted] Value format from date-time from property items[].promised_delivery_date of schema CourierPartnerTrackingDetails in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property page.item_total of schema PageDetails in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

updateShipmentTracking

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from date-time from property dp_status_updated_at of schema CourierPartnerTrackingDetails in request body

• [Deleted] Value format from date-time from property estimated_delivery_date of schema CourierPartnerTrackingDetails in request body

• [Deleted] Value format from date-time from property promised_delivery_date of schema CourierPartnerTrackingDetails in request body

• [Deleted] Value format from date-time from property dp_status_updated_at of schema CourierPartnerTrackingDetails in response with status code 200

• [Deleted] Value format from date-time from property estimated_delivery_date of schema CourierPartnerTrackingDetails in response with status code 200

• [Deleted] Value format from date-time from property promised_delivery_date of schema CourierPartnerTrackingDetails in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

Partner

Partner

addProxyPath

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ExtensionProxyPathCreation in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema ExtensionProxyPathCreation in response with status code 200

• [Added] Security in Request

removeProxyPath

• What's New

• [Added] Response with status 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 201

Payment

Payment

getBrandPaymentGatewayConfig

• What's New

• [Added] properties aggregators[].is_active, aggregators[].config_type, aggregators[].display, aggregators[].aggregator, aggregators[].logo, aggregators[].display_name in response with status code 200

• [Added] property message of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property items of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property error of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter config_type

• [Breaking] [Deleted] property description of schema ErrorCodeDescription in response with status code 400

• [Breaking] [Deleted] property code of schema ErrorCodeDescription in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] description made optional in response with status code 400

saveBrandPaymentGatewayConfig

• What's New

• [Added] property ccavenue of schema PaymentGatewayConfigCreation in request body

• [Added] property razorpay of schema PaymentGatewayConfigCreation in request body

• [Added] property juspay of schema PaymentGatewayConfigCreation in request body

• [Added] property aggregators of schema PaymentGatewayToBeReviewed in response with status code 200

• [Added] property message of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property items of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property aggregator_name of schema PaymentGatewayConfigRequest in request body

• [Breaking] [Deleted] property aggregator of schema PaymentGatewayToBeReviewed in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

getPaymentModeRoutes

• What's New

• [Added] Possible nullable value true to property payment_options.payment_option[].list[].product_cod_data of schema ProductCODData in response with status code 200

• [Added] property payment_options.payment_option[].list[].logo of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].meta of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].payment_mode_id of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].logo_url of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].version of schema RootPaymentMode in response with status code 200

• [Added] property meta of schema PaymentOptionsDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Required status of query parameter amount

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

getAllPayouts

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] items[].is_default made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

savePayout

• What's New

• [Added] properties users.unique_external_id, users.name, users.email, users.mobile in request body

• [Added] properties users.unique_external_id, users.name, users.email, users.mobile in response with status code 200

• [Added] properties bank_details.ifsc_code, bank_details.account_holder, bank_details.state, bank_details.country, bank_details.account_type, bank_details.account_no, bank_details.city, bank_details.bank_name, bank_details.branch_name, bank_details.pincode in response with status code 200

• [Added] bank_details.account_type, bank_details.ifsc_code made required in response with status code 200

• [Added] properties payouts.more_attributes, payouts.aggregator_fund_id in response with status code 200

• [Added] property error.error of schema EDCError in response with status code 400

• [Added] property message of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property data of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] payment_status made optional in response with status code 200

• [Breaking] [Changed] payouts made optional in response with status code 200

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

updatePayout

• What's New

• [Added] properties users.unique_external_id, users.name, users.email, users.mobile in request body

• [Added] property bank_details of schema UpdatePayoutDetails in response with status code 200

• [Added] property transfer_type of schema UpdatePayoutDetails in response with status code 200

• [Added] property aggregator of schema UpdatePayoutDetails in response with status code 200

• [Added] property users of schema UpdatePayoutDetails in response with status code 200

• [Added] property unique_transfer_no of schema UpdatePayoutDetails in response with status code 200

• [Added] property updated of schema UpdatePayoutDetails in response with status code 200

• [Added] property payment_status of schema UpdatePayoutDetails in response with status code 200

• [Added] property payouts of schema UpdatePayoutDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] is_active made optional in response with status code 200

• [Breaking] [Changed] is_default made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

activateAndDectivatePayout

• What's New

• [Added] property bank_details of schema UpdatePayoutDetails in response with status code 200

• [Added] property transfer_type of schema UpdatePayoutDetails in response with status code 200

• [Added] property aggregator of schema UpdatePayoutDetails in response with status code 200

• [Added] property users of schema UpdatePayoutDetails in response with status code 200

• [Added] property unique_transfer_no of schema UpdatePayoutDetails in response with status code 200

• [Added] property updated of schema UpdatePayoutDetails in response with status code 200

• [Added] property payment_status of schema UpdatePayoutDetails in response with status code 200

• [Added] property payouts of schema UpdatePayoutDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] is_default made optional in request body

• [Breaking] [Changed] is_active made optional in response with status code 200

• [Breaking] [Changed] is_default made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

deletePayout

• What's New

• [Added] property delete of schema DeletePayoutDetails in response with status code 200

• [Added] property unique_transfer_no of schema DeletePayoutDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

getSubscriptionPaymentMethod

• What's Deprecated

• [Breaking] [Deleted] method getSubscriptionPaymentMethod

deleteSubscriptionPaymentMethod

• What's Deprecated

• [Breaking] [Deleted] method deleteSubscriptionPaymentMethod

getSubscriptionConfig

• What's Deprecated

• [Breaking] [Deleted] method getSubscriptionConfig

saveSubscriptionSetupIntent

• What's Deprecated

• [Breaking] [Deleted] method saveSubscriptionSetupIntent

getBankAccountDetailsOpenAPI

• What's New

• [Added] property data[] of schema GetRefundAccountDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter request_hash

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from object to array of property data of schema RefundAccountResponse in response with status code 200

addRefundBankAccountUsingOTP

• What's New

• [Added] property details.address of schema BankDetailsForOTP in request body

• [Added] property details.comment of schema BankDetailsForOTP in request body

• [Added] property details.email of schema BankDetailsForOTP in request body

• [Added] property details.mobile of schema BankDetailsForOTP in request body

• [Added] property details.beneficiary_id of schema BankDetailsForOTP in request body

• [Added] property transfer_mode of schema AddBeneficiaryDetailsOTPCreation in request body

• [Added] property shipment_id of schema AddBeneficiaryDetailsOTPCreation in request body

• [Added] property delights of schema AddBeneficiaryDetailsOTPCreation in request body

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data made optional in response with status code 200

verifyIfscCode

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

getUserOrderBeneficiaries

• What's New

• [Added] Possible nullable value true to property beneficiaries[].mobile of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].aggregator_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].is_verified of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].status of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].txn_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].meta of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].default_beneficiary of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property bank of schema OrderBeneficiaryFetchResults in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

getUserBeneficiaries

• What's New

• [Added] Possible nullable value true to property beneficiaries[].mobile of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].aggregator_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].is_verified of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].status of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].txn_id of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].meta of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property beneficiaries[].default_beneficiary of schema OrderBeneficiaryDetails in response with status code 200

• [Added] property bank of schema OrderBeneficiaryFetchResults in response with status code 200

• [Added] property message of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property data of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property error of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property description of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] property code of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] code made optional in response with status code 400

• [Breaking] [Changed] description made optional in response with status code 400

confirmPayment

• What's New

• [Added] property payment_methods[].meta.key of schema MultiTenderPaymentMeta in request body

• [Added] property errors of schema PaymentConfirmationDetails in response with status code 200

• [Added] property return_url of schema PaymentConfirmationDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] order_id made optional in response with status code 200

getUserCODlimitRoutes

• What's New

• [Added] property items[].config.advance of schema UserPaymentLimitConfig in response with status code 200

• [Added] property items[].config.cod of schema UserPaymentLimitConfig in response with status code 200

• [Added] property items[].buisness_unit of schema GetUserBULimitDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] property items[].config.is_active of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] property items[].config.usages of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] property items[].config.user_id of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] property items[].config.merchant_user_id of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] property items[].config.remaining_limit of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] property items[].config.limit of schema CODPaymentLimitConfig in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] items[].config.is_active, items[].config.usages, items[].config.user_id, items[].config.merchant_user_id, items[].config.limit, items[].config.remaining_limit made optional in response with status code 200

• [Breaking] [Changed] items[].business_unit, items[].display_name, items[].config made optional in response with status code 200

• [Breaking] [Changed] success, items made optional in response with status code 200

setUserCODlimitRoutes

• What's New

• [Added] property mobile_no of schema SetCODForUserCreation in request body

• [Added] property items of schema SetCODForUserCreation in request body

• [Added] property items of schema GetUserCODLimitDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property business_unit of schema SetCODForUserRequest in request body

• [Breaking] [Deleted] property mobileno of schema SetCODForUserRequest in request body

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message, success made optional in response with status code 200

edcAggregatorsAndModelList

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

edcDeviceStats

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

updateEdcDevice

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

getEdcDevice

• What's New

• [Added] property message of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property data of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] property error of schema RefundErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property description of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] property code of schema NotFoundResourceError in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] code made optional in response with status code 400

• [Breaking] [Changed] description made optional in response with status code 400

addEdcDevice

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

edcDeviceList

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter page_no

• [Deleted] Required status from query parameter page_size

• [Deleted] Required status from query parameter is_active

• [Deleted] Required status from query parameter store_id

• [Deleted] Required status from query parameter device_tag

• [Breaking] [Deleted] Response with status 500

getPosPaymentModeRoutes

• What's New

• [Added] Possible nullable value true to property payment_options.payment_option[].list[].product_cod_data of schema ProductCODData in response with status code 200

• [Added] property payment_options.payment_option[].list[].logo of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].list[].meta of schema PaymentModeList in response with status code 200

• [Added] property payment_options.payment_option[].payment_mode_id of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].logo_url of schema RootPaymentMode in response with status code 200

• [Added] property payment_options.payment_option[].version of schema RootPaymentMode in response with status code 200

• [Added] properties payment_options.payment_flows.bqr_razorpay.data.gateway, payment_options.payment_flows.bqr_razorpay.data.payment_flow_data, payment_options.payment_flows.bqr_razorpay.data.data, payment_options.payment_flows.bqr_razorpay.data.payment_flow, payment_options.payment_flows.bqr_razorpay.data.api_link, payment_options.payment_flows.bqr_razorpay.data.route, payment_options.payment_flows.bqr_razorpay.data.entity, payment_options.payment_flows.bqr_razorpay.data.is_customer_validation_required, payment_options.payment_flows.bqr_razorpay.data.cust_validation_url, payment_options.payment_flows.bqr_razorpay.data.sdk, payment_options.payment_flows.bqr_razorpay.data.return_url, payment_options.payment_flows.bqr_razorpay.data.user_email, payment_options.payment_flows.bqr_razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.bqr_razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.fynd.data.gateway, payment_options.payment_flows.fynd.data.payment_flow_data, payment_options.payment_flows.fynd.data.data, payment_options.payment_flows.fynd.data.payment_flow, payment_options.payment_flows.fynd.data.api_link, payment_options.payment_flows.fynd.data.route, payment_options.payment_flows.fynd.data.entity, payment_options.payment_flows.fynd.data.is_customer_validation_required, payment_options.payment_flows.fynd.data.cust_validation_url, payment_options.payment_flows.fynd.data.sdk, payment_options.payment_flows.fynd.data.return_url, payment_options.payment_flows.fynd.data.user_email, payment_options.payment_flows.fynd.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.fynd.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.epaylater.data.gateway, payment_options.payment_flows.epaylater.data.payment_flow_data, payment_options.payment_flows.epaylater.data.data, payment_options.payment_flows.epaylater.data.payment_flow, payment_options.payment_flows.epaylater.data.api_link, payment_options.payment_flows.epaylater.data.route, payment_options.payment_flows.epaylater.data.entity, payment_options.payment_flows.epaylater.data.is_customer_validation_required, payment_options.payment_flows.epaylater.data.cust_validation_url, payment_options.payment_flows.epaylater.data.sdk, payment_options.payment_flows.epaylater.data.return_url, payment_options.payment_flows.epaylater.data.user_email, payment_options.payment_flows.epaylater.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.epaylater.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.razorpay.data.gateway, payment_options.payment_flows.razorpay.data.payment_flow_data, payment_options.payment_flows.razorpay.data.data, payment_options.payment_flows.razorpay.data.payment_flow, payment_options.payment_flows.razorpay.data.api_link, payment_options.payment_flows.razorpay.data.route, payment_options.payment_flows.razorpay.data.entity, payment_options.payment_flows.razorpay.data.is_customer_validation_required, payment_options.payment_flows.razorpay.data.cust_validation_url, payment_options.payment_flows.razorpay.data.sdk, payment_options.payment_flows.razorpay.data.return_url, payment_options.payment_flows.razorpay.data.user_email, payment_options.payment_flows.razorpay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.razorpay.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.juspay.data.gateway, payment_options.payment_flows.juspay.data.payment_flow_data, payment_options.payment_flows.juspay.data.data, payment_options.payment_flows.juspay.data.payment_flow, payment_options.payment_flows.juspay.data.api_link, payment_options.payment_flows.juspay.data.route, payment_options.payment_flows.juspay.data.entity, payment_options.payment_flows.juspay.data.is_customer_validation_required, payment_options.payment_flows.juspay.data.cust_validation_url, payment_options.payment_flows.juspay.data.sdk, payment_options.payment_flows.juspay.data.return_url, payment_options.payment_flows.juspay.data.user_email, payment_options.payment_flows.juspay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.juspay.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ajiodhan.data.gateway, payment_options.payment_flows.ajiodhan.data.payment_flow_data, payment_options.payment_flows.ajiodhan.data.data, payment_options.payment_flows.ajiodhan.data.payment_flow, payment_options.payment_flows.ajiodhan.data.api_link, payment_options.payment_flows.ajiodhan.data.route, payment_options.payment_flows.ajiodhan.data.entity, payment_options.payment_flows.ajiodhan.data.is_customer_validation_required, payment_options.payment_flows.ajiodhan.data.cust_validation_url, payment_options.payment_flows.ajiodhan.data.sdk, payment_options.payment_flows.ajiodhan.data.return_url, payment_options.payment_flows.ajiodhan.data.user_email, payment_options.payment_flows.ajiodhan.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ajiodhan.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.simpl.data.gateway, payment_options.payment_flows.simpl.data.payment_flow_data, payment_options.payment_flows.simpl.data.data, payment_options.payment_flows.simpl.data.payment_flow, payment_options.payment_flows.simpl.data.api_link, payment_options.payment_flows.simpl.data.route, payment_options.payment_flows.simpl.data.entity, payment_options.payment_flows.simpl.data.is_customer_validation_required, payment_options.payment_flows.simpl.data.cust_validation_url, payment_options.payment_flows.simpl.data.sdk, payment_options.payment_flows.simpl.data.return_url, payment_options.payment_flows.simpl.data.user_email, payment_options.payment_flows.simpl.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.simpl.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.rupifi.data.gateway, payment_options.payment_flows.rupifi.data.payment_flow_data, payment_options.payment_flows.rupifi.data.data, payment_options.payment_flows.rupifi.data.payment_flow, payment_options.payment_flows.rupifi.data.api_link, payment_options.payment_flows.rupifi.data.route, payment_options.payment_flows.rupifi.data.entity, payment_options.payment_flows.rupifi.data.is_customer_validation_required, payment_options.payment_flows.rupifi.data.cust_validation_url, payment_options.payment_flows.rupifi.data.sdk, payment_options.payment_flows.rupifi.data.return_url, payment_options.payment_flows.rupifi.data.user_email, payment_options.payment_flows.rupifi.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.rupifi.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.mswipe.data.gateway, payment_options.payment_flows.mswipe.data.payment_flow_data, payment_options.payment_flows.mswipe.data.data, payment_options.payment_flows.mswipe.data.payment_flow, payment_options.payment_flows.mswipe.data.api_link, payment_options.payment_flows.mswipe.data.route, payment_options.payment_flows.mswipe.data.entity, payment_options.payment_flows.mswipe.data.is_customer_validation_required, payment_options.payment_flows.mswipe.data.cust_validation_url, payment_options.payment_flows.mswipe.data.sdk, payment_options.payment_flows.mswipe.data.return_url, payment_options.payment_flows.mswipe.data.user_email, payment_options.payment_flows.mswipe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.mswipe.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.stripe.data.gateway, payment_options.payment_flows.stripe.data.payment_flow_data, payment_options.payment_flows.stripe.data.data, payment_options.payment_flows.stripe.data.payment_flow, payment_options.payment_flows.stripe.data.api_link, payment_options.payment_flows.stripe.data.route, payment_options.payment_flows.stripe.data.entity, payment_options.payment_flows.stripe.data.is_customer_validation_required, payment_options.payment_flows.stripe.data.cust_validation_url, payment_options.payment_flows.stripe.data.sdk, payment_options.payment_flows.stripe.data.return_url, payment_options.payment_flows.stripe.data.user_email, payment_options.payment_flows.stripe.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.stripe.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.ccavenue.data.gateway, payment_options.payment_flows.ccavenue.data.payment_flow_data, payment_options.payment_flows.ccavenue.data.data, payment_options.payment_flows.ccavenue.data.payment_flow, payment_options.payment_flows.ccavenue.data.api_link, payment_options.payment_flows.ccavenue.data.route, payment_options.payment_flows.ccavenue.data.entity, payment_options.payment_flows.ccavenue.data.is_customer_validation_required, payment_options.payment_flows.ccavenue.data.cust_validation_url, payment_options.payment_flows.ccavenue.data.sdk, payment_options.payment_flows.ccavenue.data.return_url, payment_options.payment_flows.ccavenue.data.user_email, payment_options.payment_flows.ccavenue.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.ccavenue.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.payubiz.data.gateway, payment_options.payment_flows.payubiz.data.payment_flow_data, payment_options.payment_flows.payubiz.data.data, payment_options.payment_flows.payubiz.data.payment_flow, payment_options.payment_flows.payubiz.data.api_link, payment_options.payment_flows.payubiz.data.route, payment_options.payment_flows.payubiz.data.entity, payment_options.payment_flows.payubiz.data.is_customer_validation_required, payment_options.payment_flows.payubiz.data.cust_validation_url, payment_options.payment_flows.payubiz.data.sdk, payment_options.payment_flows.payubiz.data.return_url, payment_options.payment_flows.payubiz.data.user_email, payment_options.payment_flows.payubiz.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.payubiz.type of schema AggregatorRoute in response with status code 200

• [Added] properties payment_options.payment_flows.jiopay.data.gateway, payment_options.payment_flows.jiopay.data.payment_flow_data, payment_options.payment_flows.jiopay.data.data, payment_options.payment_flows.jiopay.data.payment_flow, payment_options.payment_flows.jiopay.data.api_link, payment_options.payment_flows.jiopay.data.route, payment_options.payment_flows.jiopay.data.entity, payment_options.payment_flows.jiopay.data.is_customer_validation_required, payment_options.payment_flows.jiopay.data.cust_validation_url, payment_options.payment_flows.jiopay.data.sdk, payment_options.payment_flows.jiopay.data.return_url, payment_options.payment_flows.jiopay.data.user_email, payment_options.payment_flows.jiopay.data.user_phone in response with status code 200

• [Added] property payment_options.payment_flows.jiopay.type of schema AggregatorRoute in response with status code 200

• [Added] property payment_options.payment_flows.jio of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.payumoney of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.openapi of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.potlee of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.upi_razorpay of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.creditnote of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.pinelabs of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.checkout of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.cashfree of schema PaymentFlow in response with status code 200

• [Added] property payment_options.payment_flows.jio_extension of schema PaymentFlow in response with status code 200

• [Added] Possible nullable value true to property payment_options.payment_flows of schema PaymentFlow in response with status code 200

• [Added] Possible nullable value true to property advance_payment[].list[].product_cod_data of schema ProductCODData in response with status code 200

• [Added] property advance_payment[].list[].logo of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].bank_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].url of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_name of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_code of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].wallet_id of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].collect_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].qr_flow of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].provider of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].list[].meta of schema PaymentModeList in response with status code 200

• [Added] property advance_payment[].advance.all_cancellation_type of schema AdvanceObject in response with status code 200

• [Added] property advance_payment[].version of schema AdvancePaymentObject in response with status code 200

• [Added] property delivery_charges of schema PaymentModeRouteDetails in response with status code 200

• [Added] property store_code of schema PaymentModeRouteDetails in response with status code 200

• [Added] property order_id of schema PaymentModeRouteDetails in response with status code 200

• [Added] property cod_message of schema PaymentModeRouteDetails in response with status code 200

• [Added] property delivery_slots of schema PaymentModeRouteDetails in response with status code 200

• [Added] property user_type of schema PaymentModeRouteDetails in response with status code 200

• [Added] property cod_available of schema PaymentModeRouteDetails in response with status code 200

• [Added] property cod_charges of schema PaymentModeRouteDetails in response with status code 200

• [Added] property max_cart_value of schema PaymentModeRouteDetails in response with status code 200

• [Added] property min_cart_value of schema PaymentModeRouteDetails in response with status code 200

• [Added] property store_emp_list of schema PaymentModeRouteDetails in response with status code 200

• [Added] property delivery_charge_order_value of schema PaymentModeRouteDetails in response with status code 200

• [Added] property cod_limit of schema PaymentModeRouteDetails in response with status code 200

• [Added] property remaining_limit of schema PaymentModeRouteDetails in response with status code 200

• [Added] property cod_limit_per_order of schema PaymentModeRouteDetails in response with status code 200

• [Added] property product_cod_data of schema PaymentModeRouteDetails in response with status code 200

• [Added] property is_product_cod_available of schema PaymentModeRouteDetails in response with status code 200

• [Added] property is_pincode_cod_available of schema PaymentModeRouteDetails in response with status code 200

• [Added] property meta of schema PaymentModeRouteDetails in response with status code 200

• [Added] property error[] of schema PaymentOptionErrorCodeAndMessage in response with status code 400

• [Added] property message of schema PaymentOptionErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter cart_id

• [Deleted] Required status from query parameter checkout_mode

• [Deleted] Required status from query parameter order_id

• [Deleted] Required status from query parameter shipment_id

• [Breaking] [Deleted] property payment_options.payment_default_selection of schema PaymentOptionAndFlow in response with status code 200

• [Breaking] [Deleted] properties error.description, error.code in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from object to array of property error of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

initialisePayment

• What's New

• [Added] property merchant_transaction_id of schema PaymentInitializationCreation in request body

• [Added] property merchant_transaction_id of schema PaymentInitializationDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property email of schema PaymentInitializationRequest in request body

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentInitializationRequest in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] aggregator made optional in request body

• [Changed] amount made optional in request body

• [Changed] contact made optional in request body

• [Changed] currency made optional in request body

• [Changed] email made optional in request body

• [Changed] order_id made optional in request body

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

checkAndUpdatePaymentStatus

• What's New

• [Added] property unique_link_id of schema PaymentStatusUpdateCreation in request body

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Value format from email from property email of schema PaymentStatusUpdateRequest in request body

• [Breaking] [Deleted] Possible nullable value from true from property amount of schema PaymentStatusUpdateRequest in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] contact made optional in request body

• [Changed] currency made optional in request body

• [Changed] customer_id made optional in request body

• [Changed] email made optional in request body

• [Changed] merchant_transaction_id made optional in request body

• [Breaking] [Changed] retry made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

resendOrCancelPayment

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data.message made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

paymentStatusBulk

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from string to boolean of property success of schema PaymentStatusBulkHandlerResponse in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk

oauthGetUrl

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}

revokeOauthToken

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}

repaymentDetails

• What's New

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property extension_order_id of schema RepaymentDetailsSerialiserPayAll in request body

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

merchantOnBoarding

• What's New

• [Added] properties data.status_code, data.message, data.status in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

verifyCustomerForPayment

• What's New

• [Added] properties delivery_address.line1, delivery_address.line2, delivery_address.google_map_point, delivery_address.landmark, delivery_address.phone, delivery_address.country_iso_code, delivery_address.area_code, delivery_address.country, delivery_address.expire_at, delivery_address.geo_location, delivery_address.state, delivery_address.area, delivery_address.g_address_id, delivery_address.area_code_slug, delivery_address.country_phone_code, delivery_address.name, delivery_address.address_type, delivery_address.address, delivery_address.email, delivery_address.city, delivery_address.tags, delivery_address.pincode, delivery_address.type in request body

• [Breaking] [Added] delivery_address.city, delivery_address.country, delivery_address.state made required in request body

• [Added] properties order_items[].sku, order_items[].price, order_items[].quantity in request body

• [Added] properties merchant_params.source in request body

• [Added] properties billing_address.line1, billing_address.line2, billing_address.google_map_point, billing_address.landmark, billing_address.phone, billing_address.country_iso_code, billing_address.area_code, billing_address.country, billing_address.expire_at, billing_address.geo_location, billing_address.state, billing_address.area, billing_address.g_address_id, billing_address.area_code_slug, billing_address.country_phone_code, billing_address.name, billing_address.address_type, billing_address.address, billing_address.email, billing_address.city, billing_address.tags, billing_address.pincode, billing_address.type in request body

• [Breaking] [Added] billing_address.city, billing_address.country, billing_address.state made required in request body

• [Added] properties data.data, data.aggregator, data.api_version in response with status code 200

• [Added] property error of schema ValidateCustomerDetails in response with status code 200

• [Added] property error.order_id of schema PaymentError in response with status code 400

• [Added] property error.order_type of schema PaymentError in response with status code 400

• [Added] property error.transaction_amount_in_paise of schema PaymentError in response with status code 400

• [Added] property error_msg of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property status of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] property message of schema PaymentErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property error.description of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] property error.code of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] error, success made optional in response with status code 400

getPaymentLink

• What's New

• [Added] property currency of schema GetPaymentLinkDetails in response with status code 200

• [Added] property error of schema GetPaymentLinkDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link

createPaymentLink

• What's New

• [Added] property meta.pincode of schema CreatePaymentLinkMeta in request body

• [Added] property success_redirection_url of schema CreatePaymentLinkCreation in request body

• [Added] property failure_redirection_url of schema CreatePaymentLinkCreation in request body

• [Added] property error.description of schema ErrorDescription in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link

pollingPaymentLink

• What's New

• [Added] property error of schema PollingPaymentLinkDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/polling-payment-link/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/polling-payment-link

resendPaymentLink

• What's New

• [Added] property error of schema ResendPaymentLinkDetails in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/resend-payment-link/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/resend-payment-link

cancelPaymentLink

• What's New

• [Added] property error of schema CancelPaymentLinkDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/cancel-payment-link/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/cancel-payment-link

getPaymentModeControlRoutes

• What's New

• [Added] properties items[].display_name, items[].business_unit, items[].config, items[].device in response with status code 200

• [Added] property is_active of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property errors of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property error of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

setMerchantModeControlRoutes

• What's New

• [Added] properties items[].anonymous, items[].user_limit, items[].charges, items[].charges_max_value, items[].charges_min_value, items[].max_order_value, items[].min_order_value, items[].is_active, items[].name, items[].number_of_split, items[].slug, items[].save_allowed, items[].prepayment_type, items[].prepayment_value, items[].refund_time_limit, items[].time_unit, items[].cancellation_type, items[].all_cancellation_type, items[].allow_custom_advance_amount, items[].description, items[].display_name in request body

• [Added] properties device.android, device.ios, device.desktop in request body

• [Added] properties items[].display_name, items[].business_unit, items[].config, items[].device in response with status code 200

• [Added] property is_active of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property errors of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property error of schema PlatformOfflineAdvanceDetails in response with status code 200

• [Added] property is_active of schema PlatformOfflineAdvanceDetails in response with status code 400

• [Added] property message of schema PlatformOfflineAdvanceDetails in response with status code 400

• [Added] property items of schema PlatformOfflineAdvanceDetails in response with status code 400

• [Added] property errors of schema PlatformOfflineAdvanceDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from property business_unit of schema MerchantPaymentModeRequest in request body

• [Breaking] [Deleted] Possible nullable value from property items of schema MerchantPaymentModeRequest in request body

• [Breaking] [Deleted] Possible nullable value from property device of schema MerchantPaymentModeRequest in request body

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] device, business_unit, items made optional in request body

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error, success made optional in response with status code 400

getPaymentModeCustomConfig

• What's New

• [Added] property items[].custom_config.available of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property items[].custom_config.pre_order of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property items[].custom_config.post_order of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property message of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property items of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Type from object from property items[].custom_config.payment_mode of schema PaymentCustomConfigModeSchema in response with status code 200

• [Breaking] [Deleted] properties items[].custom_config.payment_mode.available, items[].custom_config.payment_mode.pre_order, items[].custom_config.payment_mode.post_order in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 200

• [Breaking] [Changed] items[].custom_config.customer, items[].custom_config.payment_mode, items[].custom_config.min_order_value made optional in response with status code 200

• [Breaking] [Changed] items[].custom_config.payment_mode.available made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

setPaymentModeCustomConfig

• What's New

• [Added] property items[].custom_config.available of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property items[].custom_config.pre_order of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property items[].custom_config.post_order of schema PaymentCustomConfigDetailsSchema in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Deleted] Type from object from property items[].custom_config.payment_mode of schema PaymentCustomConfigModeSchema in response with status code 200

• [Breaking] [Deleted] properties items[].custom_config.payment_mode.available, items[].custom_config.payment_mode.pre_order, items[].custom_config.payment_mode.post_order in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] message made optional in response with status code 200

• [Breaking] [Changed] items[].custom_config.customer, items[].custom_config.payment_mode, items[].custom_config.min_order_value made optional in response with status code 200

• [Breaking] [Changed] items[].custom_config.payment_mode.available made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

getPaymentCodeOption

• What's New

• [Added] property data.cod of schema GetPaymentCode in response with status code 200

• [Added] property data.nb of schema GetPaymentCode in response with status code 200

• [Added] property data.wl of schema GetPaymentCode in response with status code 200

• [Added] property data.card of schema GetPaymentCode in response with status code 200

• [Added] property data.pl of schema GetPaymentCode in response with status code 200

• [Added] property data.ps of schema GetPaymentCode in response with status code 200

• [Added] property data.op of schema GetPaymentCode in response with status code 200

• [Added] property data.upi of schema GetPaymentCode in response with status code 200

• [Added] property data.qr of schema GetPaymentCode in response with status code 200

• [Added] property data.fc of schema GetPaymentCode in response with status code 200

• [Added] property data.pac of schema GetPaymentCode in response with status code 200

• [Added] property data.stripepg of schema GetPaymentCode in response with status code 200

• [Added] property data.payumoneypg of schema GetPaymentCode in response with status code 200

• [Added] property data.rupifipg of schema GetPaymentCode in response with status code 200

• [Added] property data.cas of schema GetPaymentCode in response with status code 200

• [Added] property data.csas of schema GetPaymentCode in response with status code 200

• [Added] property data.ccavenuepg of schema GetPaymentCode in response with status code 200

• [Added] property data.cardless_emi of schema GetPaymentCode in response with status code 200

• [Added] property data.cashback of schema GetPaymentCode in response with status code 200

• [Added] property data.loyalty of schema GetPaymentCode in response with status code 200

• [Added] property data.employee_discount of schema GetPaymentCode in response with status code 200

• [Added] property data.paymentlink of schema GetPaymentCode in response with status code 200

• [Added] property data.epaylater of schema GetPaymentCode in response with status code 200

• [Added] property data.udhaari of schema GetPaymentCode in response with status code 200

• [Added] property data.creditnote of schema GetPaymentCode in response with status code 200

• [Added] property data.checkout of schema GetPaymentCode in response with status code 200

• [Added] property data.rone of schema GetPaymentCode in response with status code 200

• [Added] property data.emi of schema GetPaymentCode in response with status code 200

• [Added] property data.sodexo of schema GetPaymentCode in response with status code 200

• [Added] property data.jm_wallet of schema GetPaymentCode in response with status code 200

• [Added] Security in Request

• What's Deprecated

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

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] data.method_code made optional in response with status code 200

getPaymentSession

• What's New

• [Breaking] [Added] Type object to property payment_details of schema PaymentSessionDetail in response with status code 200

• [Added] properties payment_details.payment_id, payment_details.mode, payment_details.amount, payment_details.success_url, payment_details.shipping_address, payment_details.amount_captured, payment_details.amount_refunded, payment_details.aggregator_customer_id, payment_details.cancel_url, payment_details.payment_methods, payment_details.created, payment_details.g_user_id, payment_details.currency, payment_details.merchant_locale, payment_details.locale, payment_details.aggregator_order_id, payment_details.gid, payment_details.kind, payment_details.billing_address, payment_details.captured, payment_details.meta, payment_details.status in response with status code 200

• [Added] payment_details.aggregator_order_id, payment_details.amount, payment_details.amount_captured, payment_details.cancel_url, payment_details.currency, payment_details.g_user_id, payment_details.gid, payment_details.mode, payment_details.payment_id, payment_details.payment_methods, payment_details.status, payment_details.success_url made required in response with status code 200

• [Added] property cart_details.cart_charges of schema CartDetailsSerializerData in response with status code 200

• [Added] property meta of schema GetPaymentSessionDetails in response with status code 200

• [Added] property applied_payment_offers of schema GetPaymentSessionDetails in response with status code 200

• [Added] property checksum of schema GetPaymentSessionDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property payment_details[] of schema PaymentSessionSerializer in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property currency of schema PaymentSessionSerializer in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property gid of schema PaymentSessionSerializer in response with status code 200

• [Breaking] [Deleted] property cart_details.custom_cart_meta of schema CartDetailsSerializer in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

updatePaymentSession

• What's New

• [Added] properties payment_details[].payment_methods[].id, payment_details[].payment_methods[].priority, payment_details[].payment_methods[].name, payment_details[].payment_methods[].code, payment_details[].payment_methods[].display_name, payment_details[].payment_methods[].slug, payment_details[].payment_methods[].is_active, payment_details[].payment_methods[].merchant_transaction_id, payment_details[].payment_methods[].amount, payment_details[].payment_methods[].payment_id, payment_details[].payment_methods[].logos, payment_details[].payment_methods[].sub_payment_mode in request body

• [Added] property applied_payment_offers of schema PaymentSessionCreation in request body

• [Added] property error of schema PaymentSessionPutDetails in response with status code 200

• [Added] property success of schema PaymentSessionPutDetails in response with status code 200

• [Added] property message of schema PaymentSessionPutDetails in response with status code 200

• [Added] property transaction_details of schema PaymentSessionPutDetails in response with status code 200

• [Added] properties error.description.option_type, error.description.order_type, error.description.checksum in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] checksum made optional in request body

• [Breaking] [Changed] currency, gid, platform_transaction_details, status, total_amount made optional in response with status code 200

• [Breaking] [Changed] Type from string to object of property error.description of schema ErrorCodeAndDescription in response with status code 400

• [Breaking] [Changed] error.code, error.description made optional in response with status code 400

• [Breaking] [Changed] error, success made optional in response with status code 400

updateRefundSession

• What's New

• [Added] property error.description of schema ErrorDescription in request body

• [Added] property success of schema RefundSessionDetails in response with status code 200

• [Added] property message of schema RefundSessionDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property refund_details[].receipt_number of schema RefundSessionDetail in request body

• [Breaking] [Deleted] property refund_details[].pg_refund_id of schema RefundSessionDetail in request body

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] refund_details made optional in request body

• [Breaking] [Changed] platform_refund_details made optional in response with status code 200

• [Breaking] [Changed] status made optional in response with status code 200

• [Breaking] [Changed] total_refund_amount made optional in response with status code 200

getMerchantPaymentOption

• What's New

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

• [Added] query parameter cod_refund_agg (type: boolean)

• [Added] properties items.online, items.offline, items.advance in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] property items[] of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from array to object of property items of schema PlatformPaymentModeResponse in response with status code 200

patchMerchantPaymentOption

• What's New

• [Added] properties items[].online, items[].offline, items[].advance in response with status code 200

• [Added] property message of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property items of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property offline[] of schema MerchnatPaymentModeRequest in request body

• [Breaking] [Deleted] property online[] of schema MerchnatPaymentModeRequest in request body

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

getMerchantAggregatorPaymentModeDetails

• What's New

• [Added] properties items[].id, items[].name, items[].priority, items[].display_name, items[].slug, items[].integration_type, items[].logos, items[].is_active, items[].config, items[].payment_modes, items[].payment_mode, items[].checkout_type, items[].country, items[].currency, items[].status, items[].save_allowed, items[].extension_id, items[].is_cod_refund_agg in response with status code 200

• [Added] property business_unit of schema AggregatorPlatformPaymentModeDetails in response with status code 200

• [Added] property device of schema AggregatorPlatformPaymentModeDetails in response with status code 200

• [Added] property is_active of schema AggregatorPlatformPaymentModeDetails in response with status code 200

• [Added] property save_allowed of schema AggregatorPlatformPaymentModeDetails in response with status code 200

• [Added] property extension_id of schema AggregatorPlatformPaymentModeDetails in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

patchMerchantAggregatorPaymentModeDetails

• What's New

• [Added] properties items[].id, items[].name, items[].logos, items[].is_active, items[].priority, items[].sub_payment_mode in request body

• [Added] property business_unit of schema PlatformPaymentMode in request body

• [Added] property device of schema PlatformPaymentMode in request body

• [Added] property is_active of schema PlatformPaymentMode in request body

• [Added] properties items[].id, items[].name, items[].priority, items[].display_name, items[].slug, items[].integration_type, items[].logos, items[].is_active, items[].config, items[].payment_modes, items[].payment_mode, items[].checkout_type, items[].country, items[].currency, items[].status, items[].save_allowed, items[].extension_id, items[].is_cod_refund_agg in response with status code 200

• [Added] property business_unit of schema PlatformPaymentModeDetails in response with status code 200

• [Added] property device of schema PlatformPaymentModeDetails in response with status code 200

• [Added] property is_active of schema PlatformPaymentModeDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property message of schema PlatformPaymentModeResponse in request body

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in request body

• [Breaking] [Deleted] property success of schema PlatformPaymentModeResponse in request body

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] success made optional in request body

• [Breaking] [Changed] success made optional in response with status code 200

getPGConfigAggregators

• What's New

• [Added] properties items[].id, items[].name, items[].priority, items[].display_name, items[].slug, items[].integration_type, items[].logos, items[].is_active, items[].config, items[].payment_modes, items[].payment_mode, items[].checkout_type, items[].country, items[].currency, items[].status, items[].save_allowed, items[].extension_id, items[].is_cod_refund_agg in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

getMerchantRefundPriority

• What's New

• [Breaking] [Added] Required path parameter business_unit (type: string)

• [Added] property refund_sources_priority[].enabled of schema RefundSourcesPriority in response with status code 200

• [Added] property business_unit of schema RefundPriorityDetails in response with status code 200

• [Added] property settle_offline of schema RefundPriorityDetails in response with status code 200

• [Added] business_unit made required in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type} To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}

createMerchantRefundPriority

• What's New

• [Breaking] [Added] Required path parameter business_unit (type: string)

• [Added] property refund_sources_priority[].enabled of schema RefundSourcesPriority in request body

• [Added] property settle_offline of schema RefundPriorityCreation in request body

• [Added] property refund_sources_priority[].enabled of schema RefundSourcesPriority in response with status code 200

• [Added] property business_unit of schema RefundPriorityDetails in response with status code 200

• [Added] property settle_offline of schema RefundPriorityDetails in response with status code 200

• [Added] business_unit made required in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type} To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}

updateMerchantRefundPriority

• What's New

• [Breaking] [Added] Required path parameter business_unit (type: string)

• [Added] property refund_sources_priority[].enabled of schema RefundSourcesPriority in request body

• [Added] property settle_offline of schema RefundPriorityCreation in request body

• [Added] property refund_sources_priority[].enabled of schema RefundSourcesPriority in response with status code 200

• [Added] property business_unit of schema RefundPriorityDetails in response with status code 200

• [Added] property settle_offline of schema RefundPriorityDetails in response with status code 200

• [Added] business_unit made required in response with status code 200

• [Added] property items of schema HttpErrorDetails in response with status code 400

• [Added] property message of schema HttpErrorDetails in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] error.code made optional in response with status code 400

• [Breaking] [Changed] error made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type} To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}

createPaymentOrder

• What's New

• [Added] property payment_methods[].meta.payment_extra_identifiers of schema PaymentMethodsMetaOrder in request body

• [Added] property payment_methods[].meta.logo_url of schema PaymentMethodsMetaOrder in request body

• [Added] property customer_details of schema PaymentOrderCreation in request body

• [Added] property data.url of schema PaymentOrderData in response with status code 200

• [Added] property data.encdata of schema PaymentOrderData in response with status code 200

• [Added] property data.checksum of schema PaymentOrderData in response with status code 200

• [Added] property data.mcode of schema PaymentOrderData in response with status code 200

• [Added] property data.success of schema PaymentOrderData in response with status code 200

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

• [Added] property data.id of schema PaymentOrderData in response with status code 200

• [Added] property data.mobile of schema PaymentOrderData in response with status code 200

• [Added] property data.user of schema PaymentOrderData in response with status code 200

• [Added] property data.merchant_transaction_id of schema PaymentOrderData in response with status code 200

• [Added] property data.payment_mode_identifier of schema PaymentOrderData in response with status code 200

• [Added] property data.bank of schema PaymentOrderData in response with status code 200

• [Added] property error.description of schema ErrorDescription in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Changed] payment_methods[].meta.merchant_code made optional in request body

• [Changed] payment_methods[].meta.payment_identifier made optional in request body

• [Breaking] [Changed] status_code made optional in response with status code 200

• [Breaking] [Changed] message made optional in response with status code 400

• [Breaking] [Changed] status_code made optional in response with status code 400

• [Changed] Path From /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders/ To /service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders

getMerchantAggregatorAppVersion

• What's New

• [Added] Possible nullable value true to property items of schema AggregatorVersionDetails in response with status code 200

• [Added] property items[] of schema AggregatorVersionDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter payment_mode_id

• [Deleted] Required status from query parameter sub_payment_mode

• [Breaking] [Deleted] properties items.is_equal_to, items.is_less_than, items.is_greater_than in response with status code 200

• [Breaking] [Deleted] Response with status 400

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] Type from object to array of property items of schema AggregatorVersionItemSchema in response with status code 200

patchMerchantPaymentOptionVersion

• What's New

• [Added] properties items[].id, items[].name, items[].priority, items[].display_name, items[].slug, items[].integration_type, items[].logos, items[].is_active, items[].config, items[].payment_modes, items[].payment_mode, items[].checkout_type, items[].country, items[].currency, items[].status, items[].save_allowed, items[].extension_id, items[].is_cod_refund_agg in response with status code 200

• [Added] property message of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] property items of schema HttpErrorCodeAndMessage in response with status code 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Possible nullable value from true from property message of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Possible nullable value from true from property items of schema PlatformPaymentModeResponse in response with status code 200

• [Breaking] [Deleted] Response with status 500

• What's Changed

• [Breaking] [Changed] success made optional in response with status code 200

• [Breaking] [Changed] error.code made optional in response with status code 400

updatePayouts

• What's New

• [Added] method updatePayouts

activateAndDectivatePayouts

• What's New

• [Added] method activateAndDectivatePayouts

deletePayouts

• What's New

• [Added] method deletePayouts

getAllPayout

• What's New

• [Added] method getAllPayout

savePayouts

• What's New

• [Added] method savePayouts

getPaymentLinkId

• What's New

• [Added] method getPaymentLinkId

getPaymentModeSequencing

• What's New

• [Added] method getPaymentModeSequencing

patchPaymentModeSequencing

• What's New

• [Added] method patchPaymentModeSequencing

getPaymentMethodConfig

• What's New

• [Added] method getPaymentMethodConfig

getCodRefundAggregator

• What's New

• [Added] method getCodRefundAggregator

updateCodRefundAggregator

• What's New

• [Added] method updateCodRefundAggregator

getDevices

• What's New

• [Added] method getDevices

getAggregatorCredentialHistory

• What's New

• [Added] method getAggregatorCredentialHistory

getAggregatorCredential

• What's New

• [Added] method getAggregatorCredential

updateAggregatorCredential

• What's New

• [Added] method updateAggregatorCredential

copyConfigPaymentModes

• What's New

• [Added] method copyConfigPaymentModes

copyConfigAggPaymentModes

• What's New

• [Added] method copyConfigAggPaymentModes

addRefundBankAccount

• What's New

• [Added] method addRefundBankAccount

deleteBeneficiaryDetails

• What's New

• [Added] method deleteBeneficiaryDetails

setRefundOptionforShipment

• What's New

• [Added] method setRefundOptionforShipment

getSelectedRefundOption

• What's New

• [Added] method getSelectedRefundOption

getUserBeneficiariesDetailV2

• What's New

• [Added] method getUserBeneficiariesDetailV2

validateBeneficiaryAddress

• What's New

• [Added] method validateBeneficiaryAddress

updateDefaultBeneficiary

• What's New

• [Added] method updateDefaultBeneficiary

getPennyDropValidation

• What's New

• [Added] method getPennyDropValidation

updatePennyDropValidation

• What's New

• [Added] method updatePennyDropValidation

getShipmentBeneficiary

• What's New

• [Added] method getShipmentBeneficiary

getTransactions

• What's New

• [Added] method getTransactions

Rewards

Rewards

showGiveaways

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema Giveaway in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema Giveaway in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

saveGiveAway

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Giveaway in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema Giveaway in request body

• [Breaking] [Added] Value format date-time to property created_at of schema Giveaway in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Giveaway in response with status code 200

• [Added] Security in Request

getGiveawayById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Giveaway in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Giveaway in response with status code 200

• [Added] Security in Request

updateGiveAway

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Giveaway in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema Giveaway in request body

• [Breaking] [Added] Value format date-time to property created_at of schema Giveaway in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Giveaway in response with status code 200

• [Added] Security in Request

showOffers

• What's New

• [Breaking] [Added] Value format date-time to property [].created_at of schema Offer in response with status code 200

• [Breaking] [Added] Value format date-time to property [].updated_at of schema Offer in response with status code 200

• [Added] Security in Request

getOfferByName

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Offer in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Offer in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

updateOfferByName

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema Offer in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema Offer in request body

• [Breaking] [Added] Value format date-time to property created_at of schema Offer in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema Offer in response with status code 200

• [Added] Security in Request

updateUserStatus

• What's New

• [Breaking] [Added] Value format date-time to property updated_at of schema AppUser in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema AppUser in response with status code 200

• [Added] Security in Request

getUserDetails

• What's New

• [Breaking] [Added] Value format date-time to property user.created_at of schema RewardUser in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema RewardUser in response with status code 200

• [Added] Security in Request

getUserPointsHistory

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema PointsHistory in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema PointsHistory in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

getRewardsConfiguration

• What's New

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 500

setRewardsConfiguration

• What's New

• [Added] Security in Request

Share

Share

createShortLink

• What's New

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkReq in request body

• [Added] property url.alias of schema UrlInfo in response with status code 200

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property url.original of schema UrlInfo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in request body

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/ To /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link

getShortLinks

• What's New

• [Added] property items[].url.alias of schema UrlInfo in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema ShortLinkRes in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] property page.page of schema Page in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].url.original of schema UrlInfo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] items[].redirects.expiry, items[].redirects.url made optional in response with status code 200

• [Changed] Path From /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/ To /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link

getShortLinkByHash

• What's New

• [Added] property url.alias of schema UrlInfo in response with status code 200

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property url.original of schema UrlInfo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{hash}/ To /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{hash}

updateShortLinkById

• What's New

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkReq in request body

• [Added] property url.alias of schema UrlInfo in response with status code 200

• [Breaking] [Added] Value format date-time to property expire_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema ShortLinkRes in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ShortLinkRes in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property url.original of schema UrlInfo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• What's Changed

• [Changed] redirects.expiry, redirects.url made optional in request body

• [Changed] redirects.expiry, redirects.url made optional in response with status code 200

• [Changed] Path From /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{id}/ To /service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{id}

getShortLinkClickStats

• What's Deprecated

• [Breaking] [Deleted] method getShortLinkClickStats

Theme

Theme

getAllPages

• What's New

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].application of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].slug of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].status of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].comment of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].predicate of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].fallback of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

createPage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in request body

• [Added] property application of schema AvailablePageSchema in request body

• [Added] property page_mapper of schema AvailablePageSchema in request body

• [Added] property slug of schema AvailablePageSchema in request body

• [Added] property status of schema AvailablePageSchema in request body

• [Added] property comment of schema AvailablePageSchema in request body

• [Added] property predicate of schema AvailablePageSchema in request body

• [Added] property fallback of schema AvailablePageSchema in request body

• [Added] property store of schema AvailablePageSchema in request body

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

updateMultiplePages

• What's New

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in request body

• [Added] property pages[].application of schema AvailablePageSchema in request body

• [Added] property pages[].page_mapper of schema AvailablePageSchema in request body

• [Added] property pages[].slug of schema AvailablePageSchema in request body

• [Added] property pages[].status of schema AvailablePageSchema in request body

• [Added] property pages[].comment of schema AvailablePageSchema in request body

• [Added] property pages[].predicate of schema AvailablePageSchema in request body

• [Added] property pages[].fallback of schema AvailablePageSchema in request body

• [Added] property pages[].store of schema AvailablePageSchema in request body

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].application of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].slug of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].status of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].comment of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].predicate of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].fallback of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getPage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

updatePage

• What's New

• [Breaking] [Added] Required path parameter socket_id (type: string)

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in request body

• [Added] property application of schema AvailablePageSchema in request body

• [Added] property page_mapper of schema AvailablePageSchema in request body

• [Added] property slug of schema AvailablePageSchema in request body

• [Added] property status of schema AvailablePageSchema in request body

• [Added] property comment of schema AvailablePageSchema in request body

• [Added] property predicate of schema AvailablePageSchema in request body

• [Added] property fallback of schema AvailablePageSchema in request body

• [Added] property store of schema AvailablePageSchema in request body

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

• [Changed] Path From /service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value} To /service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}/{socket_id}

deletePage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getFonts

• What's New

• [Added] property items[] of schema FontsSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties items.family, items.variants, items.subsets, items.version, items.last_modified, items.files, items.category, items.kind in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property items of schema FontsSchemaItems in response with status code 200

getCompanyLevelThemes

• What's New

• [Added] property [].meta.release of schema ThemeMeta in response with status code 200

• [Added] property [].meta.name of schema ThemeMeta in response with status code 200

• [Added] property [].font of schema ThemesSchema in response with status code 200

• [Added] property [].config of schema ThemesSchema in response with status code 200

• [Added] property [].applied of schema ThemesSchema in response with status code 200

• [Added] property [].is_private of schema ThemesSchema in response with status code 200

• [Added] property [].tags of schema ThemesSchema in response with status code 200

• [Added] property [].application_id of schema ThemesSchema in response with status code 200

• [Added] property [].template_theme_id of schema ThemesSchema in response with status code 200

• [Added] property [].version of schema ThemesSchema in response with status code 200

• [Added] property [].styles of schema ThemesSchema in response with status code 200

• [Added] property [].global_sections of schema ThemesSchema in response with status code 200

• [Added] property [].assets of schema ThemesSchema in response with status code 200

• [Added] property [].available_sections of schema ThemesSchema in response with status code 200

• [Added] property [].theme_type of schema ThemesSchema in response with status code 200

• [Added] property [].src of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties [].marketplace_theme_id._id, [].marketplace_theme_id.is_default, [].marketplace_theme_id.release, [].marketplace_theme_id.created_at, [].marketplace_theme_id.updated_at in response with status code 200

• [Breaking] [Deleted] properties [].applied_themes[]._id, [].applied_themes[].application_id in response with status code 200

• [Breaking] [Deleted] Response with status 401

• What's Changed

• [Breaking] [Changed] Type from object to string of property [].marketplace_theme_id of schema MarketplaceThemeId in response with status code 200

• [Breaking] [Changed] Type from integer to number of property [].company_id of schema CompanyThemeSchema in response with status code 200

getCompanyLevelPrivateThemes

• What's New

• [Breaking] [Added] Required status to query parameter search_text

• [Breaking] [Added] Possible values vue2,react to property [].theme_type of schema ThemesSchema in response with status code 200

• [Added] property [].meta.release of schema ThemeMeta in response with status code 200

• [Added] property [].meta.name of schema ThemeMeta in response with status code 200

• [Added] property [].font of schema ThemesSchema in response with status code 200

• [Added] property [].config of schema ThemesSchema in response with status code 200

• [Added] property [].tags of schema ThemesSchema in response with status code 200

• [Added] property [].marketplace_theme_id of schema ThemesSchema in response with status code 200

• [Added] property [].template_theme_id of schema ThemesSchema in response with status code 200

• [Added] property [].styles of schema ThemesSchema in response with status code 200

• [Added] property [].global_sections of schema ThemesSchema in response with status code 200

• [Added] property [].assets of schema ThemesSchema in response with status code 200

• [Added] property [].available_sections of schema ThemesSchema in response with status code 200

• [Added] property [].company_id of schema ThemesSchema in response with status code 200

• [Added] property [].src of schema ThemesSchema in response with status code 200

• [Added] property [].applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 401

addMarketplaceThemeToCompany

• What's New

• [Added] property meta.release of schema ThemeMeta in response with status code 200

• [Added] property meta.name of schema ThemeMeta in response with status code 200

• [Added] property font of schema ThemesSchema in response with status code 200

• [Added] property config of schema ThemesSchema in response with status code 200

• [Added] property applied of schema ThemesSchema in response with status code 200

• [Added] property is_private of schema ThemesSchema in response with status code 200

• [Added] property tags of schema ThemesSchema in response with status code 200

• [Added] property application_id of schema ThemesSchema in response with status code 200

• [Added] property template_theme_id of schema ThemesSchema in response with status code 200

• [Added] property version of schema ThemesSchema in response with status code 200

• [Added] property styles of schema ThemesSchema in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property assets of schema ThemesSchema in response with status code 200

• [Added] property available_sections of schema ThemesSchema in response with status code 200

• [Added] property theme_type of schema ThemesSchema in response with status code 200

• [Added] property src of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties marketplace_theme_id._id, marketplace_theme_id.is_default, marketplace_theme_id.release, marketplace_theme_id.created_at, marketplace_theme_id.updated_at in response with status code 200

• [Breaking] [Deleted] properties applied_themes[]._id, applied_themes[].application_id in response with status code 200

• [Breaking] [Deleted] Response with status 401

• What's Changed

• [Breaking] [Changed] Type from object to string of property marketplace_theme_id of schema MarketplaceThemeId in response with status code 200

• [Breaking] [Changed] Type from integer to number of property company_id of schema CompanyThemeSchema in response with status code 200

deleteCompanyTheme

• What's New

• [Added] property meta.release of schema ThemeMeta in response with status code 200

• [Added] property meta.name of schema ThemeMeta in response with status code 200

• [Added] property font of schema ThemesSchema in response with status code 200

• [Added] property config of schema ThemesSchema in response with status code 200

• [Added] property applied of schema ThemesSchema in response with status code 200

• [Added] property is_private of schema ThemesSchema in response with status code 200

• [Added] property tags of schema ThemesSchema in response with status code 200

• [Added] property application_id of schema ThemesSchema in response with status code 200

• [Added] property template_theme_id of schema ThemesSchema in response with status code 200

• [Added] property version of schema ThemesSchema in response with status code 200

• [Added] property styles of schema ThemesSchema in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property assets of schema ThemesSchema in response with status code 200

• [Added] property available_sections of schema ThemesSchema in response with status code 200

• [Added] property theme_type of schema ThemesSchema in response with status code 200

• [Added] property src of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties marketplace_theme_id._id, marketplace_theme_id.is_default, marketplace_theme_id.release, marketplace_theme_id.created_at, marketplace_theme_id.updated_at in response with status code 200

• [Breaking] [Deleted] properties applied_themes[]._id, applied_themes[].application_id in response with status code 200

• What's Changed

• [Breaking] [Changed] Type from object to string of property marketplace_theme_id of schema MarketplaceThemeId in response with status code 200

• [Breaking] [Changed] Type from integer to number of property company_id of schema CompanyThemeSchema in response with status code 200

getApplicationThemes

• What's New

• [Breaking] [Added] Value format date-time to property [].created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property [].updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property [].available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property [].available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property [].available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property [].global_sections of schema ThemesSchema in response with status code 200

• [Added] property [].applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties [].config.preset.pages in response with status code 200

getApplicationThemesCount

• What's New

• [Added] Security in Request

getThemeById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

updateTheme

• What's New

• [Added] property applied of schema ThemesSchema in request body

• [Added] property is_private of schema ThemesSchema in request body

• [Added] property tags of schema ThemesSchema in request body

• [Added] property _id of schema ThemesSchema in request body

• [Added] property application_id of schema ThemesSchema in request body

• [Added] property marketplace_theme_id of schema ThemesSchema in request body

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

• [Added] property name of schema ThemesSchema in request body

• [Added] property template_theme_id of schema ThemesSchema in request body

• [Added] property version of schema ThemesSchema in request body

• [Added] property styles of schema ThemesSchema in request body

• [Added] property created_at of schema ThemesSchema in request body

• [Added] property updated_at of schema ThemesSchema in request body

• [Added] property global_sections of schema ThemesSchema in request body

• [Added] property assets of schema ThemesSchema in request body

• [Added] property available_sections of schema ThemesSchema in request body

• [Added] property theme_type of schema ThemesSchema in request body

• [Added] property company_id of schema ThemesSchema in request body

• [Added] property src of schema ThemesSchema in request body

• [Added] property applied_themes of schema ThemesSchema in request body

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in request body

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

deleteTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

addThemeToApplication

• What's Deprecated

• [Breaking] [Deleted] method addThemeToApplication

updateThemeName

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

applyTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

duplicateTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

getAppliedTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

getThemeForPreview

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

getThemeLastModified

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

isUpgradable

• What's New

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties versions.parent_theme, versions.applied_theme in response with status code 200

upgradeTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] property applied_themes of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] properties config.preset.pages in response with status code 200

getExtensionSections

• What's New

• [Added] Security in Request

getPageMapperConfig

• What's New

• [Added] method getPageMapperConfig

updatePageMapperConfig

• What's New

• [Added] method updatePageMapperConfig

createPageMapping

• What's New

• [Added] method createPageMapping

updatePageMapping

• What's New

• [Added] method updatePageMapping

deletePageMapping

• What's New

• [Added] method deletePageMapping

getFontsV2

• What's New

• [Added] method getFontsV2

createTheme

• What's New

• [Added] method createTheme

createThemePreview

• What's New

• [Added] method createThemePreview

getLatestVersionOfThemeBySlug

• What's New

• [Added] method getLatestVersionOfThemeBySlug

getDefaultMarketplaceTheme

• What's New

• [Added] method getDefaultMarketplaceTheme

User

User

getCustomers

• What's New

• [Added] property items[].phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property items[].gender of schema UserSearchSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_at of schema UserSearchSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_at of schema UserSearchSchema in response with status code 200

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

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

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

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

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter q

• [Deleted] Required status from query parameter page_size

• [Deleted] Required status from query parameter page_no

• [Breaking] [Deleted] Response with status 400

searchUsers

• What's New

• [Added] property users[].phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property users[].gender of schema UserSearchSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property users[].created_at of schema UserSearchSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property users[].updated_at of schema UserSearchSchema in response with status code 200

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

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

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

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

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter q

• [Deleted] Required status from query parameter query

createUser

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Security in Request

blockOrUnblockUsers

• What's New

• [Breaking] [Added] reason, user_id, status made required in request body

• [Added] Security in Request

unDeleteUser

• What's New

• [Breaking] [Added] reason, reason_id, user_id made required in request body

• [Added] Security in Request

updateUser

• What's New

• [Added] property user.phone_numbers[].rrid_linked of schema PhoneNumber in response with status code 200

• [Added] Possible nullable value true to property user.gender of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.created_at of schema UserSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property user.updated_at of schema UserSchema in response with status code 200

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

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

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

• [Added] Security in Request

createUserSession

• What's New

• [Added] property max_age of schema CreateUserSessionRequestSchema in request body

• [Added] property external_id of schema CreateUserSessionRequestSchema in request body

• [Breaking] [Added] domain, user_id made required in request body

• [Added] Security in Request

deleteSession

• What's New

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

• [Added] property external_id of schema SessionDeleteResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter id

getActiveSessions

• What's New

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

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter id

deleteActiveSessions

• What's New

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

• [Added] property external_id of schema SessionsDeleteResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter id

archiveUser

• What's New

• [Breaking] [Added] user_id made required in request body

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

getPlatformConfig

• What's New

• [Breaking] [Added] Value format date-time to property updated_at of schema PlatformSchema in response with status code 200

• [Added] property login.via of schema Login in response with status code 200

• [Added] property social.truecaller of schema Social in response with status code 200

• [Added] property required_fields.password of schema RequiredFields in response with status code 200

• [Added] property register_required_fields.password of schema RegisterRequiredFields in response with status code 200

• [Added] property social_tokens.accountkit of schema SocialTokens in response with status code 200

• [Added] property social_tokens.truecaller of schema SocialTokens in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property mobile_image of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property desktop_image of schema PlatformSchema in response with status code 200

• [Added] property account_lockout of schema PlatformSchema in response with status code 200

• [Added] property password_settings of schema PlatformSchema in response with status code 200

• [Added] property jwt_config of schema PlatformSchema in response with status code 200

• [Added] property auth_method of schema PlatformSchema in response with status code 200

• [Added] property retail_account of schema PlatformSchema in response with status code 200

• [Added] property phone_number_limit of schema PlatformSchema in response with status code 200

• [Added] property email_id_limit of schema PlatformSchema in response with status code 200

• [Added] property updated_by of schema PlatformSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property social_tokens.account_kit of schema SocialTokens in response with status code 200

updatePlatformConfig

• What's New

• [Breaking] [Added] Value format date-time to property updated_at of schema PlatformSchema in request body

• [Added] property login.via of schema Login in request body

• [Added] property social.truecaller of schema Social in request body

• [Added] property required_fields.password of schema RequiredFields in request body

• [Added] property register_required_fields.password of schema RegisterRequiredFields in request body

• [Added] property social_tokens.accountkit of schema SocialTokens in request body

• [Added] property social_tokens.truecaller of schema SocialTokens in request body

• [Breaking] [Added] Value format date-time to property created_at of schema PlatformSchema in request body

• [Added] Possible nullable value true to property mobile_image of schema PlatformSchema in request body

• [Added] Possible nullable value true to property desktop_image of schema PlatformSchema in request body

• [Added] property account_lockout of schema PlatformSchema in request body

• [Added] property password_settings of schema PlatformSchema in request body

• [Added] property jwt_config of schema PlatformSchema in request body

• [Added] property auth_method of schema PlatformSchema in request body

• [Added] property retail_account of schema PlatformSchema in request body

• [Added] property phone_number_limit of schema PlatformSchema in request body

• [Added] property email_id_limit of schema PlatformSchema in request body

• [Added] property updated_by of schema PlatformSchema in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema PlatformSchema in response with status code 200

• [Added] property login.via of schema Login in response with status code 200

• [Added] property social.truecaller of schema Social in response with status code 200

• [Added] property required_fields.password of schema RequiredFields in response with status code 200

• [Added] property register_required_fields.password of schema RegisterRequiredFields in response with status code 200

• [Added] property social_tokens.accountkit of schema SocialTokens in response with status code 200

• [Added] property social_tokens.truecaller of schema SocialTokens in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property mobile_image of schema PlatformSchema in response with status code 200

• [Added] Possible nullable value true to property desktop_image of schema PlatformSchema in response with status code 200

• [Added] property account_lockout of schema PlatformSchema in response with status code 200

• [Added] property password_settings of schema PlatformSchema in response with status code 200

• [Added] property jwt_config of schema PlatformSchema in response with status code 200

• [Added] property auth_method of schema PlatformSchema in response with status code 200

• [Added] property retail_account of schema PlatformSchema in response with status code 200

• [Added] property phone_number_limit of schema PlatformSchema in response with status code 200

• [Added] property email_id_limit of schema PlatformSchema in response with status code 200

• [Added] property updated_by of schema PlatformSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property social_tokens.account_kit of schema SocialTokens in request body

• [Breaking] [Deleted] property social_tokens.account_kit of schema SocialTokens in response with status code 200

createUserGroup

• What's New

• [Added] property blacklisted_users of schema CreateUserGroup in request body

• [Added] property category of schema CreateUserGroup in request body

• [Breaking] [Added] Value format date-time to property created_at of schema UserGroupResponseSchema in response with status code 201

• [Breaking] [Added] Value format date-time to property modified_at of schema UserGroupResponseSchema in response with status code 201

• [Added] property blacklisted_users of schema UserGroupResponseSchema in response with status code 201

• [Added] property total_users of schema UserGroupResponseSchema in response with status code 201

• [Added] property tags of schema UserGroupResponseSchema in response with status code 201

• [Added] property category of schema UserGroupResponseSchema in response with status code 201

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema ConditionsSchema in request body

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema Conditions in response with status code 201

getUserGroups

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema UserGroupResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].modified_at of schema UserGroupResponseSchema in response with status code 200

• [Added] property items[].blacklisted_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property items[].total_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property items[].tags of schema UserGroupResponseSchema in response with status code 200

• [Added] property items[].category of schema UserGroupResponseSchema in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter page_no

• [Deleted] Required status from query parameter page_size

• [Deleted] Required status from query parameter name

• [Deleted] Required status from query parameter type

• [Deleted] Required status from query parameter status

• [Deleted] Required status from query parameter group_uid

• What's Changed

• [Breaking] [Changed] Type from string to object of property items[].conditions[].value of schema Conditions in response with status code 200

updateUserGroup

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema UserGroupResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema UserGroupResponseSchema in response with status code 200

• [Added] property blacklisted_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property total_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property tags of schema UserGroupResponseSchema in response with status code 200

• [Added] property category of schema UserGroupResponseSchema in response with status code 200

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema ConditionsSchema in request body

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema Conditions in response with status code 200

getUserGroupById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema UserGroupResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema UserGroupResponseSchema in response with status code 200

• [Added] property blacklisted_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property total_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property tags of schema UserGroupResponseSchema in response with status code 200

• [Added] property category of schema UserGroupResponseSchema in response with status code 200

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema Conditions in response with status code 200

updateUserGroupPartially

• What's New

• [Added] Possible values black_list to property type of schema PartialUserGroupUpdateSchema in request body

• [Added] Possible values white_list to property type of schema PartialUserGroupUpdateSchema in request body

• [Added] property whitelisted_users of schema PartialUserGroupUpdateSchema in request body

• [Added] property blacklisted_users of schema PartialUserGroupUpdateSchema in request body

• [Breaking] [Added] Value format date-time to property created_at of schema UserGroupResponseSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema UserGroupResponseSchema in response with status code 200

• [Added] property blacklisted_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property total_users of schema UserGroupResponseSchema in response with status code 200

• [Added] property tags of schema UserGroupResponseSchema in response with status code 200

• [Added] property category of schema UserGroupResponseSchema in response with status code 200

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to object of property conditions[].value of schema Conditions in response with status code 200

createUserAttributeDefinition

• What's New

• [Added] Response with status 201

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 200

• What's Changed

• [Breaking] [Changed] Type from string to object of property default_value of schema CreateUserAttributeDefinition in request body

getUserAttributeDefinitions

• What's New

• [Breaking] [Added] Value format date-time to property items[].created_at of schema UserAttributeDefinition in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].modified_at of schema UserAttributeDefinition in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter page_size

• [Deleted] Required status from query parameter page_no

• [Breaking] [Deleted] Response with status 400

updateUserAttributeDefinition

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema UserAttributeDefinition in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema UserAttributeDefinition in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from string to object of property default_value of schema CreateUserAttributeDefinition in request body

deleteUserAttributeDefinitionById

• What's New

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

getUserAttributeDefinitionById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema UserAttributeDefinition in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_at of schema UserAttributeDefinition in response with status code 200

• [Added] Response with status 404

• [Added] Security in Request

updateUserAttribute

• What's New

• [Added] Response with status 201

• [Added] Security in Request

getUserAttribute

• What's New

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

deleteUserAttribute

• What's New

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

getUserAttributesForUser

• What's New

• [Added] Security in Request

• What's Deprecated

• [Deleted] Required status from query parameter page_size

• [Deleted] Required status from query parameter page_no

• [Breaking] [Deleted] Response with status 400

getUserAttributeById

• What's New

• [Added] Response with status 404

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

createUserSessionV2

• What's New

• [Added] method createUserSessionV2

getUserGroupCategories

• What's New

• [Added] method getUserGroupCategories

getUsersByByGroupId

• What's New

• [Added] method getUsersByByGroupId

getCategorisedUserGroups

• What's New

• [Added] method getCategorisedUserGroups

getUserGroupTags

• What's New

• [Added] method getUserGroupTags

refreshUserGroupTotalUsers

• What's New

• [Added] method refreshUserGroupTotalUsers

bulkUpdateUserAttributes

• What's New

• [Added] method bulkUpdateUserAttributes

bulkUpdatePerUserAttributes

• What's New

• [Added] method bulkUpdatePerUserAttributes

checkUserGroupsExists

• What's New

• [Added] method checkUserGroupsExists

Webhook

Webhook

downloadDeliveryReport

• What's New

• [Added] Security in Request

pingWebhook

• What's New

• [Added] Security in Request

getReportFilters

• What's New

• [Added] Security in Request

getHistoricalReports

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

cancelJobByName

• What's New

• [Added] Security in Request

getDeliveryReports

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] Type from integer to number of property rows[].response_time of schema EventProcessReportObject in response with status code 200

fetchAllEventConfigurations

• What's New

• [Breaking] [Added] Value format date-time to property event_configs[].subscriber_event_mapping.created_on of schema SubscriberEventMapping in response with status code 200

• [Added] property event_configs[].subscriber_event_mapping.broadcaster_config of schema SubscriberEventMapping in response with status code 200

• [Breaking] [Added] Value format date-time to property event_configs[].created_on of schema EventConfig in response with status code 200

• [Breaking] [Added] Value format date-time to property event_configs[].updated_on of schema EventConfig in response with status code 200

• [Added] property event_configs[].type of schema EventConfig in response with status code 200

• [Added] property event_configs[].modified_by of schema EventConfig in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property event_configs[].subscriber_event_mapping.topic of schema SubscriberEventMapping in response with status code 200

registerSubscriberToEventV2

• What's New

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigPostRequestV2 in request body

• [Breaking] [Added] Type object to property association of schema Association in request body

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigPostRequestV2 in request body

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in request body

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in request body

• [Added] property events[].queue of schema Events in request body

• [Added] property events[].event_bridge_name of schema Events in request body

• [Added] property events[].workflow_name of schema Events in request body

• [Added] property events[].detail_type of schema Events in request body

• [Added] property type of schema SubscriberConfigPostRequestV2 in request body

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Type object to property association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property created_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigResult in response with status code 200

• [Added] Security in Request

updateSubscriberV2

• What's New

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigUpdateRequestV2 in request body

• [Breaking] [Added] Type object to property association of schema Association in request body

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigUpdateRequestV2 in request body

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in request body

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in request body

• [Added] property events[].queue of schema Events in request body

• [Added] property events[].event_bridge_name of schema Events in request body

• [Added] property events[].workflow_name of schema Events in request body

• [Added] property events[].detail_type of schema Events in request body

• [Added] property type of schema SubscriberConfigUpdateRequestV2 in request body

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Type object to property association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property created_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigResult in response with status code 200

• [Added] Security in Request

registerSubscriberToEvent

• What's New

• [Breaking] [Added] Type object to property association of schema Association in request body

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigPost in request body

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in request body

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in request body

• [Added] property type of schema SubscriberConfigPost in request body

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Type object to property association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property created_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigResult in response with status code 200

• [Added] Security in Request

getSubscribersByCompany

• What's New

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property items[].provider of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Type object to property items[].association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property items[].custom_headers of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Possible values hmac to property items[].auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property items[].auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].subscriber_event_mapping.created_on of schema SubscriberEventMapping in response with status code 200

• [Added] property items[].event_configs[].subscriber_event_mapping.broadcaster_config of schema SubscriberEventMapping in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].created_on of schema EventConfig in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].updated_on of schema EventConfig in response with status code 200

• [Added] property items[].event_configs[].type of schema EventConfig in response with status code 200

• [Added] property items[].event_configs[].modified_by of schema EventConfig in response with status code 200

• [Breaking] [Added] Type object to property items[] of schema SubscriberDetails in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigList in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].event_configs[].subscriber_event_mapping.topic of schema SubscriberEventMapping in response with status code 200

updateSubscriberConfig

• What's New

• [Breaking] [Added] Type object to property association of schema Association in request body

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigUpdate in request body

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in request body

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in request body

• [Added] property type of schema SubscriberConfigUpdate in request body

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Type object to property association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property custom_headers of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Value format date-time to property created_on of schema SubscriberConfigResult in response with status code 200

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigResult in response with status code 200

• [Added] Security in Request

getSubscriberById

• What's New

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property provider of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Type object to property association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property custom_headers of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property created_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Possible values hmac to property auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property event_configs[].subscriber_event_mapping.created_on of schema SubscriberEventMapping in response with status code 200

• [Added] property event_configs[].subscriber_event_mapping.broadcaster_config of schema SubscriberEventMapping in response with status code 200

• [Breaking] [Added] Value format date-time to property event_configs[].created_on of schema EventConfig in response with status code 200

• [Breaking] [Added] Value format date-time to property event_configs[].updated_on of schema EventConfig in response with status code 200

• [Added] property event_configs[].type of schema EventConfig in response with status code 200

• [Added] property event_configs[].modified_by of schema EventConfig in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberDetails in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property event_configs[].subscriber_event_mapping.topic of schema SubscriberEventMapping in response with status code 200

getSubscribersByExtensionId

• What's New

• [Breaking] [Added] Possible values kafka,sqs,rest,event_bridge,pub_sub,temporal to property items[].provider of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Type object to property items[].association of schema AssociationResp in response with status code 200

• [Added] Possible nullable value true to property items[].custom_headers of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_on of schema SubscriberDetails in response with status code 200

• [Breaking] [Added] Possible values hmac to property items[].auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Type object to property items[].auth_meta of schema AuthMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].subscriber_event_mapping.created_on of schema SubscriberEventMapping in response with status code 200

• [Added] property items[].event_configs[].subscriber_event_mapping.broadcaster_config of schema SubscriberEventMapping in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].created_on of schema EventConfig in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].updated_on of schema EventConfig in response with status code 200

• [Added] property items[].event_configs[].type of schema EventConfig in response with status code 200

• [Added] property items[].event_configs[].modified_by of schema EventConfig in response with status code 200

• [Breaking] [Added] Type object to property items[] of schema SubscriberDetails in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Breaking] [Added] Type object to property of schema SubscriberConfigList in response with status code 200

• [Added] Security in Request

• What's Deprecated

• [Breaking] [Deleted] property items[].event_configs[].subscriber_event_mapping.topic of schema SubscriberEventMapping in response with status code 200

upsertSubscriberEvent

• What's New

• [Added] method upsertSubscriberEvent

Partner REST

Partner REST Change Log

Compared against: 1.9.4-RC235H

Current version: 1.10.5

• [Added] Authorization class in partner client

• [Added] Catalog class in partner client

• [Added] Payment class in partner client

FileStorage

FileStorage

startUpload

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] cdn made optional in response with status code 200

• [Changed] Path From /service/partner/assets/v1.0/organization/{organization_id}/namespaces/{namespace}/upload/start To /service/partner/assets/v2.0/organization/{organization_id}/namespaces/{namespace}/upload/start

completeUpload

• What's New

• [Breaking] [Added] Value format date-time to property created_on of schema FileUploadComplete in response with status code 200

• [Breaking] [Added] Value format date-time to property modified_on of schema FileUploadComplete in response with status code 200

• [Added] property created_by.user_id of schema CreatedBy in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property cdn of schema StartResponse in request body

• What's Changed

• [Breaking] [Changed] cdn made optional in request body

• [Changed] Path From /service/partner/assets/v1.0/organization/{organization_id}/namespaces/{namespace}/upload/complete To /service/partner/assets/v2.0/organization/{organization_id}/namespaces/{namespace}/upload/complete

browse

• What's New

• [Added] property items[].created_by.user_id of schema in response with status code 200

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

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

• What's Deprecated

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

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

getAllNamespaceDetails

• What's New

• [Added] method getAllNamespaceDetails

getNamespaceDetail

• What's New

• [Added] method getNamespaceDetail

browseFiles

• What's New

• [Added] method browseFiles

organizationLevelFetchProxy

• What's New

• [Added] method organizationLevelFetchProxy

saveOrganizationLevelProxy

• What's New

• [Added] method saveOrganizationLevelProxy

fetchProxy

• What's New

• [Added] method fetchProxy

saveProxyDetails

• What's New

• [Added] method saveProxyDetails

Lead

Lead

getTickets

• What's New

• [Added] property items[].context.organization_id of schema TicketContext in response with status code 200

• [Added] property items[].created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property items[].category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property items[].category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property items[].subscribers of schema Ticket in response with status code 200

• [Added] property items[].additional_info of schema Ticket in response with status code 200

• [Added] property items[].ticket_link of schema Ticket in response with status code 200

• [Added] property items[].__v of schema Ticket in response with status code 200

• [Breaking] [Added] Type array to property filters.categories[].sub_categories of schema TicketCategory in response with status code 200

• [Added] property filters.categories[].sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property filters.all_categories of schema Filter in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].context.partner_id of schema TicketContext in response with status code 200

• [Deleted] Possible values from platform_panel,sales_channel from property items[].source of schema TicketSourceEnum in response with status code 200

• [Deleted] Possible values from low,medium,high,urgent from property items[].priority.key of schema PriorityEnum in response with status code 200

• [Deleted] Possible values from low,medium,high,urgent from property filters.priorities[].key of schema PriorityEnum in response with status code 200

• What's Changed

• [Breaking] [Changed] filters.assignees made optional in response with status code 200

createTicket

• What's New

• [Added] property context.organization_id of schema TicketContext in response with status code 200

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property ticket_link of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Deleted] Possible values from low,medium,high,urgent from property priority of schema PriorityEnum in request body

• [Breaking] [Deleted] property context.partner_id of schema TicketContext in response with status code 200

• [Deleted] Possible values from platform_panel,sales_channel from property source of schema TicketSourceEnum in response with status code 200

• [Deleted] Possible values from low,medium,high,urgent from property priority.key of schema PriorityEnum in response with status code 200

getTicket

• What's New

• [Added] property context.organization_id of schema TicketContext in response with status code 200

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property ticket_link of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Breaking] [Deleted] property context.partner_id of schema TicketContext in response with status code 200

• [Deleted] Possible values from platform_panel,sales_channel from property source of schema TicketSourceEnum in response with status code 200

• [Deleted] Possible values from low,medium,high,urgent from property priority.key of schema PriorityEnum in response with status code 200

editTicket

• What's New

• [Added] Possible values partner_panel to property source of schema EditTicketPayload in request body

• [Added] property context.organization_id of schema TicketContext in response with status code 200

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Breaking] [Added] Type array to property category.sub_categories of schema TicketCategory in response with status code 200

• [Added] property category.sub_categories[] of schema TicketCategory in response with status code 200

• [Added] property subscribers of schema Ticket in response with status code 200

• [Added] property additional_info of schema Ticket in response with status code 200

• [Added] property ticket_link of schema Ticket in response with status code 200

• [Added] property __v of schema Ticket in response with status code 200

• [Added] Response with status 404

• What's Deprecated

• [Deleted] Possible values from low,medium,high,urgent from property priority of schema PriorityEnum in request body

• [Breaking] [Deleted] property context.partner_id of schema TicketContext in response with status code 200

• [Deleted] Possible values from platform_panel,sales_channel from property source of schema TicketSourceEnum in response with status code 200

• [Deleted] Possible values from low,medium,high,urgent from property priority.key of schema PriorityEnum in response with status code 200

createHistory

• What's New

• [Added] Possible values diff to property type of schema TicketHistoryPayload in request body

• [Added] Possible values thread to property type of schema TicketHistoryPayload in request body

• [Added] property created_on.platform of schema CreatedOn in response with status code 200

• [Added] property __v of schema TicketHistory in response with status code 200

• [Added] Response with status 400

getTicketHistory

• What's New

• [Added] property items[].created_on.platform of schema CreatedOn in response with status code 200

• [Added] property items[].__v of schema TicketHistory in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

getGeneralConfig

• What's New

• [Added] property _id of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property show_communication_info of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property show_support_dris of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property allow_ticket_creation of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property show_listing of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property enable_dris of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property support_email of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property support_phone of schema GeneralConfigResponseSchema in response with status code 200

• [Added] property support_faq of schema GeneralConfigResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property support_communication[].value of schema SupportCommunicationSchema in response with status code 200

Logistics

Logistics

sampleFileServiceability

• What's New

• [Added] Possible nullable value true to property file_path of schema BulkRegionServiceabilityTatResponseItemData in response with status code 200

getSampleFileServiceabilityStatus

• What's New

• [Added] Possible nullable value true to property items[].file_path of schema BulkRegionServiceabilityTatResponseItemData in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

bulkTat

• What's New

• [Added] Response with status 400

getBulkTat

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

getBulkServiceability

• What's New

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

createCourierPartnerAccount

• What's Changed

• [Breaking] [Changed] company_id made optional in response with status code 200

getCourierPartnerAccounts

• What's New

• [Added] query parameter account_ids (type: array)

• [Added] property items[].company_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property items[].extension_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] Response with status 400

• What's Changed

• [Breaking] [Changed] items[].scheme_rules.extension_id, items[].scheme_rules.scheme_id, items[].scheme_rules.name, items[].scheme_rules.weight, items[].scheme_rules.transport_type, items[].scheme_rules.region, items[].scheme_rules.delivery_type, items[].scheme_rules.payment_mode, items[].scheme_rules.stage, items[].scheme_rules.feature made optional in response with status code 200

updateCourierPartnerAccount

• What's New

• [Added] property extension_id of schema CourierAccount in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property scheme_rules of schema CourierAccountResponse in response with status code 200

• What's Changed

• [Breaking] [Changed] company_id made optional in request body

getCourierPartnerAccount

• What's New

• [Added] property company_id of schema CourierAccountResponseSchema in response with status code 200

• [Added] property extension_id of schema CourierAccountResponseSchema in response with status code 200

• What's Changed

• [Breaking] [Changed] scheme_rules.extension_id, scheme_rules.scheme_id, scheme_rules.name, scheme_rules.weight, scheme_rules.transport_type, scheme_rules.region, scheme_rules.delivery_type, scheme_rules.payment_mode, scheme_rules.stage, scheme_rules.feature made optional in response with status code 200

createCourierPartnerScheme

• What's New

• [Added] property volumetric_weight of schema CourierPartnerSchemeModel in request body

• [Breaking] [Added] feature made required in request body

• [Added] property volumetric_weight of schema CourierPartnerSchemeModel in response with status code 200

• What's Changed

• [Changed] Path From /service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme/ To /service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme

updateCourierPartnerScheme

• What's New

• [Added] property volumetric_weight of schema CourierPartnerSchemeUpdateRequestSchema in request body

• [Added] property volumetric_weight of schema CourierPartnerSchemeUpdateRequestSchema in response with status code 200

getCountries

• What's New

• [Breaking] [Deleted] query parameter onboarding (type: boolean), [Added] query parameter onboard (type: boolean)

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

• [Added] Possible nullable value true to property items[].timezones of schema CountryObject in response with status code 200

• [Added] properties items[].currency.code, items[].currency.name, items[].currency.symbol in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• [Added] Response with status 400

• [Added] Security in Request

• What's Changed

• [Breaking] [Changed] page, items made optional in response with status code 200

• [Breaking] [Changed] Type from string to object of property items[].currency of schema GetCountriesItems in response with status code 200

Theme

Theme

getAllPages

• What's New

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].application of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].__v of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].slug of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].status of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].comment of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].predicate of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].fallback of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

createPage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in request body

• [Added] property application of schema AvailablePageSchema in request body

• [Added] property __v of schema AvailablePageSchema in request body

• [Added] property page_mapper of schema AvailablePageSchema in request body

• [Added] property slug of schema AvailablePageSchema in request body

• [Added] property status of schema AvailablePageSchema in request body

• [Added] property comment of schema AvailablePageSchema in request body

• [Added] property predicate of schema AvailablePageSchema in request body

• [Added] property fallback of schema AvailablePageSchema in request body

• [Added] property store of schema AvailablePageSchema in request body

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property __v of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

updateMultiplePages

• What's New

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in request body

• [Added] property pages[].application of schema AvailablePageSchema in request body

• [Added] property pages[].__v of schema AvailablePageSchema in request body

• [Added] property pages[].page_mapper of schema AvailablePageSchema in request body

• [Added] property pages[].slug of schema AvailablePageSchema in request body

• [Added] property pages[].status of schema AvailablePageSchema in request body

• [Added] property pages[].comment of schema AvailablePageSchema in request body

• [Added] property pages[].predicate of schema AvailablePageSchema in request body

• [Added] property pages[].fallback of schema AvailablePageSchema in request body

• [Added] property pages[].store of schema AvailablePageSchema in request body

• [Added] property pages[].sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property pages[].sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property pages[].sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property pages[].seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property pages[].seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property pages[].seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property pages[].updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].application of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].__v of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].slug of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].status of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].comment of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].predicate of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].fallback of schema AvailablePageSchema in response with status code 200

• [Added] property pages[].store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties pages[].sections[].predicate.schedule.cron, pages[].sections[].predicate.schedule.start, pages[].sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property pages[].sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property pages[].seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property pages[].sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getPage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property __v of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

updatePage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in request body

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in request body

• [Added] property sections[]._id of schema AvailablePageSchemaSections in request body

• [Added] property sections[].__source of schema AvailablePageSchemaSections in request body

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in request body

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in request body

• [Added] property seo.canonical_url of schema AvailablePageSeo in request body

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in request body

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in request body

• [Added] property application of schema AvailablePageSchema in request body

• [Added] property __v of schema AvailablePageSchema in request body

• [Added] property page_mapper of schema AvailablePageSchema in request body

• [Added] property slug of schema AvailablePageSchema in request body

• [Added] property status of schema AvailablePageSchema in request body

• [Added] property comment of schema AvailablePageSchema in request body

• [Added] property predicate of schema AvailablePageSchema in request body

• [Added] property fallback of schema AvailablePageSchema in request body

• [Added] property store of schema AvailablePageSchema in request body

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property __v of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in request body

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in request body

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in request body

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in request body

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

deletePage

• What's New

• [Added] property sections[].predicate.user.user_type of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.user_groups of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.start of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.user.end of schema AvailablePageUserPredicate in response with status code 200

• [Added] property sections[].predicate.schedule[] of schema AvailablePagePredicate in response with status code 200

• [Added] property sections[]._id of schema AvailablePageSchemaSections in response with status code 200

• [Added] property sections[].__source of schema AvailablePageSchemaSections in response with status code 200

• [Added] property seo.sitemap.modified_on of schema SEOSitemap in response with status code 200

• [Added] property seo.breadcrumbs of schema AvailablePageSeo in response with status code 200

• [Added] property seo.canonical_url of schema AvailablePageSeo in response with status code 200

• [Breaking] [Added] Value format date-time to property created_at of schema AvailablePageSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema AvailablePageSchema in response with status code 200

• [Added] property application of schema AvailablePageSchema in response with status code 200

• [Added] property __v of schema AvailablePageSchema in response with status code 200

• [Added] property page_mapper of schema AvailablePageSchema in response with status code 200

• [Added] property slug of schema AvailablePageSchema in response with status code 200

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

• [Added] property comment of schema AvailablePageSchema in response with status code 200

• [Added] property predicate of schema AvailablePageSchema in response with status code 200

• [Added] property fallback of schema AvailablePageSchema in response with status code 200

• [Added] property store of schema AvailablePageSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] properties sections[].predicate.schedule.cron, sections[].predicate.schedule.start, sections[].predicate.schedule.end in response with status code 200

• [Breaking] [Deleted] property sections[].source of schema AvailablePageSchemaSections in response with status code 200

• [Breaking] [Deleted] property seo.breadcrumb of schema AvailablePageSeo in response with status code 200

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Breaking] [Changed] Type from object to array of property sections[].predicate.schedule of schema AvailablePageSchedulePredicate in response with status code 200

getApplicationThemes

• What's New

• [Breaking] [Added] Value format date-time to property [].created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property [].updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property [].available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property [].available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property [].available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property [].global_sections of schema ThemesSchema in response with status code 200

• What's Changed

• [Changed] Path From /service/partner/theme/v2.0/organization/{organization_id}/company/{company_id}/application/{application_id}/themes To /service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/themes

getThemeById

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• What's Changed

• [Changed] Path From /service/partner/theme/v2.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id} To /service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}

updateTheme

• What's New

• [Added] property applied of schema ThemesSchema in request body

• [Added] property is_private of schema ThemesSchema in request body

• [Added] property tags of schema ThemesSchema in request body

• [Added] property _id of schema ThemesSchema in request body

• [Added] property application_id of schema ThemesSchema in request body

• [Added] property marketplace_theme_id of schema ThemesSchema in request body

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

• [Added] property name of schema ThemesSchema in request body

• [Added] property template_theme_id of schema ThemesSchema in request body

• [Added] property version of schema ThemesSchema in request body

• [Added] property styles of schema ThemesSchema in request body

• [Added] property created_at of schema ThemesSchema in request body

• [Added] property updated_at of schema ThemesSchema in request body

• [Added] property assets of schema ThemesSchema in request body

• [Added] property available_sections of schema ThemesSchema in request body

• [Added] property theme_type of schema ThemesSchema in request body

• [Added] property company_id of schema ThemesSchema in request body

• [Added] property src of schema ThemesSchema in request body

• [Added] property global_sections of schema ThemesSchema in request body

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• What's Changed

• [Changed] Path From /service/partner/theme/v2.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id} To /service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}

deleteTheme

• What's New

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• What's Changed

• [Changed] Path From /service/partner/theme/v2.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id} To /service/partner/theme/v1.0/organization/{organization_id}/company/{company_id}/application/{application_id}/{theme_id}

getOrganizationThemes

• What's New

• [Added] property items of schema MarketplaceThemeSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property themes of schema MarketplaceThemeSchema in response with status code 200

getOrganizationThemeDetails

• What's New

• [Added] property theme_type of schema MarketplaceTheme in response with status code 200

updateDraftTheme

• What's New

• [Added] property theme_type of schema MarketplaceTheme in request body

• [Added] property theme_type of schema MarketplaceTheme in response with status code 200

submitOrganizationTheme

• What's New

• [Added] property theme_type of schema MarketplaceTheme in request body

• [Added] property theme_type of schema MarketplaceTheme in response with status code 200

deleteOrganizationTheme

• What's New

• [Added] property theme_type of schema MarketplaceTheme in response with status code 200

getLatestVersionOfThemeBySlug

• What's New

• [Added] property [].theme_type of schema MarketplaceTheme in response with status code 200

createNewThemeInOrganization

• What's New

• [Added] property theme_type of schema MarketplaceTheme in request body

• [Added] property theme_type of schema MarketplaceTheme in response with status code 200

createExtensionSectionDraft

• What's New

• [Added] property _id of schema DraftExtensionSection in request body

• [Added] property created_at of schema DraftExtensionSection in request body

• [Added] property updated_at of schema DraftExtensionSection in request body

• [Added] property message of schema ExtensionSectionDraft in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property sections of schema DraftExtensionSectionResponse in response with status code 200

publishExtensionSections

• What's New

• [Added] property message of schema PublishExtensionSectionResponseSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property sections of schema PublishExtensionSectionResponse in response with status code 200

getThemeRejectionReasons

• What's New

• [Added] properties rejection_reasons.theme_file, rejection_reasons.theme_details, rejection_reasons.theme_value_proposition, rejection_reasons.theme_attributes, rejection_reasons.theme_variations, rejection_reasons.theme_docs, rejection_reasons.theme_review in response with status code 200

getThemeVersions

• What's New

• [Added] property items of schema MarketplaceThemeSchema in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property themes of schema MarketplaceThemeSchema in response with status code 200

createTheme

• What's New

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in request body

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in request body

• [Added] property available_sections[].preset of schema SectionItem in request body

• [Added] property font of schema ThemesSchema in request body

• [Added] property config of schema ThemesSchema in request body

• [Added] property applied of schema ThemesSchema in request body

• [Added] property is_private of schema ThemesSchema in request body

• [Added] property tags of schema ThemesSchema in request body

• [Added] property _id of schema ThemesSchema in request body

• [Added] property application_id of schema ThemesSchema in request body

• [Added] property marketplace_theme_id of schema ThemesSchema in request body

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

• [Added] property template_theme_id of schema ThemesSchema in request body

• [Added] property styles of schema ThemesSchema in request body

• [Added] property created_at of schema ThemesSchema in request body

• [Added] property updated_at of schema ThemesSchema in request body

• [Added] property assets of schema ThemesSchema in request body

• [Added] property company_id of schema ThemesSchema in request body

• [Added] property src of schema ThemesSchema in request body

• [Added] property global_sections of schema ThemesSchema in request body

• [Breaking] [Added] Value format date-time to property created_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property updated_at of schema ThemesSchema in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].props[] of schema SectionItem in response with status code 200

• [Breaking] [Added] Type object to property available_sections[].blocks[] of schema SectionItem in response with status code 200

• [Added] property available_sections[].preset of schema SectionItem in response with status code 200

• [Added] property global_sections of schema ThemesSchema in response with status code 200

• [Added] Response with status 400

• What's Deprecated

• [Breaking] [Deleted] property list of schema CreateNewTheme in request body

• [Breaking] [Deleted] property global_schema of schema CreateNewTheme in request body

• [Breaking] [Deleted] property preset of schema CreateNewTheme in request body

• [Breaking] [Deleted] property current of schema CreateNewTheme in request body

• [Breaking] [Deleted] property pages of schema CreateNewTheme in request body

• [Breaking] [Deleted] Response with status 4XX

• [Breaking] [Deleted] Response with status 5XX

• What's Changed

• [Changed] name, available_sections, version, theme_type made optional in request body

getExtensionbinding

• What's New

• [Added] method getExtensionbinding

getOrgnaizationDefaultTheme

• What's New

• [Added] method getOrgnaizationDefaultTheme

getSystemPage

• What's New

• [Added] method getSystemPage

getAppliedTheme

• What's New

• [Added] method getAppliedTheme

Webhook

Webhook

getDeliveryDetailInsights

• What's New

• [Breaking] [Added] Value format date-time to property start_date of schema DeliveryDetailsPayload in request body

• [Breaking] [Added] Value format date-time to property end_date of schema DeliveryDetailsPayload in request body

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

getHistoricalReports

• What's New

• [Breaking] [Added] Value format date-time to property items[].filters.end_date of schema HistoryFilters in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].filters.start_date of schema HistoryFilters in response with status code 200

• [Breaking] [Added] Possible values kafka,rest,sqs,event_bridge,temporal,pub_sub to property items[].filters.webhook_type[] of schema HistoryFilters in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_on of schema HistoryItems in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_on of schema HistoryItems in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

getInvalidEventList

• What's New

• [Breaking] [Added] Value format date-time to property start_date of schema InvalidEventsPayload in request body

• [Breaking] [Added] Value format date-time to property end_date of schema InvalidEventsPayload in request body

fetchSubscribers

• What's New

• [Added] Possible nullable value true to property items[].custom_headers of schema ItemSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].updated_on of schema ItemSchema in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].created_on of schema ItemSchema in response with status code 200

• [Breaking] [Added] Possible values hmac to property items[].auth_meta.type of schema AuthMeta in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].created_on of schema EventConfigDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].updated_on of schema EventConfigDetails in response with status code 200

• [Breaking] [Added] Value format date-time to property items[].event_configs[].subscriber_event_mapping.created_on of schema SubscriberEventMapping in response with status code 200

• [Added] property items[].event_configs[].subscriber_event_mapping.broadcaster_config of schema SubscriberEventMapping in response with status code 200

• [Added] property page.limit of schema Page in response with status code 200

• [Added] property page.total of schema Page in response with status code 200

• What's Deprecated

• [Breaking] [Deleted] property items[].event_configs[].subscriber_event_mapping.topic of schema SubscriberEventMapping in response with status code 200

responseTimeSummary

• What's New

• [Added] method responseTimeSummary

Webhook Differences

Webhook Change Log

Compared against: 1.9.4-RC235H

Current version: 1.10.5

click category

add_to_cart event

add_to_cart/engagement/v1

• What's New

• [Added][Breaking] query field in add_to_cart_click_v1 schema marked as required.

• [Added][Breaking] New payload.query field in add_to_cart_click_v1 schema.

• [Added] New payload.utm_medium field in add_to_cart_click_v1 schema.

• [Added] New payload.utm_source field in add_to_cart_click_v1 schema.

• [Added] New payload.utm_campaign field in add_to_cart_click_v1 schema.

order_checkout event

order_checkout/conversion/v1

• What's New

• [Added][Breaking] order_id field in order_checkout_click_v1 schema marked as required.

• [Added][Breaking] New payload.order_id field in order_checkout_click_v1 schema.

product_search event

product_search/search/v1

• What's New

• [Added][Breaking] New payload.item_total field in product_search_click_v1 schema.

• [Added][Breaking] New payload.products field in product_search_click_v1 schema.

• [Added][Breaking] item_total field in product_search_click_v1 schema marked as required.

• [Added][Breaking] products field in product_search_click_v1 schema marked as required.

product_view event

product_view/click/v1

• What's New

• [Added][Breaking] query field in product_view_click_v1 schema marked as required.

• [Added][Breaking] New payload.query field in product_view_click_v1 schema.

• [Added] New payload.utm_medium field in product_view_click_v1 schema.

• [Added] New payload.utm_source field in product_view_click_v1 schema.

• [Added] New payload.utm_campaign field in product_view_click_v1 schema.

product_wishlist_add event

product_wishlist_add/engagement/v1

• What's New

• [Added][Breaking] New payload.position field in product_wishlist_add_click_v1 schema.

• [Added] New payload.utm_medium field in product_wishlist_add_click_v1 schema.

• [Added] New payload.utm_source field in product_wishlist_add_click_v1 schema.

• [Added] New payload.utm_campaign field in product_wishlist_add_click_v1 schema.

• [Added][Breaking] New payload.query field in product_wishlist_add_click_v1 schema.

• [Added][Breaking] query field in product_wishlist_add_click_v1 schema marked as required.

• [Added][Breaking] position field in product_wishlist_add_click_v1 schema marked as required.

order_checkedout

• What's New

• [Added] order_checkedout/conversion/v1 event added

product_listing

• What's New

• [Added] product_listing/impression/v1 event added

application category

article event

article/create/v1

• What's New

• [Added] New payload.articles.items.set field in article_create_v1 schema.

• [Added] New payload.articles.items.expiration_date field in article_create_v1 schema.

• [Added] New payload.articles.items.trace_id field in article_create_v1 schema.

• [Added] New payload.articles.items.discount_meta field in article_create_v1 schema.

• [Added] New payload.articles.items.stage field in article_create_v1 schema.

• [Added] New payload.articles.items.trader field in article_create_v1 schema.

• [Added] New payload.articles.items._custom_json field in article_create_v1 schema.

• [Added] New payload.articles.items.tags field in article_create_v1 schema.

article/delete/v1

• What's New

• [Added] New payload.articles.items.weight.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.price.updated_at field in article_delete_v1 schema.

• [Added] New payload.articles.items.dimension.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.quantities.order_committed field in article_delete_v1 schema.

• [Added] New payload.articles.items.manufacturer.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.set field in article_delete_v1 schema.

• [Added] New payload.articles.items.trader field in article_delete_v1 schema.

• [Added] New payload.articles.items._custom_json field in article_delete_v1 schema.

• [Added] New payload.articles.items.tags field in article_delete_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.articles.items.discount_applied field in article_delete_v1 schema removed.

article/update/v1

• What's New

• [Added] New payload.articles.items.weight.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.price.updated_at field in article_update_v1 schema.

• [Added] New payload.articles.items.dimension.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.quantities.order_committed field in article_update_v1 schema.

• [Added] New payload.articles.items.manufacturer.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.set field in article_update_v1 schema.

• [Added] New payload.articles.items.trader field in article_update_v1 schema.

• [Added] New payload.articles.items._custom_json field in article_update_v1 schema.

• [Added] New payload.articles.items.tags field in article_update_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.articles.items.discount_applied field in article_update_v1 schema removed.

cart event

cart/create/v1

• What's New

• [Added] New payload.cart.items.items.moq.increment_unit field in cart_create_v1 schema.

cart/update/v1

• What's New

• [Added] New payload.cart.items.items.moq.increment_unit field in cart_update_v1 schema.

collection event

collection/create/v2

• What's New

• [Added] New payload.collection.query.items.action field in collection_create_v2 schema.

• [Added] New payload.collection.query.items.item_id field in collection_create_v2 schema.

• [Added] New payload.collection.query.items.priority field in collection_create_v2 schema.

• [Added] New payload.collection.hidden_items field in collection_create_v2 schema.

• [Added] New payload.collection.pinned_items field in collection_create_v2 schema.

collection/update/v2

• What's New

• [Added] New payload.collection.query.items.action field in collection_update_v2 schema.

• [Added] New payload.collection.query.items.item_id field in collection_update_v2 schema.

• [Added] New payload.collection.query.items.priority field in collection_update_v2 schema.

• [Added] New payload.collection.hidden_items field in collection_update_v2 schema.

• [Added] New payload.collection.pinned_items field in collection_update_v2 schema.

coupon event

coupon/create/v1

• What's New

• [Added] New payload.coupon.author.approved_by field in coupon_create_v1 schema.

• [Added] New payload.coupon.author.rejected_by field in coupon_create_v1 schema.

• [Added] New payload.coupon.author.reviewed_by field in coupon_create_v1 schema.

• [Added] New payload.coupon.date_meta.approved_on field in coupon_create_v1 schema.

• [Added] New payload.coupon.date_meta.rejected_on field in coupon_create_v1 schema.

• [Added] New payload.coupon.date_meta.reviewed_on field in coupon_create_v1 schema.

• [Added] New payload.coupon.restrictions.payments field in coupon_create_v1 schema.

• [Added] New payload.coupon.restrictions.user_groups field in coupon_create_v1 schema.

• [Added][Breaking] status field in coupon_create_v1 schema marked as required.

• [Added][Breaking] New payload.coupon._schedule.status field in coupon_create_v1 schema.

• [Added] New payload.coupon._id field in coupon_create_v1 schema.

• [Added] New payload.coupon.coupon_type field in coupon_create_v1 schema.

• [Added] New payload.coupon.coupon_counts field in coupon_create_v1 schema.

• [Added] New payload.coupon.coupon_prefix field in coupon_create_v1 schema.

• [Added] New payload.coupon.reason field in coupon_create_v1 schema.

coupon/redeem/v1

• What's New

• [Added][Breaking] coupon_id field in coupon_redeem_v1 schema marked as required.

• [Added][Breaking] New payload.coupon.user_id field in coupon_redeem_v1 schema.

• [Added][Breaking] New payload.coupon.app_id field in coupon_redeem_v1 schema.

• [Added][Breaking] New payload.coupon.usage_count field in coupon_redeem_v1 schema.

• [Added] New payload.coupon._version field in coupon_redeem_v1 schema.

• [Added] New payload.coupon.order_quantity field in coupon_redeem_v1 schema.

• [Added][Breaking] New payload.coupon.coupon_id field in coupon_redeem_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.coupon.coupon field in coupon_redeem_v1 schema removed.

• [Removed][Breaking] payload.coupon.cart_id field in coupon_redeem_v1 schema removed.

• [Removed][Breaking] payload.coupon.coupon_value field in coupon_redeem_v1 schema removed.

coupon/update/v1

• What's New

• [Added] New payload.coupon.author.approved_by field in coupon_update_v1 schema.

• [Added] New payload.coupon.author.rejected_by field in coupon_update_v1 schema.

• [Added] New payload.coupon.author.reviewed_by field in coupon_update_v1 schema.

• [Added] New payload.coupon.date_meta.approved_on field in coupon_update_v1 schema.

• [Added] New payload.coupon.date_meta.rejected_on field in coupon_update_v1 schema.

• [Added] New payload.coupon.date_meta.reviewed_on field in coupon_update_v1 schema.

• [Added] New payload.coupon.restrictions.payments field in coupon_update_v1 schema.

• [Added] New payload.coupon.restrictions.user_groups field in coupon_update_v1 schema.

• [Added][Breaking] status field in coupon_update_v1 schema marked as required.

• [Added][Breaking] New payload.coupon._schedule.status field in coupon_update_v1 schema.

• [Added] New payload.coupon._id field in coupon_update_v1 schema.

• [Added] New payload.coupon.coupon_type field in coupon_update_v1 schema.

• [Added] New payload.coupon.coupon_counts field in coupon_update_v1 schema.

• [Added] New payload.coupon.coupon_prefix field in coupon_update_v1 schema.

• [Added] New payload.coupon.reason field in coupon_update_v1 schema.

coupon/create/v2

• What's New

• [Added] New message coupon/create/v2 added.

coupon/update/v2

• What's New

• [Added] New message coupon/update/v2 added.

courier-partner event

courier-partner/assign/v1

• What's New

• [Added][Breaking] New payload.courier-partner.pickup_details.lat field in courier-partner_assign_v1 schema.

• [Added][Breaking] New payload.courier-partner.pickup_details.long field in courier-partner_assign_v1 schema.

• [Added][Breaking] lat field in courier-partner_assign_v1 schema marked as required.

• [Added][Breaking] long field in courier-partner_assign_v1 schema marked as required.

• [Added][Breaking] lat field in courier-partner_assign_v1 schema marked as required.

• [Added][Breaking] long field in courier-partner_assign_v1 schema marked as required.

• [Added] New payload.courier-partner.shipment_details.items.items.imei field in courier-partner_assign_v1 schema.

• [Added] New payload.courier-partner.shipment_details.items.items.serial_number field in courier-partner_assign_v1 schema.

• [Added] New payload.courier-partner.shipment_details.items.items.identifiers field in courier-partner_assign_v1 schema.

courier-partner/ndr/v1

• What's New

• [Added] New message courier-partner/ndr/v1 added.

discount event

discount/create/v1

• What's Deprecated

• [Removed][Breaking] discount/create/v1 message removed.

discount/end/v1

• What's Deprecated

• [Removed][Breaking] discount/end/v1 message removed.

discount/start/v1

• What's Deprecated

• [Removed][Breaking] discount/start/v1 message removed.

discount/update/v1

• What's Deprecated

• [Removed][Breaking] discount/update/v1 message removed.

discount/create/v3

• What's New

• [Added] New message discount/create/v3 added.

discount/update/v3

• What's New

• [Added] New message discount/update/v3 added.

discount-item/create/v3

• What's New

• [Added] New message discount-item/create/v3 added.

discount-item/update/v3

• What's New

• [Added] New message discount-item/update/v3 added.

domain event

domain/create/v1

• What's New

• [Added][Breaking] display_name field in domain_create_v1 schema marked as required.

• [Added][Breaking] New payload.domain.display_name field in domain_create_v1 schema.

domain/delete/v1

• What's New

• [Added][Breaking] display_name field in domain_delete_v1 schema marked as required.

• [Added][Breaking] New payload.domain.display_name field in domain_delete_v1 schema.

order event

order/payment_failed/v1

• What's New

• [Added] New payload.order.shipments.items.bags.items.line_number field in order_payment_failed_v1 schema.

• [Added] New payload.order.shipments.items.bags.items.bag_id field in order_payment_failed_v1 schema.

• [Added] New payload.order.shipments.items.payment_info field in order_payment_failed_v1 schema.

order/pending/v1

• What's New

• [Added] New payload.order.shipments.items.bags.items.line_number field in order_pending_v1 schema.

• [Added] New payload.order.shipments.items.bags.items.bag_id field in order_pending_v1 schema.

• [Added] New payload.order.shipments.items.payment_info field in order_pending_v1 schema.

order/placed/v1

• What's New

• [Added] New payload.order.shipments.items.bags.items.line_number field in order_placed_v1 schema.

• [Added] New payload.order.shipments.items.bags.items.bag_id field in order_placed_v1 schema.

• [Added] New payload.order.shipments.items.payment_info field in order_placed_v1 schema.

payment address removed

payment

• What's Deprecated

• [Breaking][Removed] payment/complete/v1 event removed

• [Breaking][Removed] payment/failed/v1 event removed

• [Breaking][Removed] payment/pending/v1 event removed

product event

product/create/v2

• What's New

• [Added] New message product/create/v2 added.

product/delete/v2

• What's New

• [Added] New message product/delete/v2 added.

product/update/v2

• What's New

• [Added] New message product/update/v2 added.

promotion event

promotion/create/v1

• What's New

• [Added] New payload.promotion.author.approved_by field in promotion_create_v1 schema.

• [Added] New payload.promotion.author.rejected_by field in promotion_create_v1 schema.

• [Added] New payload.promotion.author.reviewed_by field in promotion_create_v1 schema.

• [Added][Breaking] New payload.promotion._schedule.status field in promotion_create_v1 schema.

• [Added] New payload.promotion.date_meta.approved_on field in promotion_create_v1 schema.

• [Added] New payload.promotion.date_meta.rejected_on field in promotion_create_v1 schema.

• [Added] New payload.promotion.date_meta.reviewed_on field in promotion_create_v1 schema.

• [Added] New payload.promotion.display_meta.offer_label field in promotion_create_v1 schema.

• [Added] New payload.promotion.restrictions.user_type field in promotion_create_v1 schema.

• [Added] New payload.promotion.restrictions.email_domain field in promotion_create_v1 schema.

• [Added] New payload.promotion.restrictions.ordering_stores field in promotion_create_v1 schema.

• [Added] New payload.promotion.reason field in promotion_create_v1 schema.

• [Added] New payload.promotion.visibility field in promotion_create_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.promotion.visiblility field in promotion_create_v1 schema removed.

promotion/update/v1

• What's New

• [Added] New payload.promotion.author.approved_by field in promotion_update_v1 schema.

• [Added] New payload.promotion.author.rejected_by field in promotion_update_v1 schema.

• [Added] New payload.promotion.author.reviewed_by field in promotion_update_v1 schema.

• [Added][Breaking] New payload.promotion._schedule.status field in promotion_update_v1 schema.

• [Added] New payload.promotion.date_meta.approved_on field in promotion_update_v1 schema.

• [Added] New payload.promotion.date_meta.rejected_on field in promotion_update_v1 schema.

• [Added] New payload.promotion.date_meta.reviewed_on field in promotion_update_v1 schema.

• [Added] New payload.promotion.display_meta.offer_label field in promotion_update_v1 schema.

• [Added] New payload.promotion.restrictions.user_type field in promotion_update_v1 schema.

• [Added] New payload.promotion.restrictions.email_domain field in promotion_update_v1 schema.

• [Added] New payload.promotion.restrictions.ordering_stores field in promotion_update_v1 schema.

• [Added] New payload.promotion.reason field in promotion_update_v1 schema.

• [Added] New payload.promotion.visibility field in promotion_update_v1 schema.

• [Added][Breaking] New payload.promotion.apply_all_discount field in promotion_update_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.promotion.visiblility field in promotion_update_v1 schema removed.

refund address removed

refund

• What's Deprecated

• [Breaking][Removed] refund/refund_done/v1 event removed

• [Breaking][Removed] refund/refund_failed/v1 event removed

• [Breaking][Removed] refund/refund_initiated/v1 event removed

• [Breaking][Removed] refund/refund_pending/v1 event removed

seo event

seo/update/v1

• What's Deprecated

• [Removed][Breaking] sitemap_enabled field in seo_update_v1 schema removed from required.

• [Removed][Breaking] payload.seo.sitemap_enabled field in seo_update_v1 schema removed.

shipment event

shipment/create/v1

• What's New

• [Added] New payload.shipment.article_details field in shipment_create_v1 schema.

• [Added] New payload.shipment.is_active field in shipment_create_v1 schema.

• [Added] New payload.shipment.shipment_meta field in shipment_create_v1 schema.

• [Added] New payload.shipment.transaction_meta field in shipment_create_v1 schema.

• [Added] New payload.shipment.meta field in shipment_create_v1 schema.

• [Added] New payload.shipment.forward_end_shipment_id field in shipment_create_v1 schema.

• [Added] New payload.shipment.charges field in shipment_create_v1 schema.

• [Added] New payload.shipment.total_shipments_in_order field in shipment_create_v1 schema.

shipment/data_update/v1

• What's New

• [Added] New payload.shipment.article_details field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.is_active field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.shipment_meta field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.transaction_meta field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.meta field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.forward_end_shipment_id field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.charges field in shipment_data_update_v1 schema.

• [Added] New payload.shipment.total_shipments_in_order field in shipment_data_update_v1 schema.

shipment/update/v1

• What's New

• [Added] New payload.shipment.article_details field in shipment_update_v1 schema.

• [Added] New payload.shipment.is_active field in shipment_update_v1 schema.

• [Added] New payload.shipment.shipment_meta field in shipment_update_v1 schema.

• [Added] New payload.shipment.transaction_meta field in shipment_update_v1 schema.

• [Added] New payload.shipment.meta field in shipment_update_v1 schema.

• [Added] New payload.shipment.forward_end_shipment_id field in shipment_update_v1 schema.

• [Added] New payload.shipment.charges field in shipment_update_v1 schema.

• [Added] New payload.shipment.total_shipments_in_order field in shipment_update_v1 schema.

user event

user/create/v1

• What's New

• [Added] New payload.items.user.rr_id field in user_create_v1 schema.

user/delete/v1

• What's New

• [Added] New payload.items.user.rr_id field in user_delete_v1 schema.

• What's Deprecated

• [Removed][Breaking] category field in user_delete_v1 schema removed from required.

• [Removed][Breaking] id field in user_delete_v1 schema removed from required.

• [Removed][Breaking] event.category field in user_delete_v1 schema removed.

• [Removed][Breaking] event.id field in user_delete_v1 schema removed.

user/update/v1

• What's New

• [Added] New payload.items.user.rr_id field in user_update_v1 schema.

• What's Deprecated

• [Removed][Breaking] category field in user_update_v1 schema removed from required.

• [Removed][Breaking] id field in user_update_v1 schema removed from required.

• [Removed][Breaking] event.category field in user_update_v1 schema removed.

• [Removed][Breaking] event.id field in user_update_v1 schema removed.

zone

• What's New

• [Added] zone/create/v1 event added

• [Added] zone/delete/v1 event added

• [Added] zone/update/v1 event added

customer_credit_note_configuration

• What's New

• [Added] customer_credit_note_configuration/create/v1 event added

• [Added] customer_credit_note_configuration/update/v1 event added

customfield_definition

• What's New

• [Added] customfield_definition/create/v1 event added

• [Added] customfield_definition/delete/v1 event added

• [Added] customfield_definition/update/v1 event added

customfields

• What's New

• [Added] customfields/bag-update/v1 event added

• [Added] customfields/coupon-update/v1 event added

• [Added] customfields/product-update/v1 event added

• [Added] customfields/promotion-update/v1 event added

customobject_definition

• What's New

• [Added] customobject_definition/create/v1 event added

• [Added] customobject_definition/delete/v1 event added

• [Added] customobject_definition/update/v1 event added

customobjects

• What's New

• [Added] customobjects/create/v1 event added

• [Added] customobjects/update/v1 event added

• [Added] customobjects/delete/v1 event added

price_factory

• What's New

• [Added] price_factory/create/v1 event added

• [Added] price_factory/update/v1 event added

product-price

• What's New

• [Added] product-price/update/v1 event added

return_config

• What's New

• [Added] return_config/update/v1 event added

return_config_categories

• What's New

• [Added] return_config_categories/update/v1 event added

• [Added] return_config_categories/delete/v1 event added

sitemap

• What's New

• [Added] sitemap_config/update/v1 event added

user_groups

• What's New

• [Added] user_groups/create/v1 event added

• [Added] user_groups/update/v1 event added

company category

article event

article/create/v1

• What's New

• [Added] New payload.articles.items.price.updated_at field in article_create_v1 schema.

• [Added] New payload.articles.items.dimension.is_default field in article_create_v1 schema.

• [Added] New payload.articles.items.quantities.order_committed field in article_create_v1 schema.

• [Added] New payload.articles.items.manufacturer.is_default field in article_create_v1 schema.

• [Added] New payload.articles.items.trader field in article_create_v1 schema.

• [Added] New payload.articles.items.set field in article_create_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.articles.items.fynd_article_code field in article_create_v1 schema removed.

article/delete/v1

• What's New

• [Added] New payload.articles.items.price.updated_at field in article_delete_v1 schema.

• [Added] New payload.articles.items.weight.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.dimension.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.quantities.order_committed field in article_delete_v1 schema.

• [Added] New payload.articles.items.manufacturer.is_default field in article_delete_v1 schema.

• [Added] New payload.articles.items.trader field in article_delete_v1 schema.

• [Added] New payload.articles.items.set field in article_delete_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.articles.items.fynd_article_code field in article_delete_v1 schema removed.

article/update/v1

• What's New

• [Added] New payload.articles.items.price.updated_at field in article_update_v1 schema.

• [Added] New payload.articles.items.weight.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.dimension.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.quantities.order_committed field in article_update_v1 schema.

• [Added] New payload.articles.items.manufacturer.is_default field in article_update_v1 schema.

• [Added] New payload.articles.items.trader field in article_update_v1 schema.

• [Added] New payload.articles.items.set field in article_update_v1 schema.

• What's Deprecated

• [Removed][Breaking] payload.articles.items.fynd_article_code field in article_update_v1 schema removed.

theme

• What's New

• [Added] theme/install/v1 event added

• [Added] theme/remove/v1 event added

brand event

brand/update/v1

• What's New

• [Added][Breaking] description field in brand_update_v1 schema marked as required.

• [Added][Breaking] _locale_language field in brand_update_v1 schema marked as required.

company event

company/create/v2

• What's New

• [Added] New message company/create/v2 added.

company/update/v2

• What's New

• [Added] New message company/update/v2 added.

location event

location/create/v1

• What's New

• [Added] New payload.location.is_hyperlocal_active field in location_create_v1 schema.

location/update/v1

• What's New

• [Added] New payload.location.is_hyperlocal_active field in location_update_v1 schema.

location/create/v2

• What's New

• [Added] New message location/create/v2 added.

location/update/v2

• What's New

• [Added] New message location/update/v2 added.

product-size event

product-size/create/v1

• What's New

• [Added] New payload.product-size.items.product field in product-size_create_v1 schema.

product-size/update/v1

• What's New

• [Added] New payload.product-size.items.product field in product-size_update_v1 schema.

zone address removed

zone

• What's Deprecated

• [Breaking][Removed] zone/create/v1 event removed

• [Breaking][Removed] zone/update/v1 event removed

customfield_definition

• What's New

• [Added] customfield_definition/create/v1 event added

• [Added] customfield_definition/delete/v1 event added

• [Added] customfield_definition/update/v1 event added

customfields

• What's New

• [Added] customfields/inventory-delete/v1 event added

• [Added] customfields/inventory-update/v1 event added

• [Added] customfields/product-delete/v1 event added

• [Added] customfields/product-update/v1 event added

• [Added] customfields/product-size-delete/v1 event added

• [Added] customfields/product-size-update/v1 event added

• [Added] customfields/selling-location-update/v1 event added

customobject_definition

• What's New

• [Added] customobject_definition/create/v1 event added

• [Added] customobject_definition/delete/v1 event added

• [Added] customobject_definition/update/v1 event added

customobjects

• What's New

• [Added] customobjects/create/v1 event added

• [Added] customobjects/update/v1 event added

• [Added] customobjects/delete/v1 event added

product_bundle

• What's New

• [Added] product_bundle/create/v1 event added

• [Added] product_bundle/update/v1 event added