Products API

The Products API provides endpoints for fetching products from Dropi, importing/linking products to Shopify, and managing product associations.

Get Dropi Products

Fetches products from the Dropi platform with pagination and filtering support.

GET /api/dropi/products

Query Parameters

pageSize

integer

default:"50"

Number of products to return per page

startData

integer

default:"0"

Starting index for pagination

keywords

string

Search keywords to filter products

hasSearch

boolean

Whether search mode is active (automatically true when keywords are provided)

privated_product

boolean

default:"false"

Filter for private products (ignored when searching)

favorite

boolean

default:"true"

Filter for favorite products (default when not searching and privated_product is false)

Response

products

array

Array of Dropi products

Show Product Object

string

Dropi product ID

name

string

Product name

title

string

Product title

description

string

Product description HTML

gallery

array

Product images

variations

array

Product variants

total

integer

Total number of products available

pageSize

integer

Number of products per page

startData

integer

Current pagination offset

Example Response

{
  "products": [
    {
      "id": "12345",
      "name": "Premium Product",
      "title": "Premium Product",
      "description": "<p>Product description</p>",
      "gallery": [
        {
          "urlS3": "https://d39ru7awumhhs2.cloudfront.net/image.jpg",
          "url": "https://d39ru7awumhhs2.cloudfront.net/image.jpg"
        }
      ],
      "variations": [
        {
          "id": "var-1",
          "sku": "SKU-001",
          "price": 29.99
        }
      ]
    }
  ],
  "total": 150,
  "pageSize": 50,
  "startData": 0
}

Requires Dropi integration to be configured with a valid API token.

Get Shopify Products

Retrieves products from the authenticated Shopify store.

GET /api/shopify/products

Response

success

boolean

Whether the request was successful

products

array

Array of Shopify products

Show Product Object

string

Shopify product ID (GraphQL format: gid://shopify/Product/123)

title

string

Product title

handle

string

Product URL handle

status

string

Product status (ACTIVE, DRAFT, ARCHIVED)

featuredImage

object

Example Response

{
  "success": true,
  "products": [
    {
      "id": "gid://shopify/Product/7891234567890",
      "title": "Example Product",
      "handle": "example-product",
      "status": "ACTIVE",
      "featuredImage": {
        "url": "https://cdn.shopify.com/...",
        "altText": "Product image"
      },
      "variants": [
        {
          "id": "gid://shopify/ProductVariant/123",
          "title": "Default Title",
          "price": "29.99"
        }
      ]
    }
  ]
}

Returns up to 250 products. Pagination support coming soon.

Get Product Variants

Retrieves variants for a specific Shopify product.

GET /api/shopify/product/variants

Query Parameters

productId

string

required

Shopify product ID in GraphQL format (e.g., gid://shopify/Product/123)

Response

success

boolean

Whether the request was successful

product

object

Basic product information

Show Product Info

string

Shopify product ID

title

string

Product title

variants

array

Array of product variants (up to 250)

Show Variant Object

string

Variant ID

title

string

Variant title

price

string

Variant price

sku

string

SKU code

barcode

string

Barcode

inventoryQuantity

integer

Current inventory

availableForSale

boolean

Whether variant is available for sale

selectedOptions

array

Variant options (color, size, etc.)

Example Response

{
  "success": true,
  "product": {
    "id": "gid://shopify/Product/7891234567890",
    "title": "Example Product"
  },
  "variants": [
    {
      "id": "gid://shopify/ProductVariant/123",
      "title": "Small / Red",
      "price": "29.99",
      "sku": "PROD-SM-RED",
      "barcode": "123456789",
      "inventoryQuantity": 50,
      "availableForSale": true,
      "selectedOptions": [
        { "name": "Size", "value": "Small" },
        { "name": "Color", "value": "Red" }
      ]
    }
  ]
}

Import/Link Product

Imports or links a Dropi product to an existing Shopify product.

POST /api/products/import

Request Body (Form Data)

dropiProductId

string

required

Dropi product ID

dropiProductData

string

required

JSON string with complete Dropi product data

shopifyProductId

string

required

Shopify product ID to link (GraphQL format)

dropiVariations

string

JSON array of Dropi product variations

variantAssociations

string

JSON array mapping Dropi variants to Shopify variants

saveDropiName

boolean

default:"false"

Update Shopify product title with Dropi name

saveDropiDescription

boolean

default:"false"

Update Shopify product description with Dropi description

useSuggestedBarcode

boolean

default:"false"

Use Dropi suggested barcodes

saveDropiImages

boolean

default:"false"

Import Dropi product images to Shopify (up to 5 images)

Response

success

boolean

Whether the import was successful

message

string

Success or error message

association

object

Created product association record

Show Association Object

string

Association record ID

shop

string

Shop domain

dropiProductId

string

Dropi product ID

shopifyProductId

string

Shopify product ID

dropiProductName

string

Dropi product name

shopifyProductTitle

string

Shopify product title

importType

string

Import type (always “link”)

Example Response

{
  "success": true,
  "association": {
    "id": "clx123abc456",
    "shop": "mystore.myshopify.com",
    "dropiProductId": "12345",
    "shopifyProductId": "gid://shopify/Product/7891234567890",
    "dropiProductName": "Premium Product",
    "shopifyProductTitle": "Premium Product",
    "importType": "link",
    "saveDropiName": true,
    "saveDropiDescription": true,
    "useSuggestedBarcode": false,
    "saveDropiImages": true
  },
  "message": "Producto sincronizado exitosamente"
}

This endpoint only supports linking to existing Shopify products. Creating new products is not supported.

When saveDropiImages is enabled, up to 5 images from the Dropi product gallery will be appended to the Shopify product.

Delete Product Association

Removes the association between a Dropi product and a Shopify product.

POST /api/products/association/delete

Request Body (Form Data)

associationId

string

required

ID of the association to delete

Response

success

boolean

Whether the deletion was successful

message

string

Success message

associationId

string

ID of the deleted association

Example Response

{
  "success": true,
  "message": "Asociación eliminada exitosamente",
  "associationId": "clx123abc456"
}

This only removes the association record. The Shopify product remains unchanged.

API Overview

Endpoints

Database

Get Dropi Products

Query Parameters

Response

Example Response

Get Shopify Products

Response

Example Response

Get Product Variants

Query Parameters

Response

Example Response

Import/Link Product

Request Body (Form Data)

Response

Example Response

Delete Product Association

Request Body (Form Data)

Response

Example Response

Build docs developers (and LLMs) love

API Overview

Endpoints

Database

Documentation Index

​Get Dropi Products

​Query Parameters

​Response

​Example Response

​Get Shopify Products

​Response

​Example Response

​Get Product Variants

​Query Parameters

​Response

​Example Response

​Import/Link Product

​Request Body (Form Data)

​Response

​Example Response

​Delete Product Association

​Request Body (Form Data)

​Response

​Example Response

Build docs developers (and LLMs) love

Get Dropi Products

Query Parameters

Response

Example Response

Get Shopify Products

Response

Example Response

Get Product Variants

Query Parameters

Response

Example Response

Import/Link Product

Request Body (Form Data)

Response

Example Response

Delete Product Association

Request Body (Form Data)

Response

Example Response