REES46

Appearance

Частичный возврат заказа ​

Если клиент решил вернуть не весь заказ, а только часть, применяйте данный метод.

Важно

Метод тяжелый в расчете, создает много компенсирующих и списывающих бонусных транзакций, поэтому пользоваться им нужно как можно реже. Иначе потом сложно будет ориентироваться в логах.

Чаще всего метод используется именно для частичного возврата заказа. Но он также позволяет и увеличить состав корзины:

  1. Добавить новый товар в заказ. В этом случае вознаграждения и списания на новый товар не распространяются.
  2. Увеличить количество единиц конкретного товара. В этом случае вознаграждения и списания на дополнительное количество не производятся, но параметры *_per_product для увеличиваемого количества товаров уменьшается пропорционально.

    Например

    В заказе был товар A в количестве 2 штук и за него были начислены 200 бонусов со значением bonuses_reward=200 и bonuses_reward_per_product=100. Если было добавлено еще 2 единицы товара, то bonuses_reward останется прежним, а bonuses_reward_per_product будет равен 50.

Пользуйтесь увеличением корзины заказа с осторожностью. В большинстве случаев вреда от этого будет больше, чем пользы и достаточно просто создать новый заказ на новые товары.

POST https://api.rees46.ru/loyalty/checkout/change

Параметры ​

Те же самые параметры, что и в checkout/estimate, с той разницей, что order_id является обязательным.

Запрос ​

Пример запроса:

shell
curl --header "Content-Type: application/json" \
  --request POST \
  --data-binary "@payload.json" \
  https://api.rees46.ru/loyalty/checkout/change

Пример JSON-тела:

json
{
  "shop_id":        "...",
  "shop_secret":    "...",
  "order_id":       "...",
  "cart_items": [
    {"product_id": "...", "price": 1000, "quantity": 4},
    {"product_id": "...", "price": 2000, "quantity": 1, "discountable": false, "bonusable": false, "rewardable": false }
  ]
}

Ответ ​

Пример ответа сервера:

json
{
  "status": "success",
  "payload": {
    "order_id": "...",
    "identifier": "...",
    "payment_type": "...",
    "products_total": 5,
    "order_total": 6000,
    "order_total_change": -300,   // См. ниже
    "saved_total": 1100,
    "saved_by_discounts": 400,
    "saved_by_bonuses": 600,
    "saved_by_offers": 0,
    "saved_by_certificates": 100,
    "order_to_pay": 4900,
    "order_bonuses_to_charge": 500,
    "bonuses_balance": 1000,
    "bonuses_reward": 500,
    "bonuses_referrer_reward": 0,
    "referrer_identifier": "...",
    "referral_program": 21,
    "applied_promotions": [],
    "rewarded_stickers": {},
    "used_stickers": {},
    "stickers_balance": {},
    "promo_codes": [],
    "promo_codes_failed": [],
    "certificates": [],
    "certificates_failed": [],
    "items": [
      {
        "uniqid": "...",
        "quantity": 4,
        "price": 1000,
        "total": 4000,
        "discountable": true,
        "bonusable": true,
        "rewardable": true,
        "paid_with_offers": 0,
        "paid_with_offers_per_product": 0,
        "paid_with_referral_discounts": 0,
        "paid_with_referral_discounts_per_product": 0,
        "paid_with_discounts": 500,
        "paid_with_discounts_per_product": 100,
        "paid_with_bonuses": 500,
        "paid_with_bonuses_per_product": 100,
        "paid_with_certificates": 100,
        "paid_with_certificates_per_product": 25,
        "bonuses_reward": 400,
        "bonuses_reward_per_product": 100,
        "bonuses_reward_loyalty_program": {
          "total": 40,
          "per_product": 10
        },
        "bonuses_reward_referral_program": {
          "total": 80,
          "per_product": 20
        },
        "bonuses_reward_promotions": {
          "33": { "total": 100, "per_product": 25 },
          "17": { "total": 180, "per_product": 45 }
        },
        "certificates": {
          "14": { "id": 14, "code": "...", "pool_id": 11, "amount": 100, "amount_per_product": 25 },
          "32": { "id": 31, "code": "...", "pool_id": 19, "amount": 160, "amount_per_product": 40 }
        },
        "bonuses_used": 500,
        "bonuses_used_per_product": 125,
        "total_after_discounts": 3500,
        "total_after_discounts_per_product": 875
      },
      ...
    ]
  }
}

Расшифровка ответа: то же самое, что и в checkout/estimate.

Обратите внимание

Данный метод, помимо стандартной структуры ответа, возвращает еще и ключ order_total_change. Если значение положительное, это означает, сколько еще денег нужно взять с покупателя. Если отрицательное (частичный возврат), то сколько денег нужно вернуть покупателю.

В случае ошибки данных вернет подобную структуру:

json
{
   "status": "error",
   "payload": {
      "message": "Cart contains line items with the same product ID", 
      "identifier": "..."
   }
}