Gift Cards

Gift cards allow the Order Management System (OMS) to process orders as a discount. Orders with gift cards can be processed in the OMS as a promotional discount, not a payment method.

See the How gift cards work section for more information.

Gift card order

When a gift card is added to the order during checkout, it will be displayed as a discount to the total purchase amount at the order level, while the order line still shows the original product price.

How gift cards work

The OMS does not currently fully support multiple tender types per order. The gift card order flow requires some manual processing to operate effectively. See the Gift Card in our User Guide documentation for more info.

You cannot currently create store credit for orders which are fully paid with a gift card because the OMS cannot generate refunds for zero total prices.

Orders fully paid with gift cards cannot automatically generate a store credit because the OMS cannot generate refunds for zero total prices. If the order is fully paid with a gift card, the payment methods are hidden with an indication that no payment is required (if the Zero Subtotal Checkout payment method is be enabled in MC).

Orders partially paid with gift cards generate a store credit if the entire order amount, paid by another payment provider, is fully refunded.

Orders partially paid with a gift card along with another payment method create a refund for the whole order amount.

Refund and store credit

An order with multiple order lines, paid partially with a gift card and partially with another payment method (such as credit card), store credit is generated only if the entire amount of the order has been refunded.

You can generate a store credit by returning all order lines via manual appeasement. If you create a partial return the paid amount is refunded to the customer, but a store credit is not generated.

Custom attribute for gift cards

Gift card information is exported as a custom_attribute at the order level:

Example of an order with a custom attribute and gift card

{
    "order": {
        "id": "123456",
        "custom_attributes": []
            {
                "name": "gift_card",
                "value": "003YL6VBPP97"
            }
      }
}

Example of an order line with the promotions_info section per order line

        ...],
         "lines": [
            {
                "line_number": "1",
                "id": "23",
                "type": "PHYSICAL",
                "name": "Yoga pants"
                "amount": {
                        "net_amount": 50,
                        "gross_amount": 50,
                        "tax_amount": 0,
                        "tax_rate": 0,
                        "taxes": [
                            {
                                "type": "NO TAX",
                                "amount": 0,
                                "rate": 0
                            }
                        ],
                        "currency": "USD"
                    },
                    "promotions_info": {
                        "original_price": 100,
                        "promotions": [
                            {
                                "code": "003YL6VBPP97",
                                "name": "gift_card",
                                "discount": 50,
                                "percentage": 50
                            }
                        ]
                    }
            },
]

Use cases

The following are common user scenarios for gift cards in the OMS.

Gift card with a partially canceled order

A customer places an order in MC and uses a gift card during checkout:

MC checkout

The Connector sends the order and it is created in the OMS as a NEW order:

Gift card

It is possible to do a partial shipment for this order, and the invoice for that partial order is then created. The other order lines appear as line_cancelled:

line cancelled

Gift card with a partially returned order

A customer places an order in MC and uses a gift card during checkout:

MC checkout

The Connector sends the order and it is created in the OMS as a NEW order:

Gift card

The order is shipped from OMS, and it is notified to MC via the connector. Now you can create a partial return for the order. OMS sends the return to MC via the Connector and the product will appear as refunded in MC:

refund

Finally, the order shows a refund in MC for that amount:

credit memo

Gift card with a fully returned order

A customer places an order in MC and uses a gift card during checkout:

checkout gift card

The Connector sends the order and it is created in the OMS as a NEW order:

oms gift card

The order is shipped from the OMS and notifies MC via the Connector. OMS sends two shipments to MC via the Connector, and invoices are created for both products:

Gift card order

Finally, you can create a return for the order. OMS sends the return to MC via the Connector and both returns can be seen in OMS as a store credit attached to the order:

Gift card order