Skip to main content

API Change Log - Porter

🧩 Service: Porter​

🔧 Operation: exportCompany​

🔹 Change 1​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompany.methodTypePlaceHolder.methodType
  • New Schema:
"post"

🔧 Operation: exportCompanyHistory​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.process_type.enum
  • New Schema:
[
"import",
"export"
]

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.history.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.completed_on.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema --> DataSchema --> ImportCompanyRequestBody
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.product_inventory_version

🔹 Change 6​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.entity_selection.properties
  • New Schema:
{
"hsn": {
"type": "boolean"
},
"department": {
"type": "boolean"
},
"category": {
"type": "boolean"
},
"template": {
"type": "boolean"
},
"company_location": {
"type": "boolean"
},
"company_brand": {
"type": "boolean"
},
"size_guide": {
"type": "boolean"
},
"inventory": {
"type": "boolean"
},
"product": {
"type": "boolean"
},
"sales_channel": {
"type": "boolean"
},
"discounts": {
"type": "boolean"
},
"product_attribute": {
"type": "boolean"
},
"company_meta": {
"type": "boolean"
}
}

🔹 Change 8​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.process_type.enum
  • New Schema:
[
"import",
"export"
]

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.history.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 11​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.completed_on.format
  • New Schema:
"date-time"

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema --> DataSchema --> ImportCompanyRequestBody
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.product_inventory_version

🔹 Change 13​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.exportCompanyHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.entity_selection.properties
  • New Schema:
{
"hsn": {
"type": "boolean"
},
"department": {
"type": "boolean"
},
"category": {
"type": "boolean"
},
"template": {
"type": "boolean"
},
"company_location": {
"type": "boolean"
},
"company_brand": {
"type": "boolean"
},
"size_guide": {
"type": "boolean"
},
"inventory": {
"type": "boolean"
},
"product": {
"type": "boolean"
},
"sales_channel": {
"type": "boolean"
},
"discounts": {
"type": "boolean"
},
"product_attribute": {
"type": "boolean"
},
"company_meta": {
"type": "boolean"
}
}

🔧 Operation: importCompany​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema --> DataSchema --> ImportCompanyRequestBody
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.importCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.product_inventory_version

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.importCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.importCompany.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.entity_selection.properties
  • New Schema:
{
"hsn": {
"type": "boolean"
},
"department": {
"type": "boolean"
},
"category": {
"type": "boolean"
},
"template": {
"type": "boolean"
},
"company_location": {
"type": "boolean"
},
"company_brand": {
"type": "boolean"
},
"size_guide": {
"type": "boolean"
},
"inventory": {
"type": "boolean"
},
"product": {
"type": "boolean"
},
"sales_channel": {
"type": "boolean"
},
"discounts": {
"type": "boolean"
},
"product_attribute": {
"type": "boolean"
},
"company_meta": {
"type": "boolean"
}
}

🔧 Operation: fetchImportHistory​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.process_type.enum
  • New Schema:
[
"import",
"export"
]

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.history.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.completed_on.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema --> DataSchema --> ImportCompanyRequestBody
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.product_inventory_version

🔹 Change 6​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.data.properties.request_data.properties.entity_selection.properties
  • New Schema:
{
"hsn": {
"type": "boolean"
},
"department": {
"type": "boolean"
},
"category": {
"type": "boolean"
},
"template": {
"type": "boolean"
},
"company_location": {
"type": "boolean"
},
"company_brand": {
"type": "boolean"
},
"size_guide": {
"type": "boolean"
},
"inventory": {
"type": "boolean"
},
"product": {
"type": "boolean"
},
"sales_channel": {
"type": "boolean"
},
"discounts": {
"type": "boolean"
},
"product_attribute": {
"type": "boolean"
},
"company_meta": {
"type": "boolean"
}
}

🔹 Change 8​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema
  • Schema Action: ENUM_ADDED
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.process_type.enum
  • New Schema:
[
"import",
"export"
]

🔹 Change 9​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.history.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 10​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 11​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.completed_on.format
  • New Schema:
