Skip to main content

API Change Log - Catalog

🧩 Service: Catalog​

🔧 Operation: getCatalogInsights​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogInsights.methodTypePlaceHolder.responses.4XX

🔹 Change 2​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogInsights.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/analytics/insights"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogInsights.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: getApplicationBrandListing​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> ApplicationBrandListingItemSchema
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_on

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema
  • Schema Action: REQUIRED_ADDED
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.required
  • New Schema:
[
"page"
]

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.type
  • New Schema:
"object"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"page_size": [
"Must be greater than or equal to 1."
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.responses.4XX

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrandListing.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: updateAppBrand​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppBrand.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppBrand.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppBrand.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppBrand.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Brand : 99 for Company : 99"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppBrand.methodTypePlaceHolder.responses.4XX

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppBrand.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/brands/write"
]
}
]

🔧 Operation: getApplicationBrands​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: BrandListingResponseSchema --> BrandItem
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.departments.items.type
  • New Schema:
"integer"

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: BrandListingResponse --> BrandItem --> BrandMedia
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.properties.aspect_ratio

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: BrandListingResponseSchema --> BrandItem --> BrandLogo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.type
  • New Schema:
"object"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: BrandListingResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_on
  • New Schema:
{
"type": "string",
"format": "date-time",
"description": "Timestamp when the brand was last modified."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Department not Found"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.responses.4XX

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationBrands.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getCategories​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCategories.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCategories.methodTypePlaceHolder.responses.4XX

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCategories.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getApplicationCategoryListing​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.email
  • New Schema:
{
"description": "The email address of the user.",
"format": "email",
"type": "string"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.uid
  • New Schema:
{
"description": "The unique ID of the user.",
"type": "string"
}

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.type
  • New Schema:
"object"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_by.properties.email
  • New Schema:
{
"description": "The email address of the user.",
"format": "email",
"type": "string"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_by.properties.uid
  • New Schema:
{
"description": "The unique ID of the user.",
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_by.type
  • New Schema:
"object"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.responses.4XX

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationCategoryListing.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: updateAppCategory​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppCategory.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppCategory.methodTypePlaceHolder.parameters.2.schema.type
  • New Schema:
"integer"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppCategory.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppCategory.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppCategory.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Brand : 99 for Company : 99"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppCategory.methodTypePlaceHolder.responses.4XX

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppCategory.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/properties/read"
]
}
]

🔧 Operation: getAllCollections​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAllCollections.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.parameters.5
  • New Schema:
{
"description": "Each response will contain next_id param, which should be sent back to make pagination work.",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"success": {
"value": [
"Test Collection 123"
]
}
}
}

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.badge.properties

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._id

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.published

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.tags

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.sort_on

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._custom_json

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._locale_language

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo

🔹 Change 17​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponse --> GetCollectionDetailNest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_visible

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.cron
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 20​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.responses.4XX

🔹 Change 21​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections"

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllCollections.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: createCollection​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createCollection.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.required.0

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBadge
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.badge.additionalProperties
  • New Schema:
true

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.required

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.required

🔹 Change 13​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_by.allOf

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_by.properties
  • New Schema:
{
"email": {
"description": "The email address of the user.",
"format": "email",
"type": "string"
},
"uid": {
"description": "The unique ID of the user.",
"type": "string"
},
"user_id": {
"description": "The ID of the user.",
"type": "string"
},
"username": {
"description": "The username of the user.",
"type": "string"
}
}

🔹 Change 15​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_by.type
  • New Schema:
"object"

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 18​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.required

🔹 Change 19​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 20​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.modified_by.allOf

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.modified_by.properties
  • New Schema:
{
"email": {
"description": "The email address of the user.",
"format": "email",
"type": "string"
},
"uid": {
"description": "The unique ID of the user.",
"type": "string"
},
"user_id": {
"description": "The ID of the user.",
"type": "string"
},
"username": {
"description": "The username of the user.",
"type": "string"
}
}

🔹 Change 22​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.modified_by.type
  • New Schema:
"object"

🔹 Change 23​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.sitemap.properties
  • New Schema:
{
"priority": {
"type": "number"
},
"frequency": {
"type": "string"
}
}

🔹 Change 25​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 26​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.items

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 28​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 29​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 30​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 31​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 32​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 33​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 34​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 35​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection
  • Schema Action: ENUM_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.type.enum

🔹 Change 36​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.is_searchable
  • New Schema:
{
"type": "boolean"
}

🔹 Change 37​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.badge.properties
  • New Schema:
{
"color": {
"description": "The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).",
"type": "string"
},
"text": {
"description": "The text displayed on the badge, which may indicate a label or promotion related to the collection.",
"type": "string"
}
}

🔹 Change 40​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse --> ImageUrls --> BannerImage
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.landscape.properties.aspect_ratio

🔹 Change 41​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.landscape.properties.url.format

🔹 Change 42​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse --> ImageUrls --> BannerImage
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.portrait.properties.aspect_ratio

🔹 Change 43​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.portrait.properties.url.format

🔹 Change 44​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_active.default
  • New Schema:
true

🔹 Change 45​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse --> ImageUrls --> BannerImage
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.aspect_ratio

🔹 Change 46​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.url.format

🔹 Change 47​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.meta.default
  • New Schema:
{}

🔹 Change 48​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.priority.default
  • New Schema:
99999

🔹 Change 49​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 50​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.query.default
  • New Schema:
[]

🔹 Change 51​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.tag

🔹 Change 52​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.published

🔹 Change 53​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._custom_json.default
  • New Schema:
{}

🔹 Change 54​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._locale_language.default
  • New Schema:
{}

🔹 Change 55​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.sitemap.properties
  • New Schema:
{
"priority": {
"type": "number"
},
"frequency": {
"type": "string"
}
}

🔹 Change 56​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 57​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.items

🔹 Change 58​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 59​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 60​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 61​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 62​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 63​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 64​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 65​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 66​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_visible

🔹 Change 67​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.id

🔹 Change 68​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cron
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 69​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CollectionCreateResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_searchable
  • New Schema:
{
"type": "boolean"
}

🔹 Change 70​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"slug": "Slug already used."
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 71​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.responses.4XX

🔹 Change 72​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections"

🔹 Change 73​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCollection.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: getApplicationFilterValues​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.currency_code

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.currency_symbol

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.display_format

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.max

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.min

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.query_format

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.selected_max

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.selected_min

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponseSchema --> ProductQueryFiltersValue
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.value.type
  • New Schema:
"string"

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponseSchema --> ProductQueryFiltersValue
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.properties.logo
  • New Schema:
{
"type": "string",
"format": "url",
"description": "URL of the logo image associated with the category."
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersValuesResponse --> ProductFiltersValue
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.values.items.required

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.responses.4XX

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationFilterValues.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getApplicationFilterKeys​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersKeysResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getApplicationFilterKeys.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationFilterKeys.methodTypePlaceHolder.responses.4XX

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationFilterKeys.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getQueryFilters​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.currency_code

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.currency_symbol

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.display_format

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.max

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.min

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.query_format

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.selected_max

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters --> ProductFiltersValue
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.selected_min

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponseSchema --> CollectionProductFilters --> CollectionProductFiltersValue
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.value.type
  • New Schema:
"string"

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponseSchema --> CollectionProductFilters --> CollectionProductFiltersValue
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.properties.values.items.properties.logo
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse --> ProductFilters
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters.items.required

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponseSchema --> CollectionProductSortOn
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.sort_on.items.properties.logo
  • New Schema:
{
"type": "string",
"format": "url",
"description": "URL to the logo image representing the sorting option."
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetQueryFiltersResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getQueryFilters.methodTypePlaceHolder.responses.4XX

🔹 Change 16​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getQueryFilters.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/query-options"

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getQueryFilters.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: deleteCollection​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.deleteCollection.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteCollection.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteCollection.methodTypePlaceHolder.responses.4XX

🔹 Change 4​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteCollection.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteCollection.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: updateCollection​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateCollection.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._locale_language.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBadge
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.badge.additionalProperties
  • New Schema:
true

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.landscape.required

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.banners.properties.portrait.required

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 15​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.logo.required

🔹 Change 16​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 17​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.sitemap.properties
  • New Schema:
{
"priority": {
"type": "number"
},
"frequency": {
"type": "string"
}
}

🔹 Change 19​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection --> CollectionSeoDetail --> ApplicationCollectionItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.items.properties.page.additionalProperties
  • New Schema:
true

🔹 Change 20​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 21​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 24​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 25​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.action
  • New Schema:
{
"$ref": "#/components/schemas/Action"
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.app_id
  • New Schema:
{
"type": "string"
}

🔹 Change 29​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.is_searchable
  • New Schema:
{
"type": "boolean"
}

🔹 Change 30​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 31​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._locale_language.additionalProperties
  • New Schema:
true

🔹 Change 32​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 33​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 34​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBadge
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.badge.additionalProperties
  • New Schema:
true

🔹 Change 35​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.landscape.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 36​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.landscape.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 37​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.landscape.required

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.portrait.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.portrait.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 40​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.banners.properties.portrait.required

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.secure_url
  • New Schema:
{
"type": "string"
}

🔹 Change 42​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 43​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBanner --> CollectionImage
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.required

🔹 Change 44​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 45​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 46​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.sitemap.properties
  • New Schema:
{
"priority": {
"type": "number"
},
"frequency": {
"type": "string"
}
}

🔹 Change 47​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection --> CollectionSeoDetail --> ApplicationCollectionItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.items.properties.page.additionalProperties
  • New Schema:
true

🔹 Change 48​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 49​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 50​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 51​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 52​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 53​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 54​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.action
  • New Schema:
{
"$ref": "#/components/schemas/Action"
}

🔹 Change 55​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 56​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.app_id
  • New Schema:
{
"type": "string"
}

🔹 Change 57​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdateCollection
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_searchable
  • New Schema:
{
"type": "boolean"
}

🔹 Change 58​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"seo": {
"sitemap": {
"frequency": [
"Must be one of: always, hourly, daily, weekly, monthly, yearly, never."
]
}
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 59​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.responses.4XX

🔹 Change 60​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{id}"

🔹 Change 61​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateCollection.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: getCollectionItems​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.parameters.4
  • New Schema:
{
"description": "Number of items that are pinned and have priority in each page. Default is 12.",
"in": "query",
"name": "is_pinned",
"required": false,
"schema": {
"type": "boolean"
},
"examples": {
"success": {
"value": true
},
"failure": {
"value": false
}
}
}

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.parameters.7
  • New Schema:
{
"description": "Get multiple products filtered by q string",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "brown"
}
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.parameters.8
  • New Schema:
{
"description": "Number of items that are excluded from collections in each page. Default is 12.",
"in": "query",
"name": "is_excluded",
"required": false,
"schema": {
"type": "boolean"
},
"examples": {
"success": {
"value": true
},
"failure": {
"value": false
}
}
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponse --> ProductListingDetail
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.grouped_attributes

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.image_nature.enum
  • New Schema:
[
"default",
"standard"
]

🔹 Change 11​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.item_type.enum
  • New Schema:
[
"composite",
"digital",
"packaging",
"set",
"standard"
]

🔹 Change 12​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 15​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice --> Price1 --> CurrencyCodeEnum
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.effective.properties.currency_code.enum
  • New Schema:
[
"INR",
"USD",
"EUR"
]

🔹 Change 16​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice --> Price1 --> CurrencyCodeEnum
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.marked.properties.currency_code.enum
  • New Schema:
[
"INR",
"USD",
"EUR"
]

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.selling
  • New Schema:
{
"$ref": "#/components/schemas/Price1"
}

🔹 Change 18​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponse --> ProductListingDetail --> ProductListingPrice
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.type

🔹 Change 19​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.teaser_tag.type
  • New Schema:
"string"

🔹 Change 20​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 21​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.items

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 23​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.popularity
  • New Schema:
{
"type": "integer",
"description": "A numerical value indicating the popularity of the product."
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand_uid
  • New Schema:
{
"type": "integer",
"description": "The unique identifier for the brand associated with the product."
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.category_uid
  • New Schema:
{
"type": "integer",
"description": "The unique identifier for the category to which the product belongs."
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.verification_status
  • New Schema:
{
"type": "integer",
"description": "The verification status of the product, typically represented as an integer."
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.channel_identifier
  • New Schema:
{
"type": "string",
"description": "The identifier for the sales channel through which the product is sold."
}

🔹 Change 29​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.category_slug
  • New Schema:
{
"type": "string",
"description": "A URL-friendly string representing the product's category."
}

🔹 Change 30​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.size_guide
  • New Schema:
{
"type": "string",
"description": "A guide or chart providing size information for the product."
}

🔹 Change 31​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.l3_categories
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of L3 category IDs of the product."
}

🔹 Change 32​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_ids
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of store IDs where the product is available."
}

🔹 Change 33​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company_ids
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of company IDs associated with the product."
}

🔹 Change 34​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.departments
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of department IDs where the product is categorized."
}

🔹 Change 35​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.tags
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of tags or keywords associated with the product."
}

🔹 Change 36​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.l3_category_names
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of names of L3 categories of the product."
}

🔹 Change 37​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.sizes
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of available sizes for the product."
}

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.product_group_tag
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "Tags that group the product with other similar products."
}

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.multi_size
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is available in multiple sizes."
}

🔹 Change 40​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_gift
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product can be considered as a gift."
}

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_cod
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is eligible for cash on delivery (COD)."
}

🔹 Change 42​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_dependent
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product depends on another product."
}

🔹 Change 43​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_available
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is currently available for purchase."
}

🔹 Change 44​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variants
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "An object containing details about the product variants."
}

🔹 Change 45​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variant_media
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Media items specific to the product variants."
}

🔹 Change 46​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variant_group
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "A group identifier for products that are variants of one another."
}

🔹 Change 47​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.multi_categories
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MultiCategoriesSchema"
}
}

🔹 Change 48​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.template_tag
  • New Schema:
{
"type": "string",
"description": "Tag used for categorizing or templating purposes."
}

🔹 Change 49​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.net_quantity
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Net quantity details for the product."
}

🔹 Change 50​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_order
  • New Schema:
{
"$ref": "#/components/schemas/CustomOrder"
}

🔹 Change 51​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.country_of_origin
  • New Schema:
{
"type": "string",
"description": "Country where the product is manufactured or sourced from."
}

🔹 Change 52​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._custom_json
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Custom JSON data associated with the product."
}

