XpressConnect
  • Introduction
  • Version History
  • Overview
    • How It Works
    • Server
    • API Request/Response
    • Authentication
  • API Endpoints
    • Courier
      • List
    • Declaration
      • Submit
      • Query
      • Attach
    • Commodity
      • List
    • Claim
      • Submit
      • Query
      • Update
      • Attach Document
      • Detach Document
  • Models
    • Courier
    • Declaration
    • Item
    • Commodity
    • Claim
    • Claim Document
  • Reference
    • Example PHP Code
    • Country
    • Errors
Powered by GitBook
On this page
  • Endpoint
  • Request
  • Response

Was this helpful?

  1. API Endpoints
  2. Claim

Update

Modify an incomplete document claim details

Endpoint

/api/claim/update

Request

Parameters

Name
Mandatory
Description
Type
Default

claims_id

Claim ID

Integer

claim_type

Claim type. e.g.: D, L, or T

String

consignment_note

Consignment note. Must exists in declarations with approved status

String

incident_date

Incident date. Future date is not allow. Format: yyyymmdd

Date

claimer_name

Claimer's name

String (100)

claimer_contact_person

Claimer's contact person name

String (100)

claimer_contact_no

Claimer's contact number

String (20)

claimer_email

Claimer's email. To received email from XpressCover

String (100)

desire_claim_amt

Claim amount

Decimal (11, 2)

claim_item

Item's description

String (100)

callback_url

Callback URL

String (150)

Example

{
    "claims_id": 1,
    "claimer_name": "Testing 2",
    "claimer_contact_person": "Testing 2"
}

Response

Successful Response Parameters

{
    "status": "SUCCESS",
    "claim": {
        "claims_id": 1,
        "user": "abc.api",
        "claim_type": "D",
        "consignment_note": "CN0000000001",
        "claimer_name": "Testing 2",
        "claimer_contact_person": "Testing 2",
        "claimer_contact_no": "60123456789",
        "claimer_email": "someone@email.com",
        "incident_date": "2025-02-18 00:00:00",
        "police_rpt_no": "",
        "claim_item": "testing item 123",
        "desire_claim_amt": 102,
        "claims_status": 4,
        "access_code": "1968573",
        "submitted_at": "2025-02-19 18:21:49",
        "claim_documents": [
            {
                "id": 1,
                "claims_id": 1,
                "doc_type": "item_invoice",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/item_invoice_HUujfXeKVzAswsFjlGVI.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:54:56",
                "created_at": "2025-02-19 18:54:56"
            },
            {
                "id": 2,
                "claims_id": 1,
                "doc_type": "cn_copy",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/cn_copy_HXVMqCiUMbdnuZyGwao3.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:55:56",
                "created_at": "2025-02-19 18:55:56"
            },
            {
                "id": 3,
                "claims_id": 1,
                "doc_type": "invest_rpt",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/invest_rpt_0a0wd13gBZpLHQwxDY8R.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:56:31",
                "created_at": "2025-02-19 18:56:31"
            },
            {
                "id": 4,
                "claims_id": 1,
                "doc_type": "damage_photo",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/damage_photo_0DisrFRLpaIYeV5JNvDX.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:58:18",
                "created_at": "2025-02-19 18:58:18"
            },
            {
                "id": 5,
                "claims_id": 1,
                "doc_type": "damage_photo",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/damage_photo_7ibBPbSvIshERhL5ljl1.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:58:39",
                "created_at": "2025-02-19 18:58:39"
            },
            {
                "id": 6,
                "claims_id": 1,
                "doc_type": "repair_invoice",
                "doc_type_others": null,
                "url": "https://xc-connect-dev.xpresscover.com/download/new_uploaded/claim/1/repair_invoice_MOWKJB0WUakg1wdn0iCK.png",
                "remarks": null,
                "uploaded_at": "2025-02-19 18:59:50",
                "created_at": "2025-02-19 18:59:50"
            },
            {
                "id": 7,
                "claims_id": 1,
                "doc_type": "others",
                "doc_type_others": "Tracking Report",
                "url": null,
                "remarks": "",
                "uploaded_at": null,
                "created_at": "2025-02-19 19:43:55"
            },
            {
                "id": 8,
                "claims_id": 1,
                "doc_type": "others",
                "doc_type_others": "Damage Photo 2",
                "url": null,
                "remarks": "",
                "uploaded_at": null,
                "created_at": "2025-02-19 19:43:55"
            }
        ],
        "callback_url": "https://clientendpoint/path/callback"
    }
}
PreviousQueryNextAttach Document

Last updated 3 months ago

Was this helpful?