Product Catalog Integration

Workflow details

1. Shopify Webhooks

The app subscribes to Shopify product creation and update events.

Shopify Webhook

Subscribe to the products/create and products/update Webhooks in Shopify


Integration

2. API Integration

After receiving the product data, call the

POST
/api/v2/RetailerCatalog endpoint to send it to ESW. Choose one of the following modes depending on your use case:

  • Full Catalog Upload: For initial onboarding of your complete product catalog.
  • Add New Products: For sending only newly added SKUs to ESW.
  • Update Existing Products: For modifying existing SKUs in the ESW system.

API Integration

Product data from Shopify is posted to ESW using the ESW Catalog API

JSON Schema
  {
    "productCode": "11160296020014",
    "name": "JACKET",
    "description": "JACKET",
    "material": "FABRIC 53% cotton, 21% polyester, 21% acrylic, 4% viscose, 1% polyester, lining 100% polyester",
    "countryOfOrigin": "IT",
    "hsCode": "62043290",
    "hsCodeRegion": "EU",
    "category": null,
    "gender": null,
    "ageGroup": null,
    "size": null,
    "weight": null,
    "weightUnit": null,
    "url": null,
    "imageUrl": null,
    "unitPrice": null,
    "dangerousGoods": null,
    "additionalProductCode": null,
    "variantProductCode": null
  }

Parameters
productCoderequiredstring
Brand's unique master identifier or SKU (Stock Keeping Unit). Should match the SKU used on the retailer’s site.
namerequiredstring
Name of the product. Should match the product title on the retailer’s landing page and include distinguishing features.
descriptionrequiredstring
Short description of the product, used for customs clearance.
materialrequiredstring
Description of the material(s) the product is made of. Include primary and secondary materials for customs purposes.
countryOfOriginrequiredstring
ISO 3166 alpha-2 code of the product’s country of manufacture.
Enum"CN", "US", "GB".
hsCoderequiredstring
Brand’s HS code of the product. Minimum 6 digits (padded to 8 if necessary). Required for customs clearance.
hsCodeRegionrequiredstring
ESW-defined region corresponding to the HS code.
Enum"AD", "AE", "AL"
parentProductCodestring
SKU for a group of products that come in different versions (variants).
categorystring
ESW product category.
Enum"AnimalsPetSupplies", "ApparelAccessories", "Electronics", "Furniture", "Hardware".
genderstring
Intended gender for the product.
Enum"Male", "Female", "Unisex".
ageGroupstring
Intended age group for the product.
Enum"Newborn", "Infant", "Toddler", "Kids", "Adult".
Appeasements
Manage appeasements.
Pricing Import
Import Prices from PricingAdvisor into Shopify