🔹 Change 53​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.identifiers
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "Identifiers associated with the product."
}

🔹 Change 54​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.item_id
  • New Schema:
{
"type": "integer",
"description": "Unique identifier for the item."
}

🔹 Change 55​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._custom_meta
  • New Schema:
{
"description": "Custom meta associated with the product.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomMeta"
}
}

🔹 Change 56​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.discount_percentage
  • New Schema:
{
"type": "integer",
"description": "The discount applied to the product in percentage."
}

🔹 Change 57​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.1
  • New Schema:
"name"

🔹 Change 58​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.2
  • New Schema:
"is_dependent"

🔹 Change 59​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.3
  • New Schema:
"uid"

🔹 Change 60​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.4
  • New Schema:
"category_uid"

🔹 Change 61​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.5
  • New Schema:
"item_code"

🔹 Change 62​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.6
  • New Schema:
"multi_size"

🔹 Change 63​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.7
  • New Schema:
"brand_uid"

🔹 Change 64​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.8
  • New Schema:
"country_of_origin"

🔹 Change 65​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.9
  • New Schema:
"item_type"

🔹 Change 66​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.10
  • New Schema:
"departments"

🔹 Change 67​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.11
  • New Schema:
"image_nature"

🔹 Change 68​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.12
  • New Schema:
"moq"

🔹 Change 69​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.13
  • New Schema:
"seo"

🔹 Change 70​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.14
  • New Schema:
"is_cod"

🔹 Change 71​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.15
  • New Schema:
"is_gift"

🔹 Change 72​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.16
  • New Schema:
"is_available"

🔹 Change 73​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.17
  • New Schema:
"l3_categories"

🔹 Change 74​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 75​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Collection Not Found"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 76​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.responses.4XX

🔹 Change 77​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/collections/{id}/items"

🔹 Change 78​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionItems.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: addCollectionItems​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.addCollectionItems.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CollectionItemUpdateSchema --> CollectionQuerySchemaV2
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.addCollectionItems.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addCollectionItems.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request",
"errors": {
"items": {
"0": {
"priority": [
"Must be greater than or equal to -1 and less than or equal to 100."
]
}
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addCollectionItems.methodTypePlaceHolder.responses.4XX

🔹 Change 5​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addCollectionItems.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/collections/{id}/items"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addCollectionItems.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: getCollectionDetail​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.end.format

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionSchedule --> NextSchedule
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._schedule.properties.next_schedule.items.properties.start.nullable
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> CollectionBadge
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.badge.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.logo.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 8​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> CollectionQuery
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.query.items.properties.value.items.type
  • New Schema:
"string"

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.sitemap.properties
  • New Schema:
{
"priority": {
"type": "number"
},
"frequency": {
"type": "string"
}
}

🔹 Change 10​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.items

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 13​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 18​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 19​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionDetailResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cron
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionDetailResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties._id
  • New Schema:
{
"type": "string",
"description": "A unique identifier for the collection, matching `uid`."
}

🔹 Change 22​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.responses.4XX

🔹 Change 23​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/collections/{slug}"

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCollectionDetail.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: getApplicationDepartmentListing​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getApplicationDepartmentListing.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getApplicationDepartmentListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationDepartmentListing.methodTypePlaceHolder.responses.4XX

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getApplicationDepartmentListing.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/properties/read"
]
}
]

🔧 Operation: updateAppDepartment​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.parameters.2.schema.type
  • New Schema:
"integer"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationDepartmentJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationDepartmentJson
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Department : 99 for Company : 1"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.responses.4XX

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppDepartment.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/properties/read"
]
}
]

🔧 Operation: getDepartments​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getDepartments.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDepartments.methodTypePlaceHolder.responses.4XX

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getDepartments.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getAppInventory​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAppInventory.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppInventory.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"timestamp": [
"Not a valid datetime."
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body to know the exact reason."
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppInventory.methodTypePlaceHolder.responses.4XX

🔹 Change 4​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppInventory.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/inventory"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppInventory.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getAppLocations​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAppLocations.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: ENUM_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.parameters.2.schema.enum
  • New Schema:
[
"high_street",
"warehouse",
"mall"
]

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.parameters.10
  • New Schema:
{
"description": "Filter stores by company IDs available in the application.",
"in": "query",
"name": "company_uids",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"examples": {
"success": {
"value": [
1
]
}
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: LocationListSerializer --> GetLocationSerializer
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.code

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.created_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.created_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.modified_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.modified_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.modified_on.format
  • New Schema:
"date-time"

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.verified_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.verified_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 17​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_type.enum
  • New Schema:
[
"high_street",
"warehouse",
"mall"
]

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.verified_by.properties._id
  • New Schema:
{
"type": "string"
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema --> UserSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.verified_by.properties.uid
  • New Schema:
{
"type": "string"
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_code
  • New Schema:
{
"type": "string",
"description": "Unique identifier code for the store.",
"x-not-enum": true
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company_id
  • New Schema:
{
"type": "integer",
"description": "ID of the company to which this store belongs."
}

🔹 Change 22​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema --> GetLocationSchema
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.1
  • New Schema:
"store_code"

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: LocationListSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.filters
  • New Schema:
{
"items": {
"type": "object"
},
"type": "array"
}

🔹 Change 25​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.responses.4XX

🔹 Change 26​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/locations"

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppLocations.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getConfigurations​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getConfigurations.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.created_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationListing
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.listing.required

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.modified_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.details_groups
  • New Schema:
{
"$ref": "#/components/schemas/ConfigurationProductDetailsGroups"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.required

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurations.methodTypePlaceHolder.responses.4XX

🔹 Change 8​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurations.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration"

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurations.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: createConfigurationProductListing​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: AppConfiguration
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_by.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationListing
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.listing.required

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: AppConfiguration
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.modified_by.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.product.properties.details_groups
  • New Schema:
{
"$ref": "#/components/schemas/ConfigurationProductDetailsGroups"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.product.required

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.created_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationListing
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.listing.required

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.modified_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.details_groups
  • New Schema:
{
"$ref": "#/components/schemas/ConfigurationProductDetailsGroups"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.required

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"product": {
"similar": {
"config": {
"0": {
"name": [
"Unknown field."
]
}
}
}
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.responses.4XX

🔹 Change 14​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration"

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationProductListing.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: getCatalogConfiguration​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.product.properties.compare.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterItem"
}
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.product.properties.detail.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterItem"
}
},
"values": {
"$ref": "#/components/schemas/DetailFilterValues"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.product.properties.similar.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimilarItem"
}
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.product.properties.variant.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItem"
}
}
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.responses.4XX

🔹 Change 7​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/metadata"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCatalogConfiguration.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: getConfigurationByType​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.compare.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterItem"
}
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.detail.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterItem"
}
},
"values": {
"$ref": "#/components/schemas/DetailFilterValues"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.similar.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimilarItem"
}
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.variant.properties
  • New Schema:
{
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantItem"
}
}
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogEntityConfiguration --> EntityConfiguration
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.required

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.responses.4XX

🔹 Change 8​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}"

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getConfigurationByType.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]

🔧 Operation: createConfigurationByType​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: AppConfiguration
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_by.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationListing
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.listing.required

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: AppConfiguration
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.modified_by.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.product.properties.details_groups
  • New Schema:
{
"$ref": "#/components/schemas/ConfigurationProductDetailsGroups"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.product.required

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.created_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationListing
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.listing.required

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.modified_by.allOf
  • New Schema:
[
{
"$ref": "#/components/schemas/UserSchema"
}
]

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.properties.details_groups
  • New Schema:
{
"$ref": "#/components/schemas/ConfigurationProductDetailsGroups"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetAppCatalogConfiguration --> AppCatalogConfiguration --> ConfigurationProduct
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.product.required

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.responses.4XX

🔹 Change 13​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/{type}"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createConfigurationByType.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: getAppProduct​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAppProduct.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAppProduct.methodTypePlaceHolder.parameters.2.schema.type
  • New Schema:
"integer"

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.breadcrumbs.items.properties.action.items

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.properties.key

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.properties.value

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.properties.title
  • New Schema:
{
"type": "string"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.properties.items
  • New Schema:
{
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTagItem"
},
"type": "array"
}

🔹 Change 11​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTags
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.required.0
  • New Schema:
"title"

🔹 Change 12​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> Metatags --> ApplicationItemSeoMetaTagItem
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.seo.allOf.0.properties.meta_tags.items.properties.items.items.required.1

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppProduct.methodTypePlaceHolder.responses.4XX

🔹 Change 14​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppProduct.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}"

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAppProduct.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]

🔧 Operation: updateAppProduct​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.parameters.0.schema.type
  • New Schema:
"integer"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.parameters.2.schema.type
  • New Schema:
"integer"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationItemMeta
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationItemMeta
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.alt_text.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.moq.allOf

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.moq.properties
  • New Schema:
{
"increment_unit": {
"default": 1,
"description": "The minimum quantity increment in which the item can be purchased.",
"minimum": 1,
"type": "integer"
},
"maximum": {
"description": "The maximum quantity allowed for purchase.",
"type": "integer"
},
"minimum": {
"default": 1,
"description": "The minimum quantity required for purchase.",
"minimum": 1,
"type": "integer"
}
}

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationItemMeta --> ApplicationItemMOQ
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.moq.type
  • New Schema:
"object"

🔹 Change 8​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.allOf

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.properties
  • New Schema:
{
"description": {
"description": "The SEO description of the item",
"type": "string"
},
"title": {
"description": "The SEO title of the item",
"type": "string"
},
"sitemap": {
"$ref": "#/components/schemas/ApplicationItemSeoSitemap"
},
"breadcrumbs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoBreadcrumbs"
}
},
"meta_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationItemSeoMetaTags"
}
},
"canonical_url": {
"type": "string"
}
}

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationItemMeta --> ApplicationItemSEO
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.seo.type
  • New Schema:
"object"

🔹 Change 11​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.size_promotion_threshold.allOf

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.size_promotion_threshold.properties
  • New Schema:
{
"threshold_type": {
"type": "string",
"x-not-enum": true,
"description": "The type of threshold that applies to the size promotion, such as 'quantity' or 'value'."
},
"threshold_value": {
"type": "integer",
"description": "The value of the threshold required to trigger the promotion, such as a minimum number of units."
}
}

🔹 Change 13​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationItemMeta --> SizePromotionThreshold
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.updateAppProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.size_promotion_threshold.type
  • New Schema:
"object"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.responses.400
  • New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Product : 2 for Company : 99"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.responses.4XX

🔹 Change 16​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product/{item_id}"

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateAppProduct.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/products/write"
]
}
]

🔧 Operation: ::action:-:OPERATION_ID_UPDATED::​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.logo.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponse --> ProductListingDetail
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.grouped_attributes

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.image_nature.enum
  • New Schema:
[
"default",
"standard"
]

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.item_type.enum
  • New Schema:
[
"composite",
"digital",
"packaging",
"set",
"standard"
]

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.medias.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice --> Price1 --> CurrencyCodeEnum
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.effective.properties.currency_code.enum
  • New Schema:
[
"INR",
"USD",
"EUR"
]

🔹 Change 11​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice --> Price1 --> CurrencyCodeEnum
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.marked.properties.currency_code.enum
  • New Schema:
[
"INR",
"USD",
"EUR"
]

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema --> ProductListingPrice
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.properties.selling
  • New Schema:
{
"$ref": "#/components/schemas/Price1"
}

🔹 Change 13​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponse --> ProductListingDetail --> ProductListingPrice
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.price.type

🔹 Change 14​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.teaser_tag.type
  • New Schema:
"string"

🔹 Change 15​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.type
  • New Schema:
"object"

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs
  • Schema Action: ITEMS_REMOVED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.items

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.properties
  • New Schema:
{
"page": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}

🔹 Change 18​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateCollection --> SeoDetail --> ApplicationItemSeoBreadcrumbs --> ApplicationItemSeoAction
  • Schema Action: REQUIRED_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.seo.properties.breadcrumbs.items.properties.action.required
  • New Schema:
[
"type"
]

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.popularity
  • New Schema:
{
"type": "integer",
"description": "A numerical value indicating the popularity of the product."
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand_uid
  • New Schema:
{
"type": "integer",
"description": "The unique identifier for the brand associated with the product."
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.category_uid
  • New Schema:
{
"type": "integer",
"description": "The unique identifier for the category to which the product belongs."
}

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.verification_status
  • New Schema:
{
"type": "integer",
"description": "The verification status of the product, typically represented as an integer."
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.channel_identifier
  • New Schema:
{
"type": "string",
"description": "The identifier for the sales channel through which the product is sold."
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.category_slug
  • New Schema:
{
"type": "string",
"description": "A URL-friendly string representing the product's category."
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.size_guide
  • New Schema:
{
"type": "string",
"description": "A guide or chart providing size information for the product."
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.l3_categories
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of L3 category IDs of the product."
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_ids
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of store IDs where the product is available."
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company_ids
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of company IDs associated with the product."
}

🔹 Change 29​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.departments
  • New Schema:
{
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of department IDs where the product is categorized."
}

🔹 Change 30​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.tags
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of tags or keywords associated with the product."
}

🔹 Change 31​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.l3_category_names
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of names of L3 categories of the product."
}

🔹 Change 32​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.sizes
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of available sizes for the product."
}

🔹 Change 33​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.product_group_tag
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "Tags that group the product with other similar products."
}

🔹 Change 34​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.multi_size
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is available in multiple sizes."
}

🔹 Change 35​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_gift
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product can be considered as a gift."
}

🔹 Change 36​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_cod
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is eligible for cash on delivery (COD)."
}

🔹 Change 37​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_dependent
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product depends on another product."
}

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.is_available
  • New Schema:
{
"type": "boolean",
"description": "Indicates whether the product is currently available for purchase."
}

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variants
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "An object containing details about the product variants."
}

🔹 Change 40​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variant_media
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Media items specific to the product variants."
}

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.variant_group
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "A group identifier for products that are variants of one another."
}

🔹 Change 42​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.multi_categories
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/MultiCategoriesSchema"
}
}

🔹 Change 43​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.template_tag
  • New Schema:
{
"type": "string",
"description": "Tag used for categorizing or templating purposes."
}

🔹 Change 44​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.net_quantity
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Net quantity details for the product."
}

🔹 Change 45​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_order
  • New Schema:
{
"$ref": "#/components/schemas/CustomOrder"
}

🔹 Change 46​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.country_of_origin
  • New Schema:
{
"type": "string",
"description": "Country where the product is manufactured or sourced from."
}

