Update Order

post /insurance/marine/v1/orders/{order_id}/update

This endpoint to update order.

Request Header

Name	Type	Required	Description
authorization	string	Required	Bearer token
content-type	string	Required	application/json

Request Body

Name	Type	Required	Description
trans_no	string	Required	Min length: 10 Max length: 32 Unique string that the client can create to track the current request call.
quotation_id	guid	Required	The quotation id is used for issuing the policy
status	string	Required	Max length: 20 The intent to either create insurance policy immediately or update the policy after quotation created. The possible values are: `Created` Partner intends to create policy after the customer makes a quotation. `Updated` Partner intends to update policy after the customer makes a order.
effective_date	date	Required	Effective date for applying the policy Format: yyyy-mm-dd
expiry_date	date	Required	Expirty date for applying the policy Format: yyyy-mm-dd
etd_date	date	Required	ETD date for applying the policy Format: yyyy-mm-dd
insured_long_name	string	Optional	Max length: 120 Insured long name
insured_detail	object	Required	Json object containing details of the Insured
voyage_detail	object	Required	Json object containing details of the Voyage
shipper_consignee_detail	object	Required	Json object containing details of the Shipper & Consignee
vessel_detail	object	Required	Json object containing details of the Vessel
commodity_detail	object	Required	Json object containing details of the Commodity
clause_detail	object	Required	Json object containing details of the Clause
printing_detail	object	Required	Json object containing details of the Printing
transaction_by	string	Required	Globally unique identifier value of the user id Provided by AXA

Insured Reference

Name	Type	Required	Description
client_type	string	Required	Max length: 1 Client Type C : Corporate P : Personal
tax_id	string	Required	Max length: 20 `Condition:` client_type is "P" This field should be "Citizen ID (Tax Id)" value when card_type is "I" and "Passport Number" value when cardType is "P" `Condition:` client_type is "C" This field should be "Company (Tax Id)"
corporate_name1	string	Condition	Max length: 60 `Condition:` This field is required when client_type is "C"
corporate_name2	string	Optional	Max length: 60
branch	string	Conditional	Max length: 30 Branch name of customer company Note: If there is no branch, specify สำนักงานใหญ่ or Head Office `Condition:` This field is required when client_type is "C"
card_type	string	Condition	Max length: 1 Card Type I : Citizen ID P : Passport Number `Condition:` This field is required when client_type is "P"
title_code	string	Conditional	Max length: 3 `Condition:` This field is required when client_type is "P" Refer to Master Title
first_name	string	Condition	Max length: 30 First name `Condition:` This field is required when client_type is "P"
last_name	string	Condition	Max length: 30 First name `Condition:` This field is required when client_type is "P"
birth_date	date	Condition	Date of birth e.g. 1985-09-27 Format: yyyy-mm-dd `Condition:` This field is required when client_type is "P"
gender	string	Condition	Max length: 1 Type of gender M : Male F : Female Z : Unknow `Condition:` This field is required when client_type is "P"
marital_code	string	Condition	Max length: 1 Marital status S : Single M : Married W : Widowed D : Divorced `Condition:` This field is required when client_type is "P"
nationality_code	string	Condition	Max length: 3 Nationality code (Based on ISO 3166) Refer to Master Nationality `Condition:` This field is required when client_type is "P"
address_type			Max length: 1 Address Type B : Office R : Home P : Postal
country_code	string	Required	Max length: 3 Country code (Based on ISO 3166) Refer to Master Country
address1	string	Required	Max length: 30
address2	string	Required	Max length: 30 Address2
address3	string	Optional	Max length: 30
address4	string	Optional	Max length: 30
address5	string	Optional	Max length: 30
sub_district_code	string	Condition	Max length: 2 Sub district code Refer to Master Sub District `Condition:` This field is required when country_code is "THA"
district_code	string	Condition	Max length: 4 District code Refer to Master District `Condition:` This field is required when country_code is "THA"
province_code	string	Condition	Max length: 6 Province code Refer to Master Province `Condition:` This field is required when country_code is "THA"
postal_code	string	Required	Max length: 5 Postal code e.g. 12000
phone_number1	string	Optional	Max length: 60
phone_number2	string	Optional	Max length: 60
phone_number3	string	Optional	Max length: 60
email	string	Required	Max length: 60 Email address

Voyage Reference

Name	Type	Required	Description
voyage_from_description	string	required	Max length: 200 Describe the additional voyage from descrition
voyage_to_description	string	required	Max length: 200 Describe the additional voyage to descrition
deliverer	string	required	Max length: 200 Describe the additional voyage to descrition
claim_payable_at	string	required	Max length: 200 Refer to location where claim payments are settled.
survey_agent	string	required	Max length: 8 A survey agent code is responsible for inspecting and assessing the condition of goods, typically after an incident like damage during transit. They provide reports on the nature and extent of the damage to assist in processing claims For options refer to Sub Agent
settling_agent	string	required	Max length: 8 A settling agent code handles the settlement of claims, ensuring that the correct amount is paid to the claimant. They manage the claim process, including verifying documents and finalizing payments For options refer to Sub Agent

Shipper & Consignee Reference

Name	Type	Required	Description
name	string	required	Max length: 120 identifying the parties involved in the transaction and ensuring proper delivery of the shipment.
tax_id	string	required	Max length: 13 Tax id of shipper/consignee
country_code	string	required	Max length: 3 Country code of shipper/consignee

Vessel Reference