"date-time"

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ExportCompanyHistoryResponseBody --> ProcessSchema --> DataSchema --> ImportCompanyRequestBody
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.product_inventory_version

🔹 Change 13​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.created_on.format
  • New Schema:
"date-time"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.fetchImportHistory.methodTypePlaceHolder.responses.200.content.application/json.examples.success.value.schema.properties.items.items.properties.data.properties.request_data.properties.entity_selection.properties
  • New Schema:
{
"hsn": {
"type": "boolean"
},
"department": {
"type": "boolean"
},
"category": {
"type": "boolean"
},
"template": {
"type": "boolean"
},
"company_location": {
"type": "boolean"
},
"company_brand": {
"type": "boolean"
},
"size_guide": {
"type": "boolean"
},
"inventory": {
"type": "boolean"
},
"product": {
"type": "boolean"
},
"sales_channel": {
"type": "boolean"
},
"discounts": {
"type": "boolean"
},
"product_attribute": {
"type": "boolean"
},
"company_meta": {
"type": "boolean"
}
}

🔧 Operation: getConflictedEntities​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getConflictedEntities
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get conflicting entities of the process.",
"description": "This api returns entities for which conflicts exists",
"tags": [
"Conflicts"
],
"x-groups": [
"Conflicts"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"description": "Process ID of the import process for which conflicts need to be fetched",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "66210718c385801caed6cf28"
},
"failure": {
"value": "663407181115801ffed6cf22"
}
}
}
],
"operationId": "getConflictedEntities",
"responses": {
"200": {
"description": "Conflicted Entities details for that particular process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictedEntitiesResponseBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ConflictedEntitiesResponseBody"
}
}
}
}
}
}
},
"400": {
"description": "Failed to get conflicted Entities details for that particular process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
},
"examples": {
"failure": {
"value": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/conflicts/entity/{process_id}",
"methodType": "get"
}
}

🔧 Operation: getEntityConflictItems​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getEntityConflictItems
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get all the conflicting items of a particular entity.",
"description": "This api returns conflict list for a particular entity.",
"tags": [
"Conflicts"
],
"x-groups": [
"Conflicts"
],
"parameters": [
{
"in": "path",
"name": "entity",
"description": "Entity ID for which conflicts need to be fetched",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "category"
},
"failure": {
"value": "category"
}
}
},
{
"in": "path",
"name": "process_id",
"description": "Process ID of the import process for which conflicts need to be fetched",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "66210718c385801caed6cf28"
},
"failure": {
"value": "61210218c385e0dc5ed6cf37"
}
}
}
],
"operationId": "getEntityConflictItems",
"responses": {
"200": {
"description": "Conflict list of particular Entity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityConflictsResponseBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/EntityConflictsResponseBody"
}
}
}
}
}
}
},
"400": {
"description": "Failed to get conflict list of particular Entity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
},
"examples": {
"failure": {
"value": {
"message": "Invalid ID"
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/{entity}/conflicts/{process_id}",
"methodType": "get"
}
}

🔧 Operation: saveConflictResolution​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.saveConflictResolution
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Saves the updated resolution for the conflict.",
"description": "Saves the updated resolution for the conflict.",
"tags": [
"Conflicts"
],
"x-groups": [
"Conflicts"
],
"operationId": "saveConflictResolution",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResolutionRequestBody"
},
"examples": {
"success_with_ignore": {
"value": {
"_id": "662107ae74f73c2bc8e080b8",
"process_id": "66210718c385801caed6cf28",
"type": "hsn",
"to_resolve": false,
"ignore": true,
"issues": [
{
"dependency": "type",
"conflicts": {
"resolutions": "services"
}
}
]
}
},
"success": {
"value": {
"_id": "662107ae74f73c2bc8e080b8",
"process_id": "66210718c385801caed6cf28",
"type": "hsn",
"to_resolve": true,
"ignore": false,
"issues": [
{
"dependency": "type",
"conflicts": {
"resolutions": "services"
}
}
]
}
},
"failure": {
"value": {
"_id": "662107ae23453c2bc8e080b8",
"process_id": "662109876385801caed6cf28"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Saves the updated resolution for the conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolutionSavedResponseBody"
},
"examples": {
"success_with_ignore": {
"value": {
"status": "success",
"message": "Conflict ignored"
}
},
"success": {
"value": {
"status": "success",
"message": "Resolution saved successfully"
}
}
}
}
}
},
"400": {
"description": "Saves the updated resolution for the conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
},
"examples": {
"failure": {
"value": {
"message": "Failed to update resolution status"
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/conflicts/resolution/save",
"methodType": "post"
}
}

🔧 Operation: applyResolutionAndStartImport​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.applyResolutionAndStartImport
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Start conflict resolution for this process.",
"description": "Start conflict resolution for this process",
"tags": [
"Conflicts"
],
"x-groups": [
"Conflicts"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"description": "Process ID of the import process for which conflict resolution is to be started",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "66210718c385801caed6cf28"
}
}
}
],
"operationId": "applyResolutionAndStartImport",
"responses": {
"200": {
"description": "Start conflict resolution for this process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyResolutionResponseBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ApplyResolutionResponseBody"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/conflicts/resolve/{process_id}",
"methodType": "get"
}
}