🔹 Change 47​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._custom_json
  • New Schema:
{
"type": "object",
"additionalProperties": true,
"description": "Custom JSON data associated with the product."
}

🔹 Change 48​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.identifiers
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
},
"description": "Identifiers associated with the product."
}

🔹 Change 49​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.item_id
  • New Schema:
{
"type": "integer",
"description": "Unique identifier for the item."
}

🔹 Change 50​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._custom_meta
  • New Schema:
{
"description": "Custom meta associated with the product.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomMeta"
}
}

🔹 Change 51​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.discount_percentage
  • New Schema:
{
"type": "integer",
"description": "The discount applied to the product in percentage."
}

🔹 Change 52​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.1
  • New Schema:
"name"

🔹 Change 53​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.2
  • New Schema:
"is_dependent"

🔹 Change 54​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.3
  • New Schema:
"uid"

🔹 Change 55​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.4
  • New Schema:
"category_uid"

🔹 Change 56​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.5
  • New Schema:
"item_code"

🔹 Change 57​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.6
  • New Schema:
"multi_size"

🔹 Change 58​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.7
  • New Schema:
"brand_uid"

🔹 Change 59​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.8
  • New Schema:
"country_of_origin"

🔹 Change 60​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.9
  • New Schema:
"item_type"

🔹 Change 61​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.10
  • New Schema:
"departments"

🔹 Change 62​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.11
  • New Schema:
"image_nature"

🔹 Change 63​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.12
  • New Schema:
"moq"

🔹 Change 64​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.13
  • New Schema:
"seo"

🔹 Change 65​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.14
  • New Schema:
"is_cod"

🔹 Change 66​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.15
  • New Schema:
"is_gift"

🔹 Change 67​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.16
  • New Schema:
"is_available"

🔹 Change 68​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionItemsResponseSchema --> ApplicationProductsSchema
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.17
  • New Schema:
"l3_categories"

🔹 Change 69​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppicationProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 70​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getDiscountedInventoryBySizeIdentifier.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 71​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.brand.properties.logo.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 72​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.brand.properties.logo.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 73​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.brand.properties.logo.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 74​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.medias.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 75​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.medias.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 76​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductDetailBySlug.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.medias.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 77​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 78​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 79​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 80​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 81​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAutocompleteConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 82​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAllSearchKeyword.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 83​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 84​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listDepartmentsData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 85​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getDepartmentData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 86​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.bulkHsnCode

🔹 Change 87​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getHsnCode

🔹 Change 88​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateHsnCode

🔹 Change 89​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getInventories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 90​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getInventoryBulkUploadHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 91​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getOptimalLocations

🔹 Change 92​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMarketplaceOptinDetail

🔹 Change 93​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getCompanyBrandDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 94​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getStoreDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 95​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductBundle.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 96​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductAssetsInBulk.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 97​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductBulkUploadHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 98​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listProductTemplateExportDetails

🔹 Change 99​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listProductTemplate.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 100​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listProductTemplateCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 101​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getInventoryBySizeIdentifier.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 102​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getInventoryBySize.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 103​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.addInventory

🔹 Change 104​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getVariantsOfProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 105​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getVariantsOfProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.variants.items.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 106​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getVariantsOfProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.variants.items.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 107​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getVariantsOfProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.variants.items.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 108​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getConfigurationMetadata.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 109​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.listInventoryExport.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 110​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 111​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 112​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 113​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProducts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 114​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 115​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 116​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 117​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductExportJobs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 118​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 119​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 120​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProduct.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 121​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: ENUM_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.editProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.type.enum
  • New Schema:
[
"image",
"video",
"3d_model"
]

🔹 Change 122​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.editProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.alt
  • New Schema:
{
"type": "string",
"description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
}

🔹 Change 123​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetCollectionListingResponseSchema --> GetCollectionDetailNest --> Media
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.editProduct.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.media.items.properties.thumbnail
  • New Schema:
{
"type": "string",
"description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
}

🔹 Change 124​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationBrandListingSchema --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMarketplaces.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 125​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.created_by.properties.email
  • New Schema:
{
"description": "The email address of the user.",
"format": "email",
"type": "string"
}

🔹 Change 126​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.created_by.properties.uid
  • New Schema:
{
"description": "The unique ID of the user.",
"type": "string"
}

🔹 Change 127​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.created_by.type
  • New Schema:
"object"

🔹 Change 128​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.modified_by.properties.email
  • New Schema:
{
"description": "The email address of the user.",
"format": "email",
"type": "string"
}

🔹 Change 129​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.modified_by.properties.uid
  • New Schema:
{
"description": "The unique ID of the user.",
"type": "string"
}

🔹 Change 130​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ApplicationCategoryListingSchema --> ApplicationCategoryListingItemSchema --> UserInfo
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMarketplaceOptin.methodTypePlaceHolder.responses.201.content.application/json.schema.properties.modified_by.type
  • New Schema:
"object"

🔹 Change 131​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.clearCollectionItemsPriority
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "Clear priorities set for collection items.",
"operationId": "clearCollectionItemsPriority",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64c00b72c07acacc1357503b"
},
"failure": {
"value": "64aed377b1fd04565d0dff30"
}
}
},
{
"description": "A `id` is a unique identifier of a collection.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "65620443a7d23306c5d75df2"
},
"failure": {
"value": "65c3795e8d66ee4884a17508"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"message": "items updated"
}
}
},
"schema": {
"$ref": "#/components/schemas/CommonResponseSchemaCollection"
}
}
},
"description": "Status object. Tells whether the operation was successful."
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Collection Not Found"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Clear priorities set for collection items.",
"tags": [
"Collections"
],
"x-groups": [
"Collection Management"
],
"security": [
{
"oauth2": [
"application/products/write"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/application/{application_id}/collections/{id}/items",
"methodType": "delete"
}
}

🔹 Change 132​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getConfigurationsFilterMetadata
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "configured details for catalog.",
"operationId": "getConfigurationsFilterMetadata",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"description": "Filter whose values needs to be fetched.",
"in": "path",
"name": "filter",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "image_nature"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"values": [
{
"text": "standard",
"value": "standard"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/FilterResponseSchema"
}
}
},
"description": "Get application level filter details for metadata. See example below or refer `FilterResponseSchema` for details"
}
},
"summary": "Get filter details for application",
"tags": [
"Application"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-configuration/metadata/{filter}",
"methodType": "get"
}
}

🔹 Change 133​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createSearchRerank
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to create search rerank attributes for an application",
"operationId": "createSearchRerank",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"words": [
"test"
],
"is_active": true,
"application_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_key": "l3_category_slugs",
"attribute_value": "test"
}
]
}
}
},
"failure": {
"value": {
"words": [
"test"
],
"is_active": true,
"application_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_key": "l3_category_slugs",
"attribute_value": "test"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateSearchRerankRequestSchema"
}
}
},
"description": "Search rerank that needs to be created.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"words": [
"test"
],
"app_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_value": "test",
"attribute_key": "l3_category_slugs"
}
]
},
"is_active": true,
"created_on": "2023-12-24T07:10:55.725539",
"created_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
},
"modified_on": "2023-12-24T07:10:55.725553",
"modified_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateSearchRerankResponseSchema"
}
}
},
"description": "List of custom search keywords."
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"ranking": {
"boost": {
"0": {
"attribute_key": [
"Must be one of: brand_slug, l3_category_slugs."
]
}
}
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Create search rerank for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/rerank",
"methodType": "post"
}
}

🔹 Change 134​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getSearchRerank
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to create search rerank attributes for an application",
"operationId": "getSearchRerank",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"page": {
"current": 1,
"type": "number",
"size": 1,
"has_previous": false,
"has_next": false,
"item_total": 1
},
"items": [
{
"created_on": "2023-12-24T07:10:55Z",
"modified_on": "2023-12-24T07:10:55Z",
"words": [
"test"
],
"app_id": "64aed475db2cfb5b8a9f623d",
"modified_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
},
"ranking": {
"boost": [
{
"attribute_value": "test",
"attribute_key": "l3_category_slugs"
}
]
},
"created_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
},
"_id": "6587d97f00f4aedbd0d1b382",
"is_active": true,
"id": "6587d97f00f4aedbd0d1b382"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/GetSearchRerankResponseSchema"
}
}
},
"description": "List of custom search keywords."
}
},
"summary": "Get search rerank for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/rerank",
"methodType": "get"
}
}

🔹 Change 135​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getSearchRerankDetail
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to retrieve search rerank attribute detail for an application",
"operationId": "getSearchRerankDetail",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sales channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "An `id` is the identifier for a particular search rerank configuration. channel.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "6589a91055565ca43767b2e2"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"ranking": {
"boost": [
{
"attribute_key": "l3_category_slugs",
"attribute_value": "testspec3"
}
]
},
"is_active": true,
"modified_by": {
"user_id": "5e199e6998cfe1776f1385dc",
"username": "rohanshah@fynd.com"
},
"created_by": {
"user_id": "5e199e6998cfe1776f1385dc",
"username": "rohanshah@fynd.com"
},
"words": [
"testspec3"
],
"app_id": "64aed475db2cfb5b8a9f623d",
"modified_on": "2023-12-25T16:08:48Z",
"created_on": "2023-12-25T16:08:48Z",
"id": "6589a91055565ca43767b2e2"
}
}
},
"schema": {
"$ref": "#/components/schemas/GetSearchRerankDetailResponseSchema"
}
}
},
"description": "Create search rerank configuration."
}
},
"summary": "Get search rerank for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/rerank/{id}",
"methodType": "get"
}
}

🔹 Change 136​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateSearchRerankConfiguration
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to update search rerank attribute for an application",
"operationId": "updateSearchRerankConfiguration",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
},
"failure": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "An `id` is the identifier for a particular search rerank configuration. channel.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "6589a91055565ca43767b2e2"
},
"failure": {
"value": "6589a91055565ca43767b2e2"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"words": [
"testspec3"
],
"is_active": true,
"application_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_key": "l3_category_slugs",
"attribute_value": "testspec3"
}
]
}
}
},
"failure": {
"value": {
"words": [
"test"
],
"is_active": true,
"application_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_key": "l3_category_slugs",
"attribute_value": "test"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/UpdateSearchRerankRequestSchema"
}
}
},
"description": "Search rerank that needs to be updated. See `UpdateSearchRerankRequestSchema` for details",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"words": [
"test"
],
"app_id": "64aed475db2cfb5b8a9f623d",
"ranking": {
"boost": [
{
"attribute_value": "test",
"attribute_key": "l3_category_slugs"
}
]
},
"is_active": true,
"created_on": "2023-12-24T07:10:55Z",
"created_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
},
"modified_on": "2023-12-24T07:10:55Z",
"modified_by": {
"username": "rohanshah@fynd.com",
"user_id": "5e199e6998cfe1776f1385dc"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/UpdateSearchRerankResponseSchema"
}
}
},
"description": "Update search rerank configuration."
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "test already exists in another config"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Update search rerank for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/rerank/{id}",
"methodType": "put"
}
}

🔹 Change 137​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.deleteSearchRerankConfiguration
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to delete search rerank configuration for an application",
"operationId": "deleteSearchRerankConfiguration",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
},
"failure": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "An `id` is the identifier for a particular search rerank configuration. channel.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "6589a91055565ca43767b2e2"
},
"failure": {
"value": "6589a91055565ca43767b2e2"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"success": true,
"message": "Ranking Config deleted"
}
}
},
"schema": {
"$ref": "#/components/schemas/DeleteSearchRerankConfigurationResponseSchema"
}
}
},
"description": "Status of the delete operation. See `DeleteSearchRerankConfigurationResponseSchema` for details"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "No config found for application and id"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Delete search rerank configuration for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/rerank/{id}",
"methodType": "delete"
}
}

🔹 Change 138​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.patchProductExportDetail
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API helps to edit notification_emails and status of export job.",
"operationId": "patchProductExportDetail",
"parameters": [
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
},
"failure": {
"value": 10
}
}
},
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63a556e1aede4d743b333fad"
},
"failure": {
"value": "63a556e1aede4d743b333fada"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"notification_emails": [
"data@mail.com"
]
}
},
"failure": {
"value": {
"notification_emails": [
"data@mail.com"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ExportPatchRequestSchema"
}
}
},
"description": "Edit export job object.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"data": {
"stats": {
"total": 1
},
"seller_id": 10,
"task_id": "afcfccb2-9e31-11ee-a3ca-d6fb2161153f",
"filters": {
"brands": [],
"templates": [
"activewear-accessories"
],
"catalogue_types": [
"standard"
]
},
"created_by": {
"username": "app@fynd.com",
"user_id": "000000000000000016841367"
},
"created_on": "2023-12-19T05:44:33Z",
"modified_on": "2023-12-19T05:44:33Z",
"type": "excel",
"notification_emails": [
"data@mail.com"
],
"status": "pending"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/PatchProductDownloadsResponseSchema"
}
}
},
"description": "Returns a success response"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Job id."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Edit notification_emails and status of export job.",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/write"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/products/downloads/{job_id}",
"methodType": "patch"
}
}

🔹 Change 139​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductExportDetail
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API helps to get detail of Product export.",
"operationId": "getProductExportDetail",
"parameters": [
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
},
"failure": {
"value": 10
}
}
},
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63a556e1aede4d743b333fad"
},
"failure": {
"value": "63a556e1aede4d743b333fada"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"status": "pending",
"created_by": {
"username": "app@fynd.com",
"user_id": "000000000000000016841367"
},
"stats": {
"total": 1
},
"notification_emails": [],
"seller_id": 10,
"filters": {
"templates": [],
"catalogue_types": [
"standard"
],
"brands": []
},
"task_id": "afcfccb2-9e31-11ee-a3ca-d6fb2161153f",
"modified_on": "2023-12-19T05:44:33Z",
"_id": "65812dc1f4199a68512e69ff",
"type": "excel",
"created_on": "2023-12-19T05:44:33Z",
"id": "65812dc1f4199a68512e69ff"
}
}
},
"schema": {
"$ref": "#/components/schemas/GetProductDownloadsResponseSchema"
}
}
},
"description": "Returns a detail of product export jobs"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Job id."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Get Detail Product export detail.",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/products/downloads/{job_id}",
"methodType": "get"
}
}

