coupon_code_transactions

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

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

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:coupon_code_transactions": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/coupon_code_transaction">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: coupon_code_transaction

Description

This resource is a historical record for every transaction which has used a specific coupon code. It contains link relationships to the coupon code used and the transaction it was used with.

Actions

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

Properties

Property Description Type Constraints
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api-sandbox.foxycart.com/coupon_code_transactions/3992",
            "title": "Coupon Code Transaction Relationship"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/66",
            "title": "This Store"
        },
        "fx:transaction": {
            "href": "https://api-sandbox.foxycart.com/transactions/3835814",
            "title": "This Transaction"
        },
        "fx:coupon": {
            "href": "https://api-sandbox.foxycart.com/coupons/244",
            "title": "This Coupon"
        },
        "fx:coupon_code": {
            "href": "https://api-sandbox.foxycart.com/coupon_codes/6540",
            "title": "This Coupon Code"
        }
    },
    "date_created": 2015-04-27T13:42:55-0700,
    "date_modified": 2015-04-27T13:42:55-0700
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/coupon_code_transactions/3992" rel="https://api.foxycart.com/rels/coupon_code_transaction">
  <link rel="self" href="https://api-sandbox.foxycart.com/coupon_code_transactions/3992" title="Coupon Code Transaction Relationship"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/transaction" href="https://api-sandbox.foxycart.com/transactions/3835814" title="This Transaction"/>
  <link rel="https://api.foxycart.com/rels/coupon" href="https://api-sandbox.foxycart.com/coupons/244" title="This Coupon"/>
  <link rel="https://api.foxycart.com/rels/coupon_code" href="https://api-sandbox.foxycart.com/coupon_codes/6540" title="This Coupon Code"/>
  <date_created>2015-04-27T13:42:55-0700</date_created>
  <date_modified>2015-04-27T13:42:55-0700</date_modified>
</resource>

{
    "class": [
        "coupon_code_transaction"
    ],
    "properties": {
        "date_created": 2015-04-27T13:42:55-0700,
        "date_modified": 2015-04-27T13:42:55-0700
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/coupon_code_transactions/3992"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transaction"
            ],
            "href": "https://api-sandbox.foxycart.com/transactions/3835814"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/coupon"
            ],
            "href": "https://api-sandbox.foxycart.com/coupons/244"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/coupon_code"
            ],
            "href": "https://api-sandbox.foxycart.com/coupon_codes/6540"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.