Claim Request API

This API allows external partners to raise a new claim request. It validates required fields, checks for duplicates, creates order ID, stores data, and returns the generated request ID.

POST https://api.bigfix.in/api/warrantify/claim/single-order/
Purpose: Submit new warranty claim requests with complete customer and device details for processing.

Authentication

All API requests must include proper authentication headers.

Header Type Required Description
Authorization string Required JWT Token for authentication
Content-Type string Required application/json

Request Body Parameters

All fields marked as required must be included in the request payload.

Parameter Type Required Description
claim_ref_no string Required Unique claim reference number
Client Name string Required Partner / Client company name
Client Email string Required Partner email address
Name string Required Customer name
CustomerMobile string Required 10-digit mobile number
CustomerEmail string Required Customer email address
Engagement_Type string Required Service type: "Home", "Pickup", or "Walk-in"
AddressLine1 string Required Primary address line
City string Required City name (alphabets only)
State string Required State name (alphabets only)
Pincode string Required 6-digit postal code
AssetType string Required Device category (e.g., "Mobile", "Laptop")
Make string Required Device brand name
Model string Required Device model
IMEINo string Required IMEI or Serial Number
Issue string Required Problem description
Validation Rules: City and State must contain alphabets only. Mobile must be 10 digits. Pincode must be 6 digits.

Success Response

When the claim request is successfully created, the API returns the following response:

Field Type Description
Success string "True" for successful requests
Message string Success message
Status_code string HTTP status code "200"
DATA.request_id string Generated request ID
DATA.service_request_id string Your claim reference number

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
400 Bad Request Missing required fields Ensure all required fields are included
400 Validation Error Invalid City/State format Use alphabets only for City and State
400 Validation Error Invalid Pincode format Provide 6-digit pincode
400 Validation Error Invalid Mobile format Provide 10-digit mobile number
409 Conflict Duplicate claim reference number Use a unique claim_ref_no
500 Server Error Internal server error Retry request or contact support
Best Practice: Always store the returned request_id for tracking and reference purposes.

Bulk Claim Order Upload API

Upload multiple claim orders at once using an Excel file. This API processes bulk claim requests efficiently, validates data, checks for duplicates, and returns detailed processing results.

POST https://api.bigfix.in/api/warrantify/claim/bulk-order/
Bulk Processing: Upload up to 1000 claim orders in a single Excel file. The API automatically detects and reports duplicate entries.

Authentication

All API requests must include proper authentication headers.

Header Type Required Description
X-API-Key string Required Your API authentication key
Content-Type multipart/form-data Required Required for file upload

Request Parameters

Submit the following form-data parameters along with your Excel file.

Parameter Type Required Description
Client Email string Required Partner/Client email address for notifications
Client Name string Required Partner/Client company name
customFile file Required Excel file (.xlsx) containing claim orders

Excel File Structure

Your Excel file must contain the following columns with proper headers:

Important: Column names must match exactly as shown below. Maximum 1000 orders per upload.
Column Name Required Format Example
claim_ref_no Required Unique text CLM10001
Name Required Text Rahul Kumar
CustomerMobile Required 10 digits 9876543210
CustomerEmail Required Valid email rahul@gmail.com
Engagement_Type Required Home/Pickup/Walk-in Home
AddressLine1 Required Text No 12, MG Road
City Required Alphabets only Chennai
State Required Alphabets only Tamil Nadu
Pincode Required 6 digits 600001
AssetType Required Text Mobile
Make Required Text Samsung
Model Required Text Galaxy S23
IMEINo Required 15 digits 123456789012345
Issue Required Text Screen damage

Processing Logic

The API performs the following operations:

  • Validation: Checks all required fields and formats
  • Duplicate Detection: Identifies orders with existing reference numbers
  • Order ID Generation: Creates unique order IDs for valid entries
  • Bulk Save: Stores all valid orders in the database
  • Notifications: Sends email notification to client with upload summary

Success Response

When the bulk upload is successfully processed, the API returns detailed results:

