API Change Log - CompanyProfile

🧩 Service: CompanyProfile

🔧 Operation: cbsOnboardGet

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.cbsOnboardGet.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.cbsOnboardGet.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.contact_details.properties.emails.items.format

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema
• Schema Action: ENUM_ADDED
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company_type.enum
• New Schema:

[
  "distributor",
  "franchise",
  "mbo",
  "manufacturer-owner"
]

🔹 Change 4

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.addresses.items.properties.pincode.type
• New Schema:

"string"

🔹 Change 5

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.addresses.items.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.responses.400
• New Schema:

{
  "description": "Bad request. See the error object in the response body for specific reason",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorResponseSchema"
      },
      "examples": {
        "BadRequestExample": {
          "value": {
            "message": "Invalid input data",
            "code": "BAD_REQUEST",
            "status": 400,
            "meta": {}
          }
        },
        "NotFoundExample": {
          "value": {
            "message": "Resource not found",
            "code": "NOT_FOUND",
            "status": 404,
            "meta": {}
          }
        }
      }
    }
  }
}

🔹 Change 7

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

🔹 Change 8

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}"

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.cbsOnboardGet.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: updateCompany

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.updateCompany.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.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.business_info.pattern
• New Schema:

"^[a-zA-Z0-9&()_,.:/s -]*$"

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: UpdateCompany
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.warnings.additionalProperties
• New Schema:

true

🔹 Change 4

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: UpdateCompany
• Schema Action: ENUM_ADDED
• Path: paths.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.company_type.enum
• New Schema:

[
  "distributor",
  "franchise",
  "mbo",
  "manufacturer-owner"
]

🔹 Change 5

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

true

🔹 Change 6

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: UpdateCompany --> CreateUpdateAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.addresses.items.properties.pincode.type
• New Schema:

"string"

🔹 Change 7

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: UpdateCompany --> CreateUpdateAddressSerializer
• Schema Action: REQUIRED_FIELD_REMOVED
• Path: paths.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.addresses.items.required.6

🔹 Change 8

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

🔹 Change 9

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.contact_details.properties.emails.items.format

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ProfileSuccessResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.updateCompany.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data
• New Schema:

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

🔹 Change 11

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateCompany.methodTypePlaceHolder.responses.400
• New Schema:

{
  "description": "Bad request. See the error object in the response body for specific reason",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorResponseSchema"
      }
    }
  }
}

🔹 Change 12

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

🔹 Change 13

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateCompany.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}"

🔹 Change 14

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateCompany.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: getCompanyMetrics

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getCompanyMetrics.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.getCompanyMetrics.methodTypePlaceHolder.responses.400
• New Schema:

{
  "description": "Bad request. See the error object in the response body for specific reason",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorResponseSchema"
      }
    }
  }
}

🔹 Change 3

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

🔹 Change 4

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCompanyMetrics.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/metrics"

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCompanyMetrics.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: getBrand

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getBrand.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.getBrand.methodTypePlaceHolder.parameters.1.schema.type
• New Schema:

"integer"

🔹 Change 3

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

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrand.methodTypePlaceHolder.responses.400
• New Schema:

{
  "description": "Bad request. See the error object in the response body for specific reason",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorResponseSchema"
      }
    }
  }
}

🔹 Change 5

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

🔹 Change 6

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrand.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/brand/{brand_id}"

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrand.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: editBrand

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.editBrand.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.editBrand.methodTypePlaceHolder.parameters.1.schema.type
• New Schema:

"integer"

🔹 Change 3

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

true

🔹 Change 4

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

true

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CreateUpdateBrandRequestSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.editBrand.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.slug_key
• New Schema:

{
  "type": "string"
}

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ProfileSuccessResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.editBrand.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data
• New Schema:

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.editBrand.methodTypePlaceHolder.responses.400
• New Schema:

{
  "description": "Bad request. See the error object in the response body for specific reason",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorResponseSchema"
      }
    }
  }
}

🔹 Change 8

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

