Skip to main content

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
  • 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

  • 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

  • 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

  • What's New

    • [Added] method getAllNamespaceDetails

  • What's New

    • [Added] method getNamespaceDetail

  • What's New

    • [Added] method browseFiles

  • What's New

    • [Added] method organizationLevelFetchProxy

  • What's New

    • [Added] method saveOrganizationLevelProxy

  • What's New

    • [Added] method fetchProxy

  • 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
  • What's New

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

  • 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

  • What's New

    • [Added] Response with status 400

  • 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 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 Changed

    • [Breaking] [Changed] company_id made optional in response with status code 200

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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
  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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}

  • 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}

  • 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}

  • 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

  • What's New

    • [Added] property theme_type of schema MarketplaceTheme in response with status code 200

  • 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

  • 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

  • What's New

    • [Added] property theme_type of schema MarketplaceTheme in response with status code 200

  • What's New

    • [Added] property [].theme_type of schema MarketplaceTheme in response with status code 200

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • What's New

    • [Added] method getExtensionbinding

  • What's New

    • [Added] method getOrgnaizationDefaultTheme

  • What's New

    • [Added] method getSystemPage

  • 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

  • What's New

    • [Added] method responseTimeSummary


Was this section helpful?