Pixee PIM
Pixee PIM
API Reference

Connectors

Connectors sync your Pixee PIM catalog with e-commerce platforms, marketplaces, and headless commerce engines.

Supported platforms (15): Shopify, BigCommerce, Salesforce Commerce Cloud (SFCC), SAP Commerce, Wizishop, Cdiscount, Fnac, Sylius, Squarespace, Google Merchant Center, Mirakl, Medusa, Shopware 6, Saleor, Amazon SP-API.

WooCommerce and Magento have dedicated sync modules with their own routers (/api/v1/woocommerce/ and /api/v1/magento/) powered by the sync_base framework.

All mutating connector endpoints require the MANAGE_SETTINGS permission. External URLs are validated against an SSRF allowlist. Credentials are stored Fernet-encrypted.

GET/connectors/

List connectors

Returns all connectors configured on your account.

The trailing slash is required — redirect_slashes=False is active on this router.

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/{connector_id}

Get a connector

Returns a specific connector and its current sync status.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Request

GET
/connectors/{connector_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/{connector_id}/test

Test a connector

Tests the connection to the platform (authentication, reachability). Does not sync any data.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Request

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

Response

{
  "success": true,
  "platform": "shopify",
  "latency_ms": 142,
  "message": "Connection successful"
}

Sync operations

Each sync direction is a separate endpoint. All four enqueue a Celery task on the connectors queue and return immediately.

Push products

Pushes catalog data from Pixee PIM to the connected platform. Products are sent in chunks of 100.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Body parameters

  • Name
    product_ids
    Type
    array
    Description

    Optional list of product UUIDs to push. Pushes the entire catalog if omitted.

Request

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

Response

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

Pull products

Pulls product data from the connected platform into Pixee PIM. Existing products are matched by external ID or EAN and updated; new products are created.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Request

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

Response

{
  "job_id": "550e8400-e29b-41d4-a716-000000000012",
  "status": "queued"
}

Push stock

Pushes current stock levels from Pixee PIM to the connected platform. This is a lightweight operation — only ProductStock.quantity values are transmitted.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Request

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

Response

{
  "job_id": "550e8400-e29b-41d4-a716-000000000013",
  "status": "queued"
}

Push prices

Pushes pricing data to the connected platform. The connector uses the channel_price from a matching PriceList if one is configured for the platform's channel; otherwise it falls back to the product's base price.

Path parameters

  • Name
    connector_id
    Type
    string
    Description

    The connector ID.

Request

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

Response

{
  "job_id": "550e8400-e29b-41d4-a716-000000000014",
  "status": "queued"
}

Was this page helpful?