🔹 Change 140​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.patchInventoryExportDetail
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API helps to edit notification_emails and status of export job.",
"operationId": "patchInventoryExportDetail",
"parameters": [
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
},
"failure": {
"value": 10
}
}
},
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63a56c14863953d1af0856a8"
},
"failure": {
"value": "63a556e1aede4d743b333fada"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"notification_emails": [
"data@mail.com"
]
}
},
"failure": {
"value": {
"notification_emails": [
"data@mail.com"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ExportPatchRequestSchema"
}
}
},
"description": "Edit export job object.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"data": {
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/catalog/24/fffac430-829e-11ed-8ffa-f2f2a1c4d5d1/fffac430-829e-11ed-8ffa-f2f2a1c4d5d1.zip",
"completed_on": "2022-12-23T08:51:34.561000Z",
"seller_id": 24,
"task_id": "fffac430-829e-11ed-8ffa-f2f2a1c4d5d1",
"created_on": "2022-12-23T08:51:32Z",
"modified_on": "2022-12-23T08:51:32Z",
"notification_emails": [
"data@mail.com"
],
"status": "success"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/EditInventoryDownloadsResponseSchema"
}
}
},
"description": "Returns a success response"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Job id."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Edit notification_emails and status of export job.",
"tags": [
"Inventory"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/write"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/inventory/download/{job_id}",
"methodType": "put"
}
}

🔹 Change 141​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getInventoryExportDetail
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API helps to get detail of Product export.",
"operationId": "getInventoryExportDetail",
"parameters": [
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
},
"failure": {
"value": 10
}
}
},
{
"description": "Company Id in which assets to be uploaded.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63a56c14863953d1af0856a8"
},
"failure": {
"value": "63a556e1aede4d743b333fada"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/catalog/24/fffac430-829e-11ed-8ffa-f2f2a1c4d5d1/fffac430-829e-11ed-8ffa-f2f2a1c4d5d1.zip",
"completed_on": "2022-12-23T08:51:34.561000Z",
"seller_id": 24,
"task_id": "fffac430-829e-11ed-8ffa-f2f2a1c4d5d1",
"created_on": "2022-12-23T08:51:32Z",
"modified_on": "2022-12-23T08:51:32Z",
"_id": "63a56c14863953d1af0856a8",
"notification_emails": [
"data@mail.com"
],
"status": "success",
"id": "63a56c14863953d1af0856a8"
}
}
},
"schema": {
"$ref": "#/components/schemas/EditInventoryDownloadsResponseSchema"
}
}
},
"description": "Returns a detail of product export jobs"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Job id."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Get Detail Product export detail.",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/inventory/download/{job_id}",
"methodType": "get"
}
}

🔹 Change 142​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.validateProductGlobalTemplate
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "Allows you to list all product templates global validation values for all the fields present in the database for a specific company.",
"operationId": "validateProductGlobalTemplate",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "An `item_type` defines the type of item. The default value is standard.",
"in": "query",
"name": "item_type",
"schema": {
"type": "string",
"enum": [
"set",
"standard",
"composite",
"digital"
]
},
"examples": {
"success": {
"value": "standard"
},
"failure": {
"value": "set"
}
}
},
{
"description": "This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.",
"in": "query",
"name": "bulk",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"data": {
"global_validation": {
"title": "SingleProductValidationSchema",
"type": "object",
"properties": {
"name": {
"title": "Name",
"maxLength": 300,
"type": "string"
},
"item_code": {
"title": "Item Code",
"pattern": "^[A-Za-z0-9-_@,#\\(\\)\\. ]+$",
"type": "string"
},
"slug": {
"title": "Slug",
"pattern": "^[a-z0-9-_]*$",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"short_description": {
"title": "Short Description",
"maxLength": 50,
"type": "string"
},
"currency": {
"title": "Currency",
"type": "string",
"enum": [
"INR"
]
},
"country_of_origin": {
"title": "Country of Origin",
"type": "string",
"enum": [
"India",
"Nepal",
"Iceland"
]
},
"no_of_boxes": {
"title": "No. of Boxes",
"exclusiveMinimum": 0,
"type": "integer"
},
"category_slug": {
"title": "Category",
"type": "string",
"enum": []
},
"size_guide": {
"title": "Size Guide",
"type": "string"
}
}
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/TemplatesGlobalValidationResponseSchema"
}
}
},
"description": "List of fields and validation values fro each. See example below or refer `TemplatesValidationResponseSchema` for details"
},
"422": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"errors": [
{
"field": "item_type",
"message": "Must be one of: standard, set, composite, digital."
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/ValidationErrors"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Validate product template",
"x-groups": [
"Product Template Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/products/templates/validation/schema",
"methodType": "get"
}
}

🔹 Change 143​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getCompanyVerification
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API gets company verification details.",
"operationId": "getCompanyVerification",
"parameters": [
{
"description": "Get company verification details filtered by company Id",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
},
"failure": {
"value": 99
}
}
},
{
"description": "A `q` parameter is used to search the company by its name.",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "SHOPSENSE RETAIL TECHNOLOGIES LIMITED"
},
"failure": {
"value": "company"
}
}
},
{
"description": "A `page_no` parameter is a number of the page requested.",
"in": "query",
"name": "page_no",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `page_size` is the no of items per page.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"uid": 10,
"name": "SHOPSENSE RETAIL TECHNOLOGIES LIMITED",
"stats": {
"total": 2
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CompanyVerificationResponseSchema"
}
}
},
"description": "Product Meta. See example below for details"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Company does not exists."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Get company verification status",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/verification",
"methodType": "get"
}
}

🔹 Change 144​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductVerificationDetails
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "Get the verification detail of a product",
"operationId": "getProductVerificationDetails",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"description": "A `item_id` is a unique identifier for a specific product.",
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 2
},
"failure": {
"value": 99
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"rejected_fields": {},
"status": "verified",
"brand_uid": 335,
"_id": "65842100bd7817e212c71243",
"created_on": "2023-12-21T11:27:34Z",
"company_ids": [
1
],
"item_code": "DELETE",
"remark": "",
"created_by": {
"user_id": "000000000000000016841367",
"username": "app@fynd.com"
},
"modified_on": "2023-12-21T11:27:34Z",
"slug": "being-human-blue-flat-front-jeans",
"modified_by": {
"user_id": "000000000000000016841367",
"username": "app@fynd.com"
},
"item_id": 2,
"id": "65842100bd7817e212c71243"
}
}
},
"schema": {
"$ref": "#/components/schemas/ProductVerificationModel"
}
}
},
"description": "Product verification data."
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Product not found."
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Get the verification detail of a product",
"tags": [
"Product Verification"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/verification/products/{item_id}",
"methodType": "get"
}
}

🔹 Change 145​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getVariantTypes
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API gets meta associated to products.",
"operationId": "getVariantTypes",
"parameters": [
{
"description": "Get list of products filtered by company Id",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
}
}
},
{
"description": "The page number to navigate through the given set of results",
"in": "query",
"name": "template_tag",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "test"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"name": "Additional Colorsasd",
"key": "test",
"type": [
"text"
],
"image_config": {}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/VariantTypesResponseSchema"
}
}
},
"description": "Product Meta. See example below for details"
}
},
"summary": "Get variant type list",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v2.0/company/{company_id}/variant-types",
"methodType": "get"
}
}

🔹 Change 146​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductTemplateBySlug
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API retrieves template for a given slug.",
"operationId": "getProductTemplateBySlug",
"parameters": [
{
"description": "Id of the company associated to the template.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "Slug of the template.",
"in": "path",
"name": "slug",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "test"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"page": {
"current": 1,
"type": "number",
"size": 1,
"has_previous": false,
"has_next": false,
"item_total": 1
},
"items": [
{
"attributes": [
"test"
],
"departments": [
"electronics",
"fashion"
],
"is_active": true,
"tag": "test",
"is_physical": false,
"description": "test",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/x0/seller/pictures/logo/original/bPpx16_newplot.png120c05f3-138b-4130-9b2b-596c771d61da/bPpx16_newplot.png",
"is_archived": false,
"slug": "test",
"categories": [
"smart-cellphone"
],
"is_expirable": false,
"name": "Test",
"id": "6587d3f3bf65f561004fabdd"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/GetProductTemplateSlugResponseSchema"
}
}
},
"description": "Update marketplace optin config."
}
},
"summary": "Update marketplace optin",
"tags": [
"Product Template"
],
"x-groups": [
"Product Template and Department management"
],
"security": [
{
"oauth2": [
"company/products/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/products/templates/{slug}",
"methodType": "get"
}
}

🔹 Change 147​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createAutocompleteSettings
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to create autocomplete settings for an application.",
"operationId": "createAutocompleteSettings",
"parameters": [
{
"name": "application_id",
"description": "The company id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"name": "company_id",
"description": "The application id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"query_suggestion": {
"active": true,
"count": 1
},
"product_suggestion": {
"active": true,
"count": 1
},
"collection_suggestion": {
"active": true,
"count": 1
},
"brand_suggestion": {
"active": true,
"count": 1
},
"category_suggestion": {
"active": true,
"count": 1
}
}
},
"failure": {
"value": {
"query_suggestion": {
"active": "true-123",
"count": "test"
},
"product_suggestion": {
"active": true,
"count": 1
},
"collection_suggestion": {
"active": true,
"count": 1
},
"brand_suggestion": {
"active": true,
"count": 1
},
"category_suggestion": {
"active": true,
"count": 1
}
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteRequestSchema"
}
}
},
"description": "Settings config that needs to be created.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"success": true,
"id": "657884575e12e699f8187f47",
"message": "Autocomplete settings created successfully!"
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteUpsertResponseSchema"
}
}
},
"description": "return success true/false based on create operation"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"success": false,
"message": "query_suggestion - {'count': ['Not a valid integer.']} "
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteErrorResponseSchemaSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Create autocomplete settings config for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/settings",
"methodType": "post"
}
}

🔹 Change 148​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAutocompleteSettings
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get autocomplete settings config for an application.",
"operationId": "getAutocompleteSettings",
"parameters": [
{
"description": "The company id for which the autocomplete settings is being referenced",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"description": "The application id for which the autocomplete settings is being referenced",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"id": "657884575e12e699f8187f47",
"query_suggestion": {
"active": true,
"count": 1
},
"brand_suggestion": {
"active": false,
"count": 0
},
"category_suggestion": {
"active": true,
"count": 3
},
"collection_suggestion": {
"active": true,
"count": 5
},
"product_suggestion": {
"active": true,
"count": 1
}
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteResponseSchema"
}
}
},
"description": "Object of autocomplete settings config"
}
},
"summary": "Get autocomplete settings config for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/settings",
"methodType": "get"
}
}

🔹 Change 149​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateAutocompleteSettings
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to update autocomplete settings for an application.",
"operationId": "updateAutocompleteSettings",
"parameters": [
{
"name": "application_id",
"description": "The company id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"name": "company_id",
"description": "The application id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "id",
"description": "An `id` is a unique identifier for a particular autocomplete settings config.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"query_suggestion": {
"active": true,
"count": 1
},
"product_suggestion": {
"active": true,
"count": 1
},
"collection_suggestion": {
"active": true,
"count": 1
},
"brand_suggestion": {
"active": true,
"count": 1
},
"category_suggestion": {
"active": true,
"count": 1
}
}
},
"failure": {
"value": {
"query_suggestion": {
"active": "true-123",
"count": "test"
},
"product_suggestion": {
"active": true,
"count": 1
},
"collection_suggestion": {
"active": true,
"count": 1
},
"brand_suggestion": {
"active": true,
"count": 1
},
"category_suggestion": {
"active": true,
"count": 1
}
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteRequestSchema"
}
}
},
"description": "Settings config that needs to be updated.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"success": true,
"id": "657884575e12e699f8187f47",
"message": "Autocomplete settings updated!"
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteUpsertResponseSchema"
}
}
},
"description": "return success true/false based on update operation"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"success": false,
"message": "query_suggestion - {'count': ['Not a valid integer.']} "
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompleteErrorResponseSchemaSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Update autocomplete settings config for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/settings/{id}",
"methodType": "put"
}
}

🔹 Change 150​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAutocompletePreview
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get autocomplete suggestions as per config.",
"operationId": "getAutocompletePreview",
"parameters": [
{
"name": "application_id",
"description": "The company id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"name": "company_id",
"description": "The application id for which the autocomplete settings is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "q",
"in": "query",
"description": "Get suggestions related to `q` string.",
"schema": {
"type": "string"
},
"required": false,
"examples": {
"success": {
"value": "word"
},
"failure": {
"value": "word"
}
}
},
{
"name": "category_suggestion",
"description": "For getting related category suggestions.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "brand_suggestion",
"description": "For getting related brand suggestions.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "collection_suggestion",
"description": "For getting collection suggestions.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "product_suggestion",
"description": "For getting product suggestions.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"name": "query_suggestion",
"description": "For getting query suggestions.",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"display": "Cross X",
"type": "brand",
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"cross-x"
]
}
},
"type": "page"
},
"logo": {
"type": "image",
"url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/brands/pictures/square-logo/original/rgxjh2p4f-logo.png"
},
"_custom_json": {}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/AutocompletePreviewResponseSchema"
}
}
},
"description": "return autocomplete suggestions"
}
},
"summary": "Get autocomplete suggestions as per config for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/autocomplete/preview",
"methodType": "get"
}
}

🔹 Change 151​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMerchandisingRulePinAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Create Merchandising Rule's action details",
"description": "This allows you to create pin action of a merchandising rule.",
"operationId": "createMerchandisingRulePinAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PinRequestSchema"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"item_id": "2",
"position": 5,
"action": "add"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"item_id": "75779473",
"position": 1,
"action": "add"
},
{
"item_id": "2",
"position": 5,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of pinned items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Item Id 75779473 doesn't exist in database"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/pin",
"methodType": "post"
}
}

🔹 Change 152​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateMerchandisingRulePinAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update Merchandising Rule's action details",
"description": "This allows you to update pin action of a merchandising rule.",
"operationId": "updateMerchandisingRulePinAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PinRequestSchema"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"item_id": "2",
"position": 0,
"action": "delete"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"item_id": "75779473",
"position": 1,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of pinned items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Item Id 75779473 doesn't exist in database"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/pin",
"methodType": "put"
}
}

