store_transaction_folders : Foxy hAPI

store_transaction_folders

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 store_transaction_folders
POST: Create a new store_transaction_folders
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:store_transaction_folders": [...]
  },
  "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/store_transaction_folders">
  ...
  </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: store_transaction_folders

Description

Store transaction folder is used for order management.

Interact with this resource

Actions

GET: View a store_transaction_folders
PATCH: Update a store_transaction_folders (send only the properties you want to modify)
DELETE: Delete a store_transaction_folders
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
name	Name of the folder	String	Required
is_default	Specifies if the current folder is the default one. Only one folder can be default at a time. If you update one folder to be the default one we will mark others as non default.	Boolean	Optional
sort_order	Defines the sort order of transactions in the folder	Int	Optional
color	Defines the color of the folder	String	Optional
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.foxycart.com/store_transaction_folders/1",
			"title": "This Transaction Folder"
		},
		"fx:store": {
			"href": "https://api.foxycart.com/stores/2",
			"title": "This Store"
		}
	},
	"name": "Default name",
	"is_default": 0,
	"sort_order": 0,
	"color": null,
    "date_created": "2025-03-19T14:41:44-0700",
	"date_modified": "2025-03-19T14:41:44-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/store_transaction_folders/1" rel="https://api.foxycart.com/rels/transaction_folder">
	<link rel="self" href="https://api.foxycart.com/store_transaction_folders/1" title="This Transaction Folder"/>
	<link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/2" title="This Store"/>
	<name>Default name</name>
	<is_default>0</is_default>
	<sort_order>0</sort_order>
	<color></color>
	<date_created>2025-03-19T14:41:44-0700</date_created>
	<date_modified>2025-04-04T07:59:20-0700</date_modified>
</resource>

{
	"class": [
		"transaction_folder"
	],
	"properties": {
		"name": "Default name",
		"is_default": 0,
		"sort_order": 0,
		"color": null,
		"date_created": "2025-03-19T14:41:44-0700",
		"date_modified": "2025-04-04T07:59:20-0700"
	},
	"links": [
		{
			"rel": [
				"self"
			],
			"href": "https://api.foxycart.com/store_transaction_folders/1"
		},
		{
			"rel": [
				"https://api.foxycart.com/rels/store"
			],
			"href": "https://api.foxycart.com/stores/2"
		}
	],
	"actions": [
		{
			"name": "self",
			"title": "Update Transaction Folder",
			"method": "PATCH",
			"href": "https://api.foxycart.com/transaction_folders/1",
			"type": "application/x-www-form-urlencoded",
			"fields": [
				{
					"name": "name",
					"title": "Name",
					"type": "text",
					"value": "Default name"
				},
				{
					"name": "is_default",
					"title": "Is Default",
					"type": "text",
					"value": 0
				},
				{
					"name": "sort_order",
					"title": "Sort Order",
					"type": "text",
					"value": 0
				},
				{
					"name": "color",
					"title": "Color",
					"type": "text",
					"value": null
				}
			]
		}
	]
}

Zoomable Resources

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