Modules: Platform, Admin, Application
🧩 Service: Order​
🔧 Operation: invalidateShipmentCache​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.invalidateShipmentCache.methodTypePlaceHolder.responses.400 - New Schema:
{
"description": "Bad request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"Shipment cache update failure": {
"value": {
"message": "shipment_ids or affiliate_bag_ids or bag_ids in post params is mandatory",
"success": false,
"status": 400
}
}
}
}
}
}
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.invalidateShipmentCache.methodTypePlaceHolder.responses.4XX
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.invalidateShipmentCache.methodTypePlaceHolder.responses.5XX
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.invalidateShipmentCache.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/write"
]
}
🔧 Operation: reassignLocation​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.reassignLocation.methodTypePlaceHolder.responses.400 - New Schema:
{
"description": "Bad request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"success": false,
"message": "_id"
}
}
}
}
}
}
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.reassignLocation.methodTypePlaceHolder.responses.4XX
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.reassignLocation.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/fulfilment/write"
]
}
🔧 Operation: updateShipmentLock​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentLockPayload - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentLock.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.user_id - New Schema:
{
"type": "string",
"description": "The ID of the user."
}
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentLockResponseSchema --> CheckResponseSchema --> OriginalFilter - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentLock.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.check_response.items.properties.original_filter.allOf.0.properties.shipment_id - New Schema:
{
"type": "string",
"description": "Shipment ID"
}
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentLockResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentLock.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.status - New Schema:
{
"type": "integer",
"description": "Status"
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentLock.methodTypePlaceHolder.responses.400 - New Schema:
{
"description": "Bad request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
},
"examples": {
"failure": {
"value": {
"success": false,
"message": "Please provide action as either lock, unlock or check",
"error": "BAD_REQUEST"
}
}
}
}
}
}
🔹 Change 5​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentLock.methodTypePlaceHolder.responses.4XX
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentLock.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/write"
]
}
🔧 Operation: getAnnouncements​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
AnnouncementsResponseSchema --> AnnouncementResponseSchema - Schema Action:
NULLABLE_ADDED - Path:
paths.getAnnouncements.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.announcements.items.properties.company_id.nullable - New Schema:
true
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
AnnouncementsResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getAnnouncements.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message - New Schema:
{
"type": "string",
"description": "A descriptive message providing additional information about the API response."
}
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAnnouncements.methodTypePlaceHolder.responses.4XX
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAnnouncements.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/read"
]
}
🔧 Operation: updateAddress​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_REMOVED - Path:
paths.updateAddress
🔧 Operation: updateShipmentStatus​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
ProductsReasons --> ProductsReasons/properties --> ProductsReasons/properties/filters --> ProductsReasons/properties/filters/items --> ProductsReasonsFilters --> ProductsReasons/properties/filters/items/properties --> ProductsReasons/properties/filters/items/properties/quantity - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.reasons.properties.products.items.properties.filters.items.properties.quantity.type - New Schema:
"number"