{
  "opencollection": "1.0.0",
  "info": {
    "name": "BTCPay Greenfield API Keys Apps API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Apps",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Point of Sale app",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/stores/:storeId/apps/pos",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The store ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Point of Sale app allows accepting payments for items in a virtual store"
        },
        {
          "info": {
            "name": "Get Point of Sale app data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps/pos/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ]
          },
          "docs": "Returns POS app data"
        },
        {
          "info": {
            "name": "Update a Point of Sale app",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{btcpay-host}/api/v1/apps/pos/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Use this endpoint for updating the properties of a POS app"
        },
        {
          "info": {
            "name": "Get crowdfund app data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps/crowdfund/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ]
          },
          "docs": "Returns crowdfund app data"
        },
        {
          "info": {
            "name": "Update a Crowdfund app",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{btcpay-host}/api/v1/apps/crowdfund/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Full update. GET the app first, modify the data, then PUT the complete payload."
        },
        {
          "info": {
            "name": "Create a new Crowdfund app",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/stores/:storeId/apps/crowdfund",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The store ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a new Crowdfund app"
        },
        {
          "info": {
            "name": "Get basic app data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns basic app data shared between all types of apps"
        },
        {
          "info": {
            "name": "Delete app",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/apps/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes app with specified ID"
        },
        {
          "info": {
            "name": "Uploads an image for an app item",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/apps/:appId/image",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Uploads an image for an app item"
        },
        {
          "info": {
            "name": "Deletes the app item image",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/apps/:appId/image/:fileId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "The file ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes the app item image"
        },
        {
          "info": {
            "name": "Get app sales statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps/:appId/sales",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              },
              {
                "name": "numberOfDays",
                "value": "",
                "type": "query",
                "description": "How many of the last days"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns sales statistics for the app"
        },
        {
          "info": {
            "name": "Get app top items statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps/:appId/top-items",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "App ID"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "How many of the items"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for paging"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns top items statistics for the app"
        },
        {
          "info": {
            "name": "Get basic app data for all apps for a store",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/stores/:storeId/apps",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The store ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns basic app data for all apps for a store"
        },
        {
          "info": {
            "name": "Get basic app data for all apps for all stores for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/apps",
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns basic app data for all apps for all stores"
        }
      ]
    }
  ],
  "bundled": true
}