🔹 Change 9

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.editBrand.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/brand/{brand_id}"

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.editBrand.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: createBrand

🔹 Change 1

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

"integer"

🔹 Change 2

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

true

🔹 Change 3

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

true

🔹 Change 4

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createBrand.methodTypePlaceHolder.responses.200

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createBrand.methodTypePlaceHolder.responses.201
• New Schema:

{
  "description": "Returns a success response",
  "content": {
    "application/json": {
      "examples": {
        "success": {
          "value": {
            "uid": 1,
            "success": true
          }
        }
      },
      "schema": {
        "$ref": "#/components/schemas/ProfileSuccessResponseSchema"
      }
    }
  }
}

🔹 Change 6

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

🔹 Change 7

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createBrand.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/brand"

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createBrand.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: getBrands

🔹 Change 1

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

"integer"

🔹 Change 2

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.addresses.items.properties.pincode.type
• New Schema:

"string"

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.getBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.addresses.items.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 4

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: CompanyBrandListSerializer --> CompanyBrandSerializer --> CompanySerializer
• Schema Action: REQUIRED_FIELD_REMOVED
• Path: paths.getBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.required.0

🔹 Change 5

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.brand.properties.verified_on.format

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CompanyBrandListSchema --> Page
• Schema Action: PROPERTY_ADDED
• Path: paths.getBrands.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 7

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

🔹 Change 8

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrands.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/company-brand"

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getBrands.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: createCompanyBrandMapping

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.createCompanyBrandMapping.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.createCompanyBrandMapping.methodTypePlaceHolder.responses.200

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createCompanyBrandMapping.methodTypePlaceHolder.responses.201
• New Schema:

{
  "description": "Returns a success response",
  "content": {
    "application/json": {
      "examples": {
        "success": {
          "value": {
            "success": true
          }
        }
      },
      "schema": {
        "$ref": "#/components/schemas/ProfileSuccessResponseSchema"
      }
    }
  }
}

🔹 Change 4

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

🔹 Change 5

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createCompanyBrandMapping.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/company-brand"

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createCompanyBrandMapping.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: getLocations

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocations.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.getLocations.methodTypePlaceHolder.parameters.1.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.getLocations.methodTypePlaceHolder.parameters.9
• New Schema:

{
  "in": "query",
  "name": "store_codes",
  "description": "List of up to 50 store codes to fetch. Specify multiple values by repeating the query parameter (e.g., `?store_codes=high_street&store_codes=main_avenue`). Comma-separated values are not supported.",
  "required": false,
  "schema": {
    "type": "array",
    "items": {
      "type": "string"
    }
  },
  "examples": {
    "multi_query": {
      "summary": "Multiple query parameters example",
      "value": [
        "store_codes=high_street",
        "store_codes=main_avenue"
      ]
    },
    "single_value": {
      "summary": "Single value example",
      "value": [
        "store_codes=main_avenue"
      ]
    }
  }
}

🔹 Change 4

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.company_type.enum
• New Schema:

[
  "distributor",
  "franchise",
  "mbo",
  "manufacturer-owner"
]

🔹 Change 5

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.addresses.items.properties.pincode.type
• New Schema:

"string"

🔹 Change 6

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties.addresses.items.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company.properties._custom_json
• New Schema:

{
  "type": "object",
  "additionalProperties": true
}

🔹 Change 8

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.address.properties.pincode.type
• New Schema:

"string"

🔹 Change 9

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.address.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 10

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_type.enum
• New Schema:

[
  "high_street",
  "warehouse",
  "mall"
]

🔹 Change 11

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocations.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.manager.properties.email.format

🔹 Change 12

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CompanyBrandListSchema --> Page
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocations.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.getLocations.methodTypePlaceHolder.responses.4XX

🔹 Change 14

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocations.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/location"

🔹 Change 15

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocations.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: createLocation

🔹 Change 1

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

"integer"

🔹 Change 2

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

true

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.createLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.warnings.additionalProperties
• New Schema:

true

🔹 Change 4

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema --> AddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.createLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.address.properties.pincode.type
• New Schema:

