Skip to Content
Developers

Sync your catalog

Keep ENDVR's copy of your products up to date, keyed by your own ids.

ENDVR uses your product catalog when the brand builds campaigns, for example to pick the products of a training module or a Pro Deal. Keep it in sync from your store.

Upsert products

PUT /catalog/products creates or replaces up to 100 products, keyed by your product and variant ids. Sending a product again replaces the stored copy, variants included, so always send the full product.

curl -X PUT https://api.endvr.io/v1/catalog/products \
  -H "Authorization: Bearer $ENDVR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "products": [{
      "id": "prod_1001",
      "title": "Trail Runner 2",
      "url": "https://shop.example.com/products/trail-runner-2",
      "imageUrl": "https://shop.example.com/images/trail-runner-2.jpg",
      "variants": [
        { "id": "var_1001_42", "sku": "TR2-BLK-42", "title": "Black / 42", "price": "159.00", "currency": "USD" }
      ]
    }]
  }'

Each product comes back as accepted, duplicate (nothing changed) or rejected with a reason.

Archive products

When a product leaves your store, archive it:

curl -X DELETE https://api.endvr.io/v1/catalog/products/prod_1001 \
  -H "Authorization: Bearer $ENDVR_API_KEY"

Archived products can't be added to new campaigns; campaigns that already use them keep them. Upsert the product again to restore it.

Read back

  • GET /catalog/products?updatedSince=… lists what changed, to reconcile after an outage.
  • GET /catalog/products/{id} reads one product, archived or not.

A sync that holds

  1. On change: when a product is created or updated in your store, upsert it. When it is deleted or unpublished, archive it.
  2. Daily full sync: upsert every published product in batches of 100. Unchanged products come back as duplicate.
  3. Clean-up: list ENDVR's products and archive any your store no longer has.

On this page