API Change Log - Logistic

🧩 Service: Logistic

🔧 Operation: getCountries

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCountries.methodTypePlaceHolder.parameters.0
• New Schema:

{
  "in": "query",
  "name": "onboard",
  "description": "Only fetch countries which allowed for onboard on Platform.",
  "schema": {
    "type": "boolean"
  },
  "required": false,
  "examples": {
    "example_1": {
      "value": true
    },
    "example_3": {
      "value": false
    }
  }
}

🔹 Change 2

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCountries.methodTypePlaceHolder.parameters.2.schema.maximum
• New Schema:

300

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCountries.methodTypePlaceHolder.parameters.4
• New Schema:

{
  "in": "query",
  "name": "hierarchy",
  "description": "The search filter to filter countries based on their available hierarchy.",
  "schema": {
    "type": "string"
  },
  "required": false,
  "examples": {
    "example_1": {
      "value": "pincode"
    },
    "example_3": {
      "value": "pincode"
    }
  }
}

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountries --> CountryObject
• Schema Action: NULLABLE_ADDED
• Path: paths.getCountries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.timezones.nullable
• New Schema:

true

🔹 Change 5

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountries --> CountryObject --> CurrencyObject
• Schema Action: DATA_TYPE_UPDATED
• Path: paths.getCountries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.currency.type
• New Schema:

"object"

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCountries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.currency.properties
• New Schema:

{
  "code": {
    "type": "string"
  },
  "name": {
    "type": "string"
  },
  "symbol": {
    "type": "string"
  }
}

🔹 Change 7

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

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

{
  "description": "Unsuccessful Request",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "examples": {
        "example_3": {
          "value": {
            "error": "The page_size for countries is less that 1"
          }
        }
      }
    }
  }
}

🔧 Operation: getCountry

🔹 Change 1

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

🔹 Change 2

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

🔹 Change 3

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> CountryHierarchy
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.hierarchy.items.properties.name

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> CountryHierarchy
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.hierarchy.items.properties.display_name
• New Schema:

{
  "type": "string"
}

🔹 Change 5

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddress --> GetCountryFieldsValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_one.properties.params.properties.path.properties.locality_type

🔹 Change 6

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddress --> GetCountryFieldsValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_one.properties.params.properties.path.properties.locality_value

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddress --> GetCountryFieldsAddressValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_one.properties.params.properties.path.properties.type
• New Schema:

{
  "type": "string"
}

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddress --> GetCountryFieldsAddressValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_one.properties.params.properties.path.properties.value
• New Schema:

{
  "type": "string"
}

🔹 Change 9

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddress --> GetCountryFieldsValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_all.properties.params.properties.path.properties.locality_type

🔹 Change 10

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddress --> GetCountryFieldsValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_all.properties.params.properties.path.properties.locality_value

🔹 Change 11

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddress --> GetCountryFieldsAddressValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_all.properties.params.properties.path.properties.type
• New Schema:

{
  "type": "string"
}

🔹 Change 12

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddress --> GetCountryFieldsAddressValues --> GetOneOrAll --> GetOneOrAllParams --> GetOneOrAllPath
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.values.properties.get_all.properties.params.properties.path.properties.value
• New Schema:

{
  "type": "string"
}

🔹 Change 13

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddress
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address.items.properties.pre_fill
• New Schema:

{
  "type": "string"
}

🔹 Change 14

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddressTemplate
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.properties.onboarding_form

🔹 Change 15

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryAddressTemplate
• Schema Action: PROPERTY_REMOVED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.properties.location_form

🔹 Change 16

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.properties.checkout_form
• New Schema:

{
  "type": "string"
}

🔹 Change 17

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.properties.store_os_form
• New Schema:

{
  "type": "string"
}

🔹 Change 18

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: PROPERTY_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.properties.default_display
• New Schema:

{
  "type": "string"
}

🔹 Change 19

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: REQUIRED_FIELD_UPDATED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.required.0
• New Schema:

"checkout_form"

🔹 Change 20

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: REQUIRED_FIELD_UPDATED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.required.1
• New Schema:

