Skip to main content

API Change Log - Logistics

🧩 Service: Logistics​

🔧 Operation: sampleFileServiceability​

🔹 Change 1​

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

🔧 Operation: getSampleFileServiceabilityStatus​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: BulkRegionServiceabilityTatResponseItemData
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getSampleFileServiceabilityStatus.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.file_path.nullable
  • New Schema:
true

🔹 Change 2​

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

🔧 Operation: bulkTat​

🔹 Change 1​

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

🔧 Operation: getBulkTat​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBulkTat.methodTypePlaceHolder.parameters.10.schema.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBulkTat.methodTypePlaceHolder.parameters.11.schema.format
  • New Schema:
"date"

🔹 Change 3​

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

🔧 Operation: getBulkServiceability​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBulkServiceability.methodTypePlaceHolder.parameters.10.schema.format
  • New Schema:
"date"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBulkServiceability.methodTypePlaceHolder.parameters.11.schema.format
  • New Schema:
"date"

🔹 Change 3​

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

🔧 Operation: createCourierPartnerAccount​

🔹 Change 1​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CourierAccount
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.createCourierPartnerAccount.methodTypePlaceHolder.requestBody.content.application/json.schema.required.0
  • New Schema:
"account_id"

🔹 Change 2​

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

🔧 Operation: getCourierPartnerAccounts​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCourierPartnerAccounts.methodTypePlaceHolder.parameters.7
  • New Schema:
{
  "in": "query",
  "name": "account_ids",
  "description": "Filters dp accounts based on their ids",
  "schema": {
    "type": "array",
    "items": {
      "type": "string"
    }
  }
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CompanyCourierPartnerAccountListResponse --> CourierAccountResponse --> CourierPartnerSchemeModel
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getCourierPartnerAccounts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.scheme_rules.required

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CompanyCourierPartnerAccountListResponseSchema --> CourierAccountResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCourierPartnerAccounts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.company_id
  • New Schema:
{
  "type": "integer"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CompanyCourierPartnerAccountListResponseSchema --> CourierAccountResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCourierPartnerAccounts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.extension_id
  • New Schema:
{
  "type": "string"
}

🔹 Change 5​

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

🔹 Change 6​

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

🔧 Operation: updateCourierPartnerAccount​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CourierAccount
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateCourierPartnerAccount.methodTypePlaceHolder.requestBody.content.application/json.schema.required.1

🔹 Change 2​

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

🔹 Change 3​

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

🔹 Change 4​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CourierAccount
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.updateCourierPartnerAccount.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5
  • New Schema:
"extension_id"

🔧 Operation: getCourierPartnerAccount​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CompanyCourierPartnerAccountListResponse --> CourierAccountResponse --> CourierPartnerSchemeModel
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getCourierPartnerAccount.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.scheme_rules.required

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CompanyCourierPartnerAccountListResponseSchema --> CourierAccountResponseSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getCourierPartnerAccount.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.company_id
  • New Schema:
{
  "type": "integer"
}

🔹 Change 3​

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

🔧 Operation: createCourierPartnerScheme​

🔹 Change 1​

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

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CourierPartnerSchemeModel
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.createCourierPartnerScheme.methodTypePlaceHolder.requestBody.content.application/json.schema.required.9
  • New Schema:
"scheme_id"

🔹 Change 3​

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

🔹 Change 4​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createCourierPartnerScheme.methodTypePlaceHolder.path
  • New Schema:
"/service/partner/logistics/v1.0/organization/{organization_id}/courier-partner/scheme"

🔧 Operation: updateCourierPartnerScheme​

🔹 Change 1​

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

🔹 Change 2​

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

🔧 Operation: getCountries​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCountries.methodTypePlaceHolder.parameters.1
  • New Schema:
{
  "in": "query",
  "name": "onboard",
  "description": "Only fetch countries which allowed for onboard on Platform.",
  "schema": {
    "type": "boolean"
  },
  "required": false,
  "examples": {
    "example_1": {
      "value": true
    },
    "example_3": {
      "value": false
    }
  }
}

🔹 Change 2​

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

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCountries.methodTypePlaceHolder.parameters.5
  • New Schema:
{
  "in": "query",
  "name": "hierarchy",
  "description": "The search filter to filter countries based on their available hierarchy.",
  "schema": {
    "type": "string"
  },
  "required": false,
  "examples": {
    "example_1": {
      "value": "pincode"
    },
    "example_3": {
      "value": "pincode"
    }
  }
}

🔹 Change 4​

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

🔹 Change 5​

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

🔹 Change 6​

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

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCountries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.currency.properties
  • New Schema:
{
  "code": {
    "type": "string"
  },
  "name": {
    "type": "string"
  },
  "symbol": {
    "type": "string"
  }
}

🔹 Change 8​

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

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getCountries.methodTypePlaceHolder.responses.400
  • New Schema:
{
  "description": "Unsuccessful Request",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "examples": {
        "example_3": {
          "value": {
            "error": "The page_size for countries is less that 1"
          }
        }
      }
    }
  }
}

🔹 Change 10​

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

Was this section helpful?