API Event 0.8.92

Name	Value	Description
attribute_upserted	attribute_upserted
attribute_deleted	attribute_deleted
attribute_upserted_v2	attribute_upserted_v2
attribute_deleted_v2	attribute_deleted_v2
catalog_upserted	catalog_upserted
catalog_deleted	catalog_deleted
subcatalog_upserted	subcatalog_upserted
subcatalog_deleted	subcatalog_deleted
catalog_item_upserted	catalog_item_upserted
catalog_item_deleted	catalog_item_deleted
catalog_item_upserted_v2	catalog_item_upserted_v2
catalog_item_deleted_v2	catalog_item_deleted_v2
subcatalog_item_upserted	subcatalog_item_upserted
subcatalog_item_deleted	subcatalog_item_deleted
b2b_invoice_upserted	b2b_invoice_upserted
b2b_invoice_deleted	b2b_invoice_deleted
b2b_credit_memo_upserted	b2b_credit_memo_upserted
b2b_credit_memo_deleted	b2b_credit_memo_deleted
consumer_invoice_upserted	consumer_invoice_upserted
consumer_invoice_deleted	consumer_invoice_deleted
credit_memo_upserted	credit_memo_upserted
credit_memo_deleted	credit_memo_deleted
crossdock_shipment_upserted	crossdock_shipment_upserted
rate_deleted	rate_deleted
rate_upserted	rate_upserted
rate_deleted_v3	rate_deleted_v3
rate_upserted_v3	rate_upserted_v3
customer_upserted	customer_upserted
customer_deleted	customer_deleted
customer_address_book_contact_upserted	customer_address_book_contact_upserted
customer_address_book_contact_deleted	customer_address_book_contact_deleted
email_notification_upserted	email_notification_upserted
email_notification_deleted	email_notification_deleted
available_promotions_upserted	available_promotions_upserted
available_promotions_deleted	available_promotions_deleted
available_promotions_upserted_v2	available_promotions_upserted_v2
available_promotions_deleted_v2	available_promotions_deleted_v2
allocation_deleted_v2	allocation_deleted_v2
allocation_upserted_v2	allocation_upserted_v2
currency_format_deleted	currency_format_deleted
currency_format_upserted	currency_format_upserted
experience_deleted	experience_deleted
experience_upserted	experience_upserted
experience_deleted_v2	experience_deleted_v2
experience_upserted_v2	experience_upserted_v2
experience_price_book_mapping_deleted	experience_price_book_mapping_deleted
experience_price_book_mapping_upserted	experience_price_book_mapping_upserted
experience_logistics_settings_upserted	experience_logistics_settings_upserted
experience_logistics_settings_deleted	experience_logistics_settings_deleted
item_margin_deleted	item_margin_deleted
item_margin_upserted	item_margin_upserted
item_sales_margin_deleted	item_sales_margin_deleted
item_sales_margin_upserted	item_sales_margin_upserted
label_format_deleted	label_format_deleted
label_format_upserted	label_format_upserted
order_deleted	order_deleted
order_upserted	order_upserted
order_deleted_v2	order_deleted_v2
order_upserted_v2	order_upserted_v2
order_identifier_deleted	order_identifier_deleted
order_identifier_upserted	order_identifier_upserted
order_identifier_deleted_v2	order_identifier_deleted_v2
order_identifier_upserted_v2	order_identifier_upserted_v2
order_identifier_upserted_v3	order_identifier_upserted_v3
pricing_deleted	pricing_deleted
pricing_upserted	pricing_upserted
order_service_change_request	order_service_change_request
fraud_status_changed	fraud_status_changed
center_upserted	center_upserted
center_deleted	center_deleted
shipping_configuration_upserted	shipping_configuration_upserted
shipping_configuration_deleted	shipping_configuration_deleted
tier_upserted_v2	tier_upserted_v2
tier_deleted_v2	tier_deleted_v2
shipping_lane_upserted	shipping_lane_upserted
shipping_lane_deleted	shipping_lane_deleted
shipping_configuration_item_availability_upserted	shipping_configuration_item_availability_upserted
shipping_configuration_item_availability_deleted	shipping_configuration_item_availability_deleted
shipping_configuration_item_shipping_pricing_upserted	shipping_configuration_item_shipping_pricing_upserted
shipping_configuration_item_shipping_pricing_deleted	shipping_configuration_item_shipping_pricing_deleted
hs6_code_upserted	hs6_code_upserted
hs6_code_deleted	hs6_code_deleted
hs10_code_upserted	hs10_code_upserted
hs10_code_deleted	hs10_code_deleted
item_origin_upserted	item_origin_upserted
item_origin_deleted	item_origin_deleted
harmonized_landed_cost_upserted	harmonized_landed_cost_upserted
fully_harmonized_item_upserted	fully_harmonized_item_upserted
rule_upserted	rule_upserted
rule_deleted	rule_deleted
serial_upserted	serial_upserted
serial_deleted	serial_deleted
snapshot_upserted	snapshot_upserted
snapshot_deleted	snapshot_deleted
label_upserted	label_upserted
label_deleted_v2	label_deleted_v2
label_upserted_v2	label_upserted_v2
notification_upserted	notification_upserted
notification_deleted	notification_deleted
manifested_label_upserted	manifested_label_upserted
manifested_label_deleted	manifested_label_deleted
local_item_upserted	local_item_upserted
local_item_deleted	local_item_deleted
checkout_optin_responses_upserted	checkout_optin_responses_upserted
checkout_optin_responses_deleted	checkout_optin_responses_deleted
browse_optin_responses_upserted	browse_optin_responses_upserted
browse_optin_responses_deleted	browse_optin_responses_deleted
order_placed	order_placed
order_placed_v2	order_placed_v2
ready_to_fulfill	ready_to_fulfill
membership_upserted_v2	membership_upserted_v2
membership_deleted_v2	membership_deleted_v2
organization_upserted	organization_upserted
organization_deleted	organization_deleted
organization_upserted_v2	organization_upserted_v2
organization_deleted_v2	organization_deleted_v2
organization_short_id_upserted	organization_short_id_upserted
organization_short_id_deleted	organization_short_id_deleted
organization_default_configurations_upserted	organization_default_configurations_upserted
organization_default_configurations_deleted	organization_default_configurations_deleted
ecommerce_platform_upserted	ecommerce_platform_upserted
ecommerce_platform_deleted	ecommerce_platform_deleted
authorization_deleted_v2	authorization_deleted_v2
authorization_status_changed	authorization_status_changed
card_authorization_upserted_v2	card_authorization_upserted_v2
card_authorization_deleted_v2	card_authorization_deleted_v2
online_authorization_upserted_v2	online_authorization_upserted_v2
online_authorization_deleted_v2	online_authorization_deleted_v2
capture_upserted_v2	capture_upserted_v2
capture_deleted	capture_deleted
card_upserted_v2	card_upserted_v2
card_deleted	card_deleted
payment_upserted	payment_upserted
payment_deleted	payment_deleted
refund_upserted_v2	refund_upserted_v2
refund_deleted_v2	refund_deleted_v2
refund_capture_upserted_v2	refund_capture_upserted_v2
reversal_upserted	reversal_upserted
reversal_deleted	reversal_deleted
capture_identifier_upserted	capture_identifier_upserted
capture_identifier_deleted	capture_identifier_deleted
refund_identifier_upserted	refund_identifier_upserted
refund_identifier_deleted	refund_identifier_deleted
virtual_card_capture_upserted	virtual_card_capture_upserted
virtual_card_capture_deleted	virtual_card_capture_deleted
virtual_card_refund_upserted	virtual_card_refund_upserted
virtual_card_refund_deleted	virtual_card_refund_deleted
price_book_upserted	price_book_upserted
price_book_deleted	price_book_deleted
price_book_item_upserted	price_book_item_upserted
price_book_item_deleted	price_book_item_deleted
organization_rates_published	organization_rates_published
ratecard_lane_upserted	ratecard_lane_upserted
ratecard_lane_deleted	ratecard_lane_deleted
ratecard_upserted	ratecard_upserted
ratecard_deleted	ratecard_deleted
return_upserted	return_upserted
return_deleted	return_deleted
shopify_localization_setting_upserted	shopify_localization_setting_upserted
shopify_localization_setting_deleted	shopify_localization_setting_deleted
tracking_label_event_upserted	tracking_label_event_upserted

