We support both RESTful endpoints and bulk jobs. We strongly recommend to use the jobs endpoint for large data sets.

API Account Based Authentication

Create the API Account from Manage Api Accounts. Save the Client ID and Client Secret, and follow the instructions which will be shown after API Account is created to access the API.

Static Token Based AuthenticationDEPRECATED

Use “Token token=%Your_API_Token%,email=%name@domain.com%” in the Http Header Authorization.

All API related enquiries should be sent to support@comestri.com.

Resources

Alias products

Resource Description
GET /api/v2/alias_products List alias products
POST /api/v2/alias_products Create or update an alias product
PUT /api/v2/alias_products/:id Update an alias product
DELETE /api/v2/alias_product/:id Delete an alias product

Association attribute values

Resource Description
GET /api/v2/association_attribute_values List association attribute values
POST /api/v2/association_attribute_values Create a association attribute value
DELETE /api/v2/association_attribute_values/:id Delete an association attribute value

Attribute definitions

Resource Description
GET /api/v2/attribute_definitions List attribute definitions
POST /api/v2/attribute_definitions Create an attribute definition
PUT /api/v2/attribute_definitions/:id Update an attribute definition
DELETE /api/v2/attribute_definitions/:id Delete an attribute definition

Attribute group assignments

Resource Description
GET /api/v2/attribute_group_assignments List attribute group assignments
POST /api/v2/attribute_group_assignments Create an attribute group assignment
DELETE /api/v2/attribute_group_assignments/:id Delete an attribute group assignment

Attribute groups

Resource Description
GET /api/v2/attribute_groups List attribute groups
POST /api/v2/attribute_groups Create or update attribute group
DELETE /api/v2/attribute_groups/:id Delete an attribute group

Attribute sets

Resource Description
GET /api/v2/attribute_sets List attribute sets
POST /api/v2/attribute_sets Create an attribute set
PUT /api/v2/attribute_sets/:id Update an attribute set
DELETE /api/v2/attribute_sets/:id Delete an attribute set

Attribute values

Resource Description
GET /api/v2/attribute_values/changed_entities_by_attribute_values List changed entities and attribute values for given attribute definition codes

Brands

Resource Description
GET /api/v2/brands List brands
POST /api/v2/brands Create an brand
PUT /api/v2/brands/:id Update an brand
DELETE /api/v2/brands/:id Delete an brand

Catalogs

Resource Description
GET /api/v2/catalogs List catalogs
POST /api/v2/catalogs Create an catalog
PUT /api/v2/catalogs/:id Update an catalog
DELETE /api/v2/catalogs/:id Delete an catalog

Categories

Resource Description
GET /api/v2/categories List categories
POST /api/v2/categories Create an category
PUT /api/v2/categories/:id Update an category
DELETE /api/v2/categories/:id Delete an category

Category sets

Resource Description
GET /api/v2/category_sets List category sets
POST /api/v2/category_sets Create an category set
PUT /api/v2/category_sets/:id Update an category set
DELETE /api/v2/category_sets/:id Delete an category set

Entity identifiers

Resource Description
GET /api/v2/entity_identifiers List Entity identifiers
POST /api/v2/entity_identifiers Create an additional identifier for an existing entity
PUT /api/v2/entity_identifiers/:id Update an entity identifier
POST /api/v2/entity_identifiers/reset Reset the additional identifiers with the same name for an existing entity
DELETE /api/v2/entity_identifiers/:id Delete an entity identifier

Inventories

Resource Description
GET /api/v2/inventories List inventories
POST /api/v2/inventories Create an inventory
PUT /api/v2/inventories/:id Update an inventory
PUT /api/v2/inventories/:id/increment Increment or decrement an inventory
DELETE /api/v2/inventories/:id Delete an inventory

Inventory locations

Resource Description
GET /api/v2/inventory_locations List inventory locations
POST /api/v2/inventory_locations Create an inventory location
PUT /api/v2/inventory_locations/:id Update an inventory location
DELETE /api/v2/inventory_locations/:id Delete an inventory location

Inventory sources

Resource Description
GET /api/v2/inventory_sources List inventory sources
POST /api/v2/inventory_sources Create an inventory source
PUT /api/v2/inventory_sources/:id Update an inventory source
DELETE /api/v2/inventory_sources/:id Delete an inventory source

Jobs

Resource Description
POST /api/v2/jobs Create a bulk job
GET /api/v2/jobs List jobs
GET /api/v2/jobs/:id Get the job details

Languages

Resource Description
GET /api/v2/languages List languages

Lookups

Resource Description
GET /api/v2/lookups List lookups
POST /api/v2/lookups Create an lookup
PUT /api/v2/lookups/:id Update an lookup
DELETE /api/v2/lookups/:id Delete an lookup
POST /api/v2/lookups/:id/search Lookup the rows by given column values
GET /api/v2/lookups/:id Lookup by id

