### Customer Order Example in JSON
Source: https://developers.qliro.com/docs/qliro-checkout/frontend-features/listeners
An example JSON structure representing a customer's order, including total price and a list of order items with their respective details.
```JSON
{
"totalPrice": 350,
"orderItems": [
{
"merchantReference": "RedHat",
"pricePerItemIncVat": 100,
"quantity": 3
},
{
"merchantReference": "BlackHat",
"pricePerItemIncVat": 50,
"quantity": 1
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api/v2settlementsGetSettlementsByBatchId-get
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api/Upsell-post
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api/v2AddItemsToInvoice-post
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api/v2settlements-get
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Return Items Request Example
Source: https://developers.qliro.com/docs/api/v2merchantpaymentretry-post
Example of a request to return items for an order, including necessary identifiers like RequestId, MerchantApiKey, OrderId, Currency, and a list of items to be returned.
```json
{
"RequestId": "d92b8c60-6781-4946-9854-e70b27452d5a",
"MerchantApiKey": "HATS",
"OrderId": 12345,
"Currency": "SEK",
"Returns": [
{
"ReturnQuantity": 1,
"OrderItemId": "item123",
"Reason": "Damaged"
}
]
}
```
--------------------------------
### Setup Qliro Payment and Banner Widgets
Source: https://developers.qliro.com/docs/on-site-material/get-started-widgets
This guide explains how to promote Qliro Payment methods and present suitable payment options for a given amount. It involves adding a div and a script to your webpage, which will dynamically create the banners and widgets upon loading.
```html
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/v2AddItemsToInvoice-post
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/v2settlementsGetSettlementBatches-get
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/v2merchantpaymentretry-post
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/Ordersid-get
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/Upsell-post
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Post Request Example for Qliro Checkout
Source: https://developers.qliro.com/docs/api/v2AddItemsToInvoice-post
This JSON object demonstrates a typical POST request payload for initiating Qliro Checkout. It includes essential merchant details, order items with metadata, and customer information, along with various configuration URLs and styling parameters.
```json
{
"MerchantApiKey": "MerchantApiKey",
"MerchantReference": "MerchantUniqueReference",
"Currency": "SEK",
"Country": "SE",
"Language": "sv-se",
"MerchantTermsUrl": "https://merchant.com/terms/",
"MerchantIntegrityPolicyUrl": "https://merchant.com/policy/",
"MerchantConfirmationUrl": "https://merchant.com/confirmation/",
"MerchantOrderValidationUrl": "https://merchant.com/orderValidation/",
"MerchantOrderAvailableShippingMethodsUrl": "https://merchant.com/avaliableShippingMethods/",
"MerchantOrderManagementStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantNotificationUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantCheckoutStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantSavedCreditCardPushUrl": "https://ordermanagement.merchant.com/creditcard",
"MerchantOrderAvailableShippingAddressesUrl": "https://merchant.com/avaliableShippingAddresses/",
"PrimaryColor": "#00AB84",
"CallToActionColor": "#00AB84",
"CallToActionHoverColor": "#24BB99",
"BackgroundColor": "#F7F7F7",
"CornerRadius": 7,
"ButtonCornerRadius": 20,
"OrderItems": [
{
"MerchantReference": "RedHat",
"Description": "Red hat original product",
"Type": "Product",
"Quantity": 3,
"PricePerItemIncVat": 375.55,
"PricePerItemExVat": 300.35,
"VatRate": 0,
"Metadata": {
"HasRisk": true,
"Subscription": {
"Enabled": false
},
"TravelInformation": {
"DepartureCountry": "string",
"DepartureCity": "string",
"DepartureIATACode": "string",
"ArrivalCountry": "string",
"ArrivalCity": "string",
"ArrivalIATACode": "string",
"StopOverCountry": "string",
"StopOverCity": "string",
"StopOverIATACode": "string",
"TravelType": "string",
"BookingDate": "string",
"DepartureDate": "string",
"ReturnDate": "string",
"DaysToDeparture": 0,
"NoOfPassengers": 0,
"Travelers": [
{
"FirstName": "string",
"LastName": "string",
"IsMainTraveller": false,
"Gender": "integer",
"DateOfBirth": "string"
}
],
"Class": "string",
"Airline": "string",
"NoOfLuggage": 0
},
"Ingrid": {
"Weight": 0,
"Sku": "string",
"ShippingDate": {
"Start": "string",
"End": "string"
},
"Attributes": [
"string"
],
"Dimensions": {
"Height": 0,
"Length": 0,
"Width": 0
},
"OutOfStock": false,
"Discount": 0
},
"MerchantData": "string"
}
}
],
"CustomerInformation": {
"PersonalNumber": "111111-1111",
"VatNumber": "SE111111111101",
"Email": "email@domain.com",
"JuridicalType": "Physical",
"MobileNumber": 46101010101,
"DateOfBirth": "string",
"Address": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"LockCustomerInformation": true,
"LockCustomerEmail": false,
"LockCustomerMobileNumber": false,
"LockCustomerPersonalNumber": false,
"LockCustomerAddress": false
},
"AvailableShippingMethods": [
{
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/v2merchantpaymentgetCustomerAddress-get
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/CreateMerchantSavedCreditCard-post
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/v2cancelOrder-post
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/v2merchantpayment-post
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/v2ordersid-get
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Create Order Payload Example
Source: https://developers.qliro.com/docs/api/Upsell-post
An example JSON payload for creating an order with Qliro. It includes merchant API key, order items with detailed metadata (e.g., travel information, Ingrid shipping details), available shipping methods with secondary options and additional services, applicable fees, and customer information.
```json
{
"MerchantApiKey": "MerchantApiKey",
"OrderItems": [
{
"MerchantReference": "RedHat",
"Description": "Red hat original product",
"Type": "Product",
"Quantity": 3,
"PricePerItemIncVat": 375.55,
"PricePerItemExVat": 300.35,
"VatRate": 0,
"Metadata": {
"HasRisk": true,
"Subscription": {
"Enabled": false
},
"TravelInformation": {
"DepartureCountry": "string",
"DepartureCity": "string",
"DepartureIATACode": "string",
"ArrivalCountry": "string",
"ArrivalCity": "string",
"ArrivalIATACode": "string",
"StopOverCountry": "string",
"StopOverCity": "string",
"StopOverIATACode": "string",
"TravelType": "string",
"BookingDate": "string",
"DepartureDate": "string",
"ReturnDate": "string",
"DaysToDeparture": 0,
"NoOfPassengers": 0,
"Travelers": [
{
"FirstName": "string",
"LastName": "string",
"IsMainTraveller": false,
"Gender": "integer",
"DateOfBirth": "string"
}
],
"Class": "string",
"Airline": "string",
"NoOfLuggage": 0
},
"Ingrid": {
"Weight": 0,
"Sku": "string",
"ShippingDate": {
"Start": "string",
"End": "string"
},
"Attributes": [
"string"
],
"Dimensions": {
"Height": 0,
"Length": 0,
"Width": 0
},
"OutOfStock": false,
"Discount": 0
},
"MerchantData": "string"
}
}
],
"AvailableShippingMethods": [
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
],
"RequireIdentityVerification": false,
"ShippingAdditionalHeader": "string",
"ApplicableFees": {
"Fees": {
"additionalProp1": [
{
"Type": "InvoiceFee",
"MerchantReference": "MerchantReference",
"AmountIncludingVat": 100,
"AmountExcludingVat": 80,
"Description": "invoice fee"
}
],
"additionalProp2": [
{
"Type": "InvoiceFee",
"MerchantReference": "MerchantReference",
"AmountIncludingVat": 100,
"AmountExcludingVat": 80,
"Description": "invoice fee"
}
]
}
}
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/RemoveMerchantSavedCreditCard-delete
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Get Customer Address Response Example
Source: https://developers.qliro.com/docs/api/Orders-get
Example JSON response for retrieving customer address information. It includes details about payment transactions.
```json
{
"OrderId": "integer",
"PaymentTransactions": [
{
"PaymentTransactionId": "integer",
"Status": "integer"
}
]
}
```
--------------------------------
### Qliro API Error Response Example
Source: https://developers.qliro.com/docs/qliro-checkout/get-started/checkout-basics
This snippet demonstrates the structure of an error response when communicating with Qliro APIs. It includes an ErrorCode, ErrorMessage, and ErrorReference for identifying and resolving issues.
```json
{
"ErrorCode": "ORDER_NOT_FOUND",
"ErrorMessage": "Order not found",
"ErrorReference": "d7da92f4-1ad9-48c3-9cd3-26559c98e64c"
}
```
--------------------------------
### POST Request Example for Qliro Checkout
Source: https://developers.qliro.com/docs/api/v2settlementsGetSettlementsByBatchId-get
This JSON object demonstrates a typical POST request payload for initiating Qliro Checkout. It includes essential merchant details, order information, customer data, and available shipping methods, with nested structures for metadata and addresses.
```json
{
"MerchantApiKey": "MerchantApiKey",
"MerchantReference": "MerchantUniqueReference",
"Currency": "SEK",
"Country": "SE",
"Language": "sv-se",
"MerchantTermsUrl": "https://merchant.com/terms/",
"MerchantIntegrityPolicyUrl": "https://merchant.com/policy/",
"MerchantConfirmationUrl": "https://merchant.com/confirmation/",
"MerchantOrderValidationUrl": "https://merchant.com/orderValidation/",
"MerchantOrderAvailableShippingMethodsUrl": "https://merchant.com/avaliableShippingMethods/",
"MerchantOrderManagementStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantNotificationUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantCheckoutStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantSavedCreditCardPushUrl": "https://ordermanagement.merchant.com/creditcard",
"MerchantOrderAvailableShippingAddressesUrl": "https://merchant.com/avaliableShippingAddresses/",
"PrimaryColor": "#00AB84",
"CallToActionColor": "#00AB84",
"CallToActionHoverColor": "#24BB99",
"BackgroundColor": "#F7F7F7",
"CornerRadius": 7,
"ButtonCornerRadius": 20,
"OrderItems": [
{
"MerchantReference": "RedHat",
"Description": "Red hat original product",
"Type": "Product",
"Quantity": 3,
"PricePerItemIncVat": 375.55,
"PricePerItemExVat": 300.35,
"VatRate": 0,
"Metadata": {
"HasRisk": true,
"Subscription": {
"Enabled": false
},
"TravelInformation": {
"DepartureCountry": "string",
"DepartureCity": "string",
"DepartureIATACode": "string",
"ArrivalCountry": "string",
"ArrivalCity": "string",
"ArrivalIATACode": "string",
"StopOverCountry": "string",
"StopOverCity": "string",
"StopOverIATACode": "string",
"TravelType": "string",
"BookingDate": "string",
"DepartureDate": "string",
"ReturnDate": "string",
"DaysToDeparture": 0,
"NoOfPassengers": 0,
"Travelers": [
{
"FirstName": "string",
"LastName": "string",
"IsMainTraveller": false,
"Gender": "integer",
"DateOfBirth": "string"
}
],
"Class": "string",
"Airline": "string",
"NoOfLuggage": 0
},
"Ingrid": {
"Weight": 0,
"Sku": "string",
"ShippingDate": {
"Start": "string",
"End": "string"
},
"Attributes": [
"string"
],
"Dimensions": {
"Height": 0,
"Length": 0,
"Width": 0
},
"OutOfStock": false,
"Discount": 0
},
"MerchantData": "string"
}
}
],
"CustomerInformation": {
"PersonalNumber": "111111-1111",
"VatNumber": "SE111111111101",
"Email": "email@domain.com",
"JuridicalType": "Physical",
"MobileNumber": 46101010101,
"DateOfBirth": "string",
"Address": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"LockCustomerInformation": true,
"LockCustomerEmail": false,
"LockCustomerMobileNumber": false,
"LockCustomerPersonalNumber": false,
"LockCustomerAddress": false
},
"AvailableShippingMethods": [
{
// ... shipping method details would go here
}
]
}
```
--------------------------------
### Update Qliro Widgets Dynamically
Source: https://developers.qliro.com/docs/on-site-material/get-started-widgets/preparations-widgets
Call this JavaScript function to update the Qliro Payment Widget or re-render other dynamically added widgets and banners on your site.
```JavaScript
window._qliroWidgets()
```
--------------------------------
### Get Settlement Batches List
Source: https://developers.qliro.com/docs/api/v2settlementsGetBankTransferBatchDetails-get
Retrieves a list of settlement batches for a specified period, including transaction sums. Requires start date, end date, and currency code.
```HTTP
GET /checkout/adminapi/v2/settlements/GetSettlementBatches?FromBatchDate=yyyy/mm/dd&ToBatchDate=yyyy/mm/dd&CurrencyCode=XXX
```
--------------------------------
### Qliro API Data Structure Example
Source: https://developers.qliro.com/docs/api/v2ordersmerchantReference-get
An example of a comprehensive data structure used within the Qliro API, detailing shipping options, additional services, fees, and loyalty configurations.
```json
{
"MerchantReference": "HOME_DELIVERY",
"ShippingFeeMerchantReference": "SHIPPING_FEE_REF_1",
"DisplayName": "Home Deliver",
"Descriptions": [
"string"
],
"Brand": "DHL",
"PriceIncVat": 300,
"PriceExVat": 200,
"OriginalPrice": 0,
"SupportsAccessCode": false,
"SupportsDynamicSecondaryOptions": true,
"SecondaryOptions": [
{
"MerchantReference": "UniqueMerchantReference",
"DisplayName": "Pickup location 1",
"City": "Stockholm",
"Address": "Street 24",
"PostalCode": 10316,
"Descriptions": [
"string"
],
"Coordinates": {
"Lat": 59.349962,
"Lng": 18.04763
},
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"AdditionalShippingServices": [
{
"MerchantReference": "ADDITIONAL_SHIPPING_SERVICE_1",
"DisplayName": "Express delivery",
"Descriptions": [
"string"
],
"PriceExVat": 100,
"PriceIncVat": 150,
"DeliveryDate": "2099-01-01",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
}
}
],
"DeliveryDate": "2099-01-01",
"CategoryDisplayName": "HOME_DELIVERY",
"LabelDisplayName": "Name",
"DeliveryDateInfo": {
"DateStart": "2099-01-01",
"DateEnd": "2099-01-01",
"Unit": "integer"
},
"IsEcoFriendly": false,
"OptionLabels": [
{
"Name": "Morning",
"DisplayType": "icon-text"
}
]
}
```
--------------------------------
### Get Settlement Batches List
Source: https://developers.qliro.com/docs/api/v2settlements-get
Retrieves a list of settlement batches for a specified period, including transaction sums. Requires start date, end date, and currency code.
```HTTP
GET /checkout/adminapi/v2/settlements/GetSettlementBatches?FromBatchDate=yyyy/mm/dd&ToBatchDate=yyyy/mm/dd&CurrencyCode=XXX
```
--------------------------------
### Post Request Example for Qliro Checkout
Source: https://developers.qliro.com/docs/api/v2retryReversalPaymentTransaction-post
This JSON object demonstrates a typical POST request payload for initiating Qliro Checkout. It includes essential merchant details, order items with metadata, and customer information, along with various configuration URLs and styling parameters.
```json
{
"MerchantApiKey": "MerchantApiKey",
"MerchantReference": "MerchantUniqueReference",
"Currency": "SEK",
"Country": "SE",
"Language": "sv-se",
"MerchantTermsUrl": "https://merchant.com/terms/",
"MerchantIntegrityPolicyUrl": "https://merchant.com/policy/",
"MerchantConfirmationUrl": "https://merchant.com/confirmation/",
"MerchantOrderValidationUrl": "https://merchant.com/orderValidation/",
"MerchantOrderAvailableShippingMethodsUrl": "https://merchant.com/avaliableShippingMethods/",
"MerchantOrderManagementStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantNotificationUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantCheckoutStatusPushUrl": "https://ordermanagement.merchant.com/checkoutstatus",
"MerchantSavedCreditCardPushUrl": "https://ordermanagement.merchant.com/creditcard",
"MerchantOrderAvailableShippingAddressesUrl": "https://merchant.com/avaliableShippingAddresses/",
"PrimaryColor": "#00AB84",
"CallToActionColor": "#00AB84",
"CallToActionHoverColor": "#24BB99",
"BackgroundColor": "#F7F7F7",
"CornerRadius": 7,
"ButtonCornerRadius": 20,
"OrderItems": [
{
"MerchantReference": "RedHat",
"Description": "Red hat original product",
"Type": "Product",
"Quantity": 3,
"PricePerItemIncVat": 375.55,
"PricePerItemExVat": 300.35,
"VatRate": 0,
"Metadata": {
"HasRisk": true,
"Subscription": {
"Enabled": false
},
"TravelInformation": {
"DepartureCountry": "string",
"DepartureCity": "string",
"DepartureIATACode": "string",
"ArrivalCountry": "string",
"ArrivalCity": "string",
"ArrivalIATACode": "string",
"StopOverCountry": "string",
"StopOverCity": "string",
"StopOverIATACode": "string",
"TravelType": "string",
"BookingDate": "string",
"DepartureDate": "string",
"ReturnDate": "string",
"DaysToDeparture": 0,
"NoOfPassengers": 0,
"Travelers": [
{
"FirstName": "string",
"LastName": "string",
"IsMainTraveller": false,
"Gender": "integer",
"DateOfBirth": "string"
}
],
"Class": "string",
"Airline": "string",
"NoOfLuggage": 0
},
"Ingrid": {
"Weight": 0,
"Sku": "string",
"ShippingDate": {
"Start": "string",
"End": "string"
},
"Attributes": [
"string"
],
"Dimensions": {
"Height": 0,
"Length": 0,
"Width": 0
},
"OutOfStock": false,
"Discount": 0
},
"MerchantData": "string"
}
}
],
"CustomerInformation": {
"PersonalNumber": "111111-1111",
"VatNumber": "SE111111111101",
"Email": "email@domain.com",
"JuridicalType": "Physical",
"MobileNumber": 46101010101,
"DateOfBirth": "string",
"Address": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"ShippingAddress": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Qliro AB",
"Street": "Sveavägen 151",
"Street2": "lgh 1001",
"PostalCode": 12345,
"City": "Stockholm",
"CareOf": "Jane Doe",
"Area": "New York",
"AreaCode": "US-NY"
},
"LockCustomerInformation": true,
"LockCustomerEmail": false,
"LockCustomerMobileNumber": false,
"LockCustomerPersonalNumber": false,
"LockCustomerAddress": false
},
"AvailableShippingMethods": [
{
}
]
}
```
--------------------------------
### Include Qliro Widget Script
Source: https://developers.qliro.com/docs/on-site-material/get-started-widgets/preparations-widgets
Add this script tag to the bottom of your page to prepare your site for Qliro Widgets. It includes parameters for merchant configuration, country, and language.
```HTML
```