Models

allocation_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

allocation_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
allocation	io.flow.experience.v0.models.allocation_v2:0.8.80	Yes	-

attribute_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
key	string	Yes	-

attribute_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

attribute_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
key	string	Yes	-
label	string	Yes	-
intent	string	No	-
type	string	Yes	-

attribute_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
attribute	io.flow.catalog.v0.models.attribute:0.8.80	Yes	-

authorization_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

authorization_status_changed

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	The authorization id
authorization	io.flow.payment.v0.unions.authorization:0.8.80	Yes	-

available_promotions_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-

available_promotions_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
available_promotion	io.flow.experience.v0.models.available_promotion:0.8.80	Yes	-

available_promotions_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-
available_promotions	[object]	Yes	-

available_promotions_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
available_promotion	io.flow.experience.v0.models.available_promotion:0.8.80	Yes	-

b2b_credit_memo_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
b2b_credit_memo	io.flow.consumer.invoice.v0.models.b2b_credit_memo:0.8.80	Yes	-

b2b_credit_memo_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
b2b_credit_memo	io.flow.consumer.invoice.v0.models.b2b_credit_memo:0.8.80	Yes	-

b2b_invoice_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
b2b_invoice	io.flow.consumer.invoice.v0.models.b2b_invoice:0.8.80	Yes	-

b2b_invoice_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
b2b_invoice	io.flow.consumer.invoice.v0.models.b2b_invoice:0.8.80	Yes	-

browse_optin_responses

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

string

Yes

Globally unique identifier

session_id

string

Yes

optin_responses

[optin_response]

Yes

browse_optin_responses_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

browse_optin_responses_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
browse_optin_responses	browse_optin_responses	Yes	-

capture_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
capture	io.flow.payment.v0.models.capture:0.8.80	Yes	-

capture_identifier_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
identifier	io.flow.payment.v0.models.capture_identifier:0.8.80	Yes	-

capture_identifier_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
identifier	io.flow.payment.v0.models.capture_identifier:0.8.80	Yes	-

capture_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
capture	io.flow.payment.v0.models.capture:0.8.80	Yes	-

card_authorization_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
authorization	io.flow.payment.v0.models.card_authorization:0.8.80	Yes	-		personal_data consumer

card_authorization_upserted_v2

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
authorization	io.flow.payment.v0.models.card_authorization:0.8.80	Yes	-		personal_data consumer

card_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

card_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
card	io.flow.payment.v0.models.card:0.8.80	Yes	-		personal_data

card_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
card	io.flow.payment.v0.models.card:0.8.80	Yes	-		personal_data

catalog_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
catalog	string	Yes	-	Example: master

catalog_item_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
catalog	string	Yes	-	Example: master

catalog_item_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
item	io.flow.catalog.v0.models.item:0.8.80	Yes	-

catalog_item_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
catalog	string	Yes	-	Example: master
locale	string	Yes	-
name	string	Yes	-
currency	string	Yes	-
price	double	Yes	-
categories	[string]	Yes	-
description	string	No	-
attributes	map[string]	Yes	-
dimensions	object	Yes	-
images	[object]	Yes	-

catalog_item_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
item	io.flow.catalog.v0.models.item:0.8.80	Yes	-

catalog_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
catalog	string	Yes	-	Example: master

center_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
center	io.flow.fulfillment.v0.models.center:0.8.80	Yes	-

center_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
center	io.flow.fulfillment.v0.models.center:0.8.80	Yes	-