Field Type Description
Success string "True" for successful processing
Status_code integer HTTP status code (200)
Message string Summary message with count
Uploaded_Orders_Count integer Number of successfully uploaded orders
Duplicate_Orders_Count integer Number of duplicate orders found
Duplicate_Reference_IDs array List of duplicate claim reference numbers

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
400 Missing Email Email is required Provide Client Email parameter
400 Missing Client Name Client name is required Provide Client Name parameter
400 Missing File File upload is required Include customFile in request
400 Limit Exceeded The number of orders cannot exceed 1000 Split into multiple uploads
401 Unauthorized Invalid or missing API key Verify X-API-Key header
500 Server Error An error occurred during processing Check file format or contact support

Best Practices

Recommendations:
  • Validate data in your Excel file before uploading
  • Ensure all claim reference numbers are unique
  • Keep uploads under 1000 orders for optimal performance
  • Use the sample Excel template for correct formatting
  • Store the response data for tracking duplicate entries
  • Implement retry logic for 500 errors
Important Notes:
  • Duplicate orders (based on claim_ref_no) will be skipped
  • Email notifications are sent after successful processing
  • Maximum file size: 10MB recommended
  • Supported format: Excel (.xlsx) only

Download Excel Template API

Download the Excel template file for bulk claim order uploads. This template includes pre-defined column headers and sample data to help you format your bulk upload files correctly.

GET https://api.bigfix.in/api/warrantify/sample-template/
Template File: Download the standardized Excel template with correct column headers and sample data for seamless bulk uploads.

Authentication

This endpoint requires proper authentication to download the template file.

Header Type Required Description
X-API-Key string Required Your API authentication key

Request Parameters

This is a simple GET request with no additional parameters required.

No Parameters Required: Simply make a GET request with your API key to download the template file.

Template Structure

The downloaded Excel template contains the following pre-defined columns:

Column Name Data Type Format Sample Value
claim_ref_no string Unique text CLM10001
Name string Text Rahul Kumar
CustomerMobile string 10 digits 9876543210
CustomerEmail string Valid email rahul@gmail.com
Engagement_Type string Home/Pickup/Walk-in Home
AddressLine1 string Text No 12, MG Road
City string Alphabets only Chennai
State string Alphabets only Tamil Nadu
Pincode string 6 digits 600001
AssetType string Text Mobile
Make string Text Samsung
Model string Text Galaxy S23
IMEINo string 15 digits 123456789012345
Issue string Text Screen damage

Success Response

On successful request, the API returns an Excel file download:

Response Type Content-Type Filename
File Download application/vnd.openxmlformats-officedocument.spreadsheetml.sheet template.xlsx
File Contents: The template includes pre-formatted headers and sample data rows to guide your bulk upload process.

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
401 Unauthorized Invalid or missing API key Verify X-API-Key header
404 Not Found Template file not found on server Contact support team
500 Server Error Error serving the template file Retry request or contact support

How to Use the Template

Step-by-Step Guide:
  1. Download the template using this API endpoint
  2. Open the file in Microsoft Excel or compatible software
  3. Review the sample data row to understand the format
  4. Delete the sample data row(s)
  5. Add your actual claim order data (up to 1000 rows)
  6. Ensure all required fields are filled correctly
  7. Save the file as .xlsx format
  8. Upload using the Bulk Claim Order Upload API

Best Practices