🔧 Operation: getProcessEntityReport​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getProcessEntityReport
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Report of the process report of a particular entity.",
"description": "Get the report of a particular entity created system.",
"tags": [
"Process Report"
],
"x-groups": [
"Process Report"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"description": "Process ID of the import process for which the Process Report needs to be fetched",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "65f96d567e1429c4f46f431b"
}
}
},
{
"in": "path",
"name": "entity_type",
"description": "Entity Type for which the Process Report is to be fetched",
"schema": {
"type": "string",
"x-not-enum": true
},
"required": true,
"examples": {
"success": {
"value": "company_meta"
}
}
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "number"
},
"description": "Total items expected in on response.",
"required": false,
"examples": {
"success": {
"value": 0
}
}
},
{
"in": "query",
"name": "page_number",
"schema": {
"type": "number"
},
"description": "Particular page number for the paginated response.",
"required": false,
"examples": {
"success": {
"value": 1
}
}
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Substring of the entityId.",
"required": false,
"examples": {
"success": {
"value": "ent1"
}
}
},
{
"in": "query",
"name": "status",
"schema": {
"type": "string"
},
"description": "Status of the entities, one of all, error, skipped, processed",
"required": false,
"examples": {
"success": {
"value": "processed"
}
}
}
],
"operationId": "getProcessEntityReport",
"responses": {
"200": {
"description": "Entity report for that particular process and entity type.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessEntityReportSchema"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ProcessEntityReportSchema"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/process/{process_id}/entity/{entity_type}/report",
"methodType": "get"
}
}

🔧 Operation: getProcessEntityStatusCount​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getProcessEntityStatusCount
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get status counts per entity of the process.",
"description": "Get status counts per entity of the process.",
"tags": [
"Process Report"
],
"x-groups": [
"Process Report"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"description": "Process ID for which report counts need to be fetched",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"success": {
"value": "65f96d567e1429c4f46f431b"
}
}
}
],
"operationId": "getProcessEntityStatusCount",
"responses": {
"200": {
"description": "Entity status count for that particular process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityStatusCountSchema"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/EntityStatusCountSchema"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/process/{process_id}/report/counts",
"methodType": "get"
}
}

🔧 Operation: getProductOverrideFailedRecords​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getProductOverrideFailedRecords
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get Failed records for Bulk Import of Products",
"description": "Fetches all the failed records encountered during the Bulk Import of Products for a given Process ID",
"tags": [
"Products Override"
],
"x-groups": [
"Products Override"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"schema": {
"type": "string"
},
"required": true,
"description": "The Process ID of the process for which to retrieve failed records.",
"examples": {
"success": {
"value": "65127e9a80312acffc447dd8"
}
}
}
],
"operationId": "getProductOverrideFailedRecords",
"responses": {
"200": {
"description": "Successfully retrieved failed records.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsOverrideFailedRecordsBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ProductsOverrideFailedRecordsBody"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/import/{process_id}/products/override",
"methodType": "get"
}
}

