discount_details

Resource: discount_detail

This link relationship returns a collection of discount details. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

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

Collection Resource

discount_detail

Actions

GET View a list of discount_details
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:discount_details[] — array of discount_detail resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/items/{item_id}/discount_details
Available via fx:discount_details on item

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/discount_details",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/discount_details?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/discount_details?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/discount_details?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/discount_details?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:discount_details": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/discount_details/456",
            "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
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}