checkout_optin_responses

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
id	string	Yes	-	Globally unique identifier
order_number	string	Yes	-
session_id	string	Yes	-
optin_responses	[optin_response]	Yes	-

checkout_optin_responses_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

checkout_optin_responses_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
checkout_optin_responses	checkout_optin_responses	Yes	-

consumer_invoice_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
consumer_invoice	io.flow.consumer.invoice.v0.models.consumer_invoice:0.8.80	Yes	-

consumer_invoice_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
consumer_invoice	io.flow.consumer.invoice.v0.models.consumer_invoice:0.8.80	Yes	-

credit_memo_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
credit_memo	io.flow.consumer.invoice.v0.models.credit_memo:0.8.80	Yes	-

credit_memo_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-	The date/time of the request
organization	string	Yes	-	Refers to your organization’s account identifier
credit_memo	io.flow.consumer.invoice.v0.models.credit_memo:0.8.80	Yes	-

crossdock_shipment_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
crossdock_shipment	io.flow.label.v0.models.crossdock_shipment:0.8.80	Yes	-

currency_format_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

currency_format_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
experience_key	string	Yes	-
symbol	io.flow.common.v0.enums.currency_symbol_format:0.8.80	Yes	-
label_formatters	[io.flow.common.v0.enums.currency_label_formatter:0.8.80]	Yes	-

customer_address_book_contact_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
customer_address_book_contact	io.flow.customer.v0.models.customer_address_book_contact:0.8.80	Yes	-

customer_address_book_contact_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
customer_address_book_contact	io.flow.customer.v0.models.customer_address_book_contact:0.8.80	Yes	-

customer_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
customer	io.flow.customer.v0.models.customer:0.8.80	Yes	-

customer_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
customer	io.flow.customer.v0.models.customer:0.8.80	Yes	-

ecommerce_platform_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
ecommerce_platform	io.flow.organization.v0.models.ecommerce_platform:0.8.80	Yes	-

ecommerce_platform_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
ecommerce_platform	io.flow.organization.v0.models.ecommerce_platform:0.8.80	Yes	-

email_notification_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
notification	io.flow.consumer.email.v0.models.email_notification:0.8.80	Yes	-

email_notification_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
notification	io.flow.consumer.email.v0.models.email_notification:0.8.80	Yes	-

experience_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
key	string	Yes	-
subcatalog_id	string	Yes	-

experience_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience	io.flow.experience.v0.models.experience:0.8.80	Yes	-

experience_logistics_settings_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
logistics_settings	io.flow.experience.v0.models.experience_logistics_settings:0.8.80	Yes	-

experience_logistics_settings_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
logistics_settings	io.flow.experience.v0.models.experience_logistics_settings:0.8.80	Yes	-

experience_price_book_mapping_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

experience_price_book_mapping_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_price_book_mapping	io.flow.experience.v0.models.experience_price_book_mapping:0.8.80	Yes	-

experience_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
key	string	Yes	-
name	string	Yes	-
delivered_duty	string	Yes	-
subcatalog_id	string	Yes	-
region_id	string	Yes	-
country	string	Yes	-
currency	string	Yes	-
language	string	Yes	-
measurement_system	string	Yes	-
position	long	Yes	-
status	string	No	-

experience_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience	io.flow.experience.v0.models.experience:0.8.80	Yes	-

fraud_status_changed

Example Json: Minimal | Full

Event emitted when the fraud status for an order changes.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
id	string	Yes	-	The fraud review identifier.
organization	string	Yes	-	Refers to your organization’s account identifier
order	io.flow.experience.v0.models.order_reference:0.8.80	Yes	-	The order reference details.
status	io.flow.fraud.v0.enums.fraud_status:0.8.80	Yes	-	The updated fraud status.

fulfillment_item_allocation_details

Example Json: Minimal | Full

Details about how prices were allocated to a fulfillment; use for reporting the value or net value of a line

Field	Type	Required?	Default	Description
item_number	string	Yes	-	The number of an item in the Flow cagalog.
line_number	long	Yes	-	The number of a line on a customer order.
levies	io.flow.common.v0.models.price_with_base:0.8.80	Yes	-	Represents all taxes and duties paid on an item
total	io.flow.common.v0.models.price_with_base:0.8.80	Yes	-	Represents the total price of this fulfillment line.

fully_harmonized_item_upserted

Example Json: Minimal | Full

Event indicating insertion or changes to the details of a fully harmonized item. Will be triggered upon any change to the item being harmonized, its duties or taxes. If two changes occur within minutes of each other, it is possible only one upserted event will be produced, aggregating both changes.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
item_number	string	Yes	-
customs_description	string	Yes	-	Flow curated description of the product. Intended for use on commercial invoices and other customs documents.
hs6_code	string	Yes	-
landed_costs	[io.flow.harmonization.v0.models.lane_landed_cost:0.8.80]	Yes	-	Landed costs for all the lanes for which a result exists in Harmonization.

harmonized_landed_cost_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	The harmonizaed landed cost item id
landed_cost	io.flow.harmonization.v0.models.harmonized_landed_cost:0.8.80	Yes	-

hs10_code_deleted

Example Json: Minimal | Full

Event raised whenever an HS-10 code is unassigned from an item

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
origin	string	Yes	-	ISO 3166 3 character code for country of origin
destination	string	Yes	-	ISO 3166 3 character code for destination country

hs10_code_upserted

Example Json: Minimal | Full

Event raised whenever an HS-10 code is assigned to an item

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
origin	string	Yes	-	ISO 3166 3 character code for country of origin
destination	string	Yes	-	ISO 3166 3 character code for destination country
code	string	Yes	-	Example: 6209410000

hs6_code_deleted

Example Json: Minimal | Full

Event raised whenever an HS-6 code is deleted

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object

hs6_code_upserted

Example Json: Minimal | Full

Event raised whenever an HS-6 code is assigned to an item

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
code	string	Yes	-	Example: 620941

