applied_coupon_codes

Resource: applied_coupon_code

This link relationship returns a collection of applied coupon codes. 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

applied_coupon_code

Actions

GET View a list of applied_coupon_codes
POST Create a new applied coupon code
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:applied_coupon_codes[] — array of applied_coupon_code 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/carts/{cart_id}/applied_coupon_codes
Available via fx:applied_coupon_codes on cart

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/applied_coupon_codes",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/applied_coupon_codes?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/applied_coupon_codes?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/applied_coupon_codes?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/applied_coupon_codes?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:applied_coupon_codes": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/applied_coupon_codes/456",
            "title": "Applied Coupon Code"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:cart": {
            "href": "https://api.foxycart.com/carts/999",
            "title": "This Cart"
          },
          "fx:coupon": {
            "href": "https://api.foxycart.com/coupons/999",
            "title": "This Coupon"
          },
          "fx:coupon_code": {
            "href": "https://api.foxycart.com/coupon_codes/456",
            "title": "This Coupon Code"
          }
        },
        "code": "test",
        "date_created": "2015-04-27T13:42:55-0700",
        "date_modified": "2015-04-27T13:42:55-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}