v1

latestOpenAPI 3.0.12026-08-066103.9 MB

Create and store an order.

Cf. summary

post/sales/v2/individual/travel/orders

Headers

accept-languagestring
Example:en

Accepted language, IANA language codification. If language not managed, "en" will be used by default.

Request body

quote_codestring

Quote code, partner can use a default value if provided by AXA or got it with quoting API.

N.B. Required when global_quote_code is not defined.

global_quote_codestring

Quote code to return all matching products. Use this code to retrieve the previous quote request results for all products matching with same criteria used.

N.B. Required when quote_code is not defined.

product_codesstring[]

List of selected product codes. ** Should be fulfilled only if global_quote_code is not null **

original_policy_idstring

This field used in renewal context. The original policy identifier.

related_policy_idstring

This field used in renewal context. The related policy identifier.

addonsstring[]

List of additional option codes that the customer can subscribe in addition to the product. Note: There is here only the list of add-ons codes. The contents of each add-on is described in TravelQuotesResponse.Addons section.

periodicitystring

Selected periodicity for the payment. ISO 8601 format (R[n]/P18Y9M4DT11H9M8S).

formulastring

Formula selected by the customer.

Example request

{
  "quote_code": "eJytUE1PwzAM/S85d6iFfYgeEUMgcUDALlwsr3FLUOoUN5k2TfvvJN2ASpyQdrTfh9",
  "global_quote_code": "PVjhRoKMDmmzJQGH9NOuwF3zS4mkja9+XPC8MTGrjf6i+fU6IQ/ApyFcZF5rkDE1kUjZ8EmX+AEXqGOI",
  "product_codes": [
    "axa_italy_catalogue_one_product_base"
  ],
  "original_policy_id": "6c76a339-cda2-4077-9a5f-562e4d01da95",
  "related_policy_id": "7654a339-cda2-4077-9a5f-562e4d01d567",
  "agent": {
    "agent_scope": "HOME/DARTY/France",
    "agent_reference": "QS23ZED4",
    "agency_reference": "AGC_007_NORD"
  },
  "addons": [
    "eJxVj8FuwjAMht8l5wq1ULapt5J2FRJbUGh6rUIbokgs6UwibUJ99yUrReCT"
  ],
  "policy_holder": {
    "title": "MR",
    "first_name": "John",
    "last_name": "Doe",
    "birth_date": "1990-04-25",
    "age": 33,
    "additional_information": [
      {
        "code": "PASSPORT_NUMBER",
        "value": "A1455CDH"
      }
    ],
    "spoken_language": "en",
    "address": {
      "street_address": "150 Avenue de Paris",
      "postal_code": "75001",
      "city": "Paris",
      "country": "FR"
    },
    "email": "jonathan.doe@mail.com",
    "preferred_communication_channel": [
      "EMAIL",
      "SMS"
    ]
  },
  "beneficiaries": [
    {
      "title": "MR",
      "first_name": "John",
      "last_name": "Doe",
      "birth_date": "1990-04-25",
      "age": 33,
      "additional_information": [
        {
          "code": "PASSPORT_NUMBER",
          "value": "A1455CDH"
        }
      ],
      "age_segment": "ADULT"
    }
  ],
  "periodicity": "R12/P1M",
  "formula": "1-DAY"
}

Response

Order created.

order_idstring

Unique final order identifier.

original_policy_idstring

This field used in renewal context. The original policy identifier.

related_policy_idstring

This field used in renewal context. The related policy identifier.

quote_codestring required

Quote code, partner can use a default value if provided by AXA or got it with quoting API.

product_codesstring[]

List of selected product codes.

addonsstring[]

List of additional option codes that the customer can subscribe in addition to the product. Note: There is here only the list of add-ons codes. The contents of each add-on is described in TravelQuotesResponse.Addons section.

Example response

{
  "order_id": "91ff04ed-0352-4e5e-bb83-5c88e7f3cd3a",
  "original_policy_id": "6c76a339-cda2-4077-9a5f-562e4d01da95",
  "related_policy_id": "7654a339-cda2-4077-9a5f-562e4d01d567",
  "quote_code": "eJytUE1PwzAM/S85d6iFfYgeEUMgcUDALlwsr3FLUOoUN5k2TfvvJN2ASpyQdrTfh9",
  "product_codes": [
    "axa_italy_catalogue_one_product_base"
  ],
  "agent": {
    "agent_scope": "HOME/DARTY/France",
    "agent_reference": "QS23ZED4",
    "agency_reference": "AGC_007_NORD"
  },
  "addons": [
    "eJxVj8FuwjAMht8l5wq1ULapt5J2FRJbUGh6rUIbokgs6UwibUJ99yUrReCT"
  ],
  "policy_holder": {
    "title": "MR",
    "first_name": "John",
    "last_name": "Doe",
    "birth_date": "1990-04-25",
    "age": 33,
    "additional_information": [
      {
        "code": "PASSPORT_NUMBER",
        "value": "A1455CDH"
      }
    ],
    "spoken_language": "en",
    "address": {
      "street_address": "150 Avenue de Paris",
      "postal_code": "75001",
      "city": "Paris",
      "country": "FR"
    },
    "email": "jonathan.doe@mail.com",
    "preferred_communication_channel": [
      "EMAIL",
      "SMS"
    ]
  },
  "beneficiaries": [
    {
      "title": "MR",
      "first_name": "John",
      "last_name": "Doe",
      "birth_date": "1990-04-25",
      "age": 33,
      "additional_information": [
        {
          "code": "PASSPORT_NUMBER",
          "value": "A1455CDH"
        }
      ],
      "age_segment": "ADULT"
    }
  ],
  "price": {
    "formula": "12-MONTHS",
    "total_taxes": 50.02,
    "total_discount": 10,
    "premium_after_discount_excl_tax": 240,
    "price_before_discount_incl_tax": 340.45,
    "price_after_discount_incl_tax": 330.45,
    "payment_periodicities": [
      {
        "periodicity": "R12/P1M",
        "description": "MONTHLY",
        "amount_per_period": 71.87,
        "amount_first_payment": 71.87
      }
    ]
  }
}