item_margin_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
item_margin_id	string	Yes	-
organization_id	string	Yes	-
experience_key	string	Yes	-

item_margin_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
item_margin_id	string	Yes	-
organization_id	string	Yes	-
experience_key	string	Yes	-
name	string	Yes	-
q	string	Yes	-
fixed	decimal	Yes	-
percent	decimal	Yes	-
position	long	Yes	-
key	string	No	-

item_origin_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
origin	string	Yes	-	ISO 3166 3 character code for country of origin

item_origin_upserted

Example Json: Minimal | Full

Event raised whenever an item is assigned a country of origin. Note that one item may have multiple countries of origin.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
origin	string	Yes	-	ISO 3166 3 character code for country of origin

item_sales_margin_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
item_sales_margin_id	string	Yes	-
organization_id	string	Yes	-
experience_key	string	Yes	-

item_sales_margin_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
item_sales_margin_id	string	Yes	-
organization_id	string	Yes	-
experience_key	string	Yes	-
name	string	Yes	-
q	string	Yes	-
fixed	decimal	Yes	-
percent	decimal	Yes	-
position	long	Yes	-

label_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
label	io.flow.label.v0.models.shipping_label:0.8.80	Yes	-

label_format_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-

label_format_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-
format	string	Yes	-

label_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
label_id	string	Yes	-
carrier_tracking_number	string	Yes	-
commercial_invoice	string	Yes	-
flow_tracking_number	string	Yes	-
destination	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
origin	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
carrier	string	Yes	-
service	string	Yes	-
zpl	string	No	-		personal_data consumer
pdf	string	No	-		personal_data consumer
png	string	No	-		personal_data consumer
order	string	No	-
carrier_tracking_number_url	string	No	-
flow_tracking_number_url	string	No	-
center_key	string	No	-
recipient	io.flow.label.v0.enums.shipment_recipient:0.8.80	No	-		personal_data consumer
package	io.flow.label.v0.models.shipping_label_package:0.8.80	No	-
order_identifier	string	No	-	The order identifier this label is associated with. Will be blank if not specified when a label was created.
fulfillment_key	string	No	-	The key of a fulfillment this label is associated with. Will be blank if not specified when a label was created.

label_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
label	io.flow.label.v0.models.shipping_label:0.8.80	Yes	-

local_item_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
local_item	io.flow.item.v0.models.local_item:0.8.80	Yes	-

local_item_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
local_item	io.flow.item.v0.models.local_item:0.8.80	Yes	-

manifested_label_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

manifested_label_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
manifest_id	string	Yes	-
label_id	string	Yes	-
flow_tracking_number	string	Yes	-
carrier_tracking_number	string	Yes	-
order_identifier	string	No	-	The order identifier this label is associated with. Will be blank if not specified when a label was created.
fulfillment_key	string	No	-	The key of a fulfillment this label is associated with. Will be blank if not specified when a label was created.

membership_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
membership	io.flow.organization.v0.models.membership:0.8.80	Yes	-

membership_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
membership	io.flow.organization.v0.models.membership:0.8.80	Yes	-

notification_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
notification_id	string	Yes	-
carrier_tracking_number	string	Yes	-
flow_tracking_number	string	Yes	-
destination	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
origin	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
carrier	string	Yes	-
service	string	Yes	-
order	string	Yes	-
package	io.flow.label.v0.models.shipping_label_package:0.8.80	Yes	-

notification_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
notification_id	string	Yes	-
carrier_tracking_number	string	Yes	-
flow_tracking_number	string	Yes	-
destination	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
origin	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
carrier	string	Yes	-
service	string	Yes	-
order	string	Yes	-
order_identifier	string	No	-	The order identifier this notification is associated with. Will be blank if not specified when a notification is submitted.
fulfillment_key	string	No	-	The key of a fulfillment this notification is associated with. Will be blank if not specified when a notification is submitted.
package	io.flow.label.v0.models.shipping_label_package:0.8.80	Yes	-

online_authorization_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
authorization	io.flow.payment.v0.models.online_authorization:0.8.80	Yes	-		personal_data consumer

online_authorization_upserted_v2

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
authorization	io.flow.payment.v0.models.online_authorization:0.8.80	Yes	-		personal_data consumer

optin_response

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
key	string	Yes	-
value	optin_response_type	Yes	-

order_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object

order_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
order	io.flow.experience.v0.models.order:0.8.80	Yes	-

order_identifier_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

order_identifier_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

order_identifier_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
id	string	Yes	-	Globally unique identifier
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
order_number	string	Yes	-

order_identifier_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
order_number	string	Yes	-
identifier	string	Yes	-
primary	boolean	Yes	-

order_identifier_upserted_v3

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
identifier	io.flow.experience.v0.models.order_identifier:0.8.80	Yes	-

order_placed

Example Json: Minimal | Full deprecated:
Use ‘order_placed_v2’

Sent when an order is submitted, allocations are generated and the total value of the order is accounted for by discounts, subsidies, credits and authorized payments – but may not ready to fulfill (e.g. pending assignment of a DC or fraud review). Intended to fuel customer feedback and alert merchants that an order is coming.

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
order_number	string	Yes	-
order	io.flow.experience.v0.models.order:0.8.80	Yes	-	The order as submitted	personal_data consumer
allocation	io.flow.experience.v0.models.allocation_v2:0.8.80	Yes	-	Order prices allocated among the items of this order.

order_placed_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
order_placed	io.flow.order.management.v0.models.order_placed_details:0.8.80	Yes	-

order_service_change_request

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
request	io.flow.experience.v0.models.order_service_change_request_data:0.8.80	Yes	-

