🧩 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"
🔹 Change 2​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - 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.format - New Schema:
"float"
🔹 Change 3​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentStatusRequestSchema --> UpdateShipmentStatusRequestSchema/properties --> UpdateShipmentStatusRequestSchema/properties/statuses --> UpdateShipmentStatusRequestSchema/properties/statuses/items --> StatuesRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items --> ShipmentsRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/products --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/products/items --> Products --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/products/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/products/items/properties/quantity - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.products.items.properties.quantity.type - New Schema:
"number"
🔹 Change 4​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.products.items.properties.quantity.format - New Schema:
"float"
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ProductsDataUpdates --> ProductsDataUpdates/properties --> ProductsDataUpdates/properties/filters --> ProductsDataUpdates/properties/filters/items --> ProductsDataUpdatesFilters --> ProductsDataUpdates/properties/filters/items/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.data_updates.properties.products.items.properties.filters.items.properties.quantity - New Schema:
{
"type": "number",
"format": "float",
"description": "The quantity of the product or item. This indicates how many units of the product are being referenced or processed, such as the number of items in a bag or shipment."
}
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentStatusRequestSchema --> UpdateShipmentStatusRequestSchema/properties --> UpdateShipmentStatusRequestSchema/properties/statuses --> UpdateShipmentStatusRequestSchema/properties/statuses/items --> StatuesRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items --> ShipmentsRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/data_updates --> DataUpdates --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/data_updates/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.data_updates.properties.repriced_products - New Schema:
{
"description": "To update the prices of the line items and trigger the repricing event process.",
"type": "array",
"items": {
"$ref": "#/components/schemas/RepricedProductsDataUpdates"
}
}
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentStatusRequestSchema --> UpdateShipmentStatusRequestSchema/properties --> UpdateShipmentStatusRequestSchema/properties/statuses --> UpdateShipmentStatusRequestSchema/properties/statuses/items --> StatuesRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items --> ShipmentsRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/data_updates --> DataUpdates --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties/data_updates/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.data_updates.properties.order - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDataUpdates"
}
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
UpdateShipmentStatusRequestSchema --> UpdateShipmentStatusRequestSchema/properties --> UpdateShipmentStatusRequestSchema/properties/statuses --> UpdateShipmentStatusRequestSchema/properties/statuses/items --> StatuesRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items --> ShipmentsRequestSchema --> UpdateShipmentStatusRequestSchema/properties/statuses/items/properties/shipments/items/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.statuses.items.properties.shipments.items.properties.transition_comments - New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TransitionComments"
}
}
🔹 Change 9​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.responses.4XX
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateShipmentStatus.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/fulfilment/write"
]
}
🔧 Operation: getRoleBasedActions​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getRoleBasedActions.methodTypePlaceHolder.responses.4XX
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getRoleBasedActions.methodTypePlaceHolder.responses.5XX
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getRoleBasedActions.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/read"
]
}
🔧 Operation: getShipmentHistory​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.ticket_url.nullable - New Schema:
true
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l3_detail.nullable - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.ticket_id.nullable - New Schema:
true
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l2_detail.nullable - New Schema:
true
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.assigned_agent.nullable - New Schema:
true
🔹 Change 6​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.allOf
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict --> HistoryMeta - Schema Action:
DATA_TYPE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.type - New Schema:
"object"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.properties - New Schema:
{
"store_id": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "Unique identifier for the store involved in the activity."
},
"status": {
"type": "string",
"nullable": true,
"description": "Current status of the activity or item."
},
"status1": {
"type": "string",
"nullable": true,
"description": "Additional status information if necessary."
},
"call_id": {
"type": "string",
"nullable": true,
"description": "Identifier for any related calls, if applicable."
},
"starttime": {
"type": "string",
"nullable": true,
"description": "Start time of the activity."
},
"reason": {
"$ref": "#/components/schemas/HistoryReason"
},
"short_link": {
"type": "string",
"nullable": true,
"description": "A shortened link related to the activity, if available."
},
"endtime": {
"type": "string",
"nullable": true,
"description": "End time of the activity."
},
"store_name": {
"type": "string",
"nullable": true,
"description": "Name of the store involved in the activity."
},
"caller": {
"type": "string",
"nullable": true,
"description": "Name of the caller associated with the activity."
},
"store_code": {
"type": "string",
"nullable": true,
"description": "Code associated with the store.",
"x-not-enum": true
},
"billsec": {
"type": "string",
"nullable": true,
"description": "Duration of the billable period, if applicable."
},
"recordpath": {
"type": "string",
"nullable": true,
"description": "Path to any related recordings, if applicable."
},
"status2": {
"type": "string",
"nullable": true,
"description": "Additional status information if necessary."
},
"callerid": {
"type": "string",
"nullable": true,
"description": "Caller ID associated with the activity, if applicable."
},
"duration": {
"type": "string",
"nullable": true,
"description": "Total duration of the activity."
},
"channel_type": {
"type": "string",
"enum": [
"email",
"sms",
null
],
"nullable": true,
"description": "Type of channel used for the activity, if applicable."
},
"activity_comment": {
"type": "string",
"nullable": true,
"description": "Comments related to the activity, if applicable."
},
"activity_type": {
"type": "string",
"nullable": true,
"description": "Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.",
"enum": [
"activity_status",
"activity_comment",
"outbound_notification",
"outbound_voice",
"activity_escalation",
null
]
},
"receiver": {
"type": "string",
"nullable": true,
"description": "Name of the receiver involved in the activity, if applicable."
},
"recipient": {
"type": "string",
"nullable": true,
"description": "Recipient of the activity, if applicable."
},
"slug": {
"type": "string",
"nullable": true,
"description": "Slug identifier for the activity."
},
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"prev_store_name": {
"type": "string",
"nullable": true,
"description": "The name of the store where the item was previously located before being transferred or processed. This field can be null if the previous store information is not applicable or available."
},
"prev_store_code": {
"x-not-enum": true,
"type": "string",
"nullable": true,
"description": "The unique code associated with the previous store. This code helps identify the store in the system and can be null if the previous store code is not recorded or required."
},
"prev_store_id": {
"type": "string",
"nullable": true,
"description": "The unique identifier (ID) of the previous store in the database or system. This ID can be null if the previous store information is not relevant or if the store did not have a designated ID."
},
"refund_to": {
"type": "string",
"nullable": true,
"description": "The destination or method by which a refund will be issued. This indicates where the refunded amount will be sent, such as back to the original payment source (e.g., 'Back To Source')."
},
"refund_information": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RefundInformation"
}
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l1_detail.nullable - New Schema:
true
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
PROPERTY_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.user_details - New Schema:
{
"type": "object",
"description": "User Details",
"additionalProperties": true
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
PROPERTY_ADDED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.activity_type - New Schema:
{
"type": "string",
"enum": [
"activity_status",
"activity_comment",
"outbound_notification",
"outbound_voice",
"activity_escalation"
]
}
🔹 Change 12​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
REQUIRED_FIELD_UPDATED - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.required.2 - New Schema:
"activity_type"
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.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": "Error while getting the shipment history, Error: Internal Server Error",
"status": 400
}
}
}
}
}
}
🔹 Change 14​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.4XX
🔹 Change 15​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.methodTypePlaceHolder.responses.5XX
🔹 Change 16​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getShipmentHistory.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/read"
]
}
🔧 Operation: postShipmentHistory​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.ticket_url.nullable - New Schema:
true
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l3_detail.nullable - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.ticket_id.nullable - New Schema:
true
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l2_detail.nullable - New Schema:
true
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.assigned_agent.nullable - New Schema:
true
🔹 Change 6​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.allOf
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict --> HistoryMeta - Schema Action:
DATA_TYPE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.type - New Schema:
"object"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.meta.properties - New Schema:
{
"store_id": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "Unique identifier for the store involved in the activity."
},
"status": {
"type": "string",
"nullable": true,
"description": "Current status of the activity or item."
},
"status1": {
"type": "string",
"nullable": true,
"description": "Additional status information if necessary."
},
"call_id": {
"type": "string",
"nullable": true,
"description": "Identifier for any related calls, if applicable."
},
"starttime": {
"type": "string",
"nullable": true,
"description": "Start time of the activity."
},
"reason": {
"$ref": "#/components/schemas/HistoryReason"
},
"short_link": {
"type": "string",
"nullable": true,
"description": "A shortened link related to the activity, if available."
},
"endtime": {
"type": "string",
"nullable": true,
"description": "End time of the activity."
},
"store_name": {
"type": "string",
"nullable": true,
"description": "Name of the store involved in the activity."
},
"caller": {
"type": "string",
"nullable": true,
"description": "Name of the caller associated with the activity."
},
"store_code": {
"type": "string",
"nullable": true,
"description": "Code associated with the store.",
"x-not-enum": true
},
"billsec": {
"type": "string",
"nullable": true,
"description": "Duration of the billable period, if applicable."
},
"recordpath": {
"type": "string",
"nullable": true,
"description": "Path to any related recordings, if applicable."
},
"status2": {
"type": "string",
"nullable": true,
"description": "Additional status information if necessary."
},
"callerid": {
"type": "string",
"nullable": true,
"description": "Caller ID associated with the activity, if applicable."
},
"duration": {
"type": "string",
"nullable": true,
"description": "Total duration of the activity."
},
"channel_type": {
"type": "string",
"enum": [
"email",
"sms",
null
],
"nullable": true,
"description": "Type of channel used for the activity, if applicable."
},
"activity_comment": {
"type": "string",
"nullable": true,
"description": "Comments related to the activity, if applicable."
},
"activity_type": {
"type": "string",
"nullable": true,
"description": "Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.",
"enum": [
"activity_status",
"activity_comment",
"outbound_notification",
"outbound_voice",
"activity_escalation",
null
]
},
"receiver": {
"type": "string",
"nullable": true,
"description": "Name of the receiver involved in the activity, if applicable."
},
"recipient": {
"type": "string",
"nullable": true,
"description": "Recipient of the activity, if applicable."
},
"slug": {
"type": "string",
"nullable": true,
"description": "Slug identifier for the activity."
},
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"prev_store_name": {
"type": "string",
"nullable": true,
"description": "The name of the store where the item was previously located before being transferred or processed. This field can be null if the previous store information is not applicable or available."
},
"prev_store_code": {
"x-not-enum": true,
"type": "string",
"nullable": true,
"description": "The unique code associated with the previous store. This code helps identify the store in the system and can be null if the previous store code is not recorded or required."
},
"prev_store_id": {
"type": "string",
"nullable": true,
"description": "The unique identifier (ID) of the previous store in the database or system. This ID can be null if the previous store information is not relevant or if the store did not have a designated ID."
},
"refund_to": {
"type": "string",
"nullable": true,
"description": "The destination or method by which a refund will be issued. This indicates where the refunded amount will be sent, such as back to the original payment source (e.g., 'Back To Source')."
},
"refund_information": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RefundInformation"
}
}
}
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
NULLABLE_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.l1_detail.nullable - New Schema:
true
🔹 Change 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
PROPERTY_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.user_details - New Schema:
{
"type": "object",
"description": "User Details",
"additionalProperties": true
}
🔹 Change 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
PROPERTY_ADDED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.properties.activity_type - New Schema:
{
"type": "string",
"enum": [
"activity_status",
"activity_comment",
"outbound_notification",
"outbound_voice",
"activity_escalation"
]
}
🔹 Change 12​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
ShipmentHistoryResponseSchema --> HistoryDict - Schema Action:
REQUIRED_FIELD_UPDATED - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.activity_history.items.required.2 - New Schema:
"activity_type"
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.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/ErrorDetail"
},
"examples": {
"failure": {
"value": {
"success": false,
"message": "activity_history can't be empty or None",
"status": 400
}
}
}
}
}
}
🔹 Change 14​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.4XX
🔹 Change 15​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.methodTypePlaceHolder.responses.5XX
🔹 Change 16​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.postShipmentHistory.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"company/orders/write"
]
}
]
🔧 Operation: sendSmsNinja​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.sendSmsNinja.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.allOf
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
SendSmsPayload --> SmsDataPayload - Schema Action:
DATA_TYPE_ADDED - Path:
paths.sendSmsNinja.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.type - New Schema:
"object"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.sendSmsNinja.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.properties - New Schema:
{
"days": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for the shipment associated with the SMS."
},
"reason": {
"type": "string",
"description": "reason"
},
"shipment_id": {
"type": "string",
"description": "ShipmentId"
},
"phone_number": {
"type": "string",
"description": "The recipient's phone number for communication."
},
"amount_paid": {
"type": "number",
"description": "The amount that has been paid, as mapped in the communication template."
},
"order_id": {
"type": "string",
"description": "Unique identifier for the order associated with the shipment."
},
"payment_mode": {
"type": "string",
"description": "The mode of payment used for the order, as mapped in the communication template."
},
"customer_name": {
"type": "string",
"description": "The name of the customer, as mapped in the communication template."
},
"brand_name": {
"type": "string",
"description": "The name of the brand associated with the order, as mapped in the communication template."
},
"message": {
"type": "string",
"description": "The content of the SMS to be sent to the recipient."
},
"country_code": {
"type": "string",
"description": "The country code for the recipient's phone number, necessary for proper SMS delivery.",
"x-not-enum": true
}
}
🔹 Change 4​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
SendSmsPayload --> SmsDataPayload - Schema Action:
REQUIRED_ADDED - Path:
paths.sendSmsNinja.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data.required - New Schema:
[
"reason",
"days",
"country_code",
"brand_name",
"customer_name",
"message",
"order_id",
"phone_number",
"shipment_id"
]
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
SendSmsResponseSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.sendSmsNinja.methodTypePlaceHolder.responses.200.content.application/json.schema.required - New Schema:
[
"success",
"message"
]
🔹 Change 6​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.sendSmsNinja.methodTypePlaceHolder.responses.4XX
🔹 Change 7​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.sendSmsNinja.methodTypePlaceHolder.responses.5XX
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.sendSmsNinja.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/orders/write"
]
}
🔧 Operation: updatePackagingDimensions​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
UpdatePackagingDimensionsPayload --> UpdatePackagingDimensionsPayload/properties --> UpdatePackagingDimensionsPayload/properties/dimension --> UpdatePackagingDimensionsPayload/properties/dimension/items --> Dimension --> UpdatePackagingDimensionsPayload/properties/dimension/items/properties - Schema Action:
PROPERTY_REMOVED - Path:
paths.updatePackagingDimensions.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.dimension.items.properties.dead_weight
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePackagingDimensions.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": {
"status": 400,
"success": false,
"message": "Failed",
"error_trace": "Error"
}
}
}
}
}
}
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePackagingDimensions.methodTypePlaceHolder.responses.4XX
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updatePackagingDimensions.methodTypePlaceHolder.security.1 - New Schema:
{
"oauth2": [
"company/fulfilment/write"
]
}
🔧 Operation: createOrder​
🔹 Change 1​
- Action:
remove - Type:
non-breaking - xGroup:
N/A - Schema Ref:
LineItem --> LineItem/properties --> LineItem/properties/charges --> LineItem/properties/charges/items --> Charge --> LineItem/properties/charges/items/properties --> LineItem/properties/charges/items/properties/amount --> AmountSchema - Schema Action:
DATA_TYPE_REMOVED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.properties.charges.items.properties.amount.type
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.properties.charges.items.properties.amount.properties
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.properties.charges.items.properties.amount.allOf - New Schema:
[
{
"$ref": "#/components/schemas/AmountSchema"
}
]
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.properties.charges.items.properties.tax.properties.amount.properties - New Schema:
{
"ordering_currency": {
"$ref": "#/components/schemas/CurrencyValueSchema"
},
"base_currency": {
"$ref": "#/components/schemas/CurrencyValueSchema"
}
}
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Charge --> Charge/properties --> Charge/properties/tax --> Tax --> Charge/properties/tax/properties --> Charge/properties/tax/properties/amount --> AmountSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.properties.charges.items.properties.tax.properties.amount.required - New Schema:
[
"ordering_currency",
"base_currency"
]
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/line_items --> Shipment/properties/line_items/items --> LineItem - Schema Action:
REQUIRED_FIELD_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.line_items.items.required.1 - New Schema:
"charges"
🔹 Change 7​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.processing_dates.properties.pack_by_date.format - New Schema:
"date-time"
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateOrderAPI --> CreateOrderAPI/properties --> CreateOrderAPI/properties/shipments --> CreateOrderAPI/properties/shipments/items --> Shipment --> CreateOrderAPI/properties/shipments/items/properties --> CreateOrderAPI/properties/shipments/items/properties/order_type - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.order_type.enum.2 - New Schema:
"Digital"
🔹 Change 9​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_type - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.address_type.enum - New Schema:
[
"home",
"office",
"other",
null
]
🔹 Change 10​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_category - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.address_category.enum - New Schema:
[
"store",
"delivery",
"billing",
null
]
🔹 Change 11​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.created_at.format - New Schema:
"date-time"
🔹 Change 12​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.address - New Schema:
{
"type": "string",
"nullable": true,
"description": "An optional additional field for the street address of the address."
}
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.area_code_slug - New Schema:
{
"type": "string",
"nullable": true,
"description": "A slug representation of the area code."
}
🔹 Change 15​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.country_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "A code representing the country for the address."
}
🔹 Change 16​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.country_iso_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The ISO code representing the country for the address."
}
🔹 Change 17​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.country_phone_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The country-specific phone code for formatting phone numbers."
}
🔹 Change 18​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.delivery_address_id - New Schema:
{
"type": "string",
"description": "A unique identifier for the delivery address."
}
🔹 Change 19​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.geo_location - New Schema:
{
"type": "object",
"description": "An object containing additional geographical information related to the address.",
"additionalProperties": true
}
🔹 Change 20​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.name - New Schema:
{
"type": "string",
"description": "A unique identifier for the name associated with the address."
}
🔹 Change 21​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.sector - New Schema:
{
"type": "string",
"description": "The sector or zone of the address, if applicable."
}
🔹 Change 22​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.state_code - New Schema:
{
"type": "string",
"x-not-enum": true,
"description": "A code representing the state or region for the address."
}
🔹 Change 23​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.uid - New Schema:
{
"type": "string",
"description": "A unique identifier for the user associated with the address."
}
🔹 Change 24​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.user_id - New Schema:
{
"type": "string",
"description": "The unique identifier of the user in the system."
}
🔹 Change 25​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.code - New Schema:
{
"type": "string"
}
🔹 Change 26​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.store_address_json - New Schema:
{
"additionalProperties": true,
"type": "object"
}
🔹 Change 27​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.id - New Schema:
{
"type": "number"
}
🔹 Change 28​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.location_type - New Schema:
{
"type": "string",
"enum": [
"high_street",
"mall",
"store",
"warehouse"
]
}
🔹 Change 29​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.company_id - New Schema:
{
"type": "number"
}
🔹 Change 30​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.billing_address_json.properties.store_email - New Schema:
{
"type": "string"
}
🔹 Change 31​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_type - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.address_type.enum - New Schema:
[
"home",
"office",
"other",
null
]
🔹 Change 32​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_category - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.address_category.enum - New Schema:
[
"store",
"delivery",
"billing",
null
]
🔹 Change 33​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.created_at.format - New Schema:
"date-time"
🔹 Change 34​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 35​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.address - New Schema:
{
"type": "string",
"nullable": true,
"description": "An optional additional field for the street address of the address."
}
🔹 Change 36​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.area_code_slug - New Schema:
{
"type": "string",
"nullable": true,
"description": "A slug representation of the area code."
}
🔹 Change 37​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.country_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "A code representing the country for the address."
}
🔹 Change 38​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.country_iso_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The ISO code representing the country for the address."
}
🔹 Change 39​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.country_phone_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The country-specific phone code for formatting phone numbers."
}
🔹 Change 40​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.delivery_address_id - New Schema:
{
"type": "string",
"description": "A unique identifier for the delivery address."
}
🔹 Change 41​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.geo_location - New Schema:
{
"type": "object",
"description": "An object containing additional geographical information related to the address.",
"additionalProperties": true
}
🔹 Change 42​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.name - New Schema:
{
"type": "string",
"description": "A unique identifier for the name associated with the address."
}
🔹 Change 43​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.sector - New Schema:
{
"type": "string",
"description": "The sector or zone of the address, if applicable."
}
🔹 Change 44​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.state_code - New Schema:
{
"type": "string",
"x-not-enum": true,
"description": "A code representing the state or region for the address."
}
🔹 Change 45​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.uid - New Schema:
{
"type": "string",
"description": "A unique identifier for the user associated with the address."
}
🔹 Change 46​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.user_id - New Schema:
{
"type": "string",
"description": "The unique identifier of the user in the system."
}
🔹 Change 47​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.code - New Schema:
{
"type": "string"
}
🔹 Change 48​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.store_address_json - New Schema:
{
"additionalProperties": true,
"type": "object"
}
🔹 Change 49​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.id - New Schema:
{
"type": "number"
}
🔹 Change 50​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.location_type - New Schema:
{
"type": "string",
"enum": [
"high_street",
"mall",
"store",
"warehouse"
]
}
🔹 Change 51​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.company_id - New Schema:
{
"type": "number"
}
🔹 Change 52​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.delivery_address_json.properties.store_email - New Schema:
{
"type": "string"
}
🔹 Change 53​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.tags.items.properties - New Schema:
{
"slug": {
"type": "string",
"description": "A unique identifier or short label for the tag for shipment reference."
},
"display_text": {
"type": "string",
"description": "Label of the tag. This text is shown to users, representing the tag in an human-readable format."
}
}
🔹 Change 54​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.created_at.format - New Schema:
"date-time"
🔹 Change 55​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_type - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.address_type.enum - New Schema:
[
"home",
"office",
"other",
null
]
🔹 Change 56​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties --> Shipment/properties/billing_address_json/properties/address_category - Schema Action:
ENUM_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.address_category.enum - New Schema:
[
"store",
"delivery",
"billing",
null
]
🔹 Change 57​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.created_at.format - New Schema:
"date-time"
🔹 Change 58​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.updated_at.format - New Schema:
"date-time"
🔹 Change 59​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.address - New Schema:
{
"type": "string",
"nullable": true,
"description": "An optional additional field for the street address of the address."
}
🔹 Change 60​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.area_code_slug - New Schema:
{
"type": "string",
"nullable": true,
"description": "A slug representation of the area code."
}
🔹 Change 61​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.country_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "A code representing the country for the address."
}
🔹 Change 62​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.country_iso_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The ISO code representing the country for the address."
}
🔹 Change 63​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.country_phone_code - New Schema:
{
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "The country-specific phone code for formatting phone numbers."
}
🔹 Change 64​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.delivery_address_id - New Schema:
{
"type": "string",
"description": "A unique identifier for the delivery address."
}
🔹 Change 65​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.geo_location - New Schema:
{
"type": "object",
"description": "An object containing additional geographical information related to the address.",
"additionalProperties": true
}
🔹 Change 66​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.name - New Schema:
{
"type": "string",
"description": "A unique identifier for the name associated with the address."
}
🔹 Change 67​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.sector - New Schema:
{
"type": "string",
"description": "The sector or zone of the address, if applicable."
}
🔹 Change 68​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.state_code - New Schema:
{
"type": "string",
"x-not-enum": true,
"description": "A code representing the state or region for the address."
}
🔹 Change 69​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.uid - New Schema:
{
"type": "string",
"description": "A unique identifier for the user associated with the address."
}
🔹 Change 70​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.user_id - New Schema:
{
"type": "string",
"description": "The unique identifier of the user in the system."
}
🔹 Change 71​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.code - New Schema:
{
"type": "string"
}
🔹 Change 72​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.store_address_json - New Schema:
{
"additionalProperties": true,
"type": "object"
}
🔹 Change 73​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.id - New Schema:
{
"type": "number"
}
🔹 Change 74​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.location_type - New Schema:
{
"type": "string",
"enum": [
"high_street",
"mall",
"store",
"warehouse"
]
}
🔹 Change 75​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.company_id - New Schema:
{
"type": "number"
}
🔹 Change 76​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/billing_address_json --> Address --> Shipment/properties/billing_address_json/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.hand_over_contact_json.properties.store_email - New Schema:
{
"type": "string"
}
🔹 Change 77​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.status.properties.status_created_at.format - New Schema:
"date-time"
🔹 Change 78​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
Shipment --> Shipment/properties --> Shipment/properties/status --> ShipmentStatusData --> Shipment/properties/status/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.status.properties.name - New Schema:
{
"type": "string"
}
🔹 Change 79​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.refund_credit.format - New Schema:
"float"
🔹 Change 80​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.amount_paid_roundoff.format - New Schema:
"float"
🔹 Change 81​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.price_effective.format - New Schema:
"float"
🔹 Change 82​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.promotion_effective_discount.format - New Schema:
"float"
🔹 Change 83​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.refund_amount.format - New Schema:
"float"
🔹 Change 84​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.tax_collected_at_source.format - New Schema:
"float"
🔹 Change 85​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.delivery_charge.format - New Schema:
"float"
🔹 Change 86​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.cashback.format - New Schema:
"float"
🔹 Change 87​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.value_of_good.format - New Schema:
"float"
🔹 Change 88​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.cashback_applied.format - New Schema:
"float"
🔹 Change 89​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.cod_charges.format - New Schema:
"float"
🔹 Change 90​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.price_marked.format - New Schema:
"float"
🔹 Change 91​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.amount_paid.format - New Schema:
"float"
🔹 Change 92​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.coupon_value.format - New Schema:
"float"
🔹 Change 93​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.discount.format - New Schema:
"float"
🔹 Change 94​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.fynd_credits.format - New Schema:
"float"
🔹 Change 95​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.gift_price.format - New Schema:
"float"
🔹 Change 96​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.amount_to_be_collected.format - New Schema:
"float"
🔹 Change 97​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.fynd_promotion_effective_discount - New Schema:
{
"type": "number",
"format": "float",
"description": "The discount specifically from Fynd promotions, which may be part of a loyalty or promotional campaign.\n",
"example": 0
}
🔹 Change 98​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.seller_promotion_effective_discount - New Schema:
{
"type": "number",
"format": "float",
"description": "The discount provided directly by the seller, possibly as part of a seller-specific promotion or special offer.\n",
"example": 0
}
🔹 Change 99​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.cn_refund_amount - New Schema:
{
"type": "number",
"format": "float",
"description": "The refund amount issued via a Credit Note (CN). This is a formal document representing the refunded amount as per the Credit Note issued.\n",
"example": 0
}
🔹 Change 100​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.applied_emi_discount - New Schema:
{
"type": "number",
"format": "float",
"description": "The discount applied due to an EMI (Equated Monthly Installment) offer.\n",
"example": 150
}
🔹 Change 101​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.applied_instant_discount - New Schema:
{
"type": "number",
"format": "float",
"description": "The instant discount applied to the order at checkout.\n",
"example": 300
}
🔹 Change 102​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.added_to_fynd_cash - New Schema:
{
"type": "boolean"
}
🔹 Change 103​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.gst_tax_percentage - New Schema:
{
"type": "number"
}
🔹 Change 104​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
OrderDetails --> OrderDetails/properties --> OrderDetails/properties/prices --> Prices --> OrderDetails/properties/prices/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.price.properties.tcs_percentage - New Schema:
{
"type": "number"
}
🔹 Change 105​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
CreateOrderAPI --> CreateOrderAPI/properties --> CreateOrderAPI/properties/shipments --> CreateOrderAPI/properties/shipments/items --> Shipment --> CreateOrderAPI/properties/shipments/items/properties - Schema Action:
PROPERTY_ADDED - Path:
paths.createOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipments.items.properties.external_location_id - New Schema:
{
"type": "string"
}