discount_detail

Collection: discount_details

Discount details provide a summary of what portion of discounts (both category and product level) 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 discount detail
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

id Number · Read-only

The ID of this discount detail.

name String · Read-only

The original coupon name 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 (6)

self This Discount Detail
fx:store GET PATCH PUT DELETE This Store
fx:item GET PATCH PUT DELETE This Discount Item
fx:item_category GET PATCH PUT DELETE The discount item category.

Only present when the discount has an associated item category.

fx:transaction GET PATCH PUT POST The transaction this discount detail belongs to.

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

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

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

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

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/discount_details/123",
      "title": "This Discount Detail"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:item": {
      "href": "https://api.foxycart.com/items/999",
      "title": "This Discount Item"
    }
  },
  "id": 27,
  "name": "Product Level Discount",
  "amount_per": -0.3,
  "date_created": null,
  "date_modified": null
}