Connectors

Connectors sync your Pixee PIM catalog with e-commerce platforms. Supported platforms include Shopify, WooCommerce, PrestaShop, Magento, and more.

GET/connectors

List connectors

Returns all connectors configured on your account.

Request

GET

/connectors

curl https://api.pixeepim.com/api/v1/connectors \
  -H "Authorization: Bearer {api_key}"

Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-000000000010",
      "name": "My Shopify Store",
      "platform": "shopify",
      "status": "active",
      "last_sync_at": "2026-05-14T08:00:00Z",
      "created_at": "2026-01-15T00:00:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  }
}

GET/connectors/{id}

Get a connector

Returns a specific connector and its sync status.

Path parameters

Name
id
Type
string
Description
The connector ID.

Request

GET

/connectors/{id}

curl https://api.pixeepim.com/api/v1/connectors/550e8400-e29b-41d4-a716-000000000010 \
  -H "Authorization: Bearer {api_key}"

Response

{
  "id": "550e8400-e29b-41d4-a716-000000000010",
  "name": "My Shopify Store",
  "platform": "shopify",
  "status": "active",
  "sync_stats": {
    "products_synced": 1250,
    "products_pending": 0,
    "last_error": null
  },
  "last_sync_at": "2026-05-14T08:00:00Z"
}

POST/connectors/{id}/sync

Trigger a sync

Triggers an immediate sync of your catalog to the connected platform.

Path parameters

Name
id
Type
string
Description
The connector ID.

Body parameters

Name
eans
Type
array
Description
Optional list of EANs to sync. Syncs the entire catalog if omitted.

Request

POST

/connectors/{id}/sync

curl -X POST https://api.pixeepim.com/api/v1/connectors/550e8400-e29b-41d4-a716-000000000010/sync \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{"eans": ["3760000000001", "3760000000002"]}'

Response

{
  "sync_id": "550e8400-e29b-41d4-a716-000000000011",
  "status": "queued",
  "products_queued": 2
}