Skip to main content

Pimberly Component

You can integrate Commerce with Pimberly using the Pimberly component. This means you can synchronize catalog data such as products, price, images, and categories between Commerce and Pimberly.

Connections

You need the following to interact with Pimberly.

OptionDescription
API Base URLYour Pimberly API Base URL. Default value is https://sandbox.pimber.ly/api/v2.2.
API KeyYour Pimberly API Key. Login to your Pimberly account to retreive your API Keys.
Webhook URLYour Pimberly webhook URL. Default value is https://sandbox-api.pimberly.io.

Actions

The component has the following actions.

Create a Webhook

InputTypeDescription
ConnectionconnectionPimberly Connection.
enabledbooleanIf webhook is enabled.
ActiondynamicfieldselectionSet up your webhook actions depending on your requirements.
URLstringThe webhook URL.

Delete a Webhook

InputTypeDescription
ConnectionconnectionPimberly Connection.

Get all Products

InputTypeDescription
ConnectionconnectionPimberly Connection.
Max IdstringThe maximum ID.
LimitstringThe product limit.

Get a Product

InputTypeDescription
ConnectionconnectionPimberly Connection.
Product IdstringThe unique identifier of the product.

Get a Product Catagory

InputTypeDescription
ConnectionconnectionPimberly Connection.
Product IdstringThe unique identifier of the product.

Get a Webhook

InputTypeDescription
ConnectionconnectionPimberly Connection.

Get Catagories for Products

InputTypeDescription
ConnectionconnectionPimberly Connection.
ProductsdynamicfieldselectionThe products whose categories you want to retrieve.

Get Child Products

InputTypeDescription
ConnectionconnectionPimberly Connection.
Product IdstringThe unique identifier of the product.

Get Parent Products

InputTypeDescription
ConnectionconnectionPimberly Connection
Product IdstringThe unique identifier of the product.

Transform Product

InputTypeDescription
ConnectionconnectionPimberly Connection
ProductsdynamicfieldselectionThe products you want to transform.
Product Type TemplatedynamicfieldselectionThe product type templates you want to transform.
Product TemplatedynamicfieldselectionThe product templates you want to transform.
Variation TemplatedynamicfieldselectionThe variation tempate you want to transform.
Product TypestringThe product type you want to transform.