custom_fields

Resource: custom_field

This link relationship returns a collection of custom fields. 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
Read transactions_read
Write transactions_write

Collection Resource

custom_field

Actions

GET View a list of custom_fields
POST Create a new custom field
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:custom_fields[] — array of custom_field 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/transactions/{transaction_id}/transaction_custom_fields
Available via fx:custom_fields on cart·fx:custom_fields on shipment·fx:custom_fields on transaction

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/custom_fields",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/custom_fields?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/custom_fields?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/custom_fields?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/custom_fields?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:custom_fields": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/custom_fields/456",
            "title": "This Custom Field"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:transaction": {
            "href": "https://api.foxycart.com/transactions/456",
            "title": "This Transaction"
          }
        },
        "name": "Marketing_Opt_In",
        "value": "1",
        "is_hidden": false,
        "date_created": null,
        "date_modified": null
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}