order_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
environment	string	Yes	-
experience_id	string	Yes	-
expires_at	date-time-iso8601	Yes	-
customer	io.flow.common.v0.models.order_customer:0.8.80	Yes	-		personal_data consumer
selections	[string]	Yes	-
items	[io.flow.experience.v0.models.localized_line_item:0.8.80]	Yes	-
destination	io.flow.experience.v0.models.order_address:0.8.80	Yes	-		personal_data consumer
deliveries	[io.flow.fulfillment.v0.unions.delivery:0.8.80]	Yes	-		personal_data consumer
prices	[io.flow.order.price.v0.models.order_price_detail:0.8.80]	Yes	-
order_id	string	No	-
payments	[io.flow.experience.v0.models.order_payment:0.8.80]	No	-
discount	io.flow.common.v0.models.money:0.8.80	No	-
delivered_duty	string	No	-
total	io.flow.catalog.v0.models.localized_total:0.8.80	Yes	-
created_at	date-time-iso8601	No	-
updated_at	date-time-iso8601	No	-
submitted_at	date-time-iso8601	No	-
lines	[io.flow.experience.v0.models.line:0.8.80]	No	-
attributes	map[string]	No	-
geo	io.flow.experience.v0.models.order_geo:0.8.80	No	-
merchant_of_record	io.flow.common.v0.enums.order_merchant_of_record:0.8.80	No	-
tax_registration	io.flow.harmonization.v0.models.tax_registration:0.8.80	No	-	Represents the tax registration on an order, if applicable.

order_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
order	io.flow.experience.v0.models.order:0.8.80	Yes	-

organization_default_configurations_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
default_configurations	io.flow.organization.v0.models.organization_default_configurations:0.8.80	Yes	-

organization_default_configurations_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
default_configurations	io.flow.organization.v0.models.organization_default_configurations:0.8.80	Yes	-

organization_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

organization_deleted_v2

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

organization

io.flow.common.v0.models.organization:0.8.80

Yes

Refers to your organization’s account identifier

organization_rates_data

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
rates	[io.flow.currency.v0.models.rate:0.8.80]	Yes	-

organization_rates_published

Example Json: Minimal | Full

Represents the full list of exchange rates in effect for an organization. This is a bulk event - meaning any time an individual rate changes, we publish the new complete list of exchange rates. Note this event is published a few minutes after a rate is published, allowing us to aggregate multiple changes in a short period of time to reduce the number of organization_rates_published we publish.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
data	organization_rates_data	Yes	-

organization_short_id_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_short_id	io.flow.organization.v0.models.organization_short_id:0.8.80	Yes	-

organization_short_id_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_short_id	io.flow.organization.v0.models.organization_short_id:0.8.80	Yes	-

organization_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
id	string	Yes	-	Globally unique identifier
name	string	Yes	-
environment	string	Yes	-
currencies	[string]	Yes	-	Minimum: 0 deprecated: Replaced by default base currency
parent_id	string	No	-
default_base_currency	string	No	-	Unless otherwise specified, this is the currency in which all ‘base’ prices will be presented in. Will be made required once deployed. Minimum: 3 Maximum: 3
default_country	string	No	-	ISO 3166 3-character country code. See https://api.flow.io/reference/countries Minimum: 3 Maximum: 3
default_language	string	No	-	ISO 639 2-character language code. See https://api.flow.io/reference/languages Minimum: 2 Maximum: 2
default_locale	string	No	-	The ID of the default locale for this organization. See https://api.flow.io/reference/locales Minimum: 2 Maximum: 2 Example: en-US
default_timezone	string	No	-	The name of the default timezone for this organization. See https://api.flow.io/reference/timezones Minimum: 3 Maximum: 3 Example: America/New_York

organization_upserted_v2

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

organization

io.flow.common.v0.models.organization:0.8.80

Yes

Refers to your organization’s account identifier

payment_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

payment_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
payment	io.flow.payment.v0.unions.payment:0.8.80	Yes	-

price_book_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

price_book_item_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

price_book_item_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
price_book_item	io.flow.price.v0.models.price_book_item:0.8.80	Yes	-

price_book_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
price_book	io.flow.price.v0.models.price_book:0.8.80	Yes	-

pricing_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-

pricing_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
experience_key	string	Yes	-
vat	string	Yes	-
duty	string	Yes	-
rounding_type	string	No	-
rounding_method	string	No	-
rounding_value	decimal	No	-

rate_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
rate_id	string	Yes	-

rate_deleted_v3

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
rate	io.flow.currency.v0.models.rate:0.8.80	Yes	-

rate_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
rate_id	string	Yes	-
organization_id	string	Yes	-
base	string	Yes	-
target	string	Yes	-
effective_at	date-time-iso8601	Yes	-
value	decimal	Yes	-	The actual conversion rate after all margins have been applied.

rate_upserted_v3

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
rate	io.flow.currency.v0.models.rate:0.8.80	Yes	-

ratecard_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
ratecard	io.flow.ratecard.v0.models.ratecard:0.8.80	Yes	-

ratecard_lane_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

ratecard_lane_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
ratecard_lane	io.flow.ratecard.v0.models.ratecard_lane:0.8.80	Yes	-

ratecard_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
ratecard	io.flow.ratecard.v0.models.ratecard:0.8.80	Yes	-

ready_to_fulfill

Example Json: Minimal | Full

Sent when an order is assigned to a fulfillment center in whole or in part. All assigned fulfillments for all centers will be included on the message.

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
order_number	string	Yes	-
order	io.flow.experience.v0.models.order:0.8.80	Yes	-	The order as submitted	personal_data consumer
fulfillments	[io.flow.order.management.v0.models.fulfillment:0.8.80]	No	-	Current state of all fulfillments for this order
fulfillment_item_allocation_details	[fulfillment_item_allocation_details]	No	-	Allocations condensed and associated with each included fulfillment

refund_capture_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
refund_capture	io.flow.payment.v0.models.refund_capture:0.8.80	Yes	-

refund_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
refund	io.flow.payment.v0.models.refund:0.8.80	Yes	-

refund_identifier_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
identifier	io.flow.payment.v0.models.refund_identifier:0.8.80	Yes	-