Tips for Success:
  • Do not modify or delete the column headers
  • Keep the column order exactly as provided
  • Use the sample data as a reference for formatting
  • Validate data before saving the file
  • Maintain the .xlsx file format (don't convert to .xls or .csv)
  • Keep file size under 10MB for optimal upload performance
Important Notes:
  • Column headers are case-sensitive and must match exactly
  • Empty rows will be skipped during upload
  • Maximum 1000 orders per file upload
  • Invalid data formats will cause upload errors

Order Tracking API

Track claim orders in real-time using the Reference ID. This API provides detailed tracking information including current status and complete tracking history with timestamps.

GET https://api.bigfix.in/api/warrantify/claim/tracking/
Real-time Tracking: Get comprehensive order status updates including service center visits, technician schedules, and delivery information.

Authentication

All API requests must include proper authentication headers.

Header Type Required Description
X-API-Key string Required Your API authentication key

Query Parameters

Pass the reference ID as a query parameter to track the order.

Parameter Type Required Description
ReferenceID string Required Unique reference ID of the claim order (case-sensitive)
Case Sensitive: The ReferenceID parameter is case-sensitive. Ensure you use the exact reference ID provided during order creation.

Tracking Workflows

The API supports three different tracking workflows based on the order type:

Workflow Types:
  • Service Center Flow: Orders sent to service centers for part replacement
  • Technician Flow: Orders handled by technicians with parts
  • No Part Call Flow: Orders that don't require part replacement

Service Center Flow

Status Code Description
createdOrder created in system
assignedAssigned to technician
acceptedTechnician accepted the order
reached customer locationTechnician reached customer location
customer not in locationCustomer unavailable at location
pickup doneDevice picked up from customer
estimation raisedRepair estimation created
verified dateEstimation verified
reached service centreDevice reached service center
part demandedReplacement part requested
awaiting approvalWaiting for approval
approvedRepair approved
handed over to ASPHanded to authorized service provider
part allocatedReplacement part allocated
part receivedPart received at service center
performing serviceDevice under repair
devicecollectedfromaspDevice collected from ASP
repair completedRepair work completed
Servicer visitService personnel visit scheduled/completed
deliveredDevice delivered to customer

Technician Flow

Status Code Description
createdOrder created in system
assignedAssigned to technician
acceptedTechnician accepted the order
reached customer locationTechnician reached customer location
customer not in locationCustomer unavailable at location
pickup doneDevice picked up from customer
estimation raisedRepair estimation created
verified dateEstimation verified
part demandedReplacement part requested
awaiting approvalWaiting for approval
approvedRepair approved
handed over to ASPHanded to authorized service provider
part allocatedReplacement part allocated
part receivedPart received by technician
technician visitTechnician visit scheduled/completed
performing serviceDevice under repair
devicecollectedfromaspDevice collected from ASP
repair completedRepair work completed
deliveredDevice delivered to customer

No Part Call Flow

Status Code Description
createdOrder created in system
assignedAssigned to technician
acceptedTechnician accepted the order
reached customer locationTechnician reached customer location
customer not in locationCustomer unavailable at location
pickup doneDevice picked up from customer
estimation raisedRepair estimation created
verified dateEstimation verified
diagnosis completeDiagnosis completed (no parts needed)
awaiting approvalWaiting for approval
approvedRepair approved
handed over to ASPHanded to authorized service provider
performing serviceDevice under repair
device collected from ASPDevice collected from ASP
repair completedRepair work completed
deliveredDevice delivered to customer

Success Response

When tracking information is found, the API returns the current status and complete tracking history:

Field Type Description
Success string "True" for successful requests
Status_code string HTTP status code "200"
DATA.current_status object Current status with date and status code
DATA.current_status.date string Date and time in format DD-MM-YYYY HH:MM:SS
DATA.current_status.status string Current status description
DATA.tracking_details array Array of all tracking events with dates and statuses
Response Details:
  • current_status: Shows the most recent status update
  • tracking_details: Contains complete chronological history
  • Multiple visits: Customer location visits are numbered (e.g., "reached customer location - 1", "reached customer location - 2")
  • Date format: All dates follow DD-MM-YYYY HH:MM:SS format

Error Responses

The API may return the following error codes:

Status Code Error Type Description Solution
400 Bad Request ReferenceID is required as a query parameter Include ReferenceID in query string
401 Unauthorized Invalid or missing API key Verify X-API-Key header
404 Not Found Reference ID does not exist Verify the Reference ID is correct
200 No Tracking Data No tracking information available Order exists but tracking not yet started
500 Server Error Internal server error Retry request or contact support

Best Practices

Recommendations:
  • Store the Reference ID immediately after order creation
  • Use exact Reference ID (case-sensitive matching)
  • Poll this endpoint periodically for status updates
  • Implement caching to reduce API calls
  • Handle "No tracking information available" gracefully
  • Parse dates consistently using DD-MM-YYYY HH:MM:SS format
Important Notes:
  • Tracking information may not be available immediately after order creation
  • Multiple customer visits are numbered sequentially
  • Status workflow varies based on part requirements
  • All timestamps are in server timezone