Gift line properties
| Property Name | Data type | Required | Description |
|---|---|---|---|
_giftPlanLoopId | String | Mandatory | Nano ID of the selected gift plan. Can be found in the giftStorePlans.json by fetching it from https://cdn.loopwork.co/{{myshopify_domain}}/giftStorePlans.json. |
Orders | Number | Mandatory | Number of orders in the plan. In other words, number of orders to fulfill in the gift subscription. |
_storeShippingPrice | Number | Optional | Shipping price to charge for the whole gift subscription (in store currency). Example: if you charge 10$ per delivery, and your subscription will have 3 orders, then this property should be set to 30. Defaults to 0 if not provided. |
_calculatedDiscountValue | Number | Optional | Fixed amount discount in presentment currency, in cents. If you want the discount to be 10$, then you should provide 1000 as its value. The amount should be per-quantity and for the full subscription. This value is per quantity. Example: you wish to provide 10$ fixed discount regardless of what the customer checks out with. The customer chooses to buy a gift subscription for 3 orders with quantity = 2 of a product. The value expected in this property is 500 (10 * 100 / 2). Defaults to 0 if not provided. |
_recipientFirstName | String | Mandatory | First name of the gift recipient. Checkout will not be allowed if this property is empty. |
_recipientLastName | String | Mandatory | Last name of the gift recipient. |
_recipientEmail | String | Mandatory | Email of the gift recipient (must be different than the email provided by the customer in the checkout page). |
_recipientPhone | String | Optional | Phone of the gift recipient. |
_senderName | String | Mandatory | Name of the sender (customer who is currently paying for the gift). |
_senderMessage | String | Optional | Message that the sender wishes to be displayed to the recipient when they open their gift management page on Loop's customer portal. |
_discountType | Others | Optional | Discount type set in the gift plan. You can get it from giftStorePlans.json. Possible values are FIXED or PERCENTAGE. |
_discountValue | Number | Optional | Discount value set in the gift plan. You can get it from giftStorePlans.json. |
_orderScheduleDateFormat | String | Optional | You can get this data from giftStore.json. This is a preference that can be set in preferences (https://cdn.loopwork.co/{{myshopify_domain}}/giftStore.json). |
_orderScheduleDate | String | Optional | The delivery date for the first order. If the _orderScheduleDateFormat property is provided, then the value of this property is validated to ensure that the selected first order delivery date respects the gift preferences chosen. |
_canScheduleFirstOrder | Stringified Boolean | Optional | Possible values are "true" or "false". Its value can be extracted from giftStore.json, which provides all the gift preferences set (https://cdn.loopwork.co/{{myshopify_domain}}/giftStore.json). |
_minAllowedDays | Number | Optional | You can get this data from the giftStore.json API endpoint. This is a preference that can be set in preferences (https://cdn.loopwork.co/{{myshopify_domain}}/giftStore.json). |
_maxAllowedDays | Number | Optional | You can get this data from the giftStore.json API endpoint. This is a preference that can be set in preferences (https://cdn.loopwork.co/{{myshopify_domain}}/giftStore.json). |
_frequencyLoopId | String | Mandatory | The ID received in giftStorePlans.json under the frequency key for the selected gift program. Currently, there can be only one frequency per gift program. The frequencies key in giftStorePlans.json is an array for future-proofing. |
_frequencyIntervalCount | Number | Mandatory | Selected frequency interval count. If the frequency is 2 weeks, then the value of this property will be 2. |
_frequencyInterval | Others | Mandatory | Frequency unit. If the selected frequency is 2 weeks, then its value will be WEEK. Possible values: DAY, WEEK, MONTH, YEAR. |
Updated 10 days ago
