Brand Engineering Checklist

Complete checklist for integrating with the Rokt Catalog Brand API, covering authentication, products, webhooks, fulfillments, and inventory sync.

Complete each section below to finish your Rokt Catalog Brand API integration. The sections are ordered to match the typical integration flow: start with authentication, then work through products, webhooks, fulfillments, and inventory sync.

Authentication

All API requests require two headers for authentication. Your credentials are generated automatically when your account is created.

1. Locate your Application ID and API Access Token in the Rokt Catalog app under Settings → Developer → API Credentials.
2. Include both credentials as headers in every API request:
   • x-canal-app-id: your Application ID
   • x-canal-app-token: your API Access Token
3. Verify your credentials work by making a test request to any endpoint and confirming you receive a successful response.

For more details, refer to the Authentication Guide.

Products

remarque

A successor product-feed intake based on the Google product data specification is planned; the endpoints below remain supported and are the way to integrate today. See Catalog ingestion via API for details.

Push your product catalog to Rokt Catalog so Partners can discover and sell your products. Product data includes titles, descriptions, images, variants, pricing, and inventory.

1. Create your products using the Product Create endpoint. Each product must include at least one variant with a price, inventory_quantity, inventory_policy (continue or deny), and option1. A sku is not required by the schema but is strongly recommended. You can also include images with a src URL and optional position.
2. Verify your products appear correctly in the Catalog tab of your Brand app.
3. When product-level details change (title, description, images, tags), update them using the Product Update endpoint. These changes sync automatically to any connected Partners selling the product.

attention

The Product Update endpoint handles product-level fields only. To update variant-specific attributes like price, SKU, or inventory, use the Variant Update endpoint described in the Inventory Sync section below.

Webhooks

Register webhooks so your application receives real-time notifications when order events occur. Without webhooks, you would need to poll the API to discover new orders.

1. Subscribe to the order/create webhook to receive incoming orders from Partners. This is the primary webhook for Brands: it delivers the full order payload (line items, quantities, shipping address) so you can begin fulfillment.
2. Subscribe to the order/update webhook to receive changes to existing orders, such as shipping address corrections or status updates. This ensures your fulfillment system always has the latest order details.
3. Subscribe to the order/cancel webhook to be notified when a Partner cancels an order. Use this to halt fulfillment processing and update your inventory.

You can register webhooks through the Rokt Catalog app under Settings → Developer → Add Webhooks, or programmatically via the Webhook Create endpoint. For more details on webhook topics, verification, and payload format, see the Webhooks Guide.

Fulfillments

When you ship items for a Catalog order, report the fulfillment back to Catalog so the Partner and end customer are informed with tracking details.

1. After shipping items, create a fulfillment record using the Fulfillment Create endpoint. Include the order_id, tracking information (tracking_company, plus tracking_numbers and tracking_urls as lists of strings), and a list of line_items with their Catalog id and quantity being shipped. The request also requires name, service, shipment_status (one of label_printed, label_purchased, attempted_delivery, ready_for_pickup, confirmed, in_transit, out_for_delivery, delivered, failure), and status (one of pending, open, success, cancelled, error, failure).
2. If an order contains items that ship separately, create a separate fulfillment for each shipment. A single order can have multiple fulfillments.
3. When tracking information changes after the initial fulfillment (for example, a corrected tracking number or updated carrier), update the fulfillment using the Fulfillment Update endpoint.

Catalog automatically syncs fulfillment data to the Partner's storefront and emits a fulfillment/create webhook event when a fulfillment is created and a fulfillment/update event when one is updated. Creating a fulfillment also emits an order/update event for the parent order.

Inventory Sync

Keep variant-level data (pricing, stock quantities, and SKUs) synchronized between your system and Rokt Catalog. Accurate inventory prevents overselling, and accurate pricing ensures Partners display the correct amounts.

1. When a variant's price, compare_at_price, sku, or inventory_quantity changes in your system, push the update to Catalog using the Variant Update endpoint. Price and inventory changes sync automatically to connected Partners.
2. To add a new variant to an existing product (e.g., a new size or color), use the Variant Create endpoint. The new variant syncs to Partners automatically.
3. To remove a variant that is no longer available, use the Variant Delete endpoint. Catalog removes the variant from Partner storefronts and recalculates positions for the remaining variants.

info

You cannot delete the last remaining variant of a product. To remove a product entirely, use the Product Delete endpoint instead.