🔧 Operation: postProductOverrideRecords​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.postProductOverrideRecords
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Add Updated Records for Products Override",
"description": "Individually update each CSV file with all the errors fixed",
"tags": [
"Products Override"
],
"x-groups": [
"Products Override"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"schema": {
"type": "string"
},
"required": true,
"description": "The Process ID of the process for which the updated records should be saved",
"examples": {
"success": {
"value": "65f96d567e1429c4f46f431b"
}
}
}
],
"operationId": "postProductOverrideRecords",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostProductsOverridePayload"
},
"examples": {
"success": {
"value": {
"process_id": "65127e9a80312acffc447dd8",
"file_path": "http://localhost:9000/GRINDOR_INTERNL_SVC/override/csv_override_test_file.csv",
"template": {
"slug": "bottomwear",
"departments": [
"fashion"
]
},
"product_type": "standard"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated records",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostProductsOverride"
},
"examples": {
"success": {
"value": {
"status": "success",
"message": "CSV Override Data Saved"
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/import/{process_id}/products/override/update",
"methodType": "post"
}
}

🔧 Operation: startProductOverride​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.startProductOverride
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Start the Products Override Process",
"description": "Starts the product override process with all the fixed CSV files which are updated",
"tags": [
"Products Override"
],
"x-groups": [
"Products Override"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"schema": {
"type": "string"
},
"required": true,
"description": "The Process ID of the process for which the override process should start",
"examples": {
"success": {
"value": "65127e9a80312acffc447dd8"
},
"failure": {
"value": "65127e9a80312acffc447dd7"
}
}
}
],
"operationId": "startProductOverride",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartProductsOverride"
},
"examples": {
"success": {
"value": {
"process_id": "65127e9a80312acffc447dd8"
}
},
"failure": {
"value": {
"process_id": "65127e9a80312acffc447dd7"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully started override process",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostProductsOverride"
},
"examples": {
"success": {
"value": {
"status": "success",
"message": "Override Process Started"
}
}
}
}
}
},
"400": {
"description": "Failed to start override process",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
},
"examples": {
"failure": {
"value": {
"message": "Override Process Count not be started"
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/import/{process_id}/products/override/start",
"methodType": "post"
}
}

🔧 Operation: cancelProcessById​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.cancelProcessById
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Cancel a particular type of process.",
"description": "Cancel a particular type of process if it is cancellable.",
"tags": [
"Cancel Process"
],
"x-groups": [
"Cancel Process"
],
"parameters": [
{
"in": "path",
"name": "process_id",
"schema": {
"type": "string"
},
"required": true,
"description": "The Process ID of the process which needs to be cancelled.",
"examples": {
"success": {
"value": "66570f76bc336d4497701f16"
}
}
},
{
"in": "query",
"name": "author_email",
"schema": {
"type": "string"
},
"required": true,
"description": "Respective user email if who is cancelling the process",
"examples": {
"success": {
"value": "geetanshumathur@gofynd.com"
}
}
}
],
"operationId": "cancelProcessById",
"responses": {
"200": {
"description": "Success message",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericMessage"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/GenericMessage"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/process/{process_id}/cancel",
"methodType": "post"
}
}

🔧 Operation: getImportDependency​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getImportDependency
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get the import dependency graph.",
"description": "Imports a list of entities along with their dependencies.",
"tags": [
"Import"
],
"x-groups": [
"Import"
],
"operationId": "getImportDependency",
"responses": {
"200": {
"description": "Successfully imported dependency graph.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/import/dependency/graph",
"methodType": "get"
}
}

🔧 Operation: getExportDependency​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getExportDependency
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get the export dependency graph.",
"description": "Exports a list of entities along with their dependencies.",
"tags": [
"Export"
],
"x-groups": [
"Export"
],
"operationId": "getExportDependency",
"responses": {
"200": {
"description": "Successfully fetched export dependency graph.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/export/dependency/graph",
"methodType": "get"
}
}

🔧 Operation: getDeleteDependency​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getDeleteDependency
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get the delete dependency graph.",
"description": "Exports a list of entities for delete along with their dependencies.",
"tags": [
"Delete"
],
"x-groups": [
"Delete"
],
"operationId": "getDeleteDependency",
"responses": {
"200": {
"description": "Successfully fetched delete dependency graph.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ImportDependency"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/delete/dependency/graph",
"methodType": "get"
}
}

🔧 Operation: deleteCompany​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.deleteCompany
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Initiate delete company process.",
"description": "Initiate company delete process",
"tags": [
"Delete"
],
"x-groups": [
"Delete"
],
"parameters": [
{
"in": "path",
"name": "company_id",
"schema": {
"type": "number"
},
"required": true,
"examples": {
"success": {
"value": 1
},
"failure": {
"value": 501
}
}
},
{
"in": "query",
"name": "author_email",
"schema": {
"type": "string"
},
"description": "Email ID of the registered user",
"required": true,
"examples": {
"success": {
"value": "nachiketvaidya@gofynd.com"
},
"failure": {
"value": "nachiketvaidya@gofynd.com"
}
}
},
{
"in": "query",
"name": "first_name",
"schema": {
"type": "string"
},
"description": "First name of the intiating user.",
"required": true,
"examples": {
"success": {
"value": "Nachiket"
},
"failure": {
"value": "Nachiket"
}
}
},
{
"in": "query",
"name": "last_name",
"schema": {
"type": "string"
},
"description": "Last name of the intiating user.",
"required": true,
"examples": {
"success": {
"value": "Vaidya"
},
"failure": {
"value": "Vaidya"
}
}
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "string"
},
"description": "User ID of the intiating user.",
"required": true,
"examples": {
"success": {
"value": "12345"
},
"failure": {
"value": "7890"
}
}
}
],
"operationId": "deleteCompany",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteCompanyRequestBody"
},
"examples": {
"success": {
"value": {
"entity_selection": {
"navigations": true,
"blogs": true,
"pages": true
},
"company_name": "Brunt Test Company",
"sales_channel_selection": {
"all": true,
"ids": [
"1",
"2"
]
}
}
},
"failure": {
"value": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Delete Process Started Successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnqueueResponseBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/EnqueueResponseBody"
}
}
}
}
}
}
},
"400": {
"description": "Delete Process Start Failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
},
"examples": {
"failure": {
"value": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/delete/company/{company_id}",
"methodType": "post"
}
}

