
Shopper Ledyer

<OpenAPI supportedSubmitMethods="[]" />


ShopperLedyer

Shopper API Key should be used for integrations using BFF (Backend for Frontend) or
other reverse-proxy between the end-user and Shopper. Generated by Brink Commerce


x-shopper-api-key

Id of the bundle group applying this discount

Campaign

Id of the discount cart rule applying this discount

Max amount in minor units from bonus points

Recipient information used for gift card product distribution

Id of the discount code rule applying this discount

CountryCode

CreateSessionRequest

CurrencyCode

CustomAttributes

Dimensions

Error

Reference from the external provider used with this rule

Id of the discount external rule applying this discount

GetLedyerConfirmationResponse

LanguageCode

Payment provider specific fields, please see the Ledyer documentation for details.

A string that should either be "pos" or "online".

Only needed in case of multiple stores with same country and currency.

ledyer

Customer specified options for item

The keys must use only alphanumeric, hyphen & underscore characters, and max 40 in length (`^[A-Za-z0-9_-]{1,40}$`).


The amount reduced to prevent negative value

If free shipping was applied by a discount rule

Deprecated: This field is deprecated due to being replaced with more informative models. Use CodeRules, CartRules and ExternalRules instead.

The total discount amount from discount rules applied directly on the order

OrderDiscountOutcome

Per unit base unit price of the product variant

Display description of the product variant

Per unit sale price of the product variant

Number of decimals in tax percentage, eg. taxPercentage=2500 and taxPercentageDecimals=2 -> 25 % tax

Total discount amount of the checkout gift

Total discount amount of the order line including distributed order discount

Total amount of the order line including distributed order discount

Total tax amount for the order line including distributed order discount

Per unit tax amount for the product variant

Deprecated: This field is deprecated due to being replaced by more informative models. Use CodeRules, CartRules and ExternalRules instead.

The total discount amount from discount rules applied on this order line

OrderLineDiscountOutcome

Deprecated: it's now part of discountTotal

A product parent id from product-management

Attributes that could be used to adjust delivery and shipping options

ShippingAttributes

Per unit base unit price of the shipping fee

UpdateSessionRequest

Optional fields to prefill fields in Ledyer Checkout.