Channels

Connect to every marketplace

Channel connections for Shopify, Amazon 1P/3P, or custom endpoints. Configure field mapping, schema/catalog filtering, and dimension scoping to syndicate product data exactly how each channel expects it.

Shopify

Push products, variants, and images to Shopify stores. Requires shopUrl and apiKey in config.

Amazon 1P

Vendor Central integration for first-party selling. Type: amazon-1p

Amazon 3P

Seller Central integration for third-party marketplace. Type: amazon-3p

Custom

Connect to any REST endpoint with configurable field mappings and transforms. Type: custom

Endpoints

Method	Endpoint	Description
GET	`/channels`	List all channels
GET	`/channels/:id`	Get channel by ID
POST	`/channels`	Create a new channel
PUT	`/channels/:id`	Update a channel
DELETE	`/channels/:id`	Delete a channel

List all channels

Returns all configured channels for the current tenant.

curl https://api.sigma-pim.com/api/v1/channels \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

// Response
[
  {
    "id": "ch-shopify-eu",
    "name": "Shopify EU Store",
    "alias": "shopify-eu",
    "type": "shopify",
    "description": "European Shopify storefront",
    "config": {
      "shopUrl": "https://sigma-eu.myshopify.com",
      "apiKey": "shpat_***"
    },
    "fieldMappings": [
      { "sourceAttribute": "product-name", "targetField": "title" },
      { "sourceAttribute": "description", "targetField": "body_html" },
      { "sourceAttribute": "price", "targetField": "variants[0].price" }
    ],
    "schemaId": "schema-apparel",
    "catalogId": "cat-eu-retail",
    "dimensionScope": { "dim-language": "seg-en", "dim-market": "seg-eu" },
    "active": true
  }
]

Get channel by ID

Returns a single channel with its full configuration including field mappings and scope.

curl https://api.sigma-pim.com/api/v1/channels/ch-shopify-eu \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Create channel

Create a new channel connection. Specify the channel type, connection config, and field mappings. Optionally filter by schema, catalog, or dimension scope.

Request body

Field	Type	Description
`name`	string	Display name for the channel
`alias`	string	URL-safe identifier
`type`	string	`shopify` \| `amazon-1p` \| `amazon-3p` \| `custom`
`description`	string?	Optional description
`config`	object	Connection config. Shopify: `{ shopUrl, apiKey }`
`fieldMappings`	array	Array of `{ sourceAttribute, targetField, transform? }`
`schemaId`	string?	Filter to records of this schema
`catalogId`	string?	Filter to records in this catalog
`dimensionScope`	object?	Dimension scope for value resolution
`active`	boolean	Whether the channel is active

curl -X POST https://api.sigma-pim.com/api/v1/channels \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Shopify EU Store",
    "alias": "shopify-eu",
    "type": "shopify",
    "description": "European Shopify storefront",
    "config": {
      "shopUrl": "https://sigma-eu.myshopify.com",
      "apiKey": "shpat_xxxxxxxxxxxxxxxxxxxx"
    },
    "fieldMappings": [
      { "sourceAttribute": "product-name", "targetField": "title" },
      { "sourceAttribute": "description", "targetField": "body_html" },
      { "sourceAttribute": "price", "targetField": "variants[0].price" }
    ],
    "schemaId": "schema-apparel",
    "catalogId": "cat-eu-retail",
    "dimensionScope": {
      "dim-language": "seg-en",
      "dim-market": "seg-eu"
    },
    "active": true
  }'

// Response
{
  "id": "ch-shopify-eu",
  "name": "Shopify EU Store",
  "alias": "shopify-eu",
  "type": "shopify",
  "description": "European Shopify storefront",
  "config": {
    "shopUrl": "https://sigma-eu.myshopify.com",
    "apiKey": "shpat_***"
  },
  "fieldMappings": [
    { "sourceAttribute": "product-name", "targetField": "title" },
    { "sourceAttribute": "description", "targetField": "body_html" },
    { "sourceAttribute": "price", "targetField": "variants[0].price" }
  ],
  "schemaId": "schema-apparel",
  "catalogId": "cat-eu-retail",
  "dimensionScope": { "dim-language": "seg-en", "dim-market": "seg-eu" },
  "active": true
}

Update channel

Update an existing channel's configuration, field mappings, or scope. Send the full channel object.

curl -X PUT https://api.sigma-pim.com/api/v1/channels/ch-shopify-eu \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Shopify EU Store",
    "alias": "shopify-eu",
    "type": "shopify",
    "config": {
      "shopUrl": "https://sigma-eu.myshopify.com",
      "apiKey": "shpat_new_key_here"
    },
    "fieldMappings": [
      { "sourceAttribute": "product-name", "targetField": "title" },
      { "sourceAttribute": "description", "targetField": "body_html" },
      { "sourceAttribute": "price", "targetField": "variants[0].price" },
      { "sourceAttribute": "weight", "targetField": "variants[0].weight", "transform": "kg_to_g" }
    ],
    "schemaId": "schema-apparel",
    "catalogId": "cat-eu-retail",
    "dimensionScope": {
      "dim-language": "seg-en",
      "dim-market": "seg-eu"
    },
    "active": true
  }'

Delete channel

Permanently delete a channel and its configuration. Sync mappings and logs for this channel are also removed.

curl -X DELETE https://api.sigma-pim.com/api/v1/channels/ch-shopify-eu \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

// Response
{
  "deleted": true
}

Field Mapping Reference

Field mappings connect Sigma PIM attributes to external channel fields. Each mapping specifies a source attribute alias and the target field path on the external platform.

sourceAttribute

The alias of the Sigma PIM attribute to read from. Example: product-name

targetField

The field path on the external platform. Supports dot notation and array indexing: variants[0].price

transform

Optional transform function applied during sync: kg_to_g, html_strip, uppercase

Shopify Mapping

Common targets: title, body_html, vendor, product_type, variants[0].price, variants[0].sku

Previous Export Jobs Next Sync