Skip to main content
API docs by Redocly

Shopify Integration API (1.0.0)

Download OpenAPI specification:Download

Use this API to integrate with Shopify. For more information, see the Shopify section in the developer docs.

Customer profiles

Use the following endpoints to manage customer data.

Retrieve customer data (Headless stores)

Fetches the Talon.One customer profile for a Shopify customer in a headless store. The response is also stored in a customer metafield in Shopify.

The response schema is identical to the List customer data endpoint of the Integration API.

If you call this endpoint repeatedly with the same customer access token, the endpoint sends a cached response for the given customer. The cache clears after 10 seconds. This is done to reduce data load.

Authorizations:
ShopifyCustomerAccessToken
header Parameters
X-Shopify-Shop-Domain
required
string
Example: store.myshopify.com

The Shopify domain of the shop (e.g., store.myshopify.com).

Responses

Response samples

Content type
application/json
{
  • "profile": { },
  • "loyalty": { },
  • "referrals": [
    ],
  • "coupons": [
    ],
  • "giveaways": [
    ],
  • "achievements": [
    ]
}

Retrieve customer data (Theme-based stores)

Fetches the Talon.One customer profile for a Shopify customer in a theme-based store. The response is also stored in a customer metafield in Shopify.

The response schema is identical to the List customer data endpoint of the Integration API.

If you call this endpoint repeatedly with the same customer JWT token, the endpoint sends a cached response for the given customer. The cache clears after 10 seconds. This is done to reduce data load.

Authorizations:
ShopifyJWT

Responses

Response samples

Content type
application/json
{
  • "profile": { },
  • "loyalty": { },
  • "referrals": [
    ],
  • "coupons": [
    ],
  • "giveaways": [
    ],
  • "achievements": [
    ]
}

Session

Use the following endpoints to manage customer sessions.

Create or update customer session

Creates or updates a session in Talon.One and submits Shopify cart items.

The response schema is identical to the Update customer session endpoint of the Integration API.

header Parameters
X-Shopify-Shop-Domain
required
string
Example: store.myshopify.com

The Shopify domain of the shop (e.g., store.myshopify.com).

Request Body schema: application/json
required
id
required
string

The Shopify cart ID.

required
Array of objects

The Shopify cart line items.

Array
variant_id
required
integer
title
required
string
price
required
string
quantity
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": "gid://shopify/Cart/Z2NwLXVzLWV4YW1wbGU6MDEyMzQ1Njc4OTAxMjM0NTY3ODkw?key=examplekey1234567890",
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{ }