refund_identifier_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
identifier	io.flow.payment.v0.models.refund_identifier:0.8.80	Yes	-

refund_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
refund	io.flow.payment.v0.models.refund:0.8.80	Yes	-

return_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

return_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
id	string	Yes	-	Globally unique identifier
organization	string	Yes	-	Refers to your organization’s account identifier
destination	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer
items	[io.flow.return.v0.models.return_line_item:0.8.80]	Yes	-
key	string	Yes	-
labels	[io.flow.label.v0.models.shipping_label:0.8.80]	Yes	-		personal_data consumer
service	string	Yes	-
origin	io.flow.fulfillment.v0.models.shipping_address:0.8.80	Yes	-		personal_data consumer

reversal_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
reversal	io.flow.payment.v0.models.reversal:0.8.80	Yes	-

reversal_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
reversal	io.flow.payment.v0.models.reversal:0.8.80	Yes	-

rule_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

rule_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
rule	io.flow.inventory.v0.models.inventory_rule:0.8.80	Yes	-

serial_deleted

Example Json: Minimal | Full

Field

Type

Required?

Default

Description

Annotations

event_id

string

Yes

timestamp

date-time-iso8601

Yes

string

Yes

Globally unique identifier

serial_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
serial	io.flow.inventory.v0.models.serial:0.8.80	Yes	-

shipping_configuration_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

shipping_configuration_item_availability_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shipping_configuration_item_availability	io.flow.fulfillment.v0.models.shipping_configuration_item_availability:0.8.80	Yes	-

shipping_configuration_item_availability_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shipping_configuration_item_availability	io.flow.fulfillment.v0.models.shipping_configuration_item_availability:0.8.80	Yes	-

shipping_configuration_item_shipping_pricing_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shipping_configuration_item_shipping_pricing	io.flow.fulfillment.v0.models.shipping_configuration_item_shipping_pricing:0.8.80	Yes	-

shipping_configuration_item_shipping_pricing_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shipping_configuration_item_shipping_pricing	io.flow.fulfillment.v0.models.shipping_configuration_item_shipping_pricing:0.8.80	Yes	-

shipping_configuration_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
shipping_configuration	io.flow.fulfillment.v0.models.shipping_configuration:0.8.80	Yes	-

shipping_lane_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
shipping_lane	io.flow.fulfillment.v0.models.shipping_lane:0.8.80	Yes	-

shipping_lane_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
shipping_lane	io.flow.fulfillment.v0.models.shipping_lane:0.8.80	Yes	-

shopify_localization_setting_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shopify_localization_setting	io.flow.shopify.v0.models.shopify_localization_setting:0.8.80	Yes	-

shopify_localization_setting_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization_id	string	Yes	-
shopify_localization_setting	io.flow.shopify.v0.models.shopify_localization_setting:0.8.80	Yes	-

snapshot_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
snapshot_id	string	Yes	-

snapshot_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
snapshot_id	string	Yes	-
available	long	Yes	-
center_key	string	Yes	-
item_number	string	Yes	-
quantity	long	Yes	-

subcatalog_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
catalog	string	Yes	-	Example: master
subcatalog_id	string	Yes	-

subcatalog_item_deleted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
catalog	string	Yes	-	Example: master
subcatalog_id	string	Yes	-

subcatalog_item_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
number	string	Yes	-	Client’s unique identifier for this object
catalog	string	Yes	-	Example: master
subcatalog_id	string	Yes	-
status	string	Yes	-

subcatalog_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
catalog	string	Yes	-	Example: master
subcatalog_id	string	Yes	-

tier_deleted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
tier	io.flow.fulfillment.v0.models.tier:0.8.80	Yes	-

tier_upserted_v2

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
tier	io.flow.fulfillment.v0.models.tier:0.8.80	Yes	-

tracking_label_event_upserted

Example Json: Minimal | Full

Field	Type	Required?	Default	Description	Annotations
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
address	io.flow.common.v0.models.address:0.8.80	Yes	-	Location of the label tracking event	personal_data consumer
carrier	string	Yes	-	Example: ups, dhl
carrier_timestamp	date-time-iso8601	Yes	-	Actual carrier-reported timestamp for event
carrier_tracking_number	string	Yes	-
flow_tracking_number	string	Yes	-
status	string	Yes	-	Example: pending, info_received
delivery_estimate	date-time-iso8601	No	-	Carrier-provided delivered estimate when available
description	string	No	-
order_number	string	No	-

transit_window

Example Json: Minimal | Full

Field	Type	Required?	Default	Description
origin_country	string	Yes	-
destination_country	string	Yes	-
from	long	Yes	-	min transit Minimum: 0
to	long	Yes	-	max transit Minimum: 0

virtual_card_capture_deleted

Example Json: Minimal | Full

Event emitted when a previous virtual card capture has been deleted.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

virtual_card_capture_upserted

Example Json: Minimal | Full

Emitted when a capture event occurs against an existing virtual credit card.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
capture	io.flow.payment.v0.models.virtual_card_capture:0.8.80	Yes	-

virtual_card_refund_deleted

Example Json: Minimal | Full

Event emitted when a previous virtual card refund has been deleted.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier

virtual_card_refund_upserted

Example Json: Minimal | Full

Emitted when a refund event occurs against an existing virtual credit card.

Field	Type	Required?	Default	Description
event_id	string	Yes	-
timestamp	date-time-iso8601	Yes	-
organization	string	Yes	-	Refers to your organization’s account identifier
id	string	Yes	-	Globally unique identifier
refund	io.flow.payment.v0.models.virtual_card_refund:0.8.80	Yes	-

Unions

event

Type discriminator: discriminator

