API docs by Redocly

DTC Shopify API (1.0)

Download OpenAPI specification:Download

Shopify authorisation callback

Not called directly, return from OAuth dance as part of the Shopify App installation process.

query Parameters
hmac
required
string

The hmac signature

timestamp
required
integer <int64>

The request timestamp

shop
required
string

The Shopify store

Code
required
string

The OAuth code used to exchange for access token

State
required
string

State information passed through the OAuth dance

Responses

Check if entity is in customers favorites

Simple endpoint that gives a 200 if found in the customers favorites or 404 if not.

path Parameters
customer_id
required
string

The Shopify Store ID for the customer

query Parameters
entity_id
required
string

The entity ID, the Shopify store resource identifier

entity_type
string
Default: "ProductVariant"

The type of entity, for now only ProductVariant is supported

shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Responses

Response samples

Content type
application/json
{
  • "favorite_id": "string"
}

Adds Favorite for Customer

Adds an entity in the customers favorites

path Parameters
customer_id
required
string

ID of the customer

query Parameters
shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Request Body schema: application/json
entity_id
string
entity_type
string
Default: "ProductVariant"

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "entity_type": "ProductVariant"
}

Response samples

Content type
application/json
{
  • "favorite_id": "string"
}

Get details for a customers favorite

path Parameters
customer_id
required
integer

ID of the customer

favorite_id
required
integer

ID of the favorite registration

query Parameters
shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Responses

Response samples

Content type
application/json
{
  • "customer_id": "string",
  • "favorite_id:": "string",
  • "favorite": {
    }
}

Delete a favorite for a customer

path Parameters
customer_id
required
integer

ID of the customer

favorite_id
required
integer

ID of the favorite registration

query Parameters
shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Responses

Get a customers favorites

path Parameters
customer_id
required
integer

ID of the customer

query Parameters
page_size
integer

The number of items to return in each page. Provided on the first call only.

page
string

The page identifier, this is what is set in the uri's provided from prev/next fields on initial call.

shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Responses

Response samples

Content type
application/json
{
  • "customer_id": "string",
  • "count": 0,
  • "prev": "string",
  • "next": "string",
  • "favorite": { }
}

VTO Email Creation Endpoint

Provides a means to create a VTO email to a consumer

query Parameters
shop
required
string

Provided by the Shopify Proxy

path_prefix
required
string

Provided by the Shopify Proxy

logged_in_customer_id
required
string

Provided by the Shopify Proxy the customer_id of logged in user

timestamp
required
integer <int64>

Provided by the Shopify Proxy

signature
required
string

Provided by the Shopify Proxy

Request Body schema: application/json

details for VTO email

email
required
string
content_type
required
string
main
required
string
additional
Array of strings

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "content_type": "string",
  • "main": "string",
  • "additional": [
    ]
}

Response samples

Content type
application/json
{
  • "signed_upload": {
    }
}

System and Database Check

Connects through the database validating end to end operation.

Responses