🔹 Change 153​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingRulePinAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's action details",
"description": "This allows you to get details of pin action of a merchandising rule.",
"operationId": "getMerchandisingRulePinAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "List of pinned items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PinResponseSchema"
},
"examples": {
"success": {
"value": {
"data": [
{
"uid": 7500094,
"name": "Realme Techlife T100 TWS Earbuds with 28 Hours Playback, IPX5 Water Resistance, Al Noise Cancellation for",
"position": 0
}
]
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Kindly create the action first using POST call!."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/pin",
"methodType": "get"
}
}

🔹 Change 154​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMerchandisingRuleHideAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Create Merchandising Rule's Hide action details",
"description": "This allows you to create hide action of a merchandising rule.",
"operationId": "createMerchandisingRuleHideAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HideRequestSchema"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"item_id": 75757575,
"action": "add"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"item_id": 75779473,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of hide items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Item Id 75779473 doesn't exist in database"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/hide",
"methodType": "post"
}
}

🔹 Change 155​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateMerchandisingRuleHideAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update Merchandising Rule's Hide action details",
"description": "This allows you to update hide action of a merchandising rule.",
"operationId": "updateMerchandisingRuleHideAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HideRequestSchema"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"item_id": 2,
"action": "add"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"item_id": 75779473,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of hide items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Item Id 75779473 doesn't exist in database"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/hide",
"methodType": "put"
}
}

🔹 Change 156​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingRuleHideAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's Hide action details",
"description": "This allows you to get details of hide action of a merchandising rule.",
"operationId": "getMerchandisingRuleHideAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "List of hide items.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HideResponseSchema"
},
"examples": {
"success": {
"value": {
"data": [
{
"uid": 1,
"name": "facilitate value-added infrastructures"
},
{
"uid": 2,
"name": "extend back-end relationships"
},
{
"uid": 3,
"name": "incentivize cross-media portals"
}
]
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Kindly create the action first using POST call!."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/hide",
"methodType": "get"
}
}

🔹 Change 157​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMerchandisingRuleBoostAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Create Merchandising Rule's Boost action details",
"description": "This allows you to create Boost action of a merchandising rule.",
"operationId": "createMerchandisingRuleBoostAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostMerchandisingRuleBoostAction"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"attribute": "l3_category_slugs",
"value": "yolanda852553493020241759652",
"strength": 80,
"action": "add"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"attribute": "l3_category_slugs",
"value": "yolanda852553493020241759652",
"strength": 80,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of Boost conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/boost",
"methodType": "post"
}
}

🔹 Change 158​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateMerchandisingRuleBoostAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update Merchandising Rule's Boost action details",
"description": "This allows you to update Boost action of a merchandising rule.",
"operationId": "updateMerchandisingRuleBoostAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostMerchandisingRuleBoostAction"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"attribute": "brand",
"value": "MAC",
"strength": 80,
"action": "delete"
},
{
"attribute": "name2",
"value": "Intel2",
"strength": 20,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of Boost conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/boost",
"methodType": "put"
}
}

🔹 Change 159​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingRuleBoostAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's Boost action details",
"description": "This allows you to get details of Boost action of a merchandising rule.",
"operationId": "getMerchandisingRuleBoostAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "List of Boost conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMerchandisingRuleBoostAction"
},
"examples": {
"success": {
"value": {
"data": [
{
"attribute": "brand",
"value": "MAC",
"strength": 80
},
{
"attribute": "name",
"value": "Intel",
"strength": 20
}
]
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Kindly create the action first using POST call!."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/boost",
"methodType": "get"
}
}

🔹 Change 160​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMerchandisingRuleBuryAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's Bury action details",
"description": "This allows you to create Bury action of a merchandising rule.",
"operationId": "createMerchandisingRuleBuryAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostMerchandisingRuleBoostAction"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"attribute": "department",
"value": "MAC",
"strength": 80,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of Bury conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/bury",
"methodType": "post"
}
}

🔹 Change 161​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateMerchandisingRuleBuryAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update Merchandising Rule's Bury action details",
"description": "This allows you to update Bury action of a merchandising rule.",
"operationId": "updateMerchandisingRuleBuryAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostMerchandisingRuleBoostAction"
},
"examples": {
"success": {
"value": {
"action_value": [
{
"attribute": "category",
"value": "Intel",
"strength": 80,
"action": "add"
}
]
}
},
"failure": {
"value": {
"action_value": [
{
"attribute": "brand",
"value": "Intel",
"strength": 20,
"action": "add"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "List of Bury conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request",
"errors": "Duplicate Attribute Intel2 name2 entered."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/bury",
"methodType": "put"
}
}

🔹 Change 162​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingRuleBuryAction
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's Bury action details",
"description": "This allows you to get details of Bury action of a merchandising rule.",
"operationId": "getMerchandisingRuleBuryAction",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000002"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
},
"failure": {
"value": "asb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "List of Bury conditions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMerchandisingRuleBuryAction"
},
"examples": {
"success": {
"value": {
"data": [
{
"attribute": "brand",
"value": "MAC",
"strength": 80
},
{
"attribute": "name",
"value": "Intel",
"strength": 20
}
]
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Kindly create the action first using POST call!."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/bury",
"methodType": "get"
}
}

🔹 Change 163​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createMerchandisingRuleQuery
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Create a Merchandising Rule's query",
"description": "This allows you to Create a merchandising rule's query.",
"operationId": "createMerchandisingRuleQuery",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchandisingRuleQueryPost"
},
"examples": {
"success": {
"value": {
"query": {
"query_condition": "search_query",
"query": {
"condition": "contains",
"search_query": "abcd",
"synonyms": true
},
"filter": [
{
"attribute": "Category",
"value": "selected"
},
{
"attribute": "Department",
"value": "kids"
}
]
},
"zone_id": "1"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Update a merchandise rule's query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchandiseQueryResponseSchema"
},
"examples": {
"success": {
"value": {
"message": "ok",
"merchandising_rule_id": "r4f34f3f"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/query",
"methodType": "post"
}
}

🔹 Change 164​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingQuery
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Merchandising Rule's query details",
"description": "This allows you to get details of a merchandising rule's query.",
"operationId": "getMerchandisingQuery",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "Details of merchandise query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponseSchema"
},
"examples": {
"success": {
"value": {
"message": "Rule found for given MerchandisingId.",
"_id": "65b36fefe0b368503c28774b",
"zone_id": "1",
"query": {
"filter": [
{
"attribute": "is_set",
"value": "No"
},
{
"attribute": "image_nature",
"value": "Good Quality"
}
],
"query_condition": "search_query"
},
"application_id": "000000000000000000000001",
"merchandising_rule_id": "u5hp1f2uwi",
"status": "preview",
"created_on": "2024-01-26T08:39:53Z",
"modified_on": "2024-01-26T08:39:53Z"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/query",
"methodType": "get"
}
}

🔹 Change 165​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateMerchandisingRuleQuery
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update a Merchandising Rule's query",
"description": "This allows you to Update a merchandising rule's query.",
"operationId": "updateMerchandisingRuleQuery",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchandisingRuleQueryPost"
},
"examples": {
"success": {
"value": {
"zone_id": "1",
"query": {
"query_condition": "search_query",
"query": {
"condition": "is",
"search_query": "games",
"synonyms": false
},
"filter": [
{
"attribute": "department",
"value": "fashion"
}
]
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Update a merchandise rule's query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/query",
"methodType": "put"
}
}

🔹 Change 166​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.saveMerchandisingRules
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Save a Merchandising Rule",
"description": "This allows you to Save a merchandising rule's preview state.",
"operationId": "saveMerchandisingRules",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchandisingRuleSave"
},
"examples": {
"success": {
"value": {
"rule_name": "cdss",
"is_active": true,
"_schedule": {
"start": "2024-01-16T08:05:19Z",
"cron": "10 * * 1 *",
"next_schedule": [
{
"start": "2024-01-16T02:40:00Z",
"end": "2024-01-16T02:42:00Z"
}
],
"duration": 120,
"end": "2024-01-30T19:00:00Z"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Update a merchandise rule's query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}",
"methodType": "post"
}
}

🔹 Change 167​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.deleteMerchandisingRule
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Delete a Merchandising Rule",
"description": "This allows you to Update a merchandising rule.",
"operationId": "deleteMerchandisingRule",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
}
}
}
],
"responses": {
"200": {
"description": "Delete a merchandise rule's query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"message": "No Rule or Action found with the given MerchandiseId."
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}",
"methodType": "delete"
}
}

🔹 Change 168​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getMerchandisingRules
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get list of all Merchandising Rule's details",
"description": "This allows you to get details of all merchandising rule's details.",
"operationId": "getMerchandisingRules",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "query",
"name": "page_id",
"description": "Each response will contain next_id param, which should be sent back to make pagination work.",
"schema": {
"type": "string"
},
"required": false,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "query",
"name": "page_size",
"description": "Number of items to retrieve in each page. Default is 12.",
"schema": {
"type": "integer"
},
"required": false,
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"description": "Details of all merchandise rule's details. See example below or refer `MerchandisingRulesList` for details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MerchandisingRulesList"
},
"examples": {
"success": {
"value": {
"data": [
{
"query": {
"_id": "65a8f6f70c18ced33f6c434e",
"query": {
"query_condition": "search_query",
"query": {
"condition": "contains",
"search_query": "abcd",
"synonyms": "true"
},
"filter": [
{
"attribute": "Category",
"value": "selected"
},
{
"attribute": "Department",
"value": "kids"
}
]
},
"is_active": true,
"merchandising_rule_id": "xsb1w2wjxb",
"rule_name": "Merchandising Rule Name 1",
"status": "live",
"zone_id": [
1
],
"application_id": "000000000000000000000001"
},
"action": [
"bury",
"hide"
]
}
],
"page": {
"current": 1,
"type": "number",
"size": 1,
"has_previous": false,
"has_next": false,
"item_total": 1
}
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules",
"methodType": "get"
}
}

🔹 Change 169​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.deleteMerchandisingRulesPreview
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Delete a Merchandising Rule's preview",
"description": "This allows you to Update a merchandising rule's preview.",
"operationId": "deleteMerchandisingRulesPreview",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 2
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
},
"failure": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "kgv1euym26"
},
"failure": {
"value": "invalid"
}
}
}
],
"responses": {
"200": {
"description": "Delete a merchandise rule's query.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponseMerchandising"
},
"examples": {
"success": {
"value": {
"message": "ok"
}
}
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"message": "No Rule or Action found with the given MerchandiseId."
}
}
}
}
}
}
},
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/preview",
"methodType": "delete"
}
}

