Create Order
V1
post /insurance/marine/v1/orders
This endpoint to create 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 | 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 |
The intent to either create insurance policy immediately or update the policy after quotation created.
The possible values are:
|
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 | 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
|
tax_id | string | Required | Max length: 20
This field should be "Citizen ID (Tax Id)" value when card_type is "I" and "Passport Number" value when cardType is "P"
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 companyNote: 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
Condition: This field is required when client_type is "P"
|
title_code | string | Conditional | Max length: 3
Refer to Master Title |
first_name | string | Condition | Max length: 30 First name
|
last_name | string | Condition | Max length: 30 First name
|
birth_date | date | Condition |
Date of birth e.g. 1985-09-27
Format: yyyy-mm-dd
|
gender | string | Condition | Max length: 1 Type of gender
Condition: This field is required when client_type is "P"
|
marital_code | string | Condition | Max length: 1 Marital status
|
nationality_code | string | Condition | Max length: 3 Nationality code (Based on ISO 3166)Refer to Master Nationality
|
address_type | Max length: 1 Address Type
| ||
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 codeRefer to Master Sub District
|
district_code | string | Condition | Max length: 4 District codeRefer to Master District
|
province_code | string | Condition | Max length: 6 Province codeRefer to Master Province
|
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 |
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 claimsFor 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 paymentsFor 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
Response
Name | Type | Description |
---|---|---|
trans_no | string | Unique string the client made the request |
status | string |
Order status
|
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
|
layer | string |
Type of layer
|
link | string | Hyperlink points to a whole document |