Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.0",
"info": {
"title": "Ubi Api",
"description": "Ubi Api Documenation",
"contact": {
"email": "admin@ubicquia2.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "0.0.1"
},
"servers": [
{
"url": "https://config.api.ubicquia.com/api/",
"description": "L5 Swagger OpenApi Server"
}
],
"paths": {
"/AuthCheck": {
"get": {
"tags": [
"AuthCheck"
],
"summary": "Get all data",
"description": "Returns a list of data",
"operationId": "index",
"responses": {
"401": {
"description": "Unauthenticated"
},
"400": {
"description": "Bad Request"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/fulfillment-detail": {
"post": {
"tags": [
"Fulfillment Details"
],
"summary": "Add fulfillment Details",
"description": "",
"operationId": "store",
"requestBody": {
"$ref": "#/components/requestBodies/createFulfillmentDetailssRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successGetFulfillmentDetailsStoreResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/delete-fulfillment-detail": {
"post": {
"tags": [
"Fulfillment Details"
],
"summary": "Delete fulfillment Details",
"description": "",
"operationId": "destroy",
"requestBody": {
"$ref": "#/components/requestBodies/FulfillmentDetailssRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successGetFulfillmentDetailsResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/fulfillment-detail-update": {
"post": {
"tags": [
"Fulfillment Details"
],
"summary": "Upadate fulfillment Details",
"description": "",
"operationId": "fulfillment-detail-update",
"requestBody": {
"$ref": "#/components/requestBodies/FulfillmentDetailssRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successGetFulfillmentDetailsResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/extended-fulfillment-detail": {
"post": {
"tags": [
"Fulfillment Details"
],
"summary": "Extended fulfillment Details",
"description": "",
"operationId": "extended-fulfillment-detail",
"requestBody": {
"$ref": "#/components/requestBodies/createExtendedFulfillmentDetailssRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successGetFulfillmentDetailsResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/extended-fulfillment-detail-update": {
"post": {
"tags": [
"Fulfillment Details"
],
"summary": "Extended fulfillment Details Update",
"description": "",
"operationId": "extended-fulfillment-detail-update",
"requestBody": {
"$ref": "#/components/requestBodies/createExtendedFulfillmentDetailssRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successGetFulfillmentDetailsResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/fulfillment-detail-status": {
"get": {
"tags": [
"Fulfillment Details"
],
"summary": "get fulfillment detail status",
"description": "get fulfillment detail status",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Request id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/fulfillmentDetailsLogResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/iccid-master/update/{iccid}": {
"put": {
"tags": [
"ICCID Master"
],
"summary": "Update ICCID master status",
"description": "Updates ICCID status. For used status, records replacement metadata and requires replaced_by_iccid to already exist in iccid_master. For available status, replacement metadata is cleared and returned as null.",
"operationId": "updateIccidRecord",
"parameters": [
{
"name": "iccid",
"in": "path",
"description": "ICCID to update (alphanumeric, no special characters)",
"required": true,
"schema": {
"type": "string",
"example": "89011703324655860429"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/IccidMasterReplaceRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/iccidMasterUpdateResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
},
"422": {
"description": "Validation error (invalid payload, ICCID already has replacement data, or replaced_by_iccid not found)",
"content": {
"application/json": {
"example": {
"status": "failed",
"code": 422,
"message": "JSON Payload is not correct",
"errors": [
"Validation error message"
],
"version": "value"
}
}
}
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/update-iccid-master-file": {
"post": {
"tags": [
"ICCID Master"
],
"summary": "Upload ICCID master CSV for bulk update",
"description": "Upload a CSV file to create or update ICCID master records. Processing runs asynchronously on the iccid-master-file-upload queue. Roles: configuser, factoryadmin, factoryuser.",
"operationId": "updateIccidMasterFile",
"requestBody": {
"$ref": "#/components/requestBodies/IccidMasterFileRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/iccidMasterFileUploadResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
},
"422": {
"description": "Invalid file (must be CSV) or validation error"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/delete-iccid-master-file": {
"post": {
"tags": [
"ICCID Master"
],
"summary": "Upload ICCID master CSV for bulk delete",
"description": "Upload a CSV file listing ICCIDs to delete. Records with replacement data cannot be deleted. Processing runs asynchronously. Roles: configuser, factoryadmin.",
"operationId": "deleteIccidMasterFile",
"requestBody": {
"$ref": "#/components/requestBodies/IccidMasterFileRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/iccidMasterFileUploadResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
},
"422": {
"description": "Invalid file (must be CSV) or validation error"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-iccid-master-list": {
"get": {
"tags": [
"ICCID Master"
],
"summary": "Get paginated ICCID master list",
"description": "Returns ICCID master records with optional search and sorting. Roles: configuser, factoryadmin, factoryuser.",
"operationId": "getIccidMasterList",
"parameters": [
{
"name": "per_page",
"in": "query",
"description": "Items per page",
"schema": {
"type": "integer",
"default": 50
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "sort_by",
"in": "query",
"schema": {
"type": "string",
"default": "id",
"enum": [
"id",
"customer_id",
"iccid",
"eid",
"date_added",
"activation_code",
"replaced_iccid_sr_num",
"replaced_on"
]
}
},
{
"name": "sort_dir",
"in": "query",
"schema": {
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "search_type",
"in": "query",
"description": "Column to search",
"schema": {
"type": "string",
"enum": [
"iccid",
"eid",
"activation_code",
"replaced_iccid_sr_num",
"replaced_on"
]
}
},
{
"name": "q",
"in": "query",
"description": "Search string (partial match)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/getIccidMasterListResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/log/iccid-master": {
"get": {
"tags": [
"ICCID Master"
],
"summary": "Get latest ICCID master file upload status",
"description": "Returns status of the most recent ICCID master file upload (success, failed, in progress, or no file found). Roles: configuser, factoryadmin, factoryuser.",
"operationId": "getIccidMasterLatestLog",
"responses": {
"200": {
"$ref": "#/components/responses/iccidMasterLatestLogResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-latest-failed-log/{type}": {
"get": {
"tags": [
"ICCID Master"
],
"summary": "Download latest failed ICCID master CSV log",
"description": "Returns the processed CSV content from the latest ICCID master upload with failed rows. Type must be iccid_master. Roles: configuser, factoryadmin, factoryuser.",
"operationId": "getIccidMasterFailedCsv",
"parameters": [
{
"name": "type",
"in": "path",
"description": "File type (only iccid_master supported)",
"required": true,
"schema": {
"type": "string",
"enum": [
"iccid_master"
],
"example": "iccid_master"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/iccidMasterFailedCsvResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
},
"422": {
"description": "Invalid type parameter"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/update-sales-order": {
"put": {
"tags": [
"Sales Order"
],
"summary": "Update Sales Order by id",
"description": "",
"operationId": "update",
"requestBody": {
"$ref": "#/components/requestBodies/SalesOrderRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/salesOrderResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/delete-sales-order": {
"delete": {
"tags": [
"Sales Order"
],
"summary": "Deletes Sales order by id",
"operationId": "destroy",
"requestBody": {
"$ref": "#/components/requestBodies/SalesOrderDeleteRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successOperation"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-sales-order/{sales_order_number}": {
"get": {
"tags": [
"Sales Order"
],
"summary": "get sales order detail",
"description": "get sales order detail",
"parameters": [
{
"$ref": "#/components/parameters/param_sales_order_number"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/salesOrderResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/add-sales-order": {
"post": {
"tags": [
"Sales Order"
],
"summary": "Add Sales Order by async",
"description": "",
"operationId": "add-sales-order",
"requestBody": {
"$ref": "#/components/requestBodies/AsyncSalesOrderRequestBody"
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"example": {
"data": "Sales Order setup request placed successfully",
"status": "success",
"code": 200,
"message": "Operation success",
"version": "value"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-sales-order-status": {
"get": {
"tags": [
"Sales Order"
],
"summary": "get sales order status",
"description": "get sales order status",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Request id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "customer_id",
"in": "query",
"description": "Customer id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/salesOrderResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/add-sales-order-config": {
"post": {
"tags": [
"Sales Order"
],
"summary": "Add Sales Order on Config",
"description": "",
"operationId": "add-sales-order-config",
"requestBody": {
"$ref": "#/components/requestBodies/SalesOrderRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/salesOrderResponseConfig"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/update-production-file": {
"post": {
"tags": [
"Serial Number"
],
"summary": "Update Serial Number",
"description": "Allow file: CSV or JSON",
"operationId": "update",
"requestBody": {
"$ref": "#/components/requestBodies/SerialNumberDetailRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successSerialNumberDetailResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/delete-production-file": {
"post": {
"tags": [
"Serial Number"
],
"summary": "Delete Serial Number",
"description": "",
"operationId": "destroy",
"requestBody": {
"$ref": "#/components/requestBodies/SerialNumberDetailRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successSerialNumberDetailResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-customer-id": {
"post": {
"tags": [
"Customer Detail"
],
"summary": "Get Customer Id",
"description": "",
"operationId": "getcustid",
"requestBody": {
"$ref": "#/components/requestBodies/getCustIdRequestBody"
},
"responses": {
"200": {
"$ref": "#/components/responses/successSerialNumberDetailResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-serial-number-list": {
"get": {
"tags": [
"Serial Number"
],
"summary": "Get all serial number details",
"description": "",
"operationId": "get-serial-number-list",
"parameters": [
{
"name": "customer_id",
"in": "query",
"description": "Customer Id",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "so_number",
"in": "query",
"description": "Sales Order Number",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "search_type",
"in": "query",
"description": "select search type",
"required": false,
"schema": {
"type": "string",
"default": "dev_eui",
"enum": [
"serial_number",
"imei",
"dev_eui",
"iccid",
"iccid_secondary",
"fulfillment_id",
"partner_id",
"partner_serial_num",
"partner_item_name"
]
}
},
{
"name": "q",
"in": "query",
"description": "searching string",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": "1"
}
},
{
"name": "per_page",
"in": "query",
"description": "Per page items to show in list",
"schema": {
"type": "integer",
"default": "20"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/paginateGetSerialNumberDetailResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/check-uploaded-production-file-status": {
"get": {
"tags": [
"Serial Number"
],
"summary": "Get check uploaded production file status",
"description": "",
"operationId": "check-uploaded-production-file-status",
"responses": {
"200": {
"$ref": "#/components/responses/checkUploadedProductionFileStatusResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-production-file-list": {
"get": {
"tags": [
"Serial Number"
],
"summary": "Get all production file details",
"description": "Get a list of production file details with filtering options.",
"operationId": "get-production-file-list",
"parameters": [
{
"name": "sort_by",
"in": "query",
"description": "Sort field (e.g., 'created_at')",
"required": false,
"schema": {
"type": "string",
"default": "created_at"
}
},
{
"name": "sort_dir",
"in": "query",
"description": "Sort direction ('asc' or 'desc')",
"required": false,
"schema": {
"type": "string",
"default": "desc"
}
},
{
"name": "file_type",
"in": "query",
"description": "Select file type",
"required": false,
"schema": {
"type": "string",
"default": "prod_file",
"enum": [
"prod_file",
"coil_file"
]
}
},
{
"name": "search_type",
"in": "query",
"description": "Select search type",
"required": false,
"schema": {
"type": "string",
"default": "filename",
"enum": [
"filename",
"name",
"status"
]
}
},
{
"name": "q",
"in": "query",
"description": "Searching string",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": "1"
}
},
{
"name": "per_page",
"in": "query",
"description": "Per page items to show in the list",
"schema": {
"type": "integer",
"default": "20"
}
},
{
"name": "start_date_time",
"in": "query",
"description": "Start Date and Time of the file (yyyy-MM-dd h:m:s)",
"schema": {
"type": "string"
}
},
{
"name": "end_date_time",
"in": "query",
"description": "End Date and Time of the file (yyyy-MM-dd h:m:s)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/paginateProductionFileDetailResponse"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/update-transformer-file": {
"post": {
"tags": [
"Transformer Details"
],
"summary": "Update transformer details",
"description": "Allow file: CSV",
"operationId": "update",
"requestBody": {
"$ref": "#/components/requestBodies/TransformerDetailRequestBody"
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"example": {
"data": "File Upload successful! Data processing is in progress. Please wait while we process your data in the background.",
"status": "success",
"code": 200,
"message": "success",
"version": "value"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/delete-transformer-file": {
"post": {
"tags": [
"Transformer Details"
],
"summary": "Delete transformer details",
"description": "",
"operationId": "destroy",
"requestBody": {
"$ref": "#/components/requestBodies/TransformerDetailRequestBody"
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"example": {
"data": "File Upload successful! Data processing is in progress. Please wait while we process your data in the background.",
"status": "success",
"code": 200,
"message": "success",
"version": "value"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"$ref": "#/components/responses/404ResourceResponse"
}
},
"security": [
{
"Api Key": []
}
]
}
},
"/get-transformer-file-list": {
"get": {
"tags": [
"Transformer Details"
],
"summary": "Get all transformer file list",
"description": "",
"operationId": "get-transformer-file-list",
"parameters": [
{
"name": "sort_by",
"in": "query",
"schema": {
"type": "string",
"default": "created_at"
}
},
{
"name": "sort_dir",
"in": "query",
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ubicquia/refs/heads/main/openapi/ubicquia-config-api-openapi-original.json