🔧 Operation: fetchDeleteHistory​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.fetchDeleteHistory
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Fetch all the delete history.",
"description": "Fetching all the delete history.",
"tags": [
"Delete"
],
"x-groups": [
"Delete"
],
"parameters": [
{
"in": "query",
"name": "page_size",
"schema": {
"type": "number"
},
"description": "Total items expected in on response.",
"required": false
},
{
"in": "query",
"name": "page_number",
"schema": {
"type": "number"
},
"description": "Particular page number for the paginated response.",
"required": false
},
{
"in": "query",
"name": "date_range",
"schema": {
"type": "string"
},
"description": "Particular date range, sperated by comma.",
"required": false,
"examples": {
"success": {
"value": "2024-01-01,2024-01-05"
}
}
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Substring of company name.",
"required": false,
"examples": {
"success": {
"value": "some_company_name"
}
}
},
{
"in": "query",
"name": "status",
"schema": {
"type": "string"
},
"description": "Status of the process, one of ERROR, ALL, PROCESSED, QUEUED, IN_PROCESS",
"required": false,
"examples": {
"success": {
"value": "PROCESSED"
}
}
}
],
"operationId": "fetchDeleteHistory",
"responses": {
"200": {
"description": "Import History",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportCompanyHistoryResponseBody"
},
"examples": {
"success": {
"value": {
"schema": {
"$ref": "#/components/schemas/ExportCompanyHistoryResponseBody"
}
}
}
}
}
}
}
},
"path": "/service/___/administrator/porter/v1.0/delete/history",
"methodType": "get"
}
}

Was this section helpful?