integration

Collection: integrations

An integration represents an active OAuth refresh token with the current store. Each OAuth integration that has been activated and approved for the current store will be represented as an integration. Integrations can be deleted which will delete the refresh token from our system.

When deleting an integration, you will also be deleting any access tokens with the same client_id, user_uri, and scope. Warning: If you delete the integration your API client is currently using, you will have to re-authenticate your client via the OAuth Code Grant process.

Required Scopes

Full store_full_access
Read integrations_read
Write integrations_write

Actions

GET View an integration
DELETE Delete an integration
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (13)

user_uri String · Read-only

A full API URI of the user resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids.

client_id String · Read-only

A unique identifier for this client. Maps to the client_id of the client resource.

scope String · Read-only

The OAuth scope granted to this integration.

expires Number · Read-only

When this OAuth refresh token expires.

project_name String · Read-only

Maps to the project_name of the client resource.

project_description String · Read-only

Maps to the project_description of the client resource.

company_name String · Read-only

Maps to the company_name of the client resource.

company_url String · Read-only

Maps to the company_url of the client resource.

company_logo String · Read-only

Maps to the company_logo of the client resource.

contact_name String · Read-only

Maps to the contact_name of the client resource.

contact_email String · Read-only

Maps to the contact_email of the client resource.

added_by_name String · Read-only

Maps to the first_name and last_name of the user resource.

added_by_email String · Read-only

Maps to the email of the user resource.

Link Relations (4)

self This OAuth Integration
fx:store GET PATCH PUT DELETE This Store
fx:user GET PATCH PUT DELETE This User
fx:client GET PATCH PUT This Client
https://api.foxycart.com/integrations/{token}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/integrations/abc123def",
      "title": "This OAuth Integration"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:user": {
      "href": "https://api.foxycart.com/users/999",
      "title": "This User"
    },
    "fx:client": {
      "href": "https://api.foxycart.com/clients/999",
      "title": "This Client"
    }
  },
  "user_uri": "https://api.foxycart.com/users/92",
  "client_id": "super_duper_client_id",
  "scope": "user_full_access store_full_access store_id_66",
  "expires": 1752787287,
  "project_name": "My Super Project",
  "project_description": "A really cool project you should be excited about.",
  "company_name": "FoxyCart",
  "company_url": "http://www.foxycart.com",
  "company_logo": "http://www.foxycart.com/assets/templates/v02/slices/foxycart-seo-ecommerce.png",
  "contact_name": "Mr. Example",
  "contact_email": "example@example.com",
  "added_by_name": "First Last",
  "added_by_email": "someone@example.com"
}