The Warranty Claim object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: Open

complaint_date string required

serial_no string

customer string required

complaint string required

item_code string

item_name string

description string

warranty_amc_status string

warranty_expiry_date string

amc_expiry_date string

resolution_date string

resolved_by string

resolution_details string

customer_name string

contact_person string

contact_display string

contact_mobile string

contact_email string

territory string

customer_group string

customer_address string

address_display string

service_address string

company string required

complaint_raised_by string

from_company string

The Warranty Claim object

{
  "id": "warranty-claim_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open",
  "complaint_date": "2024-01-15",
  "serial_no": "serial_no_example",
  "customer": "customer_example",
  "complaint": "complaint_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "warranty_amc_status": "warranty_amc_status_example",
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "resolution_date": "2024-01-15",
  "resolved_by": "resolved_by_example",
  "resolution_details": "resolution_details_example",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "service_address": "service_address_example",
  "company": "Example Corp",
  "complaint_raised_by": "complaint_raised_by_example",
  "from_company": "Example Corp"
}

GET /api/support/warranty-claim/{id}

Retrieve a warranty claim

Retrieves the details of an existing warranty claim. Supply the unique warranty claim ID that was returned from a previous request.

Path parameters

id string required

The identifier of the warranty claim to retrieve.

Returns

Returns the warranty claim object if a valid identifier was provided.

GET /api/support/warranty-claim/{id}

curl https://api.overplane.dev/api/support/warranty-claim/warranty-claim_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "warranty-claim_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open",
  "complaint_date": "2024-01-15",
  "serial_no": "serial_no_example",
  "customer": "customer_example",
  "complaint": "complaint_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "warranty_amc_status": "warranty_amc_status_example",
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "resolution_date": "2024-01-15",
  "resolved_by": "resolved_by_example",
  "resolution_details": "resolution_details_example",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "service_address": "service_address_example",
  "company": "Example Corp",
  "complaint_raised_by": "complaint_raised_by_example",
  "from_company": "Example Corp"
}

GET /api/support/warranty-claim

List all warranty claims

Returns a list of warranty claims. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of warranty claim objects.

GET /api/support/warranty-claim

curl https://api.overplane.dev/api/support/warranty-claim \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "warranty-claim_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "Open",
      "complaint_date": "2024-01-15",
      "serial_no": "serial_no_example",
      "customer": "customer_example",
      "complaint": "complaint_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "description": "description_example",
      "warranty_amc_status": "warranty_amc_status_example",
      "warranty_expiry_date": "2024-01-15",
      "amc_expiry_date": "2024-01-15",
      "resolution_date": "2024-01-15",
      "resolved_by": "resolved_by_example",
      "resolution_details": "resolution_details_example",
      "customer_name": "customer_name_example",
      "contact_person": "contact_person_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "user@example.com",
      "territory": "territory_example",
      "customer_group": "customer_group_example",
      "customer_address": "customer_address_example",
      "address_display": "address_display_example",
      "service_address": "service_address_example",
      "company": "Example Corp",
      "complaint_raised_by": "complaint_raised_by_example",
      "from_company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/support/warranty-claim

Create a warranty claim

Creates a new warranty claim object.

Body parameters

status string

Default: Open

complaint_date string required

serial_no string

customer string required

complaint string required

item_code string

item_name string

description string

warranty_amc_status string

warranty_expiry_date string

amc_expiry_date string

resolution_date string

resolved_by string

resolution_details string

customer_name string

contact_person string

contact_display string

contact_mobile string

contact_email string

territory string

customer_group string

customer_address string

address_display string

service_address string

company string required

complaint_raised_by string

from_company string

Returns

Returns the newly created warranty claim object if the call succeeded.

POST /api/support/warranty-claim

curl https://api.overplane.dev/api/support/warranty-claim \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"complaint_date":"2024-01-15","customer":"customer_example","complaint":"complaint_example","company":"Example Corp"}'

Response

{
  "id": "warranty-claim_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open",
  "complaint_date": "2024-01-15",
  "serial_no": "serial_no_example",
  "customer": "customer_example",
  "complaint": "complaint_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "warranty_amc_status": "warranty_amc_status_example",
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "resolution_date": "2024-01-15",
  "resolved_by": "resolved_by_example",
  "resolution_details": "resolution_details_example",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "service_address": "service_address_example",
  "company": "Example Corp",
  "complaint_raised_by": "complaint_raised_by_example",
  "from_company": "Example Corp"
}

PATCH /api/support/warranty-claim/{id}

Update a warranty claim

Updates the specified warranty claim by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the warranty claim to update.

Body parameters

status string

Default: Open

complaint_date string

serial_no string

customer string

complaint string

item_code string

item_name string

description string

warranty_amc_status string

warranty_expiry_date string

amc_expiry_date string

resolution_date string

resolved_by string

resolution_details string

customer_name string

contact_person string

contact_display string

contact_mobile string

contact_email string

territory string

customer_group string

customer_address string

address_display string

service_address string

company string

complaint_raised_by string

from_company string

Returns

Returns the updated warranty claim object.

PATCH /api/support/warranty-claim/{id}

curl https://api.overplane.dev/api/support/warranty-claim/warranty-claim_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"Open","complaint_date":"2024-01-15"}'

Response

{
  "id": "warranty-claim_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "Open",
  "complaint_date": "2024-01-15",
  "serial_no": "serial_no_example",
  "customer": "customer_example",
  "complaint": "complaint_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "warranty_amc_status": "warranty_amc_status_example",
  "warranty_expiry_date": "2024-01-15",
  "amc_expiry_date": "2024-01-15",
  "resolution_date": "2024-01-15",
  "resolved_by": "resolved_by_example",
  "resolution_details": "resolution_details_example",
  "customer_name": "customer_name_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "territory": "territory_example",
  "customer_group": "customer_group_example",
  "customer_address": "customer_address_example",
  "address_display": "address_display_example",
  "service_address": "service_address_example",
  "company": "Example Corp",
  "complaint_raised_by": "complaint_raised_by_example",
  "from_company": "Example Corp"
}

DELETE /api/support/warranty-claim/{id}

Delete a warranty claim

Permanently deletes a warranty claim. This cannot be undone.

Path parameters

id string required

The identifier of the warranty claim to delete.

Returns

Returns a confirmation that the warranty claim has been deleted.

DELETE /api/support/warranty-claim/{id}

curl https://api.overplane.dev/api/support/warranty-claim/warranty-claim_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "warranty-claim_abc123",
  "deleted": true
}

The Warranty Claim object

Attributes

Retrieve a warranty claim

Path parameters

Returns

List all warranty claims

Query parameters

Returns

Create a warranty claim

Body parameters

Returns

Update a warranty claim

Path parameters

Body parameters

Returns

Delete a warranty claim

Path parameters

Returns

Coming Soon