store_transaction_folder

Collection: store_transaction_folders

Store transaction folder is used for order management. There is a limit of 10 store transaction folders per store.

Required Scopes

Full store_full_access
Read transactions_read
Write transactions_write

Actions

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

Properties (6)

name String · Required

Name of the folder.

is_default Boolean

Specifies if the current folder is the default folder for all new transactions. Only one folder can be default at a time. If a different folder is set to be default, any existing folder marked as default will be set to false.

sort_order Number

Defines a sort order for folders, primarily used within the Foxy administration.

color String (nullable)

Defines the color of the folder.

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 (3)

self This Transaction Folder
fx:store GET PATCH PUT DELETE This Store
fx:transactions GET Transactions in this Folder
https://api.foxycart.com/store_transaction_folders/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/store_transaction_folders/123",
      "title": "This Transaction Folder"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:transactions": {
      "href": "https://api.foxycart.com/stores/456/transactions?folder_id=123",
      "title": "Transactions in this Folder"
    }
  },
  "name": "Default name",
  "is_default": false,
  "sort_order": 0,
  "color": null,
  "date_created": "2025-03-19T14:41:44-0700",
  "date_modified": "2025-03-19T14:41:44-0700"
}