Type	Discriminator Value	Example Json	Description
attribute_upserted	attribute_upserted	Minimal \| Full
attribute_deleted	attribute_deleted	Minimal \| Full
attribute_upserted_v2	attribute_upserted_v2	Minimal \| Full
attribute_deleted_v2	attribute_deleted_v2	Minimal \| Full
catalog_upserted	catalog_upserted	Minimal \| Full
catalog_deleted	catalog_deleted	Minimal \| Full
subcatalog_upserted	subcatalog_upserted	Minimal \| Full
subcatalog_deleted	subcatalog_deleted	Minimal \| Full
catalog_item_upserted	catalog_item_upserted	Minimal \| Full
catalog_item_deleted	catalog_item_deleted	Minimal \| Full
catalog_item_upserted_v2	catalog_item_upserted_v2	Minimal \| Full
catalog_item_deleted_v2	catalog_item_deleted_v2	Minimal \| Full
subcatalog_item_upserted	subcatalog_item_upserted	Minimal \| Full
subcatalog_item_deleted	subcatalog_item_deleted	Minimal \| Full
b2b_invoice_upserted	b2b_invoice_upserted	Minimal \| Full
b2b_invoice_deleted	b2b_invoice_deleted	Minimal \| Full
b2b_credit_memo_upserted	b2b_credit_memo_upserted	Minimal \| Full
b2b_credit_memo_deleted	b2b_credit_memo_deleted	Minimal \| Full
consumer_invoice_upserted	consumer_invoice_upserted	Minimal \| Full
consumer_invoice_deleted	consumer_invoice_deleted	Minimal \| Full
credit_memo_upserted	credit_memo_upserted	Minimal \| Full
credit_memo_deleted	credit_memo_deleted	Minimal \| Full
crossdock_shipment_upserted	crossdock_shipment_upserted	Minimal \| Full
rate_deleted	rate_deleted	Minimal \| Full
rate_upserted	rate_upserted	Minimal \| Full
rate_deleted_v3	rate_deleted_v3	Minimal \| Full
rate_upserted_v3	rate_upserted_v3	Minimal \| Full
customer_upserted	customer_upserted	Minimal \| Full
customer_deleted	customer_deleted	Minimal \| Full
customer_address_book_contact_upserted	customer_address_book_contact_upserted	Minimal \| Full
customer_address_book_contact_deleted	customer_address_book_contact_deleted	Minimal \| Full
email_notification_upserted	email_notification_upserted	Minimal \| Full
email_notification_deleted	email_notification_deleted	Minimal \| Full
available_promotions_upserted	available_promotions_upserted	Minimal \| Full
available_promotions_deleted	available_promotions_deleted	Minimal \| Full
available_promotions_upserted_v2	available_promotions_upserted_v2	Minimal \| Full
available_promotions_deleted_v2	available_promotions_deleted_v2	Minimal \| Full
allocation_deleted_v2	allocation_deleted_v2	Minimal \| Full
allocation_upserted_v2	allocation_upserted_v2	Minimal \| Full
currency_format_deleted	currency_format_deleted	Minimal \| Full
currency_format_upserted	currency_format_upserted	Minimal \| Full
experience_deleted	experience_deleted	Minimal \| Full
experience_upserted	experience_upserted	Minimal \| Full
experience_deleted_v2	experience_deleted_v2	Minimal \| Full
experience_upserted_v2	experience_upserted_v2	Minimal \| Full
experience_price_book_mapping_deleted	experience_price_book_mapping_deleted	Minimal \| Full
experience_price_book_mapping_upserted	experience_price_book_mapping_upserted	Minimal \| Full
experience_logistics_settings_upserted	experience_logistics_settings_upserted	Minimal \| Full
experience_logistics_settings_deleted	experience_logistics_settings_deleted	Minimal \| Full
item_margin_deleted	item_margin_deleted	Minimal \| Full
item_margin_upserted	item_margin_upserted	Minimal \| Full
item_sales_margin_deleted	item_sales_margin_deleted	Minimal \| Full
item_sales_margin_upserted	item_sales_margin_upserted	Minimal \| Full
label_format_deleted	label_format_deleted	Minimal \| Full
label_format_upserted	label_format_upserted	Minimal \| Full
order_deleted	order_deleted	Minimal \| Full
order_upserted	order_upserted	Minimal \| Full
order_deleted_v2	order_deleted_v2	Minimal \| Full
order_upserted_v2	order_upserted_v2	Minimal \| Full
order_identifier_deleted	order_identifier_deleted	Minimal \| Full
order_identifier_upserted	order_identifier_upserted	Minimal \| Full
order_identifier_deleted_v2	order_identifier_deleted_v2	Minimal \| Full
order_identifier_upserted_v2	order_identifier_upserted_v2	Minimal \| Full
order_identifier_upserted_v3	order_identifier_upserted_v3	Minimal \| Full
pricing_deleted	pricing_deleted	Minimal \| Full
pricing_upserted	pricing_upserted	Minimal \| Full
order_service_change_request	order_service_change_request	Minimal \| Full
fraud_status_changed	fraud_status_changed	Minimal \| Full
center_upserted	center_upserted	Minimal \| Full
center_deleted	center_deleted	Minimal \| Full
shipping_configuration_upserted	shipping_configuration_upserted	Minimal \| Full
shipping_configuration_deleted	shipping_configuration_deleted	Minimal \| Full
tier_upserted_v2	tier_upserted_v2	Minimal \| Full
tier_deleted_v2	tier_deleted_v2	Minimal \| Full
shipping_lane_upserted	shipping_lane_upserted	Minimal \| Full
shipping_lane_deleted	shipping_lane_deleted	Minimal \| Full
shipping_configuration_item_availability_upserted	shipping_configuration_item_availability_upserted	Minimal \| Full
shipping_configuration_item_availability_deleted	shipping_configuration_item_availability_deleted	Minimal \| Full
shipping_configuration_item_shipping_pricing_upserted	shipping_configuration_item_shipping_pricing_upserted	Minimal \| Full
shipping_configuration_item_shipping_pricing_deleted	shipping_configuration_item_shipping_pricing_deleted	Minimal \| Full
hs6_code_upserted	hs6_code_upserted	Minimal \| Full
hs6_code_deleted	hs6_code_deleted	Minimal \| Full
hs10_code_upserted	hs10_code_upserted	Minimal \| Full
hs10_code_deleted	hs10_code_deleted	Minimal \| Full
item_origin_upserted	item_origin_upserted	Minimal \| Full
item_origin_deleted	item_origin_deleted	Minimal \| Full
harmonized_landed_cost_upserted	harmonized_landed_cost_upserted	Minimal \| Full
fully_harmonized_item_upserted	fully_harmonized_item_upserted	Minimal \| Full
rule_upserted	rule_upserted	Minimal \| Full
rule_deleted	rule_deleted	Minimal \| Full
serial_upserted	serial_upserted	Minimal \| Full
serial_deleted	serial_deleted	Minimal \| Full
snapshot_upserted	snapshot_upserted	Minimal \| Full
snapshot_deleted	snapshot_deleted	Minimal \| Full
label_upserted	label_upserted	Minimal \| Full
label_deleted_v2	label_deleted_v2	Minimal \| Full
label_upserted_v2	label_upserted_v2	Minimal \| Full
notification_upserted	notification_upserted	Minimal \| Full
notification_deleted	notification_deleted	Minimal \| Full
manifested_label_upserted	manifested_label_upserted	Minimal \| Full
manifested_label_deleted	manifested_label_deleted	Minimal \| Full
local_item_upserted	local_item_upserted	Minimal \| Full
local_item_deleted	local_item_deleted	Minimal \| Full
checkout_optin_responses_upserted	checkout_optin_responses_upserted	Minimal \| Full
checkout_optin_responses_deleted	checkout_optin_responses_deleted	Minimal \| Full
browse_optin_responses_upserted	browse_optin_responses_upserted	Minimal \| Full
browse_optin_responses_deleted	browse_optin_responses_deleted	Minimal \| Full
order_placed	order_placed	Minimal \| Full
order_placed_v2	order_placed_v2	Minimal \| Full
ready_to_fulfill	ready_to_fulfill	Minimal \| Full
membership_upserted_v2	membership_upserted_v2	Minimal \| Full
membership_deleted_v2	membership_deleted_v2	Minimal \| Full
organization_upserted	organization_upserted	Minimal \| Full
organization_deleted	organization_deleted	Minimal \| Full
organization_upserted_v2	organization_upserted_v2	Minimal \| Full
organization_deleted_v2	organization_deleted_v2	Minimal \| Full
organization_short_id_upserted	organization_short_id_upserted	Minimal \| Full
organization_short_id_deleted	organization_short_id_deleted	Minimal \| Full
organization_default_configurations_upserted	organization_default_configurations_upserted	Minimal \| Full
organization_default_configurations_deleted	organization_default_configurations_deleted	Minimal \| Full
ecommerce_platform_upserted	ecommerce_platform_upserted	Minimal \| Full
ecommerce_platform_deleted	ecommerce_platform_deleted	Minimal \| Full
authorization_deleted_v2	authorization_deleted_v2	Minimal \| Full
authorization_status_changed	authorization_status_changed	Minimal \| Full	Trigger whenever an auth status changes (e.g. from pending to authorized). Common use case is to subscribe to this event to know when an auth is cleared from fraud review.
card_authorization_upserted_v2	card_authorization_upserted_v2	Minimal \| Full
card_authorization_deleted_v2	card_authorization_deleted_v2	Minimal \| Full
online_authorization_upserted_v2	online_authorization_upserted_v2	Minimal \| Full
online_authorization_deleted_v2	online_authorization_deleted_v2	Minimal \| Full
capture_upserted_v2	capture_upserted_v2	Minimal \| Full
capture_deleted	capture_deleted	Minimal \| Full
card_upserted_v2	card_upserted_v2	Minimal \| Full
card_deleted	card_deleted	Minimal \| Full
payment_upserted	payment_upserted	Minimal \| Full
payment_deleted	payment_deleted	Minimal \| Full
refund_upserted_v2	refund_upserted_v2	Minimal \| Full
refund_deleted_v2	refund_deleted_v2	Minimal \| Full
refund_capture_upserted_v2	refund_capture_upserted_v2	Minimal \| Full
reversal_upserted	reversal_upserted	Minimal \| Full
reversal_deleted	reversal_deleted	Minimal \| Full
capture_identifier_upserted	capture_identifier_upserted	Minimal \| Full
capture_identifier_deleted	capture_identifier_deleted	Minimal \| Full
refund_identifier_upserted	refund_identifier_upserted	Minimal \| Full
refund_identifier_deleted	refund_identifier_deleted	Minimal \| Full
virtual_card_capture_upserted	virtual_card_capture_upserted	Minimal \| Full
virtual_card_capture_deleted	virtual_card_capture_deleted	Minimal \| Full
virtual_card_refund_upserted	virtual_card_refund_upserted	Minimal \| Full
virtual_card_refund_deleted	virtual_card_refund_deleted	Minimal \| Full
price_book_upserted	price_book_upserted	Minimal \| Full
price_book_deleted	price_book_deleted	Minimal \| Full
price_book_item_upserted	price_book_item_upserted	Minimal \| Full
price_book_item_deleted	price_book_item_deleted	Minimal \| Full
organization_rates_published	organization_rates_published	Minimal \| Full
ratecard_lane_upserted	ratecard_lane_upserted	Minimal \| Full
ratecard_lane_deleted	ratecard_lane_deleted	Minimal \| Full
ratecard_upserted	ratecard_upserted	Minimal \| Full
ratecard_deleted	ratecard_deleted	Minimal \| Full
return_upserted	return_upserted	Minimal \| Full
return_deleted	return_deleted	Minimal \| Full
shopify_localization_setting_upserted	shopify_localization_setting_upserted	Minimal \| Full
shopify_localization_setting_deleted	shopify_localization_setting_deleted	Minimal \| Full
tracking_label_event_upserted	tracking_label_event_upserted	Minimal \| Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].