Name	Type	Required	Description
vessel_name	string	reqired	Max length: 200 Describe the name of Vessel
imo_no	string	reqired	Max length: 200 Describe the information of IMO No.
sailing_from_country	string	reqired	Max length: 3 Sailing from country refer to the OIC Country code the port of origin that represented by the following options: For options refer to Master OIC Country
sailing_to_country	string	reqired	Max length: 3 Sailing to country refer to the OIC Country code the destination port that represented by the following options: For options refer to Master OIC Country
sailing_date	date	reqired	Refers to the date when the vessel departs from the port of origin, marking the start of the shipment journey Format: yyyy-mm-dd
arrival_date	date	reqired	Refers to the date when the vessel reaches its destination port, indicating the completion of the shipment process Format: yyyy-mm-dd
conveyance	string	reqired	Max length: 200 Describe the information related to the conveyance.

Comodity Reference

Name	Type	Required	Description
interest_description	array[string]	required	Max length: 60 foreach Descripbe the purpose of the interest, its elements, and any specific details about interest description

Clause Reference

Name	Type	Required	Description
other_clauses	array[string]	optional	Max length: 60 foreach Explain the purpose of the clause, its elements, and any specific details about clause description

Printing Reference

Name	Type	Required	Description
client_invoice_no	string	requred	Max length: 200 The reference client invoice number printed on policy schedule
remark_on_tax_invoice	string	requred	Max length: 200 The remark printed on the tax invoice
document_title	string	requred	Max length: 200 The document title printed on policy schedule
is_print_premium_on_policy	bool	requred	Flag to indicate whether the premium should be printed on the policy schedule

Example request

{
  "trans_no": "AXA:cgg75tRB9B0wH9dwOHFmnWuWPteU",
  "quotation_id": "a174458a-49a8-4f41-a2d7-126e58be239a",
  "status": "Created",
  "effective_date": "2024-09-25",
  "expiry_date": "2024-12-24",
  "etd_date": "2024-09-25",
  "insured_long_name": "",
  "insured_detail": {
    "client_type": "C",
    "corporate_name1": "Crop111",
    "corporate_name2": "",
    "tax_id": "0000000000001",
    "branch": "000",
    "address_type": "R",
    "country_code": "THA",
    "address1": "719/225",
    "address2": "",
    "address3": "",
    "address4": "",
    "address5": "",
    "sub_district_code": "500104",
    "district_code": "5001",
    "province_code": "50",
    "postal_code": "50300",
    "phone_number1": "",
    "phone_number2": "",
    "phone_number3": "",
    "email": "user.name@axa.co.th"
  },
  "voyage_detail": {
    "voyage_from_description": "SOUTHERN, THAILAND",
    "voyage_to_description": "NANSHA NEW PORT, CHINA",
    "deliverer": "VIA: PENANG, MALAYSIA",
    "claim_payable_at": "NANSHA NEW PORT, CHINA",
    "survey_agent": "SV289",
    "settling_agent": "SV400"
  },
  "shipper_consignee_detail": {
    "name": "name 1",
    "tax_id": "0000000000001",
    "country_code": "THA"
  },
  "vessel_detail": {
    "vessel_name": "MARIE DE LOURDES",
    "imo_no": "8688171",
    "sailing_from_country": "764",
    "sailing_to_country": "036",
    "sailing_date": "2024-08-10",
    "arrival_date": "2024-08-29",
    "conveyance": "HUNSA BHUM V.0413-010S"
  },
  "commodity_detail": {
    "interest_description": [
      "L/C NO. : I027635",
      "DATE : JUNE 06, 2024",
      "NAME OF APPLICANT'S BANK : PT BANK OCBC NISP TBK"
    ]
  },
  "clause_detail": {
    "other_clauses": [
     "striAS PER OPEN COVER NO M001/2006",
      "INSURANCE POLICY IN 1 ORIGINAL AND 1 COPY"
    ]
  },
  "printing_detail": {
    "client_invoice_no": "82PTDH2408026",
    "remark_on_tax_invoice": "xx",
    "document_title": "MARINE CARGO POLICY SCHEDULE",
    "is_print_premium_on_policy": false
  },
  "transaction_by": "6d4150f2-a5f4-4586-a10b-08dcb5bef2d4"
}

Response

Name	Type	Description
trans_no	string	Unique string the client made the request
status	string	Order status Pending Issued
message	string
order_id	string	Unique Order id
policies	array[object]	Array of Policy

Policy Reference

Name	Type	Description
policy_id	guid	Unique Policy id
policy_no	string	Unique Policy number
policy_type	string	Type of policy
downloads	array[object]	Array of Download

Download Reference

Name	Type	Description
type	string	Type of download Schedule Receipt OpenCover
layer	string	Type of layer Original Copy Draft
link	string	Hyperlink points to a whole document

Example response

{
    "trans_no": "AXA:cgg75tRB9B0wH9dwOHFmnWuWPteU",
    "status": "Pending",
    "message": "",
    "order_id": "f2272867-1911-4121-947f-0769edd9e3c2",
    "policies": [
        {
            "policy_id": "08ea862c-fcdd-4958-bf56-5fa95afc4bed",
            "policy_no": "S1101509",
            "policy_type": "MCX",
            "downloads": [
                {
                    "type": "Clause",
                    "layer": "Draft",
                    "link": "https://uatapiconnect.axa.co.th/report/4c3497371f0042b4a0b5299e2c234fc0"
                },
                {
                    "type": "Policy Schedule",
                    "layer": "Draft",
                    "link": "https://uatapiconnect.axa.co.th/report/7a43de192ece4dca831e6e93e3057285"
                }
            ]
        }
    ]
}

V1

Request Header

Request Body

Insured Reference

Voyage Reference

Shipper & Consignee Reference

Vessel Reference

Comodity Reference

Clause Reference

Printing Reference

Example request

Response

Policy Reference

Download Reference

Example response