Media items

Resource Description
GET /api/v2/media_items List media_items
POST /api/v2/media_items Create a media_item
POST /api/v2/media_items/upload Create a media_item via binary upload. The request is a multipart/form-data and the response is json like other API calls.
PUT /api/v2/media_items/:id Update a media_item
DELETE /api/v2/media_items/:id Delete a media_item
POST /api/v2/media_items/delete_by_filter Delete media_items with specified tags in the given product

Npc entities

Resource Description
GET /api/v2/npc_entities DEPRECATED List npc entities
POST /api/v2/npc_entities DEPRECATED Create or update npc entity
DELETE /api/v2/npc_entities/:id DEPRECATED Delete a npc entity

Npc entity categories

Resource Description
GET /api/v2/npc_entity_categories DEPRECATED List npc entity category links.
POST /api/v2/npc_entity_categories DEPRECATED Create a npc entity category.
DELETE /api/v2/npc_entity_categories/:id DEPRECATED Delete a npc entity category.

Option values

Resource Description
GET /api/v2/attribute_definitions/:id/option_values List option values
POST /api/v2/attribute_definitions/:id/option_values Create an option value
PUT /api/v2/attribute_definitions/:id/option_values/:id Update an option value
DELETE /api/v2/attribute_definitions/:id/option_values/:id Delete an option value

Price books

Resource Description
GET /api/v2/price_books List price books
POST /api/v2/price_books Create an price book
PUT /api/v2/price_books/:id Update an price book
DELETE /api/v2/price_books/:id Delete an price book

Price items

Resource Description
GET /api/v2/price_items List price items
POST /api/v2/price_items Create an price item
PUT /api/v2/price_items/:id Update an price item
DELETE /api/v2/price_items/:id Delete an price item

Product catalogs

Resource Description
GET /api/v2/product_catalogs List product catalog links
POST /api/v2/product_catalogs Create a product catalog link
DELETE /api/v2/product_catalogs/:id Delete a product catalog link

Product categories

Resource Description
GET /api/v2/product_categories List product category links
POST /api/v2/product_categories Create a product category
DELETE /api/v2/product_categories/:id Delete a product category

Product classes

Resource Description
GET /api/v2/product_classes List product classes
POST /api/v2/product_classes Create product class
PUT /api/v2/product_classes/:id Update a product class
DELETE /api/v2/product_classes/:id Delete a product class

Product families

Resource Description
GET /api/v2/product_families List product families
POST /api/v2/product_families Create or update product family
DELETE /api/v2/product_families/:id Delete a product family

Product family attribute groups

Resource Description
GET /api/v2/product_family_attribute_groups List product family and attribute group links
POST /api/v2/product_family_attribute_groups Create or update product family attribute group link
DELETE /api/v2/product_family_attribute_groups/:id Delete a product family attribute group link

Product groups

Resource Description
GET /api/v2/product_groups List product group associations
POST /api/v2/product_groups Create or update a product group
DELETE /api/v2/product_groups/:id Delete a product group

Product kits

Resource Description
GET /api/v2/product_kits List product kit associations
POST /api/v2/product_kits Create or update a product kit
DELETE /api/v2/product_kits/:id Delete a product kit

Product relationships

Resource Description
GET /api/v2/product_relationships List product relationships
POST /api/v2/product_relationships Create or update product relationship
DELETE /api/v2/product_relationships/:id Delete a relationship

Product variations

Resource Description
GET /api/v2/product_variations List product variation associations
POST /api/v2/product_variations Create a product variation
DELETE /api/v2/product_variations/:id Delete a product variation

Products

Resource Description
GET /api/v2/products List products
POST /api/v2/products Create or update a product
PUT /api/v2/products/:id Update a product
DELETE /api/v2/products/:id Delete a product
POST /api/v2/products/attribute_values List attribute values

Relationships

Resource Description
GET /api/v2/relationships List relationships
POST /api/v2/relationships Create or update relationship
DELETE /api/v2/relationships/:id Delete a relationship

Shared reference categories

Resource Description
GET /api/v2/shared_reference_categories List Shared reference category links
POST /api/v2/shared_reference_categories Create a Shared reference category
DELETE /api/v2/shared_reference_categories/:id Delete a Shared reference category

Shared references

Resource Description
GET /api/v2/shared_references List Shared references
POST /api/v2/shared_references Create or update Shared reference
DELETE /api/v2/shared_references/:id Delete a Shared reference

Shipping zones

Resource Description
GET /api/v2/shipping_zones List shipping zones
POST /api/v2/shipping_zones Create an shipping zone
PUT /api/v2/shipping_zones/:id Update an shipping zone
DELETE /api/v2/shipping_zones/:id Delete an shipping zone

Tenants

Resource Description
GET /api/v2/tenants/1 Show tenant information

Variants

Resource Description
PUT /api/v2/variants/:id Update a variant