API docs by Redocly

Public Apis (1.0)

Download OpenAPI specification:Download

Droplinked Public Apis for external usage, only authorized domains and local IPs can access these endpoints

Get complete shop information

header Parameters
x-shop-id
required
string

Add your client ID in the header as x-shop-id

Responses

Response samples

Content type
application/json
{
  • "_id": "6756fba81ebb5688d79189ea",
  • "addressBookID": "675d360259ed0012eece16fa",
  • "admins": [ ],
  • "backgroundColor": "#141414",
  • "backgroundImage": "https://example.com/images/background.jpg",
  • "backgroundImageSecondary": "https://example.com/images/background-secondary.jpg",
  • "backgroundText": "Welcome to our shop",
  • "createdAt": "2024-12-09T14:16:08.941Z",
  • "currency": {
    },
  • "description": "A modern e-commerce shop with a wide range of products",
  • "discordURL": "https://discord.gg/example",
  • "facebookURL": "https://facebook.com/example",
  • "fullWidthHero": true,
  • "hasCustomDomain": false,
  • "headerIcon": "https://example.com/images/icon.png",
  • "imsTypeUpdated": false,
  • "instagramURL": "https://instagram.com/example",
  • "isAgeRestricted": false,
  • "isCatalogMode": false,
  • "launchDate": null,
  • "linkedinURL": "https://linkedin.com/company/example",
  • "loginMethods": [
    ],
  • "logo": "https://example.com/images/logo.png",
  • "name": "Example Shop",
  • "ownerID": "6756fba81ebb5688d79189e6",
  • "paymentMethods": [
    ],
  • "shopDesign": {
    },
  • "tags": [
    ],
  • "templateID": {
    },
  • "paymentWallets": [
    ],
  • "tokenBasedPricing": {
    }
}

Retrieve paginated list of shop products

query Parameters
page
number
Example: page=1

Page number for pagination

limit
number
Example: limit=15

Number of products per page

search
string
Example: search=fsdfa

Search term to filter products

header Parameters
x-shop-id
required
string

Your client ID to identify the shop

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 1,
  • "totalPages": 2,
  • "hasNextPage": true,
  • "hasPreviousPage": false,
  • "nextPage": 2,
  • "previousPage": null,
  • "limit": 20,
  • "totalDocuments": 34
}

Get product details by slug

Retrieves detailed product information using the product slug. This endpoint is useful for SEO-friendly URLs and product pages.

path Parameters
slug
required
string
Example: premium-smart-led-bulb-v2

SEO-friendly URL slug of the product

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "_id": "67d54e3fa3a00a5ac273de31",
  • "slug": "premium-smart-led-bulb-v2",
  • "title": "Premium Smart LED Bulb V2",
  • "description": "<p>Experience the future of lighting with our Premium Smart LED Bulb V2. Features include:<br>- Smart home integration with Alexa & Google Home<br>- 16 million color options<br>- Energy efficient design<br>- Mobile app control<br>- Scheduled lighting patterns<br>- Voice control enabled</p>",
  • "skuIDs": [
    ],
  • "media": [],
  • "productCollectionID": {
    },
  • "ownerID": "6756fba81ebb5688d79189e6",
  • "product_type": "NORMAL",
  • "purchaseAvailable": true,
  • "shippingType": "EASY_POST",
  • "m2m_positions": [ ],
  • "m2m_services": [ ]
}

Get product details by ID

Retrieves comprehensive product information including variants, media, pricing, and collection details. Useful for product detail pages and inventory management.

path Parameters
id
required
string
Example: 67d54e3fa3a00a5ac273de31

Unique identifier of the product

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "_id": "67d54e3fa3a00a5ac273de31",
  • "slug": "premium-smart-led-bulb-v2",
  • "title": "Premium Smart LED Bulb V2",
  • "description": "<p>Experience the future of lighting with our Premium Smart LED Bulb V2. Features include:<br>- Smart home integration with Alexa & Google Home<br>- 16 million color options<br>- Energy efficient design<br>- Mobile app control<br>- Scheduled lighting patterns<br>- Voice control enabled</p>",
  • "skuIDs": [
    ],
  • "media": [],
  • "productCollectionID": {
    },
  • "ownerID": "6756fba81ebb5688d79189e6",
  • "product_type": "NORMAL",
  • "purchaseAvailable": true,
  • "shippingType": "EASY_POST",
  • "m2m_positions": [ ],
  • "m2m_services": [ ]
}

