Object - order

Field

Description

Mandatory

Type

Example

Condition

ref

Order reference.
This reference must be unique since it is used in duplicate request check.
The back slash character ("\") is forbidden.

Yes

AN50

12345678

origin

Type of order with the values :

E-commerce (default)
MO for mail order
TO for telephon order
In-Store for Proximity (For Monext internal use Only)

No

AN

country

Code of the country in which the order is done, see the list

No

AN2

FR

taxes

The amount of tax added to the order in the smallest currency unit.
An amount of 1 € corresponds to 100.

No

N12

100

amount

The amount of order in smallest unit of currency.
An amount of 60 € corresponds to 6000.

Yes

N12

6000

From version 28 of the API, this field must contain the amount to be authenticated (3DSV2)

currency

Currency code used for order. The ISO code :

978: euros
840: US dollars

See complete list in List of currencies

Yes

N3

978

date

The merchant order date. Format : dd/mm/yyyy HH24:MI

Yes

AN16

07/04/2016 11:00

details

Information about the ordered items. The order details is limited to 100 items.

No

List of Objects 'OrderDetails'

deliveryTime

Delivery time : Values for deliveryTime

No

N

1

deliveryMode

Delivery method : Values for deliveryMode

No

N

4

deliveryCharge Amount of delivery charges in smallest unit of currency, example 250 for 2.50 euros No N version 18 ou higher

deliveryExpectedDate

Expected delivery date must be greater than the current date. Format: dd/mm/yyyy

No

datetime

07/04/2016

Posted to Limonetik

deliveryExpectedDelay Expected delivery time (in days) No N2 10 Posted to Limonetik

discountAmount

Amount of the discount for this order (in the same currency than the order)

No

N12

version 21 or higher

OTAPackageType

Type of package (flight only, journey+accomodation, …). See the table of values Codes - OTAPackageType

No

N2

version 21 or higher

OTADestinationCountry

Country code of the destination, in ISO 3166-1 format. See the table of values Codes - country

No

AN2

version 21 or higher

bookingReference

Booking reference or Id of the travel file

No

AN100

version 21 or higher

orderDetail

Used only for origin = MO or TO.

No

AN4

version 21 or higher

orderExtended

Additionnal information about the order.

In JSON format

No

AN in JSON format

{
"deliveryProvider": "deliveryProvider",
"riskLevel": "3",
"giftCardAmount": "4000",
"giftCardCurrency": "978",
"giftCardCount": "2",
"reorderIndicator": "01"
}

version 21 or higher (3DSV2)

orderOTA

Online Travel Agency information.

No

AN in JSON format

See Object OrderOTA

{

"bookingDate": "2018-12-05",

"agencyCode": "6565",

"agencyName": "My Agency",

"travelPurpose": "1",

"countryDestination": "ANG",

"transport": { },

"carRental": {...},

"accomodation": {...}

}

transport :

{

"transportMode": "1",

"travelerList": [...],

"legList": [...]

}

travelersList :

 {
    "lastName": "France",
    "firstName": "Oliver",
    "birthDate": "1970-01-01",
    "legalDocumentType": "1",
    "legalDocument": "passeportId",
    "loyaltyMemberId": "123453453",
    "loyaltyMemberType": "4"
  },
  {
    "lastName": "France",
    "firstName": "Oliver",
    "birthDate": "1970-01-01",
    "legalDocumentType": "1",
    "legalDocument": "passeportId",
    "loyaltyMemberId": "4537884",
    "loyaltyMemberType": "4"
  }
legsList : 
  {
    "segment": "O",
    "ticketNumber": "T98374556",
    "ticketClass": "Economy",
    "isTicketRestricted": "N",
    "hasTicketInsurance": "N",
    "airlineCode": "LFT",
    "airlineName": "Lufthansa",
    "departureDate": "2019-01-24",
    "departureAirport": "MRS",
    "arrivalDate": "2019-01-25",
    "arrivalAirport": "SFO"
  },
  {
    "segment": "T1",
    "ticketNumber": "T98774556",
    "ticketClass": "Economy",
    "isTicketRestricted": "N",
    "hasTicketInsurance": "N",
    "airlineCode": "LFT",
    "airlineName": "Lufthansa",
    "departureDate": "2019-01-24",
    "departureAirport": "MRS",
    "arrivalDate": "2019-01-25",
    "arrivalAirport": "SFO"
  }
]

version 21 or higher

Page tree

Object - order