"store_os_form"

🔹 Change 21

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetCountry --> GetCountryFields --> GetCountryFieldsAddressTemplate
• Schema Action: REQUIRED_FIELD_ADDED
• Path: paths.getCountry.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fields.properties.address_template.required.2
• New Schema:

"default_display"

🔹 Change 22

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

{
  "type": "string"
}

🔹 Change 23

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

{
  "type": "string"
}

🔹 Change 24

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

{
  "$ref": "#/components/schemas/GetCountryFields"
}

🔧 Operation: getLocalities

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getLocalities.methodTypePlaceHolder.parameters.7
• New Schema:

{
  "in": "query",
  "name": "name",
  "description": "Search for localities. Either provide a full name or a search term.",
  "schema": {
    "type": "string"
  },
  "examples": {
    "example_1": {
      "value": "400001"
    },
    "example_3": {
      "value": "400001"
    }
  }
}

🔹 Change 2

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.meta
• New Schema:

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

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.lat_long
• New Schema:

{
  "$ref": "#/components/schemas/PincodeLatLongData"
}

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.parent_uid
• New Schema:

{
  "type": "string",
  "nullable": true
}

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.localities
• New Schema:

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LocalityParent"
  }
}

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.code
• New Schema:

{
  "type": "string",
  "description": "Unique Identifier of the Geolocality"
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.iso2
• New Schema:

{
  "type": "string",
  "example": "",
  "description": "ISO 3166-1 alpha-2 code for the country."
}

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.iso3
• New Schema:

{
  "type": "string",
  "example": "",
  "description": "ISO 3166-1 alpha-3 code for the country."
}

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.currency
• New Schema:

{
  "type": "object",
  "additionalProperties": true,
  "description": "Currency information for the country."
}

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.phone_code
• New Schema:

{
  "type": "string",
  "example": "",
  "x-not-enum": true,
  "description": "Country's international phone dialing code."
}

🔹 Change 11

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.hierarchy
• New Schema:

{
  "type": "object",
  "additionalProperties": true,
  "description": "Hierarchical data of the country's location."
}

🔹 Change 12

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.latitude
• New Schema:

{
  "type": "string",
  "example": "",
  "description": "Latitude of the country's geographic center."
}

🔹 Change 13

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocalities --> Localities
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.longitude
• New Schema:

{
  "type": "string",
  "example": "",
  "description": "Longitude of the country's geographic center."
}

🔹 Change 14

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

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ErrorResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocalities.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
• New Schema:

{
  "type": "string"
}

🔧 Operation: getLocality

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: GetLocality
• Schema Action: NULLABLE_ADDED
• Path: paths.getLocality.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.parent_ids.nullable
• New Schema:

true

🔹 Change 2

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

🔹 Change 3

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

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

🔹 Change 4

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

{
  "type": "string",
  "nullable": true
}

🔹 Change 5

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

{
  "type": "string",
  "description": "Unique Identifier of the Geolocality"
}

🔹 Change 6

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

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LocalityParent"
  }
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ErrorResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getLocality.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
• New Schema:

{
  "type": "string"
}

🔧 Operation: validateAddress

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: ENUM_VALUE_UPDATED
• Path: paths.validateAddress.methodTypePlaceHolder.parameters.1.schema.enum.0
• New Schema:

"checkout_form"

🔹 Change 2

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: ENUM_VALUE_UPDATED
• Path: paths.validateAddress.methodTypePlaceHolder.parameters.1.schema.enum.1
• New Schema:

"store_os_form"

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: ENUM_VALUE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.parameters.1.schema.enum.2
• New Schema:

"default_display"

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.name.nullable
• New Schema:

true

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.phone.nullable
• New Schema:

true

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email.nullable
• New Schema:

true

🔹 Change 7

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

{
  "type": "string",
  "x-not-enum": true,
  "description": "A string containing the recipient's email address."
}

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.name.nullable
• New Schema:

true

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.phone.nullable
• New Schema:

true

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ValidateAddressRequestSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.email.nullable
• New Schema:

true

🔹 Change 11

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

