coupon_detail

Collection: coupon_details

Coupon details provide a summary of what portion of coupons apply to a given item in the cart.

Required Scopes

Full store_full_access

When part of a completed transaction:

Read transactions_read
Write transactions_write

When part of a cart:

Read carts_read
Write carts_write

Actions

GET View a coupon detail
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (6)

id Number · Read-only

The ID of this coupon detail.

name String · Read-only

The original coupon name used for this discount.

code String · Read-only

The original coupon code used for this discount.

amount_per Number · Read-only

The amount of discount applied to this item.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (7)

self This Coupon Detail
fx:store GET PATCH PUT DELETE This Store
fx:item GET PATCH PUT DELETE This Coupon Item
fx:coupon GET PATCH PUT DELETE This Coupon
fx:coupon_code GET PATCH PUT DELETE This Coupon Code
fx:transaction GET PATCH PUT POST The transaction this coupon detail belongs to.

Only present when this coupon detail belongs to a completed transaction.

fx:cart GET PATCH PUT POST DELETE The cart this coupon detail belongs to.

Only present when this coupon detail belongs to an incomplete transaction (cart).

https://api.foxycart.com/coupon_details/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/coupon_details/123",
      "title": "This Coupon Detail"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:item": {
      "href": "https://api.foxycart.com/items/999",
      "title": "This Coupon Item"
    },
    "fx:coupon": {
      "href": "https://api.foxycart.com/coupons/999",
      "title": "This Coupon"
    },
    "fx:coupon_code": {
      "href": "https://api.foxycart.com/coupon_codes/999",
      "title": "This Coupon Code"
    }
  },
  "id": 30,
  "name": "Test",
  "code": "test",
  "amount_per": -14.9710075546,
  "date_created": null,
  "date_modified": null
}