Shopify Api Token

View as Markdown

Create and manage credentials and access to external systems.

ShopifyApiToken: Create auth

POSThttps://api.lytics.io/v2/auth/shopify-api-token

Create a ShopifyApiToken auth

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

account_idoptionalstring

Lytics Account ID

configrequiredobject

The type-specific configuration for the authorization

config.subdomainoptionalstring

Get this from Shopify account UI

config.tokenoptionalstring

descriptionoptionalstring

A client-defined description for the authorization

labelrequiredstring

A client-defined label for the authorization

provider_idoptionalstring

The authorization's provider ID

provider_slugoptionalstring

The authorization's provider slug

typeoptionalstring

The auth type. Providers may have one or more auth types

user_idoptionalstring

The user ID that created or updated the authorization

Sample Request

{
  "account_id": "string",
  "config": {
    "subdomain": "string",
    "token": "string"
  },
  "description": "string",
  "label": "string",
  "provider_id": "string",
  "provider_slug": "string",
  "type": "string",
  "user_id": "string"
}

Sample Response

Status|201 Created

{
  "_meta": {},
  "data": {
    "account_id": "string",
    "alert_enabled": true,
    "created": "string",
    "description": "string",
    "expires": "string",
    "id": "string",
    "internal": true,
    "label": "string",
    "last_accessed_at": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "scopes": [
      "string"
    ],
    "status": "healthy",
    "ttl": "string",
    "type": "string",
    "unhealthy": true,
    "updated": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

ShopifyApiToken: Get auth

GEThttps://api.lytics.io/v2/auth/shopify-api-token/{id}

Get a ShopifyApiToken auth

Hide Parameters

URL Parameters

idrequiredstring

The Authorization ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Sample Response

ShopifyApiToken: Update auth

PUThttps://api.lytics.io/v2/auth/shopify-api-token/{id}

{ "account_id": "string", "config": { "subdomain": "string", "token": "string" }, "description": "string", "label": "string", "provider_id": "string", "provider_slug": "string", "type": "string", "user_id": "string" }

{ "_meta": {}, "data": { "account_id": "string", "alert_enabled": true, "created": "string", "description": "string", "expires": "string", "id": "string", "internal": true, "label": "string", "last_accessed_at": "string", "provider_id": "string", "provider_slug": "string", "scopes": [ "string" ], "status": "healthy", "ttl": "string", "type": "string", "unhealthy": true, "updated": "string", "user_id": "string" }, "request_id": "string", "status": 0 }