🔹 Change 170​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getLivePreview
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get live preview of a Merchandising Rule",
"description": "This allows you to get live preview of a merchandising rule.",
"operationId": "getLivePreview",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "A `company_id` is a unique identifier for a particular seller account.",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "application_id",
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"in": "path",
"name": "merchandising_rule_id",
"description": "A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "xsb1w2wjxb"
}
}
},
{
"in": "query",
"name": "search_keyword",
"description": "A sample query that can be used to get a live preview of the merchandising rule.",
"schema": {
"type": "string"
},
"required": false,
"examples": {
"success": {
"value": "test"
}
}
}
],
"responses": {
"200": {
"description": "Get live preview of a merchandise rule.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductListingResponseSchema"
},
"examples": {
"success": {
"value": {
"items": [
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc8c0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Cookie Box, Pack of 8",
"pinned": true,
"sizes": [
"OS"
],
"slug": "cookie-box-pack-of-8-7500520",
"tags": [],
"uid": 7500520,
"item_code": "COOKIES051",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Allen Solly",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/brands/pictures/square-logo/original/qYk-zhgWQ-Logo.png"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"allen-solly"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"cookie-box-pack-of-8-7500520"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/allen-solly/COOKIES051/0/eMu_MHvv8f-81G00AyHv0L.jpg",
"alt": "Cookie Box, Pack of 8"
}
],
"identifiers": [
"COOKIES51",
"COOKIES051"
],
"discount": "",
"price": {
"marked": {
"min": 116,
"max": 116,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 116,
"max": 116,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Cookie Box, Pack of 8",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc940>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Chocobakes ChocoChip Cookies 167 g",
"sizes": [
"OS"
],
"slug": "chocobakes-chocochip-cookies-167-g-7500481",
"tags": [],
"uid": 7500481,
"item_code": "COOKIES015",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "W for Woman",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"w-for-woman"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"chocobakes-chocochip-cookies-167-g-7500481"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/w-for-woman/COOKIES015/0/A2b4cNjnob-61LrAe-7JL.jpg",
"alt": "Chocobakes ChocoChip Cookies 167 g"
}
],
"identifiers": [
"COOKIES15",
"COOKIES015"
],
"discount": "",
"price": {
"marked": {
"min": 66,
"max": 66,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 66,
"max": 66,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Chocobakes ChocoChip Cookies 167 g",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc140>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Oats with Almonds cookies Biscuits, 150g",
"sizes": [
"OS"
],
"slug": "oats-with-almonds-cookies-biscuits-150g-7500517",
"tags": [],
"uid": 7500517,
"item_code": "COOKIES046",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Van Heusen",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"van-heusen"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"oats-with-almonds-cookies-biscuits-150g-7500517"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/van-heusen/COOKIES046/0/-aboJbiHYa-61ewIMzO6jL.jpg",
"alt": "Oats with Almonds cookies Biscuits, 150g"
}
],
"identifiers": [
"COOKIES46",
"COOKIES046"
],
"discount": "",
"price": {
"marked": {
"min": 50,
"max": 50,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 50,
"max": 50,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Oats with Almonds cookies Biscuits, 150g",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc4c0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Oats Cranberry Cookies (Pack of 2 x 125g)",
"sizes": [
"OS"
],
"slug": "oats-cranberry-cookies-pack-of-2-x-125g-7500506",
"tags": [],
"uid": 7500506,
"item_code": "COOKIES059",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Biba",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"biba"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"oats-cranberry-cookies-pack-of-2-x-125g-7500506"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/biba/COOKIES059/0/V7R6AYjEyJ-811waMWHTzL.jpg",
"alt": "Oats Cranberry Cookies (Pack of 2 x 125g)"
}
],
"identifiers": [
"COOKIES059",
"COOKIES59"
],
"discount": "",
"price": {
"marked": {
"min": 189,
"max": 189,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 189,
"max": 189,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Oats Cranberry Cookies (Pack of 2 x 125g)",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc540>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "7 Grain Breakfast Cookies|Assorted,Pack Of 6 (330G)",
"sizes": [
"OS"
],
"slug": "7-grain-breakfast-cookies-assorted-pack-of-6-330g-7500509",
"tags": [],
"uid": 7500509,
"item_code": "COOKIES026",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Van Heusen",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"van-heusen"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"7-grain-breakfast-cookies-assorted-pack-of-6-330g-7500509"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/van-heusen/COOKIES026/0/SqZsagaLAC-61ZolESmSZL.jpg",
"alt": "7 Grain Breakfast Cookies|Assorted,Pack Of 6 (330G)"
}
],
"identifiers": [
"COOKIES26",
"COOKIES026"
],
"discount": "",
"price": {
"marked": {
"min": 291,
"max": 291,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 291,
"max": 291,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "7 Grain Breakfast Cookies|Assorted,Pack Of 6 (330G)",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe256bbc1c0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Max Protein Cookies Trail Mix [Pack of 12 ] 7 Grain Breakfast Cookie loaded with Protein, Fiber and calcium, NO MAIDA, GMO FREE, NO Preservatives",
"sizes": [
"OS"
],
"slug": "max-protein-cookies-trail-mix-pack-of-12-7-grain-breakfast-cookie-loaded-with-protein-fiber-and-calcium-no-maida-gmo-free-no-preservatives-7500501",
"tags": [],
"uid": 7500501,
"item_code": "COOKIES035",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "W for Woman",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"w-for-woman"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"max-protein-cookies-trail-mix-pack-of-12-7-grain-breakfast-cookie-loaded-with-protein-fiber-and-calcium-no-maida-gmo-free-no-preservatives-7500501"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/w-for-woman/COOKIES035/0/QD-mtDSdjg-71kdPR6YUmL.jpg",
"alt": "Max Protein Cookies Trail Mix [Pack of 12 ] 7 Grain Breakfast Cookie loaded with Protein, Fiber and calcium, NO MAIDA, GMO FREE, NO Preservatives"
}
],
"identifiers": [
"COOKIES035",
"COOKIES35"
],
"discount": "",
"price": {
"marked": {
"min": 570,
"max": 570,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 570,
"max": 570,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Max Protein Cookies Trail Mix [Pack of 12 ] 7 Grain Breakfast Cookie loaded with Protein, Fiber and calcium, NO MAIDA, GMO FREE, NO Preservatives",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe25792cd40>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Choco Chip, Chocolate Cookies Loaded with Choco Chips, 357.5g",
"sizes": [
"OS"
],
"slug": "choco-chip-chocolate-cookies-loaded-with-choco-chips-357-5g-7500529",
"tags": [],
"uid": 7500529,
"item_code": "COOKIES043",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Levi's",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"levi-s"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"choco-chip-chocolate-cookies-loaded-with-choco-chips-357-5g-7500529"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/levi-s/COOKIES043/0/N4kgc6mxMa-71BoLifelZL.jpg",
"alt": "Choco Chip, Chocolate Cookies Loaded with Choco Chips, 357.5g"
}
],
"identifiers": [
"COOKIES043",
"COOKIES43"
],
"discount": "",
"price": {
"marked": {
"min": 70,
"max": 70,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 70,
"max": 70,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Choco Chip, Chocolate Cookies Loaded with Choco Chips, 357.5g",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe25714acc0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Choco Fills, 300g, Original Filled Cookies with Choco Creme",
"sizes": [
"OS"
],
"slug": "choco-fills-300g-original-filled-cookies-with-choco-cr-me-7500480",
"tags": [],
"uid": 7500480,
"item_code": "COOKIES013",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Levi's",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"levi-s"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"choco-fills-300g-original-filled-cookies-with-choco-cr-me-7500480"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/levi-s/COOKIES013/0/nDD3hau8cJ-81egmZT3u-L.jpg",
"alt": "Choco Fills, 300g, Original Filled Cookies with Choco Creme"
}
],
"identifiers": [
"COOKIES13",
"COOKIES013"
],
"discount": "",
"price": {
"marked": {
"min": 144,
"max": 144,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 144,
"max": 144,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Choco Fills, 300g, Original Filled Cookies with Choco Creme",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe257d442c0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Choco Almond Story Box | 1 Healthy Choco Almond Cookies Story Box|Nutty & Chocolatey | Family Snacks Biscuit | No Added Maida | 6 Cookies Per Box, 75 gm",
"sizes": [
"OS"
],
"slug": "choco-almond-story-box-1-healthy-choco-almond-cookies-story-box-nutty-chocolatey-family-snacks-biscuit-no-added-maida-6-cookies-per-box-75-gm-7500516",
"tags": [],
"uid": 7500516,
"item_code": "COOKIES044",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Pantaloons",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"pantaloons"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"choco-almond-story-box-1-healthy-choco-almond-cookies-story-box-nutty-chocolatey-family-snacks-biscuit-no-added-maida-6-cookies-per-box-75-gm-7500516"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/pantaloons/COOKIES044/0/Q8RrtzO3dw-61LB-ljQL.jpg",
"alt": "Choco Almond Story Box | 1 Healthy Choco Almond Cookies Story Box|Nutty & Chocolatey | Family Snacks Biscuit | No Added Maida | 6 Cookies Per Box, 75 gm"
}
],
"identifiers": [
"COOKIES044",
"COOKIES44"
],
"discount": "",
"price": {
"marked": {
"min": 94,
"max": 94,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 94,
"max": 94,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Choco Almond Story Box | 1 Healthy Choco Almond Cookies Story Box|Nutty & Chocolatey | Family Snacks Biscuit | No Added Maida | 6 Cookies Per Box, 75 gm",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe257140140>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Premium Dark Chocolate Cookies | Handcrafted with Butter and Rich Dark Chocolate Chunks | Eggless Cookies | Perfect Snack for Mid- Meal Cravings | Pack of 1 | 200g",
"sizes": [
"OS"
],
"slug": "premium-dark-chocolate-cookies-handcrafted-with-butter-and-rich-dark-chocolate-chunks-eggless-cookies-perfect-snack-for-mid-meal-cravings-pack-of-1-200g-7500510",
"tags": [],
"uid": 7500510,
"item_code": "COOKIES027",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Zara",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"zara"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"premium-dark-chocolate-cookies-handcrafted-with-butter-and-rich-dark-chocolate-chunks-eggless-cookies-perfect-snack-for-mid-meal-cravings-pack-of-1-200g-7500510"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/zara/COOKIES027/0/CRAXBOSA8S-618icP0ydgL.jpg",
"alt": "Premium Dark Chocolate Cookies | Handcrafted with Butter and Rich Dark Chocolate Chunks | Eggless Cookies | Perfect Snack for Mid- Meal Cravings | Pack of 1 | 200g"
}
],
"identifiers": [
"COOKIES027",
"COOKIES27"
],
"discount": "",
"price": {
"marked": {
"min": 189,
"max": 189,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 189,
"max": 189,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Premium Dark Chocolate Cookies | Handcrafted with Butter and Rich Dark Chocolate Chunks | Eggless Cookies | Perfect Snack for Mid- Meal Cravings | Pack of 1 | 200g",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe257140cc0>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Quadratini Chocolate Bite Size Wafer Cookies,125 GMS",
"sizes": [
"OS"
],
"slug": "quadratini-chocolate-bite-size-wafer-cookies-125-gms-7500518",
"tags": [],
"uid": 7500518,
"item_code": "COOKIES048",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "H&M (Hennes & Mauritz)",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/addsale/brands/pictures/square-logo/original/QDbYsWm5D-Logo.webp"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"h-m-hennes-mauritz"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"quadratini-chocolate-bite-size-wafer-cookies-125-gms-7500518"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/h-m-hennes-mauritz/COOKIES048/0/tvMT-gW7Ny-61834q2fz2L.jpg",
"alt": "Quadratini Chocolate Bite Size Wafer Cookies,125 GMS"
}
],
"identifiers": [
"COOKIES48",
"COOKIES048"
],
"discount": "",
"price": {
"marked": {
"min": 199,
"max": 199,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 199,
"max": 199,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Quadratini Chocolate Bite Size Wafer Cookies,125 GMS",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
},
{
"type": "product",
"attributes": {
"primary_color_hex": null
},
"categories": [
{
"id": 9,
"uid": 9,
"name": "Krystel441740523020241757150",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/media/banner_portrait/brand/original/540_ecba3a1af141467da8abc20500f983db.jpg"
},
"action": "<coroutine object Category.action_url at 0x7fe257140d40>",
"_custom_json": {}
}
],
"_custom_meta": [],
"sellable": true,
"name": "Assorted Cookies, Brown Butter (Pack Of 10), 750 Gram",
"sizes": [
"OS"
],
"slug": "assorted-cookies-brown-butter-pack-of-10-750-gram-7500476",
"tags": [],
"uid": 7500476,
"item_code": "COOKIES001",
"item_type": "standard",
"brand": {
"type": "brand",
"name": "Allen Solly",
"logo": {
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/brands/pictures/square-logo/original/qYk-zhgWQ-Logo.png"
},
"action": {
"page": {
"type": "products",
"query": {
"brand": [
"allen-solly"
]
}
},
"type": "page"
},
"_custom_json": {}
},
"action": {
"page": {
"type": "product",
"params": {
"slug": [
"assorted-cookies-brown-butter-pack-of-10-750-gram-7500476"
]
}
},
"type": "page"
},
"medias": [
{
"type": "image",
"url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/products/pictures/item/free/original/allen-solly/COOKIES001/0/K7rLeuNZjn-81EgwRfgLiL.jpg",
"alt": "Assorted Cookies, Brown Butter (Pack Of 10), 750 Gram"
}
],
"identifiers": [
"COOKIES01",
"COOKIES001"
],
"discount": "",
"price": {
"marked": {
"min": 255,
"max": 255,
"currency_code": "INR",
"currency_symbol": "₹"
},
"effective": {
"min": 255,
"max": 255,
"currency_code": "INR",
"currency_symbol": "₹"
}
},
"is_tryout": false,
"channel": "659b8f782d483329f0f3d201",
"_custom_json": {},
"moq": {
"minimum": 1,
"increment_unit": 1
},
"net_quantity": {
"unit": "nos",
"value": 1
},
"seo": {
"title": "Assorted Cookies, Brown Butter (Pack Of 10), 750 Gram",
"description": ""
},
"short_description": "",
"country_of_origin": "India",
"variants": []
}
],
"sort_on": [
{
"display": "Relevance",
"name": "Relevance",
"logo": "https://hdn-1.fynd.com/global/menu-icons/Relevance.svg",
"value": "relevance",
"is_selected": true
},
{
"display": "Latest Products",
"name": "Latest Products",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/QEvUfhsfyg-Latest-Products.png",
"value": "latest",
"is_selected": false
},
{
"display": "Popularity",
"name": "Popularity",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/iG82Qjay9X-Popularity.png",
"value": "popular",
"is_selected": false
},
{
"display": "Price Low to High",
"name": "Price Low to High",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/dLUtvNwoQt-Price-High-to-Low.png",
"value": "price_asc",
"is_selected": false
},
{
"display": "Price High to Low",
"name": "Price High to Low",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/dLUtvNwoQt-Price-High-to-Low.png",
"value": "price_dsc",
"is_selected": false
},
{
"display": "Discount Low to High",
"name": "Discount Low to High",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/9VdjDVc_aR-Discount-Low-to-High.png",
"value": "discount_asc",
"is_selected": false
},
{
"display": "Discount High to Low",
"name": "Discount High to Low",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/9VdjDVc_aR-Discount-Low-to-High.png",
"value": "discount_dsc",
"is_selected": false
},
{
"display": "Rating",
"name": "Rating",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/IyaIm4EZXI-Rating.png",
"value": "rating_dsc",
"is_selected": false
},
{
"display": "Size Depth (High to Low)",
"name": "Size Depth (High to Low)",
"logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/products/pictures/attribute/logo/original/hyWWrNJ1A--Size-Depth.png",
"value": "depth_desc",
"is_selected": false
}
],
"page": {
"type": "cursor",
"next_id": "AoMIQCqRBQVAiVGGwAAAAD8HNzUwMDQ3NiE2NTliOGY3ODJkNDgzMzI5ZjBmM2QyMDEhX2FsbF8=",
"has_previous": true,
"has_next": true,
"item_total": 74
}
}
}
}
}
}
}
},
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/merchandise/rules/{merchandising_rule_id}/preview",
"methodType": "get"
}
}

🔹 Change 171​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createAppPriceFactory
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to create price factory.",
"operationId": "createAppPriceFactory",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 99
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"name": "test12",
"code": "test12",
"is_active": true,
"factory_type_ids": [
"65c0790dccf2ef52e9ed5d53",
"65c078dae861a65ddf7e0409"
],
"department_ids": [
1
],
"application_id": "65b9f8110a89930b186b1e82",
"factory_type": "price_zone",
"currency": "INR",
"currency_symbol": "₹"
}
},
"failure": {
"value": {
"name": "test12",
"code": "test12",
"is_active": true,
"factory_type_ids": [
"65c0790dccf2ef52e9ed5d53",
"65c078dae861a65ddf7e0409"
],
"department_ids": [
58712
],
"application_id": "65b9f8110a89930b186b1e82",
"factory_type": "invalid",
"currency": "INR",
"currency_symbol": "₹"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryRequestSchema"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"factory_type": "price_zone",
"is_active": true,
"code": "test12",
"factory_type_ids": [
"65c0790dccf2ef52e9ed5d53",
"65c078dae861a65ddf7e0409"
],
"currency": "INR",
"application_id": "507f1f77bcf86cd799439011",
"created_on": "2024-03-11T12:00:14Z",
"created_by": {
"username": "app@fynd.com",
"user_id": "000000000000000016841367"
},
"modified_by": {
"username": "app@fynd.com",
"user_id": "000000000000000016841367"
},
"name": "test12",
"department_ids": [
1
],
"modified_on": "2024-03-11T12:00:14Z",
"_id": "65eef24e2f967d16d714c0b2"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryResponseSchema"
}
}
},
"description": "Returns a success response"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"error": {
"factory_type": [
"Must be one of: price_zone, user_group, price_zone_user_group."
]
},
"message": "Price factory already exists with same department and price zone",
"errors": {
"page_size": [
"Must be greater than or equal to 1."
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/PriceFactoryCreateErrorSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
},
"summary": "Create price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory",
"methodType": "post"
}
}

