Skip to main content

/api/lite/settings/checkout

Получение настроек работы виджета чекаута

/api/lite/settings/checkout

Метод возвращает настройки виджета чекаута

В ответ возвращается

успех:

{
    "success": true,
    "deliveryPremiumType": "PERCENT",
    "importOrderType": "APPROVED",
    "insurancePercent": 100,
    "freeDeliveryAmount": null,
    "freeDeliveryRegion": "RU", // RU_SNG, ALL
    "ownCourierTariff": null,
    "selfPickupTariff": null,
    "merchantId": null,
    "accountSecret": null,
    "ipnUrl": null,
  	"additionalIpnFailUrl": null,  // только для Робокассы
  	"additionalIpnSuccessUrl": null, // только для Робокассы
    "findByExtID": false, - режим поиска по ExtId
    "defaultCity": null,
    "paymentMethods": [
        {
            "code": "no-cod",
            "name": "Предоплата",
            "method": "NO_COD",
            "isDiscountActive": true,
            "discountType": "PERCENT",
            "discountValue": 10,
            "minApplyValue": 1000
        },
        {
            "code": "cod-card",
            "method": "COD_CARD",
            "name": "Оплата картой курьеру",
            "isDiscountActive": false
        }
    ],
    "promocodesAllowed": null,
    "defaultVAT": "VAT_20",
    "uiRequiredFields": [
        "PHONE",
        "EMAIL"
    ],
    "onlySufficientOffers": true,
    "disableCodSumInTariff": false, //Не учитывать тариф за наложку в сумме доставки
	"disableInsuranceSumInTariff": false, //Не учитывать тариф за страховку в сумме доставки
    "paymentProvider": "PAYU"  // "YANDEX", "ROBOKASSA",
	"paymentWithoutCommission": false,
    "defaultDeliveryServiceOptions": { // Услуги доставки, включенные у заказа по умолчанию. Если они не заданы, поле не отображается
        "GLOBAL_DELIVERY": "TRYING;PARTIAL_DELIVERY",
        "PICKPOINT": "PARTIAL_DELIVERY; TRYING; CHECK_CONTENT; PERSONALLY_IN_HANDS; DANGEROUS_CARGO; VERIFY; REVERSE"
    },
    "commercialAccount": true,
    "commercialAccountRequested": false,
    "isJurClient": null,
    "isPostfactumPaymentMode": null,
    "isContractOk": null,
    "accountantEmail": null,
    "allowSNG": null,
    "isSelfPpz": null,
    "disableCodSumInTariff": false,
    "cdekSelfPpz": null,
    "orderSubType": null,
    "catalogCode": "1000",
    "defaultVAT": null,
    "policyCheckEnabled": true,
    "personalInfoPolicyLink": "http://example.link",
    "confidentialPolicyLink": "http://example.link",
 	"country": "RU",
    "currency": "RUB",
	"successRedirectUrl": "http://example.link",
    "customersRegistrationEnabled": false,
	"unlockOrderDuringOnlinePayment": false,
	"showConsentToNewsletter": true,
	"reserveAfterPayment": true,
	"showDeliveryOptions": true,
	"deliveryRegionSettings": {
        "commonSettings": [
            {
                "country": "RU",
                "region": "MOSCOW",
                "extraFeeFixValue": 100,
                "extraFeePercentValue": 0,
                "enabled": false,
                "tariffEnabled": true
            },
            {
                "country": "ALL",
                "region": "ALL_REGIONS",
                "extraFeeFixValue": 100,
                "extraFeePercentValue": -50,
                "enabled": true,
                "tariffEnabled": true
            },
            {
                "country": "SNG",
                "region": "ALL_REGIONS",
                "extraFeeFixValue": 100,
                "extraFeePercentValue": 0,
                "enabled": true,
                "tariffEnabled": true
            }
        ]
    }
}

ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}

 

Сохранение настроек работы виджета чекаута

/api/lite/settings/checkout

Запись/обновление настроек чекаута

Запрос:

{   
    "deliveryPremiumAmount": 15.3, - размер наценки в процентах, дробное число в диапазоне [-100; +бесконечность]
    "deliveryPremiumFixAmount": 20 - - размер наценки в процентах, дробное число, можно применять как отдельно от deliveryPremiumAmount, так и               совместно
    "importOrderType": "NEED_CONFIRM", - загружать ли заказ подтверждённым? "APPROVED" | "NEED_CONFIRM"
    "insurancePercent": 100, - процент от суммы товаров для расчета страховой стоимости, дробное число, в диапазоне [0; 100]
    "freeDeliveryAmount": 1500, - сумма заказа для бесплатной доставки, если задана - то не менее 0
	"freeDeliveryRegion": "RU", - регион действия бесплатной доставки. "RU" | "RU_SNG" | "ALL"
    "ownCourierTariff": 150 - тариф на доставку своими курьерами, null -если доставки своими курьерами нет
    "selfPickupTariff": 200,  - тариф на самовывоз, null - если самовывоза нет
     "paymentMethods": [
        {
            "code": "no-cod",
            "name": "Предоплата",
            "isDiscountActive": true,
            "discountType": "PERCENT",
            "discountValue": 10,
            "minApplyValue": 1000
        }
    ],
    "findByExtID": true, - режим поиска по ExtId, (дублирование /api/lite/settings/offer-id-type)
    "defaultCity" : "Москва",
    "uiRequiredFields": ["PHONE", "EMAIL"], - перечень полей для которых чекаут должен включить обязательную валидацию непустого значения
    "onlySufficientOffers": true, - флаг для запрета покупки товаров без остатков
    "disableCodSumInTariff": false, //Не учитывать тариф за наложку в сумме доставки
	"disableInsuranceSumInTariff": false, //Не учитывать тариф за страховку в сумме доставки
    "paymentProvider": "PAYU",  // "YANDEX", "ROBOKASSA"    - подключенный провайдер эквайринга
 	"paymentWithoutCommission": false,
    //необязательный параметр. Услуги доставки, включенные у заказа по умолчанию. Ключ - внешний код службы доставки, например "PICKPOINT".
    //Значение - (DeliveryServiceOption) строковое перечисление с разделителем ";". Может быть переопределён, если передать значение deliveryServiceOptions в методе /api/lite/pub/order
    "defaultDeliveryServiceOptions": {
        "GLOBAL_DELIVERY": "TRYING;PARTIAL_DELIVERY",
        "PICKPOINT": "PARTIAL_DELIVERY; TRYING; CHECK_CONTENT; PERSONALLY_IN_HANDS; DANGEROUS_CARGO; VERIFY; REVERSE"
    },
    "catalogCode": "1005", - номер каталога, который станет основным
    "policyCheckEnabled": true,
    "personalInfoPolicyLink": "http://example.link",
    "confidentialPolicyLink": "http://example.link",
 	"country": "RU",
    "currency": "RUB",
	"successRedirectUrl": "http://example.link", 
    "customersRegistrationEnabled" : true - включение авторегистрации покупателей ,
	"unlockOrderDuringOnlinePayment" : false,
	"showConsentToNewsletter": true,
	"reserveAfterPayment": true,
	"showDeliveryOptions": true
}

В ответ возвращается

успех:

{
"success": true
}

ошибка: 

{
"success": false,
"errors": [
 {
 "code": 0,
 "message": "Текст ошибки"
 }
]
}