Backend API
Fields
The unique identifier for the purchase link.
Human-friendly name of the purchase link.
The active status of the purchase link is automatically set to off and must be toggled on to activate, share, and use.
Expandable link to the coupon applied to purchase link items.
ID of the coupon applied to purchase link items.
Three-letter ISO currency code in uppercase. Defaults to your store's base currency.
Date the purchase link was created.
Date the purchase link was last updated.
Total discount amount.
Discounts applied to purchase link items.
Unique identifier for the object.
Type of discount. Can be coupon or promo-<id> referring to the source of the discount. Custom discounts don't require this value.
Object describing the discount rule details. Custom discounts don't require this value.
Fixed discount amount.
Grand total including items, shipping, and taxes.
Total discount applied to line items.
List of line items describing the products ordered.
Unique identifier for the item.
Quantity of the bundle item being ordered. Defaults to 1.
Price of the item. If a product price is reduced by a sale or price rule, this would be set to the reduced price automatically. Also, item price can be overridden when adding to a cart. Line item prices don't change unless explicitly edited by a store admin.
Total price added to sub total by multiplying quantity and price.
Configuration of one or more purchase options for purchase link items. Can be standard for one-time purchases or subscription for a subscription plan. Products can support both purchase options simultaneously.
Possible enum values:
ID of the subscription plan.
Options that allow for variations of the base product within the purchase link. If the option is part of a variant or required=true, an option value must be set for the product to be added to a purchase link cart.
Unique identifier for the object.
Name value of the product option. When adding to the cart, specify either the product option value id or name (case-insensitive) to identify the value.
List of items offered as a bundle. Defaults to product.bundle_items.
Unique identifier for the object.
Quantity of the bundle item being ordered. Defaults to 1.
ID of the bundle item product.
Expandable link to the bundle item product.
ID of the bundle item variant.
Expandable link to the bundle item variant.
Unique identifier for the object.
Name value of the product option. When adding to the cart, specify either the product option value id or name (case-insensitive) to identify the value.
ID of product in the purchase link.
Expandable link to the product within the purchase link.
ID of the product variant, if applicable.
Expandable link to the product variant.
List of discounts applied to the item by coupons, promotions, or custom logic.
Unique identifier for the object. Refers to one of the IDs in the cart discounts object.
Fixed discount amount.
Total discount applied to the item.
Total discount amount divided by quantity.
Arbitrary item data, typically set in a checkout flow to store custom values. See Storefront API for details.
Arbitrary data, typically set in a checkout flow to store custom values. See Frontend API for more details.
Array of promotion ids associated to the purchase link.
Link to promotions associated to the purchase link.
The subtotal of all of the items in a purchase link.
The purchase link model
{
"active": true,
"name": "Mythic Dawn Commentaries Collection",
"items": [
{
"product_id": "628ba6011869c10019b41f70",
"quantity": 1,
"price": 60,
"id": "628ba7241869c10019b41f7d",
"orig_price": 60,
"delivery": "shipment",
"shipment_weight": 0,
"price_total": 60,
"discount_total": 0,
"discount_each": 0
},
{
"product_id": "628ba67a1869c10019b41f76",
"quantity": 1,
"price": 60,
"id": "628ba728499bba0019b1a9c2",
"orig_price": 60,
"delivery": "shipment",
"shipment_weight": 0,
"price_total": 60,
"discount_total": 0,
"discount_each": 0
},
{
"product_id": "628ba6b7499bba0019b1a9b2",
"quantity": 1,
"price": 60,
"id": "628ba72b499bba0019b1a9c5",
"orig_price": 60,
"delivery": "shipment",
"shipment_weight": 0,
"price_total": 60,
"discount_total": 0,
"discount_each": 0
},
{
"product_id": "628ba701499bba0019b1a9bb",
"quantity": 1,
"price": 60,
"id": "628ba72d499bba0019b1a9c8",
"orig_price": 60,
"delivery": "shipment",
"shipment_weight": 0,
"price_total": 60,
"discount_total": 0,
"discount_each": 0
}
],
"shipment_delivery": true,
"currency": "USD",
"sub_total": 240,
"item_discount": 0,
"discount_total": 0,
"grand_total": 240,
"date_created": "2022-05-23T15:24:20.977Z",
"date_updated": "2022-05-23T15:24:32.137Z",
"id": "5wFVZQzV"
}