🔹 Change 172​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppPriceFactories
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get price factories.",
"operationId": "getAppPriceFactories",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "gets price factory filtered by active status.",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "boolean"
},
"examples": {
"success": {
"value": true
}
}
},
{
"description": "gets price factory filtered by factory_type_id.",
"in": "query",
"name": "factory_type_id",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "gets price factory filtered by pricezone code.",
"in": "query",
"name": "code",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "pricezone"
}
}
},
{
"description": "The page number to navigate through the given set of results.",
"in": "query",
"name": "page_no",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "Number of items to retrieve in each page. Default is 12.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 12
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"application_id": "507f1f77bcf86cd799439011",
"department_ids": [
123,
124
],
"factory_type": "price_zone",
"currency": "INR",
"factory_type_ids": [
"507f1f77bcf86cd799439011"
],
"code": "pricezone",
"name": "pricezone",
"is_active": true,
"created_by": "testuser",
"modified_by": "testuser",
"created_on": "2021-09-23T12:00:00Z",
"modified_on": "2021-09-23T12:00:00Z",
"_id": "507f1f77bcf86cd799439011"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/GetAppPriceFactoryResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "Get price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory",
"methodType": "get"
}
}

🔹 Change 173​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppPriceFactory
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get price factory.",
"operationId": "getAppPriceFactory",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"currency": "INR",
"application_id": "507f1f77bcf86cd799439011",
"department_ids": [
1
],
"factory_type": "price_zone",
"factory_type_ids": [
"507f1f77bcf86cd799439011"
],
"code": "pricezone",
"name": "pricezone",
"is_active": true,
"created_by": "testuser",
"modified_by": "testuser",
"created_on": "2021-09-23T12:00:00Z",
"modified_on": "2021-09-23T12:00:00Z",
"_id": "507f1f77bcf86cd799439011"
}
}
},
"schema": {
"$ref": "#/components/schemas/AppPriceFactory"
}
}
},
"description": "Returns a success response"
}
},
"summary": "Get price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}",
"methodType": "get"
}
}

🔹 Change 174​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.editAppPriceFactory
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to update price factory.",
"operationId": "editAppPriceFactory",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"name": "Chips",
"code": "",
"is_active": true,
"factory_type_ids": [
"507f1f77bcf86cd799439011"
],
"department_ids": [
1
],
"application_id": "507f1f77bcf86cd799439011",
"factory_type": "price_zone",
"currency": "INR",
"currency_symbol": "₹"
}
}
},
"schema": {
"$ref": "#/components/schemas/EditAppPriceFactoryRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"message": "Price factory with 507f1f77bcf86cd799439011 not found",
"errors": {
"status_code": 400
},
"application_id": "507f1f77bcf86cd799439011",
"currency": "INR",
"department_ids": [
1
],
"factory_type": "price_zone",
"factory_type_ids": [
"507f1f77bcf86cd799439011"
],
"code": "pricezone",
"name": "pricezone",
"is_active": true,
"created_by": "testuser",
"modified_by": "testuser",
"created_on": "2021-09-23T12:00:00Z",
"modified_on": "2021-09-23T12:00:00Z",
"_id": "507f1f77bcf86cd799439011"
}
}
},
"schema": {
"$ref": "#/components/schemas/AppPriceFactory"
}
}
}
}
},
"summary": "Edit a price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}",
"methodType": "put"
}
}

🔹 Change 175​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.addProductsInPriceFactoryByZoneId
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to add products in price factory.",
"operationId": "addProductsInPriceFactoryByZoneId",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 99
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"name": "Drools Optimum Performance Adult Dry Dog Food, Chicken Flavor, 10Kg, 1 Count",
"item_id": 7649082,
"seller_identifier": "SRSGFWGHG26",
"marked_price": 1037,
"selling_price": 936,
"zone": "Karnataka",
"command": "Enable"
}
]
}
},
"failure": {
"value": {
"items": [
{
"name": "Drools Optimum Performance Adult Dry Dog Food, Chicken Flavor, 10Kg, 1 Count",
"item_id": 7649082,
"seller_identifier": "SRSGFWGHG26",
"marked_price": 1037,
"selling_price": 936,
"zone": "Karnataka",
"command": "test"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/CreatePriceFactoryProductRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"total_records": 2,
"success_records": 1,
"failed_records": 1,
"failed_records_data": [
{
"item_id": 1234,
"message": "Price Zone not found for this price factory"
}
],
"stage": "processed"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreatePriceFactoryProductResponseSchema"
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"summary": "Add products to price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/products",
"methodType": "post"
}
}

🔹 Change 176​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getProductsInPriceFactoryByZoneId
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get products in price factory.",
"operationId": "getProductsInPriceFactoryByZoneId",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `zone_id` is a unique identifier for a particular price factory zone.",
"in": "query",
"name": "zone_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "gets price factory filtered by item_id.",
"in": "query",
"name": "item_id",
"required": false,
"schema": {
"type": "number"
},
"examples": {
"success": {
"value": 1234
}
}
},
{
"description": "gets price factory filtered by search query.",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "test"
}
}
},
{
"description": "The page number to navigate through the given set of results.",
"in": "query",
"name": "page_no",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "Number of items to retrieve in each page. Default is 12.",
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 12
}
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"item_id": 1234,
"name": "Test-01",
"item_code": "TEST-01",
"brand": "Test Brand",
"category": "Abayas",
"factory_type_id": [
"507f1f77bcf86cd799439011"
],
"media": [
{
"type": "image",
"url": "/x0/products/pictures/item/free/original/Hsw-U3Kut-Test-01.jpeg"
}
],
"sizes": [
{
"seller-identifier": "qwert123",
"size_name": "XL",
"marked_price": 1500,
"selling_price": 1400,
"currency": "INR",
"is_active": true
}
],
"company_sizes": [
{
"seller-identifier": "qwert123",
"size_name": "XL",
"marked_price": 1200,
"selling_price": 1100,
"currency": "INR"
}
]
}
],
"page": {
"current": 1,
"type": "number",
"size": 0,
"has_previous": false,
"has_next": false,
"item_total": 0
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductsResponseSchema"
}
}
}
}
},
"summary": "Get products listed in price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/products",
"methodType": "get"
}
}

🔹 Change 177​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createProductPriceFactoryBulkJob
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to create bulk job for adding products in price factory.",
"operationId": "createProductPriceFactoryBulkJob",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"file_type": "xlsx",
"file_path": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/K5NXm7Lyo-price-factory-1709894593135.xlsx",
"job_type": "upload"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"file_type": "xlsx",
"stage": "pending",
"created_by": {
"user_id": "000000000000000016841367",
"username": "app@fynd.com"
},
"company_id": 1,
"job_type": "upload",
"total_records": 0,
"is_active": true,
"modified_on": "2024-03-08T15:28:13Z",
"application_id": "507f1f77bcf86cd799439011",
"factory_id": "507f1f77bcf86cd799439011",
"modified_by": {
"user_id": "000000000000000016841367",
"username": "app@fynd.com"
},
"created_on": "2024-03-08T15:28:13Z",
"failed_records": 0,
"file_path": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/K5NXm7Lyo-price-factory-1709894593135.xlsx",
"success_records": 0,
"_id": "65eb2e8d33bcabd6b8deaeb0"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobResponseSchema"
}
}
}
}
},
"summary": "Add products in price factory in bulk",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/bulk",
"methodType": "post"
}
}

🔹 Change 178​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.pollProductPriceFactoryBulkJob
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to poll bulk job for adding products in price factory.",
"operationId": "pollProductPriceFactoryBulkJob",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "A `job_id` is a unique identifier for a particular bulk job.",
"in": "path",
"name": "job_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"total_records": 0,
"success_records": 0,
"failed_records": 0,
"stage": "validated",
"is_active": true,
"_id": "507f1f77bcf86cd799439011",
"created_on": "2024-03-11T09:21:13Z",
"modified_on": "2024-03-11T09:21:13Z",
"created_by": {
"username": "abhinavkumarmishra23_gmail_com_28510",
"user_id": "5960b02b3b2a7cecc680a3d0"
},
"modified_by": {
"username": "abhinavkumarmishra23_gmail_com_28510",
"user_id": "5960b02b3b2a7cecc680a3d0"
},
"error_file_url": null
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobPollResponseSchema"
}
}
}
}
},
"summary": "Poll bulk job for adding products in price factory.",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/poll/{job_id}",
"methodType": "get"
}
}

🔹 Change 179​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.validateProductPriceFactoryBulkJob
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to validate bulk job for adding products in price factory.",
"operationId": "validateProductPriceFactoryBulkJob",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 99
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
},
{
"description": "A `job_id` is a unique identifier for a particular bulk job.",
"in": "path",
"name": "job_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "validate",
"file_type": "xlsx",
"file_path": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/K5NXm7Lyo-price-factory-1709894593135.xlsx"
}
},
"failure": {
"value": {
"job_type": "invalid",
"file_type": "invalid",
"file_path": "https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/50DbgKLND-NtnL_EAVb-REicn1sDv-V8ZrKdnLt-product_inventory.csv"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "validate",
"file_type": "xlsx",
"file_path": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/general/free/original/K5NXm7Lyo-price-factory-1709894593135.xlsx",
"job_id": "65eaebeb9b38cc1e7cefd775",
"status": "validating",
"created_on": "2024-03-08T10:43:55Z",
"modified_on": "2024-03-08T10:43:55Z",
"created_by": {
"username": "purvashukla_gofynd_com_01172",
"user_id": "492cc0ee949ef72b996a8d6e"
},
"modified_by": {
"username": "purvashukla_gofynd_com_01172",
"user_id": "492cc0ee949ef72b996a8d6e"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobValidateResponseSchema"
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"summary": "Validate bulk job for adding products in price factory.",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/bulk/{job_id}/validate",
"methodType": "post"
}
}

🔹 Change 180​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.processProductPriceFactoryBulkJob
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to process bulk job for adding products in price factory.",
"operationId": "processProductPriceFactoryBulkJob",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 99
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
},
{
"description": "A `job_id` is a unique identifier for a particular bulk job.",
"in": "path",
"name": "job_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
},
"failure": {
"value": "507f1f77bcf86cd799439023"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "process",
"file_type": "csv",
"file_path": "https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/50DbgKLND-NtnL_EAVb-REicn1sDv-V8ZrKdnLt-product_inventory.csv"
}
},
"failure": {
"value": {
"job_type": "invalid",
"file_type": "invalid",
"file_path": "https://hdn-1.addsale.com/x0/company/1/self/documents/inventory-import/free/original/50DbgKLND-NtnL_EAVb-REicn1sDv-V8ZrKdnLt-product_inventory.csv"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_id": "507f1f77bcf86cd799439011",
"status": "processing",
"created_on": "2021-09-23T12:00:00Z",
"modified_on": "2021-09-23T12:00:00Z",
"created_by": {
"user_id": "507f1f77bcf86cd799439011",
"username": "testuser"
},
"modified_by": {
"user_id": "507f1f77bcf86cd799439011",
"username": "testuser"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductBulkJobResponseSchema"
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"summary": "Process bulk job for adding products in price factory.",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/bulk/{job_id}/process",
"methodType": "post"
}
}

🔹 Change 181​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.exportProductsInPriceFactory
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to export products in price factory.",
"operationId": "exportProductsInPriceFactory",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"sample_with_data": true
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductExportJobRequestSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "export",
"file_type": "xlsx",
"company_id": 1,
"_id": "65eaebeb9b38cc1e7cefd775",
"created_on": "2024-03-08T10:43:55Z",
"modified_on": "2024-03-08T10:43:55Z",
"created_by": {
"username": "purvashukla_gofynd_com_01172",
"user_id": "492cc0ee949ef72b996a8d6e"
},
"modified_by": {
"username": "purvashukla_gofynd_com_01172",
"user_id": "492cc0ee949ef72b996a8d6e"
},
"success_records": "0,",
"application_id": "65b9f8110a89930b186b1e82,",
"total_records": "0,",
"factory_id": "65c07c52ac3fb9368516566b,",
"is_active": "true,",
"stage": "pending,",
"failed_records": "0,"
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductExportJobResponseSchema"
}
}
}
},
"400": {
"description": "Bad request. See the error object in the response body for specific reason",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Request"
}
}
}
}
}
}
},
"summary": "Export products of price factory.",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/export",
"methodType": "post"
}
}

🔹 Change 182​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.pollPriceFactoryJobs
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to poll job for adding products in price factory.",
"operationId": "pollPriceFactoryJobs",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "An `id` is a unique identifier for a particular price factory.",
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "Date that filters the jobs created after this date",
"in": "query",
"name": "start_date",
"schema": {
"type": "string",
"format": "date"
},
"required": false,
"examples": {
"success": {
"value": "2024-03-08"
}
}
},
{
"description": "Date that filters the jobs created before this date",
"in": "query",
"name": "end_date",
"schema": {
"type": "string",
"format": "date"
},
"required": false,
"examples": {
"success": {
"value": "2024-03-08"
}
}
},
{
"description": "Filter jobs by the stage",
"in": "query",
"name": "stage",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pending",
"validated",
"processed"
]
}
},
"required": false,
"examples": {
"success": {
"value": [
"pending"
]
}
}
},
{
"description": "Filter active or inactive jobs",
"in": "query",
"name": "is_active",
"schema": {
"type": "boolean"
},
"required": false,
"examples": {
"success": {
"value": true
}
}
},
{
"description": "Pass unique identifier for a particular job to poll",
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"required": false,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "Pass type for a particular job to poll",
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"export",
"upload"
]
}
},
"required": false,
"examples": {
"success": {
"value": [
"upload"
]
}
}
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"id": "507f1f77bcf86cd799439011",
"stage": "pending",
"is_active": true,
"created_on": "2024-03-08T15:28:13Z",
"total_records": 0,
"success_records": 10,
"failed_records": 0,
"job_type": "upload"
}
],
"page": {
"current": 1,
"type": "number",
"size": 0,
"has_previous": false,
"has_next": false,
"item_total": 0
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CreateAppPriceFactoryProductExportJobPollResponseSchema"
}
}
}
}
},
"summary": "poll job for adding products in price factory",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/owner-application/{application_id}/price-factory/{id}/poll",
"methodType": "get"
}
}

