gift_card_code_log_detail

Collection: gift_card_code_log_details

This resource is a historical record for every event (Foxy transactions, external (POS) transactions you sync with Foxy using this API, admin actions to update the balance, etc.) for specific gift card codes. It contains link relationships to the gift card code used and the transaction (if applicable) it was used with.

Required Scopes

Full store_full_access
Read gift_cards_read
Write gift_cards_write

Actions

GET View a gift card code log detail
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (7)

user_id Number (nullable) · Optional

User id that made the change, for store admin or API initiated balance adjustments.

external_id String (nullable) · Optional · max 50

External id associated with gift card. If you maintain gift card balances across multiple systems, you can use this field to track non-Foxy transactions.

transaction_id Number (nullable) · Optional

The Foxy transaction ID associated with gift card usage.

balance_adjustment Number · Optional

Balance adjustment for the gift card.

Format: Decimal

source String (nullable) · Read-only

Source that made the change for the gift card.

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 Gift Card Code Transaction Relationship
fx:store GET PATCH PUT DELETE This Store
fx:gift_card GET PATCH PUT DELETE This Gift Card
fx:gift_card_code GET PATCH PUT DELETE This Gift Card Code
fx:transaction GET PATCH PUT POST The transaction associated with this log entry.

Only present when this gift card code log entry is for a completed transaction.

fx:cart GET PATCH PUT POST DELETE The cart associated with this log entry.

Only present when this gift card code log entry is for an incomplete transaction (cart).

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

gift_card
https://api.foxycart.com/gift_card_code_log_detail/{id}

Example Representation

Zoom
{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/gift_card_code_log_detail/123",
      "title": "Gift Card Code Transaction Relationship"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:gift_card": {
      "href": "https://api.foxycart.com/gift_cards/999",
      "title": "This Gift Card"
    },
    "fx:gift_card_code": {
      "href": "https://api.foxycart.com/gift_card_codes/999",
      "title": "This Gift Card Code"
    }
  },
  "transaction_id": 3859534,
  "external_id": null,
  "balance_adjustment": -40.3,
  "user_id": null,
  "source": null,
  "date_created": "2021-11-15T19:30:33-0800",
  "date_modified": "2021-11-15T19:30:35-0800"
}