SYNC_CART_SUCCEEDED

Fired when adding products to a user’s merchant cart is successful.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Body

application/json

event

string

Name of the webhook event.

Example:

"SYNC_CART_SUCCEEDED"

external_user_id

string

Unique identifier for the user.

Example:

"123abc"

merchant

object

Show child attributes

merchant.id

integer

Unique identifier for the merchant.

Example:

4

merchant.name

string

Name of the merchant.

Example:

"Walmart"

merchant.logo

string

Logo of the merchant.

Example:

"https://knot.imgix.net/merchants/KBQ5j6cN010PPpwbO7RpKGyDrCpsZ91FRhwnZp5u.png?auto=format&w=240"

data

object

Show child attributes

data.cart

object

Show child attributes

data.cart.products

object[]

List of products in the cart.

Show child attributes

data.cart.products.external_id

string

External identifier for the product.

Example:

"123abc"

data.cart.products.fulfillment

object

Fulfillment information containing the currently selected fulfillment preference in the root and additional fulfillment options in fulfillment.options.

Show child attributes

data.cart.products.fulfillment.id

string

Unique identifier for the fulfillment preference.

Example:

"5cfbe095d0cb9e597e316170d6ee9a6c667bddcde4a999222d2cc2b5bbfef7cf"

data.cart.products.fulfillment.type

Type of fulfillment preference Delivered from a fulfillment center to the user's address without a scheduled delivery window.

Available options:

UNSCHEDULED_DELIVERY

Example:

"SCHEDULED_DELIVERY"

data.cart.products.fulfillment.label

string

Label of the fulfillment preference from the merchant.

Example:

"Express delivery"

data.cart.products.fulfillment.availabilityStart

string | null

Timestamp of the fulfillment preference in UTC. ISO 8601 format. If unscheduled, this value represents the date of the fulfillment. If scheduled, this value represents the beginning of the scheduled window.

Example:

"2025-08-10T15:00:00Z-05:00"

data.cart.products.fulfillment.availabilityEnd

string | null

Timestamp of the end of the scheduled fulfillment preference window in UTC. ISO 8601 format. If unscheduled, this value will be the same as the availabilityStart. If scheduled, this value represents the end of the scheduled window.

Example:

"2025-08-10T15:00:00Z-08:00"

data.cart.products.fulfillment.price

object

Price information for the fulfillment preference.

Show child attributes

data.cart.products.fulfillment.price.total

string

Total price of the fulfillment preference. This is included in price.total for the entire cart, despite not being listed in price.adjustments.

Example:

"0.00"

data.cart.products.fulfillment.price.currency

string

Currency of the price. ISO 4217 format.

Example:

"USD"

data.cart.products.fulfillment.options

object[]

Alternative fulfillment options to the currently selected fulfillment preference.

Show child attributes

data.cart.products.fulfillment.options.id

string

Unique identifier for the fulfillment preference.

Example:

"5cfbe095d0cb9e597e316170d6ee9a6c667bddcde4a999222d2cc2b5bbfef7cf"

data.cart.products.fulfillment.options.type

Type of fulfillment preference Delivered from a fulfillment center to the user's address without a scheduled delivery window.

Available options:

UNSCHEDULED_DELIVERY

Example:

"SCHEDULED_DELIVERY"

data.cart.products.fulfillment.options.label

string

Label of the fulfillment preference from the merchant.

Example:

"Express delivery"

data.cart.products.fulfillment.options.availabilityStart

string | null

Example:

"2025-08-10T15:00:00Z-05:00"

data.cart.products.fulfillment.options.availabilityEnd

string | null

Example:

"2025-08-10T15:00:00Z-08:00"

data.cart.products.fulfillment.options.price

object

Price information for the fulfillment preference.

Show child attributes

data.cart.products.fulfillment.options.price.total

string

Total price of the fulfillment preference. This is included in price.total for the entire cart, despite not being listed in price.adjustments.

Example:

"0.00"

data.cart.products.fulfillment.options.price.currency

string

Currency of the price. ISO 4217 format.

Example:

"USD"

data.cart.delivery_location

object

Delivery location for the cart.

Show child attributes

data.cart.delivery_location.address

object

Show child attributes

data.cart.delivery_location.address.line1

string

First line of the delivery address.

Example:

"123 Main St"

data.cart.delivery_location.address.line2

string | null

Second line of the delivery address.

Example:

"Floor 4"

data.cart.delivery_location.address.city

string

City portion of the delivery address.

Example:

"Los Angeles"

data.cart.delivery_location.address.region

string

Region portion of the delivery address, usually a state abbreviation. Must be an ISO 3166-2 sub-division code.

Example:

"CA"

data.cart.delivery_location.address.postal_code

string

Postal code of the delivery address.

Example:

"94105"

data.cart.delivery_location.address.country

string

Country portion of the delivery address. Must be an ISO 3166-1 alpha-2 code.

Example:

"US"

data.cart.delivery_location.first_name

string | null

First name for the delivery address.

Maximum string length: 255

Example:

"Ada"

data.cart.delivery_location.last_name

string | null

Last name for the delivery address.

Maximum string length: 255

Example:

"Lovelace"

data.cart.delivery_location.phone_number

string | null

Phone number for the delivery address in E.164 format.

Example:

"+11234567890"

data.cart.price

object

Show child attributes

data.cart.price.sub_total

string

Subtotal price of the products in the cart.

Example:

"12.56"

data.cart.price.adjustments

object[]

List of price adjustments.

Show child attributes

data.cart.price.adjustments.type

enum<string>

Type of adjustment.

Available options:

DISCOUNT,

TAX,

TIP,

FEE,

REFUND,

UNRECOGNIZED

Example:

"TAX"

data.cart.price.adjustments.label

string | null

Label of the adjustment from the merchant.

Example:

"NYC local sales tax"

data.cart.price.adjustments.amount

string

Amount of the adjustment.

Example:

"3.67"

data.cart.price.total

string

Total price of the products in the cart.

Example:

"16.23"

data.cart.price.currency

string

Currency of the price. ISO 4217 format.

Example:

"USD"

timestamp

string

Unix timestamp of the webhook event in UTC.

Example:

"1710864923198"

General

SDK

CardSwitcher

TransactionLink

Shopping

Detect

Vaulting

Merchant Account Linking

SYNC_CART_SUCCEEDED

Authorizations

Body