Authentication

Overview

All API endpoints require a JWT token passed via the x-access-token header. You obtain this token by exchanging your API key and shop domain.

Get a Token

string

required

Your API key, found at Settings > Information in the PuppetVendors dashboard.

string

required

Your Shopify store domain (e.g. my-store.myshopify.com).

curl -X POST https://api.puppetvendors.com/v1/authenticate \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "shopDomain": "my-store.myshopify.com"
  }'

Response

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "shopDomain": "my-store.myshopify.com"
}

Using the Token

Include the token in all subsequent requests:

curl -X POST https://api.puppetvendors.com/v1/lineitems/update \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{ ... }'

Tokens expire after 24 hours. Use POST /v1/refresh-token with a valid token to get a new one.

Getting Started

Vendors

Users

Orders

Products

Payouts

Fulfillments

Commissions

Reports

Line Items

Overview

Get a Token

Response

Using the Token

​Overview

​Get a Token

​Response

​Using the Token

Overview

Get a Token

Response

Using the Token