{
  "type": "string",
  "x-not-enum": true,
  "description": "A string containing the recipient's email address."
}

🔹 Change 12

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: ErrorResponse
• Schema Action: PROPERTY_REMOVED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message

🔹 Change 13

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ErrorResponseV3
• Schema Action: PROPERTY_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.success
• New Schema:

{
  "type": "boolean"
}

🔹 Change 14

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ErrorResponseV3
• Schema Action: PROPERTY_ADDED
• Path: paths.validateAddress.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
• New Schema:

{
  "$ref": "#/components/schemas/ErrorObject"
}

🔧 Operation: getLocalitiesByPrefix

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getLocalitiesByPrefix
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Localities by Name Prefix",
    "description": "Get localities that start with a specified prefix.",
    "tags": [
      "Logistics",
      "Pagination"
    ],
    "operationId": "getLocalitiesByPrefix",
    "parameters": [
      {
        "in": "query",
        "name": "page_no",
        "description": "Starting index of the items.",
        "schema": {
          "type": "integer",
          "default": 1,
          "minimum": 1
        },
        "examples": {
          "example_1": {
            "value": 1
          }
        },
        "required": false
      },
      {
        "in": "query",
        "name": "page_size",
        "description": "Number of items per page.",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 10,
          "minimum": 1
        },
        "examples": {
          "example_1": {
            "value": 10
          }
        }
      },
      {
        "in": "query",
        "name": "q",
        "description": "Localities starting with the specified prefix.",
        "schema": {
          "type": "string"
        },
        "required": false,
        "examples": {
          "example_1": {
            "value": "40000"
          },
          "example_3": {
            "value": "ZNX"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Get Locality data",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetLocalities"
            },
            "examples": {
              "example_1": {
                "$ref": "#/components/examples/GetLocalities1"
              }
            }
          }
        }
      },
      "400": {
        "description": "Invalid request.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string"
                }
              }
            },
            "examples": {
              "example_3": {
                "value": {
                  "message": "No items found with search value ZNX"
                }
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Country & Locality"
    ],
    "security": [
      {
        "oauth2": [
          "company/logistics/read"
        ]
      }
    ],
    "path": "/service/panel/logistics/v1.0/localities",
    "methodType": "get"
  }
}

🔧 Operation: getAllCountries

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getAllCountries
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Lists all countries.",
    "description": "Retrieve a list of all countries supported by the system.",
    "tags": [
      "Logistics"
    ],
    "operationId": "getAllCountries",
    "responses": {
      "200": {
        "description": "Get Country List",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CountryListResponseSchema"
            },
            "examples": {
              "example_1": {
                "$ref": "#/components/examples/GetCountriesList1"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Country Information"
    ],
    "path": "/service/panel/logistics/v1.0/country-list",
    "methodType": "get"
  }
}

🔧 Operation: getCompanyConfiguration

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getCompanyConfiguration
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieves company level logistics information",
    "description": "Retrieves company level logistics information",
    "tags": [
      "CourierCompanyRules"
    ],
    "operationId": "getCompanyConfiguration",
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "Unique identifier of the company.",
        "schema": {
          "type": "integer"
        },
        "required": true,
        "examples": {
          "success": {
            "value": 123
          },
          "failure": {
            "value": 988765
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "API response status code",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CompanyConfig"
            },
            "examples": {
              "success": {
                "value": {
                  "sort": [
                    "fastest"
                  ],
                  "company_id": 123,
                  "logistics_as_actual": "seller-controlled"
                }
              }
            }
          }
        }
      },
      "400": {
        "description": "Bad request. See the error object in the response body for specific reason",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/FailureResponseMulitpleErrorSchema"
            },
            "examples": {
              "failure": {
                "value": {
                  "success": false,
                  "error": [
                    {
                      "type": "NotFound",
                      "value": "company_id",
                      "message": "company_id 988765 does not exists in records"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Courier Partner Setup & Rules"
    ],
    "security": [
      {
        "oauth2": [
          "company/logistics/read"
        ]
      }
    ],
    "path": "/service/panel/logistics/v1.0/company/{company_id}/configuration",
    "methodType": "get"
  }
}