V2NodesPlytix
Plytix
V2

Plytix

Query and mutate supported Plytix PIM resources from a Flowgear Workflow by using template-driven Early Access methods.

Revision History

0.0.0.2 - Expanded the Early Access surface with create, update, delete, and action methods.
0.0.0.1 - Initial release.

Connection

Use this Connection to store the Plytix API credentials and base URLs that the Node uses to acquire and refresh bearer tokens automatically.

Property Type Description
Api Key String API key created by a Plytix account administrator.
Api Password Masked API password paired with the Api Key.
Api Base Url String Base URL for authenticated Plytix API calls. The default is https://pim.plytix.com/api/v1.
Auth Base Url String Base URL for token acquisition. The default is https://auth.plytix.com.
Access Token Masked Cached bearer token acquired automatically during Connection test and runtime calls.
Access Token Expires At UTC String UTC expiry timestamp for the cached bearer token, stored in ISO 8601 format.
Request Timeout Seconds Integer Timeout used for token and API requests. The default is 30.

Setup Notes

  1. Create API credentials in Plytix under the account administrator API section.
  2. Create a Flowgear Connection and enter Api Key and Api Password.
  3. Leave Api Base Url and Auth Base Url at their defaults unless Plytix gives you tenant-specific alternatives.
  4. Run the Connection test. Flowgear requests a bearer token and then calls GET /filters/product to confirm that the credentials can reach the curated read surface.
  5. Select the method and template you want to run so Flowgear fills in the correct OperationId plus the typed Options and, when applicable, Items contract.
  6. Expect Flowgear to manage bearer-token renewal for you. Plytix documents a 15-minute token lifetime, and the Connection reacquires a token when the cached token is missing, close to expiry, or rejected by the API.

Methods

The Node exposes template-driven methods. You select a template-backed operation and then populate the matching typed Options and, for mutations, Items contract.

Query

Use this method for the supported Early Access Plytix read surface, including filter discovery, product search, single-record reads, and product-family metadata.

Parameter Type Description
Connection Connection Plytix Connection profile.
OperationId String Stable template-selected identifier for the supported Plytix operation.
Options Object Typed route and request options for the selected operation. Search templates expose fields such as Filters, RelationshipFilters, Attributes, and Order. Single-read templates expose route fields such as ProductId, RelationshipId, or ProductFamilyId.
Return Type Description
Response Array One normalized response row per item returned in Plytix data[]. Search rows also include copied pagination metadata when Plytix returns it.

The current Query templates cover these operations:

  • Get product filters
  • Get relationship filters
  • Search products
  • Get product
  • Search product categories
  • Search product attributes
  • Search product attribute groups
  • Search relationships
  • Get relationship
  • Search product families
  • Get product family
  • Get product family attributes
  • Get product family all attributes

Create

Use this method for supported Plytix create operations such as new products, relationships, product families, categories, and attribute groups.

Parameter Type Description
Connection Connection Plytix Connection profile.
OperationId String Stable template-selected identifier for the supported create operation.
Options Object Typed route options when the selected create endpoint includes route identifiers.
Items Array Streamed request-body item or items for the selected create payload.
Return Type Description
Response Array One normalized response row per item returned by the provider, or zero rows for accepted/no-content responses.

Update

Use this method for supported Plytix update operations such as editing products, relationships, product families, attributes, and categories.

Parameter Type Description
Connection Connection Plytix Connection profile.
OperationId String Stable template-selected identifier for the supported update operation.
Options Object Typed route identifiers such as ProductId, RelationshipId, CategoryId, or ProductFamilyId.
Items Array Streamed request-body item or items for the selected update payload.
Return Type Description
Response Array One normalized response row per item returned by the provider, or zero rows for accepted/no-content responses.

Delete

Use this method for supported Plytix delete operations such as removing products, relationships, product families, categories, and linked assets.

Parameter Type Description
Connection Connection Plytix Connection profile.
OperationId String Stable template-selected identifier for the supported delete operation.
Options Object Typed route identifiers required by the selected delete endpoint.
Return Type Description
Response Array One normalized response row per item returned by the provider, or zero rows for accepted/no-content responses.

Action

Use this method for supported Plytix non-CRUD mutations such as linking or unlinking family attributes, editing family inheritance settings, assigning related resources, or resyncing variants.

Parameter Type Description
Connection Connection Plytix Connection profile.
OperationId String Stable template-selected identifier for the supported action operation.
Options Object Typed route identifiers required by the selected action endpoint.
Items Array Streamed request-body item or items when the selected action requires a payload.
Return Type Description
Response Array One normalized response row per item returned by the provider, or zero rows for accepted/no-content responses.

Usage Notes

  • Search operations page internally. You do not supply transport paging fields such as page or page_size in the designer.
  • Successful rows use status = OK. Failures use status = ERROR with normalized statusMessage and errorMessage fields.
  • Search responses emit one row per Plytix data[] item. Empty successful responses emit zero rows.
  • Mutation methods stream Items into the provider request body. A single incoming item becomes one JSON object, while multiple incoming items become a JSON array.
  • The Node retries once after reacquiring a bearer token when Plytix returns an authorization failure.
  • The Early Access surface now includes supported /api/v1 writes and actions, but still excludes account-administration endpoints and beta /api/v2/products* endpoints.