"string"

🔹 Change 5

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ENUM_ADDED
• Path: paths.createLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.store_type.enum
• New Schema:

[
  "high_street",
  "warehouse",
  "mall"
]

🔹 Change 6

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.manager.properties.email.format

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ProfileSuccessResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.createLocation.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data
• New Schema:

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

🔹 Change 8

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

🔹 Change 9

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocation.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/location"

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocation.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: getLocationDetail

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocationDetail.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.getLocationDetail.methodTypePlaceHolder.parameters.1.schema.type
• New Schema:

"integer"

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company.properties.company_type.enum
• New Schema:

[
  "distributor",
  "franchise",
  "mbo",
  "manufacturer-owner"
]

🔹 Change 4

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company.properties.addresses.items.properties.pincode.type
• New Schema:

"string"

🔹 Change 5

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company.properties.addresses.items.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema --> GetCompanySchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company.properties._custom_json
• New Schema:

{
  "type": "object",
  "additionalProperties": true
}

🔹 Change 7

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.address.properties.pincode.type
• New Schema:

"string"

🔹 Change 8

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCompanyProfileSerializerResponseSchema --> GetAddressSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.address.properties.address_type.enum
• New Schema:

[
  "home",
  "registered",
  "office"
]

🔹 Change 9

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationListSchema --> GetLocationSchema
• Schema Action: ENUM_ADDED
• Path: paths.getLocationDetail.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_type.enum
• New Schema:

[
  "high_street",
  "warehouse",
  "mall"
]

🔹 Change 10

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

🔹 Change 11

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

🔹 Change 12

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocationDetail.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/location/{location_id}"

🔹 Change 13

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocationDetail.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]

🔧 Operation: updateLocation

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.updateLocation.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.updateLocation.methodTypePlaceHolder.parameters.1.schema.type
• New Schema:

"integer"

🔹 Change 3

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

true

🔹 Change 4

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.updateLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.warnings.additionalProperties
• New Schema:

true

🔹 Change 5

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema --> AddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.updateLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.address.properties.pincode.type
• New Schema:

"string"

🔹 Change 6

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ENUM_ADDED
• Path: paths.updateLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.store_type.enum
• New Schema:

[
  "high_street",
  "warehouse",
  "mall"
]

🔹 Change 7

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateLocation.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.manager.properties.email.format

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ProfileSuccessResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.updateLocation.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data
• New Schema:

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

🔹 Change 9

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

🔹 Change 10

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateLocation.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v2.0/company/{company_id}/location/{location_id}"

🔹 Change 11

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateLocation.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: createLocationBulk

🔹 Change 1

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

"integer"

🔹 Change 2

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.createLocationBulk.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.items.properties._custom_json.additionalProperties
• New Schema:

true

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.createLocationBulk.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.items.properties.warnings.additionalProperties
• New Schema:

true

🔹 Change 4

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema --> AddressSchema
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.createLocationBulk.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.items.properties.address.properties.pincode.type
• New Schema:

"string"

🔹 Change 5

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: LocationSchema
• Schema Action: ENUM_ADDED
• Path: paths.createLocationBulk.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.items.properties.store_type.enum
• New Schema:

[
  "high_street",
  "warehouse",
  "mall"
]

🔹 Change 6

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocationBulk.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.items.properties.manager.properties.email.format

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ProfileSuccessResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.createLocationBulk.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data
• New Schema:

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

🔹 Change 8

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

🔹 Change 9

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocationBulk.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/location/bulk"

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.createLocationBulk.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/write"
    ]
  }
]

🔧 Operation: getLocationTags

🔹 Change 1

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

🔹 Change 2

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocationTags.methodTypePlaceHolder.path
• New Schema:

"/service/platform/catalog/v1.0/company/{company_id}/location/tags"

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocationTags.methodTypePlaceHolder.security
• New Schema:

[
  {
    "oauth2": [
      "company/properties/read"
    ]
  }
]