PublicApiController_getProductTile

path Parameters
productTileId
required
string
Example: 6463f7cfd06c1637910d43d5

product tile id

Responses

Response samples

Content type
application/json
{
  • "skuIDs": [
    ],
  • "embedded_tag": "string",
  • "style": { }
}

Create a new shopping cart

Creates an empty cart for either an authenticated user or an anonymous customer. If access token is provided, creates a personalized cart tied to the user account. Otherwise creates an anonymous cart.

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Retrieve cart information

Gets detailed information about a cart including items, totals, shipping info and gift card status. Works for both anonymous and authenticated carts.

path Parameters
cartId
required
string
header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Add product to cart

Adds a product with specified SKU and options to an existing cart. Works for both anonymous and authenticated carts.

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

ID of the cart to add product to

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Product details to add to cart

required
object

its an optional property that should be used when adding a mint to merch product to the cart

shopID
required
string

shop id .

skuID
required
string

sku id

quantity
required
number

quantity

Responses

Request samples

Content type
application/json
{
  • "skuID": "6791f9e201f727b25c336f64",
  • "quantity": 1,
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Update cart item quantity

Updates the quantity of a specific item in the cart. Can increase or decrease quantity.

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

ID of the cart to update

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Update quantity details

shopID
required
string

shop id

skuID
required
string

sku id

quantity
required
number

quantity

itemId
required
string

Item Id

Responses

Request samples

Content type
application/json
{
  • "skuID": "6791f9e201f727b25c336f64",
  • "shopID": "6756fba81ebb5688d79189ea",
  • "quantity": 2,
  • "itemId": "67fa3a4bc5da053e89baf1c3"
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Delete cart

Permanently removes a cart and all its items. This action cannot be undone.

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

ID of the cart to delete

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

generate an overlay image from the uploaded nft image (you should show the nfts from the customer wallet) to use for mint to merch functionality

Request Body schema: application/json
baseImageLink
required
string

link of the base image of the product, from the chosen m2m_position_option url

overlayImageLink
required
string

link of the uploaded nft or image from the user (in png format or others)

Responses

Request samples

Content type
application/json
{
  • "baseImageLink": "string",
  • "overlayImageLink": "string"
}

Mint to Merch functionality

header Parameters
access-token
string

you can send the access token if user has been logged in using droplinked oauth

Request Body schema: application/json
variant_ids
required
Array of strings

an array that contains the externalID of a chosen product SKU

files
required
Array of strings

an array that contains a object with the uploaded nft image url and the chosen placement

pod_blank_product_id
required
string

the pod_blank_product_id that you get from the product data

technique
required
string

optional property if the product has a specific technique in the retrieved data

Responses

Request samples

Content type
application/json
{}

send the link of generated mockup to be added to cart, a m2m_preview field will be added to the cart item. show that instead of default image of the item.

path Parameters
cartId
required
string

id of the current cart

itemId
required
string

Cart details retrieved successfully

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json
preview
required
string

the link of generated mockup to be added to cart

Responses

Remove item from shopping cart

Removes a specific item from the cart. Returns the updated cart after removal.

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

Unique identifier of the cart

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Item details to remove from cart

itemId
required
string

item id

Responses

Request samples

Content type
application/json
{
  • "itemId": "67fa3a4bc5da053e89baf1c3"
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Attach additional details to cart

Add or update email, shipping address and note for a cart

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

Unique identifier of the cart

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Additional details to attach to cart

addressId
required
string
email
required
string
note
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "customer@example.com",
  • "addressId": "67fa3a49c5da053e89baf1ad",
  • "note": "Please deliver during business hours"
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Add email to anonymous cart

Add email to anonymous cart (use for not authenticated user)

path Parameters
cartId
required
string

cart id

Request Body schema: application/json
email
required
string

An valid email

note
required
string

additional info

Responses

Request samples

Content type
application/json
{
  • "email": "example@droplinked.com",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Get available payment methods for cart

Returns a list of all available payment methods including cryptocurrency and traditional payment options

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

Cart ID

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search countries

Returns a list of countries filtered by search query. Supports pagination and partial name matching.

query Parameters
limit
number
Example: limit=10

Maximum number of records to return

offset
number

Number of records to skip

name
any
Example: name=us

Search term to filter countries by name

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "message": null,
  • "data": {
    }
}

Search cities

Returns a list of cities filtered by country name and/or city name. Includes state information and supports pagination.

query Parameters
offset
number

Number of records to skip

limit
number
Example: limit=100

Maximum number of records to return

name
any
Example: name=los a

Search term to filter cities by name (partial match supported)

country_name
any
Example: country_name=United States

Full country name to filter cities

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Responses

Response samples

Content type
application/json
{
  • "cities": [
    ],
  • "limit": "100",
  • "length": 4
}

Create a new customer address

Creates a new address record for a customer with detailed location and contact information

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Address details

firstName
required
string

first name

lastName
required
string

last name

addressLine1
required
string

first address line

addressLine2
required
string

second address line

country
required
string

country

city
required
string

city

state
required
string

state

zip
required
string

zip code

addressType
required
string
Enum: "CUSTOMER" "SHOP" "SHIPPING_CUSTOMER"

address type

phoneNumber
string

Phone Number

forceVerify
boolean

Force to verify address

Responses

Request samples

Content type
application/json
Example
{
  • "firstName": "John",
  • "lastName": "Doe",
  • "phoneNumber": "+1234567890",
  • "address1": "123 Main Street",
  • "address2": "Apt 4B",
  • "city": "Los Angeles",
  • "state": "California",
  • "country": "United States",
  • "zipCode": "90001"
}

Response samples

Content type
application/json
{
  • "_id": "645eb20ed39c5d06ec87cd78",
  • "firstName": "John",
  • "lastName": "Doe",
  • "phoneNumber": "+1234567890",
  • "address1": "123 Main Street",
  • "address2": "Apt 4B",
  • "city": "Los Angeles",
  • "state": "California",
  • "country": "United States",
  • "zipCode": "90001",
  • "addressType": "CUSTOMER",
  • "createdAt": "2024-03-15T10:30:00.000Z",
  • "updatedAt": "2024-03-15T10:30:00.000Z"
}

Add the created address to the customer cart

path Parameters
cartId
required
string

cart id

Request Body schema: application/json
addressBookID
required
string

address book id

note
required
string

Responses

Request samples

Content type
application/json
{
  • "addressBookID": "628e6179e16d1959dc1a42c5",
  • "note": "example note"
}

Create Checkout based on Chain

path Parameters
cartID
required
string
paymentType
required
string
Enum: "CASPER" "POLYGON" "BINANCE" "REDBELLY" "BITLAYER" "ETH" "STACKS" "XRPLSIDECHAIN" "NEAR" "SKALE" "BASE" "LINEA" "SOLANA"
tokenType
required
string
Enum: "USDT" "USDC" "BINANCE_PEG_BSC_USD" "CSPR" "MATIC" "BNB" "XRP" "BASE" "LINEA" "ETH" "MEW" "PARAM" "SOL" "PARAMT" "PARAMB" "BDC" "RBNT" "BTC"
Request Body schema: application/json
email
required
string

user email address .

walletAddress
required
string

Wallet Address

Responses

Request samples

Content type
application/json
{
  • "email": "example@email.com",
  • "walletAddress": "0x000"
}

Send Order Payment to the Chain Network

path Parameters
chain
required
string
Enum: "CASPER" "POLYGON" "BINANCE" "REDBELLY" "BITLAYER" "ETH" "STACKS" "XRPLSIDECHAIN" "NEAR" "SKALE" "BASE" "LINEA" "SOLANA"
Example: SOLANA
Request Body schema: application/json
deploy_hash
required
string
cryptoAmount
required
number
orderID
required
string
walletAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "deploy_hash": "0x68213890d155f1ef9990e9d9fb8ed9f7cdb014c5c2f24a84b4807a0ac50aa040",
  • "cryptoAmount": 125.53424,
  • "orderID": "6332a65d26038728b5aa9e43",
  • "walletAddress": "0x0"
}

Get cart shipping rate based on the address

path Parameters
cartId
required
string

cart id

Responses

Add shipping rates to cart

Adds selected shipping rates to the cart. Updates cart with chosen shipping method and recalculates total costs.

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

Unique identifier of the cart

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json

Shipping rate details to add to cart

rates
required
Array of strings

Array of shipment rates

Responses

Request samples

Content type
application/json
{
  • "rates": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "checkoutAddressID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntent": { },
  • "shipmentRates": { },
  • "selectedShipmentRate": 2,
  • "selectedShipmentRateID": "string",
  • "shipmentData": { },
  • "availableShipmentRates": [
    ],
  • "selectedShipmentRates": 2,
  • "selectedShipmentRateIDs": [
    ],
  • "shipmentInformation": [
    ],
  • "costs": {
    }
}

Create Stripe payment session

Initializes a Stripe payment session for the cart and creates an order

path Parameters
cartId
required
string
Example: 67fa3a49c5da053e89baf1ad

Unique identifier of the cart

header Parameters
x-shop-id
required
string

Client ID for shop authentication

Request Body schema: application/json
email
required
string

Customer email address

Responses

Request samples

Content type
application/json
{
  • "email": "customer@example.com"
}

Response samples

Content type
application/json
{
  • "totalPrice": 47.29,
  • "client_secret": "pi_3RD6wzJYpy7bkFtu0lHrhINP_secret_6KETz2fly5E9CqyX2jVqTbIHO",
  • "type": "stripe",
  • "orderID": "67fa952bc5da053e89baf8d5",
  • "currency": "USD",
  • "convertedAmount": 47.29,
  • "conversionRate": 1
}

get order by id

path Parameters
id
required
string
Example: 636fd84d0a7a1ec1a6d66e33

order id

Responses

Response samples

Content type
application/json
{
  • "status": "WAITING_FOR_PAYMENT",
  • "ownerID": "6332a65d26038728b5aa9e43",
  • "customerID": "6332a65d26038728b5aa9e43",
  • "shopID": "6332a65d26038728b5aa9e43",
  • "cartID": "6332a65d26038728b5aa9e43",
  • "items": [
    ],
  • "paymentIntentID": "pi_4KXvOUDHP9PnFF5D1MChaPrM",
  • "selectedShipmentRates": 7,
  • "purchaseID": "3cyix2",
  • "seenByProducer": false,
  • "customerAddressBook": {
    },
  • "shippingPrice": "7,47",
  • "shipmentPostageLabelURL": "shipment postage label url",
  • "shipmentTrackingCode": ""
}

Apply the gift card code to the cart

apply the gift card code to the cart (for both non authenticated and oauth authenticated users)

Request Body schema: application/json
code
required
string

Gift Card code

cartId
required
string

Cart Id

Responses

Request samples

Content type
application/json
{
  • "code": "dfr54tgy6u",
  • "cartId": "64cf871007f3ef6c1c01b931"
}

Retrieve cart details and update additional details if provided

Fetches the cart details based on the provided cart ID and updates any additional details (email, address, note) if they are specified in the request body.

path Parameters
cartId
required
string
Example: 628e6179e16d1959dc1a42c5

The unique identifier of the cart that needs to be updated.

Request Body schema: application/json

Details to be added to the cart, including email, address ID, and an optional note.

addressId
required
string
email
required
string
note
required
string

Responses

Request samples

Content type
application/json
{
  • "addressId": "628e6179e16d1959dc1a42c5",
  • "email": "drop@link.com",
  • "note": "Some additional note"
}