🔹 Change 183​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppProductPrices
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows to get product prices.",
"operationId": "getAppProductPrices",
"parameters": [
{
"description": "A `company_id` is a unique identifier for a particular company.",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "A `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "507f1f77bcf86cd799439011"
}
}
},
{
"description": "List of item ids to get product prices filtered by items.",
"in": "query",
"name": "item_ids",
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array"
},
"examples": {
"success": {
"value": [
7633128
]
}
}
},
{
"description": "List of factory type ids to get product prices filtered by factory type id.",
"in": "query",
"name": "factory_type_ids",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"examples": {
"success": {
"value": [
"65c0790dccf2ef52e9ed5d53"
]
}
}
},
{
"in": "query",
"name": "page_no",
"description": "The page number to navigate through the given set of results",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "query",
"name": "page_size",
"description": "Number of items to retrieve in each page. Default is 10.",
"required": false,
"schema": {
"type": "integer",
"default": 12
},
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"data": [
{
"discount_meta": {
"start": "2024-02-27T12:33:00Z",
"end": "2024-02-28T18:30:00Z",
"timer": false
},
"product_name": "MDH Peacock Kasoori Methi 50 g",
"item_id": 7642737,
"factory_type_id": "65c0790dccf2ef52e9ed5d53",
"price": {
"selling": {
"min": 111,
"max": 111
},
"effective": {
"min": 111,
"max": 111
},
"currency": "INR",
"marked": {
"min": 6930,
"max": 6930
}
},
"store_id": 47439,
"is_sellable": true,
"seller_id": 20165,
"delivery_zone_ids": [
"65c9f96079eb4e803ddf902e"
],
"sizes": [
"OS"
]
}
],
"page": {
"type": "number",
"current": 1,
"size": 1,
"item_total": 1,
"has_previous": false,
"has_next": false
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ProductPrices"
}
}
},
"description": "Returns a success response"
}
},
"summary": "Get product prices",
"tags": [
"Price Factory"
],
"x-groups": [
"App Product Handling"
],
"security": [
{
"oauth2": [
"application/price_rules/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/product-prices",
"methodType": "get"
}
}

🔹 Change 184​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to list down the available synonyms for an application",
"operationId": "getSynonyms",
"parameters": [
{
"description": "The company id for which the synonym is being referenced",
"in": "path",
"name": "company_id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "The application id for which the synonym is being referenced",
"in": "path",
"name": "application_id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "1"
}
}
},
{
"description": "Mongo id of the particular synonym",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63734731995437c3bfd243b2"
}
}
},
{
"description": "Synonym name",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "maggie"
}
}
},
{
"description": "Synonym type - oneway/twoway",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "oneway"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"page": {
"current": 1,
"type": "number",
"sixe": 10,
"has_previous": false,
"has_next": false,
"item_total": 1
},
"items": [
{
"created_on": "2023-12-04T11:54:15Z",
"_id": "656dbdeed8b44ca030b878e8",
"type": "oneway",
"key": "shampoo22",
"synonyms": [
"parleg",
"marie"
],
"app_id": "7579549",
"modified_on": "2023-12-04T17:24:15Z"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymListResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "List search synonyms for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/synonyms",
"methodType": "get"
}
}

🔹 Change 185​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.createSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to create search synonyms for an application",
"operationId": "createSynonyms",
"parameters": [
{
"description": "The company id for which the synonym is being referenced",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": "1"
},
"failure": {
"value": "1"
}
}
},
{
"description": "The application id for which the synonym is being referenced",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SynonymCreateRequestSchema"
},
"examples": {
"success": {
"value": {
"key": "jeans",
"type": "oneway",
"synonyms": [
"pants",
"trousers"
]
}
},
"failure": {
"value": {
"key": "jeans",
"type": "invalid",
"synonyms": [
"pants",
"trousers"
]
}
}
}
}
},
"description": "Synonym attributes that needs to be created",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"status": true,
"_id": "657884575e12e699f8187f47",
"message": "Synonyms created successfully"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymCreateResponseSchema"
}
}
},
"description": "List of custom search keywords"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"message": "failed",
"errors": {
"type": [
"Invalid type. Must be 'oneway' or 'twoway'"
]
},
"code": 400
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymCreateErrorSchema"
}
}
},
"description": "Returns a failed response"
}
},
"summary": "create oneway/ twoway search synonyms for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/synonyms",
"methodType": "post"
}
}

🔹 Change 186​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.updateSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to modify synonym attributes for a particular application",
"operationId": "updateSynonyms",
"parameters": [
{
"name": "company_id",
"description": "The company id for which the synonym is being referenced",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "1"
}
}
},
{
"name": "application_id",
"description": "The application id for which the synonym is being referenced channel.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"name": "id",
"description": "An `id` is a unique identifier for a particular synonym channel.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "65f15a798458d1d40f1f415c"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"key": "jogger",
"synonyms": [
"pants",
"trousers"
],
"type": "twoway"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymCreateRequestSchema"
}
}
},
"description": "Synonym attributes that needs to be created. See `SynonymRequest` for details",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"success": true,
"message": "Synonym updated"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymUpdateResponseSchema"
}
}
},
"description": "return true/false based on the mongo db operation"
}
},
"summary": "Update synonym attributes for an application",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/synonym/{id}",
"methodType": "put"
}
}

🔹 Change 187​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.deleteSynonym
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to delete synonym for an application",
"operationId": "deleteSynonym",
"parameters": [
{
"description": "The company id for which the synonym is being referenced account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "1"
}
}
},
{
"description": "The application id for which the synonym is being referenced channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "A `id` is a unique identifier of a synonym that is to be deleted.",
"in": "query",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63734731995437c3bfd243b2"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"success": true,
"message": "Synonyms deleted successfully"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymDeleteResponseSchemaSchema"
}
}
},
"description": "Success object. Tells whether the operation was successful."
}
},
"summary": "Delete synonym for an application.",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/synonym",
"methodType": "delete"
}
}

🔹 Change 188​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.exportSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows you to start a job creates a csv file containing all the synonyms for that application",
"operationId": "exportSynonyms",
"parameters": [
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "Id of the company associated to product that is to be viewed",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "export",
"created_on": "2023-12-12T16:03:35Z",
"stage": "pending",
"modified_on": "2023-12-12T16:03:35Z",
"id": "657884575e12e699f8187f47",
"application_id": "65bfcb23b8ba34481e5a986d"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymExportResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "Export synonym for an application.",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/bulk/export",
"methodType": "post"
}
}

🔹 Change 189​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.sampleBulkSynonymsFile
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This api return you the sample file for bulk synonyms upload",
"operationId": "sampleBulkSynonymsFile",
"parameters": [
{
"description": "Type of the file",
"in": "query",
"name": "type",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "csv"
}
}
},
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "1"
}
}
},
{
"description": "Id of the company associated to product that is to be viewed",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"content": {
"text/csv": {
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "ID,TYPE,KEY,SYNONYMS"
}
}
}
},
"description": "Returns a success response"
}
},
"summary": "Get sample file for bulk synonyms upload",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/bulk/sample",
"methodType": "get"
}
}

🔹 Change 190​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.uploadSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This API allows you to upload a list of one-way/two-way synonyms",
"operationId": "uploadSynonyms",
"parameters": [
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
},
"failure": {
"value": "1"
}
}
},
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"file_type": "text/csv",
"tracking_url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/misc/general/free/original/VODIXoxXE-synonyms_sample-1706497535850.csv",
"job_type": "upload"
}
},
"failure": {
"value": {
"file_type": "invalid",
"tracking_url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/misc/general/free/original/VODIXoxXE-synonyms_sample-1706497535850.csv",
"job_type": "invalid"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymUploadRequestSchema"
}
}
},
"description": "Information related to the bulk upload synonym file.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_type": "upload",
"tracking_url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/catalog/asset/6576b9f44306757668cbd1a3/sample.csv",
"file_type": "csv",
"created_on": "2023-12-12T16:03:35Z",
"stage": "pending",
"is_active": true,
"failed_records": 0,
"total_records": 1,
"success_records": 0,
"modified_on": "2023-12-12T16:03:35Z",
"id": "657884575e12e699f8187f47"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymUploadResponseSchema"
}
}
},
"description": "Returns a success response"
},
"400": {
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"message": "failed",
"errors": "validation failed",
"code": 400
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymUploadErrorSchema"
}
}
},
"description": "Returns a failed response"
}
},
"summary": "Upload csv/xls/xlsx file with synonyms",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/bulk",
"methodType": "post"
}
}

🔹 Change 191​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.validateBulkSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to validate the file uploaded for synonyms",
"operationId": "validateBulkSynonyms",
"parameters": [
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_id": "65b71c420fe168ec6be214c9",
"tracking_url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/misc/general/free/original/VODIXoxXE-synonyms_sample-1706497535850.csv",
"file_type": "text/csv",
"job_type": "validate"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymBulkValidateRequestSchema"
}
}
},
"description": "Request body information related to the bulk upload validate endpoint.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"message": "Validation job started",
"job_id": "657884575e12e699f8187f47"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymBulkValidateResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "Validate csv/xls/xlsx file with synonyms",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/bulk/validate",
"methodType": "post"
}
}

🔹 Change 192​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.processBulkSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to process a list of one-way/two-way synonyms",
"operationId": "processBulkSynonyms",
"parameters": [
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"job_id": "65b71c420fe168ec6be214c9",
"tracking_url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/rajatjain/misc/general/free/original/VODIXoxXE-synonyms_sample-1706497535850.csv",
"file_type": "text/csv",
"job_type": "process"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymBulkProcessRequestSchema"
}
}
},
"description": "Information related to the bulk upload validate endpoint.",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"message": "Bulk process Queued",
"job_id": "657884575e12e699f8187f47"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymBulkProcessResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "process csv/xls/xlsx file with synonyms and insert onto db",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/write"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/bulk/process",
"methodType": "post"
}
}

🔹 Change 193​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.pollBulkSynonyms
  • New Schema:
{
"methodTypePlaceHolder": {
"description": "This view allows you to poll for the status of the respective bulk upload job",
"operationId": "pollBulkSynonyms",
"parameters": [
{
"description": "The application id where custom search configuration is set",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "64aed475db2cfb5b8a9f623d"
}
}
},
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"description": "Id of the bulk job that needs to be polled.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "63734731995437c3bfd243b2"
}
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"total_records": 1,
"success_records": 0,
"failed_records": 1,
"stage": "validated",
"error_url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/catalog/asset/657884575e12e699f8187f47/sample.csv"
}
}
},
"schema": {
"$ref": "#/components/schemas/SynonymBulkPollResponseSchema"
}
}
},
"description": "Returns a success response"
}
},
"summary": "poll a particular synonym bulk job for status",
"tags": [
"Search"
],
"x-groups": [
"Application Search Management"
],
"security": [
{
"oauth2": [
"application/settings/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/search/poll/{id}",
"methodType": "get"
}
}

🔹 Change 194​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getCompanyBrandsDRI
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get support representative's associated to a company",
"description": "This API helps to view support representative's associated to a particular company.",
"operationId": "getCompanyBrandsDRI",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Id of the company.",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 385
}
}
},
{
"in": "query",
"name": "page_no",
"description": "The page number to navigate through the given set of results",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "query",
"name": "page_size",
"description": "Number of items to retrieve in each page. Default is 10.",
"required": false,
"schema": {
"type": "integer",
"default": 20
},
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"description": "Company Support representative object.",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"items": [
{
"tags": [
"11"
],
"responsibilities": [
"finance_manager",
"catalog_manager"
],
"responsibilities_display_name": [
"Finance Manager",
"Catalog Manager"
],
"company_id": 385,
"uid": 7,
"contact": {},
"status": true,
"contact_details": {
"id": "5e19b1ba98cfe13fe3138efb",
"firstName": "Gaurang",
"lastName": "Patel",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": 8793638893
}
],
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "gaurangpatel@gofynd.com"
}
]
}
}
],
"page": {
"current": 1,
"size": 1,
"has_previous": false,
"type": "number",
"has_next": false,
"item_total": 1
}
}
}
},
"schema": {
"$ref": "#/components/schemas/CompanyDRIListResponseSchema"
}
}
}
}
},
"tags": [
"Company"
],
"x-groups": [
"Company Onboarding and Metrics"
],
"security": [
{
"oauth2": [
"company/properties/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/poc",
"methodType": "get"
}
}

🔹 Change 195​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getLocationTags
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get tags associated with locations for a company.",
"description": "This API fetches all the tags associated to a company.",
"operationId": "getLocationTags",
"parameters": [
{
"in": "path",
"name": "company_id",
"description": "Id of the company inside which the location is to be created.",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 10
}
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"tags": [
"hyperlocale"
],
"success": true
}
}
},
"schema": {
"$ref": "#/components/schemas/StoreTagsResponseSchema"
}
}
}
}
},
"tags": [
"Location"
],
"x-groups": [
"Application Information & Brand/Category/Department/Location Management"
],
"security": [
{
"oauth2": [
"company/properties/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/location/tags",
"methodType": "get"
}
}

🔹 Change 196​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getAppPriceById
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get pricing of a product",
"description": "Retrieve the discounted price of a specific product for a given application. This endpoint allows filtering by stores, factory types, and sellers",
"tags": [
"Product"
],
"x-groups": [
"Product Management"
],
"operationId": "getAppPriceById",
"parameters": [
{
"description": "An `application_id` is a unique identifier for a particular sale channel.",
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"success": {
"value": "000000000000000000000001"
}
}
},
{
"description": "A `company_id` is a unique identifier for a particular seller account.",
"in": "path",
"name": "company_id",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "path",
"name": "item_id",
"description": "Unique identifier of the product",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"success": {
"value": 7513279
}
}
},
{
"in": "query",
"name": "store_ids",
"description": "An array of unique identifiers representing the store locations from which the product pricing should be fetched. If not provided, pricing for all applicable store locations will be returned.",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"required": false,
"examples": {
"success": {
"value": [
9691
]
}
}
},
{
"in": "query",
"name": "factory_type_ids",
"description": "An array of unique factory type identifiers that specify that pricing from which factory type should be retrieved. This parameter allows filtering the price based on factory types.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"success": {
"value": [
"65f14a0e33072af204b29263"
]
}
}
},
{
"in": "query",
"name": "seller_id",
"description": "The company uid for which we want to fetch discounted pricing for a product",
"schema": {
"type": "integer"
},
"required": false,
"examples": {
"success": {
"value": 1
}
}
}
],
"responses": {
"200": {
"description": "Success. Returns discounted price grouped by factory_type_ids and the min-max marked, effective and selling price",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPriceByIdResponseSchema"
},
"examples": {
"success": {
"value": {
"data": [
{
"discount": "",
"store_id": [
52483
],
"seller_id": 23512,
"factory_type_id": "_all_",
"discount_meta": {},
"price": {
"marked": {
"min": 1194,
"max": 1194,
"currency_code": "INR",
"currency_symbol": "?"
},
"effective": {
"min": 1194,
"max": 1194,
"currency_code": "INR",
"currency_symbol": "?"
},
"selling": {
"min": 1194,
"max": 1194,
"currency_code": "INR",
"currency_symbol": "?"
}
}
}
]
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/products/read"
]
}
],
"path": "/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/item/{item_id}/price",
"methodType": "get"
}
}

Was this section helpful?