API Internal Event 0.8.46

  • Contact: N/A
  • License: N/A

Resources

No resources

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/tracking-internal/latest/service.json
https://app.apibuilder.io/flow/tracking/latest/service.json
https://app.apibuilder.io/flow/payment-internal/latest/service.json
https://app.apibuilder.io/flow/ratecard-internal/latest/service.json
https://app.apibuilder.io/flow/ratecard/latest/service.json
https://app.apibuilder.io/flow/catalog/latest/service.json
https://app.apibuilder.io/flow/currency-internal/latest/service.json
https://app.apibuilder.io/flow/currency/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/checkout-configuration/latest/service.json
https://app.apibuilder.io/flow/experiment-internal/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/experience/latest/service.json
https://app.apibuilder.io/flow/fulfillment/latest/service.json
https://app.apibuilder.io/flow/order-management-event/latest/service.json
https://app.apibuilder.io/flow/order-management/latest/service.json
https://app.apibuilder.io/flow/label-internal/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/experience-internal/latest/service.json
https://app.apibuilder.io/flow/experience/latest/service.json
https://app.apibuilder.io/flow/catalog-internal/latest/service.json
https://app.apibuilder.io/flow/catalog/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/feature/latest/service.json
https://app.apibuilder.io/flow/ftp/latest/service.json
https://app.apibuilder.io/flow/item-dimension-estimate/latest/service.json
https://app.apibuilder.io/flow/duty-internal/latest/service.json
https://app.apibuilder.io/flow/harmonization-internal/latest/service.json
https://app.apibuilder.io/flow/price/latest/service.json
https://app.apibuilder.io/flow/reference/latest/service.json
https://app.apibuilder.io/flow/shopify-internal/latest/service.json
https://app.apibuilder.io/flow/content-internal/latest/service.json
https://app.apibuilder.io/flow/currency-internal/latest/service.json
https://app.apibuilder.io/flow/catalog/latest/service.json
https://app.apibuilder.io/flow/issuer/latest/service.json
https://app.apibuilder.io/flow/optin-internal/latest/service.json
https://app.apibuilder.io/flow/duty-internal/latest/service.json
https://app.apibuilder.io/flow/billing-internal/latest/service.json
https://app.apibuilder.io/flow/billing/latest/service.json
https://app.apibuilder.io/flow/fraud-internal/latest/service.json
https://app.apibuilder.io/flow/currency-internal/latest/service.json
https://app.apibuilder.io/flow/fulfillment-internal/latest/service.json
https://app.apibuilder.io/flow/reference/latest/service.json
https://app.apibuilder.io/flow/adyen/latest/service.json
https://app.apibuilder.io/flow/billing-internal/latest/service.json
https://app.apibuilder.io/flow/billing/latest/service.json

Enums

catalog_import_type

Name Value Description
catalog_items catalog_items

item_form_overlays item_form_overlays

item_prices item_prices

price_book_items_import price_book_items_import

price_book_items_query_import price_book_items_query_import

experience_import_type

Name Value Description
experience_with_settings experience_with_settings

quote_request_type

Name Value Description
generate generate

delete delete

update_currency_rate update_currency_rate

update_country update_country

suggestion_action

Describes what action to take on a given suggestion.

Name Value Description
accept accept

The suggestion can be immediately accepted.

validate validate

The suggestion can be accepted but should be validated.

review review

The suggestion must be reviewed before accepting.

tracking_integration_type

This specifies the way in which we fetch tracking updates for a specific carrier.

Name Value Description
api api

Each tracking number requires one api call and can not be done in bulk. Api calls are done through AWS Lambda and the result is published to tracking_response_event.

bulk bulk

Tracking updates are fetched in bulk for multiple tracking numbers. Can be fetched through csv file, api call, etc.

aftership aftership

Third party service that sends a webhook with tracking updates per tracking number.

event_type

Name Value Description
adyen_authorization_deleted adyen_authorization_deleted

adyen_authorization_upserted adyen_authorization_upserted

adyen_cancel_deleted adyen_cancel_deleted

adyen_cancel_upserted adyen_cancel_upserted

adyen_capture_deleted adyen_capture_deleted

adyen_capture_upserted adyen_capture_upserted

adyen_refund_deleted adyen_refund_deleted

adyen_refund_upserted adyen_refund_upserted

billing_statement_upserted billing_statement_upserted

billing_statement_deleted billing_statement_deleted

tax_remittance_transaction_upserted tax_remittance_transaction_upserted

tax_remittance_transaction_deleted tax_remittance_transaction_deleted

account_transactions_export_request account_transactions_export_request

account_orders_export_request account_orders_export_request

master_transaction_upserted master_transaction_upserted

master_transaction_deleted master_transaction_deleted

transfer_transaction_upserted transfer_transaction_upserted

transfer_transaction_deleted transfer_transaction_deleted

processing_transaction_upserted processing_transaction_upserted

processing_transaction_deleted processing_transaction_deleted

bank_payment_upserted bank_payment_upserted

bank_payment_deleted bank_payment_deleted

carrier_account_upserted carrier_account_upserted

catalog_import_request catalog_import_request

catalog_item_region_availabilities_published catalog_item_region_availabilities_published

checkout_configuration_upserted checkout_configuration_upserted

checkout_configuration_deleted checkout_configuration_deleted

localized_content_upserted localized_content_upserted

localization_upserted localization_upserted

rate_deleted rate_deleted

rate_upserted rate_upserted

spot_rate_deleted spot_rate_deleted

spot_rate_upserted spot_rate_upserted

organization_currency_settings_upserted organization_currency_settings_upserted

organization_currency_settings_deleted organization_currency_settings_deleted

rate_deleted_v2 rate_deleted_v2

rate_upserted_v2 rate_upserted_v2

customs_description_import customs_description_import

customs_description_tariffs_import customs_description_tariffs_import

item_dimension_estimate_upserted_v2 item_dimension_estimate_upserted_v2

item_dimension_estimate_deleted_v2 item_dimension_estimate_deleted_v2

duty_rate_request duty_rate_request

duty_rate_bulk_request duty_rate_bulk_request

duty_raw_upserted duty_raw_upserted

duty_raw_bulk_upserted duty_raw_bulk_upserted

duty_rate_upserted duty_rate_upserted

duty_rate_response duty_rate_response

duty_rate_bulk_response duty_rate_bulk_response

item_sales_margin_deleted item_sales_margin_deleted

item_sales_margin_upserted item_sales_margin_upserted

order_attribute_deleted order_attribute_deleted

order_attribute_upserted order_attribute_upserted

experience_export_request experience_export_request

experience_import_request experience_import_request

submitted_order_upserted submitted_order_upserted

experiment_upserted experiment_upserted

experiment_deleted experiment_deleted

experiment_results_upserted experiment_results_upserted

experiment_results_deleted experiment_results_deleted

export_completed export_completed

export_failed export_failed

feature_upserted feature_upserted

feature_deleted feature_deleted

organization_boolean_value_upserted organization_boolean_value_upserted

organization_boolean_value_deleted organization_boolean_value_deleted

fraud_review_upserted fraud_review_upserted

fraud_review_deleted fraud_review_deleted

fraud_pending_review_upserted fraud_pending_review_upserted

fraud_pending_review_deleted fraud_pending_review_deleted

fraud_review_decision_upserted fraud_review_decision_upserted

fraud_review_decision_deleted fraud_review_decision_deleted

ftp_file_upserted ftp_file_upserted

ftp_file_deleted ftp_file_deleted

ftp_file_to_process_uploaded ftp_file_to_process_uploaded

pregenerated_quote_upserted pregenerated_quote_upserted

pregenerated_quote_deleted pregenerated_quote_deleted

pregenerated_request_event pregenerated_request_event

blacklisted_item_created blacklisted_item_created

blacklisted_item_updated blacklisted_item_updated

blacklisted_item_deleted blacklisted_item_deleted

all_items_export all_items_export

harmonized_items_hs6_export harmonized_items_hs6_export

unharmonized_items_export unharmonized_items_export

dutied_items_export dutied_items_export

landed_cost_export landed_cost_export

harmonization_phrase_suggestion_request_import harmonization_phrase_suggestion_request_import

harmonization_codes_import harmonization_codes_import

customs_description_sugestion_created customs_description_sugestion_created

item_classification_created item_classification_created

harmonize_fully_with_rate harmonize_fully_with_rate

item_harmonized item_harmonized

harmonize_fully_request harmonize_fully_request

import_completed import_completed

import_failed import_failed

issuer_upserted issuer_upserted

issuer_deleted issuer_deleted

item_form_import_request item_form_import_request

localized_item_upserted_v2 localized_item_upserted_v2

localized_item_deleted localized_item_deleted

localized_item_deleted_v2 localized_item_deleted_v2

localized_item_snapshot localized_item_snapshot

localized_item_prices_export_request localized_item_prices_export_request

optin_prompt_upserted optin_prompt_upserted

optin_prompt_deleted optin_prompt_deleted

order_fulfillment_deleted order_fulfillment_deleted

order_fulfillment_upserted order_fulfillment_upserted

order_placed order_placed

ready_to_fulfill ready_to_fulfill

fulfillment_cancel fulfillment_cancel

order_shipped order_shipped

items_shipped items_shipped

internal_authorization_upserted internal_authorization_upserted

internal_authorization_deleted internal_authorization_deleted

afterpay_authorization_upserted afterpay_authorization_upserted

afterpay_authorization_deleted afterpay_authorization_deleted

afterpay_capture_upserted afterpay_capture_upserted

afterpay_capture_deleted afterpay_capture_deleted

afterpay_refund_upserted afterpay_refund_upserted

afterpay_refund_deleted afterpay_refund_deleted

adyen_merchant_account_upserted adyen_merchant_account_upserted

adyen_merchant_account_deleted adyen_merchant_account_deleted

chargeback_upserted chargeback_upserted

chargeback_deleted chargeback_deleted

paypal_payment_deleted paypal_payment_deleted

paypal_payment_upserted paypal_payment_upserted

paypal_execution_deleted paypal_execution_deleted

paypal_execution_upserted paypal_execution_upserted

paypal_refund_deleted paypal_refund_deleted

paypal_refund_upserted paypal_refund_upserted

order_rates_published_v3 order_rates_published_v3

ratecard_lanes_import_request ratecard_lanes_import_request

ratecard_standard_configuration_upserted ratecard_standard_configuration_upserted

ratecard_standard_configuration_deleted ratecard_standard_configuration_deleted

ratecard_lane_aggregate_upserted ratecard_lane_aggregate_upserted

ratecard_lane_aggregate_deleted ratecard_lane_aggregate_deleted

batch_rate_refill_request batch_rate_refill_request

rate_refill_request rate_refill_request

resync_by_hs6_destinations resync_by_hs6_destinations

resync_by_destinations resync_by_destinations

shopify_shop_upserted shopify_shop_upserted

shopify_shop_deleted shopify_shop_deleted

shopify_experience_short_id_upserted shopify_experience_short_id_upserted

shopify_experience_short_id_deleted shopify_experience_short_id_deleted

stripe_authorization_deleted stripe_authorization_deleted

stripe_authorization_upserted stripe_authorization_upserted

stripe_reversal_deleted stripe_reversal_deleted

stripe_reversal_upserted stripe_reversal_upserted

stripe_capture_deleted stripe_capture_deleted

stripe_capture_upserted stripe_capture_upserted

stripe_refund_deleted stripe_refund_deleted

stripe_refund_upserted stripe_refund_upserted

svb_virtual_card_clearing_upserted svb_virtual_card_clearing_upserted

svb_virtual_card_clearing_deleted svb_virtual_card_clearing_deleted

tracking_label_event_upserted_v2 tracking_label_event_upserted_v2

tracking_label_event_deleted_v2 tracking_label_event_deleted_v2

tracking_label_upserted tracking_label_upserted

tracking_label_deleted tracking_label_deleted

tracking_upserted tracking_upserted

tracking_deleted tracking_deleted

tracking_request_upserted tracking_request_upserted

tracking_response_upserted tracking_response_upserted

user_upserted_v2 user_upserted_v2

user_deleted_v2 user_deleted_v2

Models

account_orders_export_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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

export_id string Yes -

account_id string No -

statement_id string No -

transaction_type io.flow.billing.v0.enums.billing_transaction_type:0.8.16 No -

transaction_status io.flow.billing.v0.enums.billing_transaction_status:0.8.16 No -

transaction_posted_from date-iso8601 No -

transaction_posted_to date-iso8601 No -

transaction_posted_on_or_after date-time-iso8601 No -

transaction_posted_after date-time-iso8601 No -

transaction_posted_on_or_before date-time-iso8601 No -

transaction_posted_before date-time-iso8601 No -

transaction_created_from date-iso8601 No -

transaction_created_to date-iso8601 No -

transaction_created_on_or_after date-time-iso8601 No -

transaction_created_after date-time-iso8601 No -

transaction_created_on_or_before date-time-iso8601 No -

transaction_created_before date-time-iso8601 No -

account_transactions_export_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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

export_id string Yes -

account_id string No -

statement_id string No -

status io.flow.billing.v0.enums.billing_transaction_status:0.8.16 No -

posted_from date-iso8601 No -

posted_to date-iso8601 No -

posted_on_or_after date-time-iso8601 No -

posted_after date-time-iso8601 No -

posted_on_or_before date-time-iso8601 No -

posted_before date-time-iso8601 No -

created_from date-iso8601 No -

created_to date-iso8601 No -

created_on_or_after date-time-iso8601 No -

created_after date-time-iso8601 No -

created_on_or_before date-time-iso8601 No -

created_before date-time-iso8601 No -

adyen_authorization_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

authorization adyen_internal_authorization Yes -

adyen_authorization_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

authorization adyen_internal_authorization Yes -

adyen_cancel_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

cancel adyen_internal_cancel Yes -

adyen_cancel_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

cancel adyen_internal_cancel Yes -

adyen_capture_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

capture adyen_internal_capture Yes -

adyen_capture_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

capture adyen_internal_capture Yes -

adyen_internal_authorization

Example Json: Minimal | Full

Stores the results of authorize requests

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_authorization_id string Yes -

merchant_account string Yes -

request object No -

psp_reference string No -

Adyen’s 16-digit unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.

Example: 7914595433280823

result_code string Yes -

Example: Authorized

auth_code string No -

Example: 33600

refusal_reason string No -

When the payment is not authorised, it is refused, or if an error occurs, this field holds Adyen’s mapped reason for the refusal or a description of the error.

cvc_result long No -

avs_result long No -

payment_amount long No -

The amount in minor units (e.g. 12300 equates to $123.00 when the currency is USD).

payment_currency string No -

The currency of the payment amount.

skin_code string No -

The Adyen skin code used for this payment.

session_validity date-time-iso8601 No -

The time at which the authorization expires.

brand_code string No -

The payment method type, such as UnionPay or AliPay.

issuer_id string No -

The issuer id of the bank, which is only required in cases

post_payment_success_redirect_url string No -

post_payment_failure_redirect_url string No -

payment_redirect_url string No -

adyen_internal_cancel

Example Json: Minimal | Full

Records the cancel response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_authorization_id string Yes -

flow_reversal_id string No -

merchant_account string Yes -

request object Yes -

psp_reference string Yes -

response string Yes -

adyen_internal_capture

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_capture_id string Yes -

merchant_account string Yes -

request object No -

psp_reference string Yes -

response string Yes -

adyen_internal_refund

Example Json: Minimal | Full

Records the refund response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_refund_id string Yes -

merchant_account string Yes -

request object No -

psp_reference string Yes -

response string Yes -

adyen_merchant_account

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

accountId string Yes -

organization_id string Yes -

merchant_account string Yes -

adyen_merchant_account_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

adyen_merchant_account adyen_merchant_account Yes -

adyen_merchant_account_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

adyen_merchant_account adyen_merchant_account Yes -

adyen_refund_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund adyen_internal_refund Yes -

adyen_refund_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund adyen_internal_refund Yes -

afterpay_authorization

Example Json: Minimal | Full

Stores the results of authorize requests (requests to order details endpoint)

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_authorization_id string Yes -

request object Yes -

post_payment_success_redirect_url string No -

post_payment_failure_redirect_url string No -

payment_redirect_url string No -

token string No -

token_expiration date-time-iso8601 No -

result_code string No -

afterpay_authorization_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_authorization afterpay_authorization Yes -

afterpay_authorization_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_authorization afterpay_authorization Yes -

afterpay_capture

Example Json: Minimal | Full

Records the capture response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

afterpay_id string Yes -

flow_capture_id string Yes -

order_status string Yes -

total_amount decimal Yes -

total_amount_currency string Yes -

merchant_reference string Yes -

events [object] Yes -

order_details object Yes -

afterpay_capture_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_capture afterpay_capture Yes -

afterpay_capture_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_capture afterpay_capture Yes -

afterpay_refund

Example Json: Minimal | Full

Records the refund response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_refund_id string Yes -

amount decimal Yes -

currency string Yes -

request object Yes -

afterpay_refund_id string No -

refunded_at date-time-iso8601 No -

request_id string No -

merchant_reference string No -

response object No -

afterpay_refund_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_refund afterpay_refund Yes -

afterpay_refund_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

afterpay_refund afterpay_refund Yes -

all_items_export

Example Json: Minimal | Full

Export harmonized and unharmonized items.

Field Type Required? Default Description Annotations
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

export_id string Yes -

bank_payment_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

bank_payment io.flow.billing.internal.v0.models.bank_payment:0.8.16 Yes -

bank_payment_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

bank_payment io.flow.billing.internal.v0.models.bank_payment:0.8.16 Yes -

batch_rate_refill_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
requests [rate_refill_request] Yes -

billing_statement_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

statement io.flow.billing.v0.models.billing_statement:0.8.16 Yes -

billing_statement_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

statement io.flow.billing.v0.models.billing_statement:0.8.16 Yes -

blacklisted_item_created

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

blacklisted_item io.flow.harmonization.internal.v0.models.blacklisted_item:0.8.16 Yes -

blacklisted_item_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

id string Yes -

Globally unique identifier

blacklisted_item_updated

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

blacklisted_item io.flow.harmonization.internal.v0.models.blacklisted_item:0.8.16 Yes -

carrier_account_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_id string Yes -

carrier_account io.flow.label.internal.v0.models.carrier_account:0.8.16 Yes -

catalog_import_request

Example Json: Minimal | Full

Defines data necessary to process bulk import of catalog items.

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

import_id string Yes -

type catalog_import_type Yes -

source_url string Yes -

filename string No -

catalog_item_region_availabilities

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
region string Yes -

Example: europe

states [io.flow.catalog.v0.enums.subcatalog_item_status:0.8.80] Yes -

catalog_item_region_availabilities_data

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
item_number string Yes -

availabilities [catalog_item_region_availabilities] Yes -

catalog_item_region_availabilities_published

Example Json: Minimal | Full

Represents a catalog item and a list of regions with the item’s availability in each. This is a bulk event - meaning any time an individual item status changes, we publish the new complete list of the item’s region availability statuses.

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

data catalog_item_region_availabilities_data Yes -

chargeback_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

chargeback io.flow.payment.internal.v0.models.chargeback:0.8.16 Yes -

chargeback_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

chargeback io.flow.payment.internal.v0.models.chargeback:0.8.16 Yes -

checkout_configuration_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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

checkout_configuration io.flow.checkout.configuration.v0.models.checkout_configuration:0.8.16 Yes -

checkout_configuration_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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

checkout_configuration io.flow.checkout.configuration.v0.models.checkout_configuration:0.8.16 Yes -

customs_description_import

Example Json: Minimal | Full

Defines the data needed to process a customs description import.

Field Type Required? Default Description Annotations
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

import_id string Yes -

source_url string Yes -

filename string No -

customs_description_sugestion

Example Json: Minimal | Full

Defines a customs description suggestion for a product.

Field Type Required? Default Description Annotations
value decimal Yes -

customs_description string Yes -

action suggestion_action No -

customs_description_sugestion_created

Example Json: Minimal | Full

Defines the data needed to process a harmonization phrase suggestion.

Field Type Required? Default Description Annotations
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

item_id string Yes -

suggestions [customs_description_sugestion] Yes -

model_id string Yes -

customs_description_tariffs_import

Example Json: Minimal | Full

Import / create customs descriptions (phrases) and optionally corresponding tariffs.

Field Type Required? Default Description Annotations
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

import_id string Yes -

source_url string Yes -

filename string No -

dutied_items_export

Example Json: Minimal | Full

Export dutied items.

Field Type Required? Default Description Annotations
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

export_id string Yes -

origin string No -

The optional origin to use for tax and duty computation

destination string Yes -

The specific destination to export

item_numbers [string] No -

The optional list of item numbers to include in the export

duty_rate_bulk_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

context duty_rate_context Yes -

origin string Yes -

alpha-3 ISO 3166-1

destination_tariff_code map[string] Yes -

destination alpha-3 ISO 3166-1 to tariff_code

duty_rate_bulk_response

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

context duty_rate_context Yes -

duty_rate [io.flow.duty.internal.v0.models.duty_rate:0.8.16] Yes -

duty_rate_context

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
phrase_id string No -

item_number string No -

product_id string No -

duty_rate_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

destination string Yes -

alpha-3 ISO 3166-1

origin string Yes -

alpha-3 ISO 3166-1

tariff_code string Yes -

duty_rate_response

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

duty_rate io.flow.duty.internal.v0.models.duty_rate:0.8.16 Yes -

duty_rate_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

source_event duty_raw_upserted Yes -

duty_rate io.flow.duty.internal.v0.models.duty_rate:0.8.16 Yes -

unparsable_rates [string] Yes -

duty_raw_bulk_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

randomly generated id specific to this event

timestamp date-time-iso8601 Yes -

when this event was generated

context duty_rate_context Yes -

duty_raw [io.flow.duty.internal.v0.models.duty_raw:0.8.16] Yes -

duty_raw_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

randomly generated id specific to this event

timestamp date-time-iso8601 Yes -

when this event was generated

duty_raw io.flow.duty.internal.v0.models.duty_raw:0.8.16 Yes -

experience_export_request

Example Json: Minimal | Full

Defines data necessary to process bulk export of experiences.

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

ids [string] No -

keys [string] No -

export_id string Yes -

experience_import_request

Example Json: Minimal | Full

Defines data necessary to process bulk import of experiences.

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

import_id string Yes -

type experience_import_type Yes -

source_url string Yes -

filename string No -

experience_session_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

experiment_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_id string Yes -

id string Yes -

Globally unique identifier

experiment_results_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_id string Yes -

experiment_results io.flow.experiment.internal.v0.models.experiment_results:0.8.16 Yes -

experiment_results_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_id string Yes -

experiment_results io.flow.experiment.internal.v0.models.experiment_results:0.8.16 Yes -

experiment_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_id string Yes -

experiment io.flow.experiment.internal.v0.models.experiment:0.8.16 Yes -

export_completed

Example Json: Minimal | Full

Event indicating that an export has been completed

Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

The date/time of the request

export_id string Yes -

url string Yes -

URL at which to download the export

export_failed

Example Json: Minimal | Full

Event indicating that an export has failed with a system error

Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

The date/time of the request

export_id string Yes -

error string Yes -

export_tracking_label

Example Json: Minimal | Full

Represents a specific label being tracked as part of the tracking bucket

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

carrier string Yes -

carrier_tracking_number string Yes -

status io.flow.tracking.v0.enums.tracking_status:0.8.80 Yes -

created_at date-time-iso8601 Yes -

delivery_estimate date-time-iso8601 No -

description string No -

export_tracking_label_event

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

address io.flow.common.v0.models.address:0.8.80 No -

Location of the label tracking event

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 io.flow.tracking.v0.enums.tracking_status:0.8.80 Yes -

delivery_estimate date-time-iso8601 No -

Carrier-provided delivered estimate when available

description string No -

order_number string No -

feature_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

feature io.flow.feature.v0.models.feature:0.8.16 Yes -

feature_id_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

feature_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

feature io.flow.feature.v0.models.feature:0.8.16 Yes -

fraud_pending_review_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

id string Yes -

Globally unique identifier

fraud_pending_review_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

id string Yes -

Globally unique identifier

fraud_pending_review io.flow.fraud.internal.v0.models.fraud_pending_review:0.8.16 Yes -

fraud_review_decision_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

id string Yes -

Globally unique identifier

fraud_review_decision_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

id string Yes -

Globally unique identifier

fraud_review_decision io.flow.fraud.internal.v0.models.fraud_review_decision:0.8.16 Yes -

fraud_review_deleted

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

fraud_review_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

fraud_review io.flow.fraud.internal.v0.models.fraud_review:0.8.16 Yes -

ftp_file_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

id string Yes -

Globally unique identifier

ftp_file_to_process_uploaded

Example Json: Minimal | Full

Indicates a file was uploaded to the ‘to-flow’ folder of the FTP server, indicating that this file should be processed

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

ftp_file io.flow.ftp.v0.models.ftp_file:0.8.80 Yes -

emails [string] Yes -

List of email addresses to notify upon completed

ftp_file_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

ftp_file io.flow.ftp.v0.models.ftp_file:0.8.80 Yes -

fulfillment_cancel

Example Json: Minimal | Full

Sent when a cancel is requested or automatically triggered, such as via a failed fraud review

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] Yes -

Current state of all fulfillments for this order

change_source io.flow.order.management.v0.enums.order_change_source:0.8.80 Yes fulfillment

The original source of this update, regardless of who is submitting it to Flow. This can control which parties are notified of a change.

reason io.flow.order.management.v0.enums.cancel_reason:0.8.80 Yes -

Reason for the cancellation.

cancelled_lines [io.flow.order.management.v0.models.fulfillment_line_cancel_form:0.8.80] Yes -

fulfillment_shipment_tracking

Example Json: Minimal | Full

Indicates tracking data for some part of a fulfillment.

Field Type Required? Default Description Annotations
fulfillment_key string Yes -

flow_tracking_number string Yes -

carrier_tracking_number string No -

carrier_tracking_url string No -

items [io.flow.order.management.v0.models.fulfillment_item:0.8.80] Yes -

harmonization_codes_import

Example Json: Minimal | Full

Defines the data needed to process a harmonization codes import.

Field Type Required? Default Description Annotations
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

import_id string Yes -

source_url string Yes -

filename string No -

harmonization_phrase_suggestion_request_import

Example Json: Minimal | Full

Defines the data needed to process a harmonization phrase suggestion request import.

Field Type Required? Default Description Annotations
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

import_id string Yes -

source_url string Yes -

filename string No -

harmonize_fully_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

item_id string Yes -

harmonize_fully_with_rate

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

duty_rate io.flow.duty.internal.v0.models.duty_rate:0.8.16 Yes -

harmonized_items_hs6_export

Example Json: Minimal | Full

Export harmonized items.

Field Type Required? Default Description Annotations
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

export_id string Yes -

import_completed

Example Json: Minimal | Full

Event indicating that an import has been completed

Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

The date/time of the request

import_id string Yes -

number_successful long Yes -

Represents the number of successfully processed rows of data.

Minimum: 0

number_errors long Yes -

Represents the number of rows that were unable to be processed. See the results url for details as to why.

Minimum: 0

results_url string No -

If there were errors processing the rows, the event will include the URL to the detailed results from processing the import.

import_failed

Example Json: Minimal | Full

Event indicating that an import has been failed with a system error

Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

The date/time of the request

import_id string Yes -

error string Yes -

internal_authorization

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

processor io.flow.payment.internal.v0.enums.processor:0.8.16 Yes -

internal_authorization_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

internal_authorization internal_authorization Yes -

internal_authorization_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

internal_authorization internal_authorization Yes -

issuer_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

issuer io.flow.issuer.v0.models.issuer:0.8.16 Yes -

issuer_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

issuer io.flow.issuer.v0.models.issuer:0.8.16 Yes -

item_classification_created

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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

item_number string Yes -

model_id string Yes -

labels_prediction labels_prediction Yes -

action suggestion_action Yes -

item_dimension_estimate_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

id string Yes -

Globally unique identifier

item_dimension_estimate_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

estimate io.flow.item.dimension.estimate.v0.models.item_dimension_estimate:0.8.16 Yes -

item_form_import_request

Example Json: Minimal | Full

Catalog item form request made through a stream rather than a network call

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

internal_item_form io.flow.catalog.internal.v0.models.internal_item_form:0.8.29 Yes -

item_harmonized

Example Json: Minimal | Full

This event is designed to contain all harmonization information necessary to price or ship an item.

Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

If using / storing any data from this event, attach the timestamp to allow tracing.

organization string Yes -

Refers to your organization’s account identifier

item_number string Yes -

product_id string Yes -

customs_description string Yes -

countries_of_origin [string] Yes -

Country code iso31663

hs_6 string Yes -

tariffs map[io.flow.harmonization.internal.v0.models.tariff_code_duty:0.8.16] Yes -

Destination country code iso31663 to tariff_code_duty

item_sales_margin_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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 Description Annotations
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 -

items_shipped

Example Json: Minimal | Full

Sent when Flow received a signal indicating some items of an order were shipped (regardless of how that shipment was reported). Will be sent at most once per item quantity.

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] Yes -

Current state of all fulfillments for this order

flow_tracking_number string Yes -

The Flow tracking number for this shipment

shipped_item_values [shipped_item_value] Yes -

labels_prediction

Example Json: Minimal | Full

Collection of label probabilities for important categories on the product.

Field Type Required? Default Description Annotations
main_material map[decimal] Yes -

gender map[decimal] Yes -

construction map[decimal] Yes -

product_type map[decimal] Yes -

landed_cost_export

Example Json: Minimal | Full

Export landed cost items.

Field Type Required? Default Description Annotations
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

export_id string Yes -

items [landed_cost_item] Yes -

The list of item numbers to include in the export

landed_cost_item

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
number string Yes -

The item number to export

origin string Yes -

The origin country code to use for tax and duty computation

destination string Yes -

The destination country code to use for tax and duty computation

localization_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

localization_id string Yes -

locale string Yes -

status io.flow.content.internal.v0.enums.content_status:0.8.16 Yes -

localized_content_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

content_id string Yes -

schema_key string Yes -

source_localization_id string Yes -

The locale of the source content.

localized_item_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

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

localized_item_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

id string Yes -

Globally unique identifier

localized_item_prices_export_request

Example Json: Minimal | Full

Requests localized item prices export

Field Type Required? Default Description Annotations
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

export_id string Yes -

since date-time-iso8601 No -

Full export when empty; delta export since this timestamp until now if provided

localized_item_snapshot

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

subcatalog_id string Yes -

url string Yes -

localized_item_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

item io.flow.catalog.v0.models.item:0.8.80 Yes -

catalog string Yes -

Example: master

master_transaction_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

master_transaction io.flow.billing.internal.v0.models.master_transaction:0.8.16 Yes -

master_transaction_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

master_transaction io.flow.billing.internal.v0.models.master_transaction:0.8.16 Yes -

optin_prompt_deleted

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

optin_prompt_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

optin_prompt io.flow.optin.internal.v0.models.optin_prompt:0.8.16 Yes -

order_attribute_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

id string Yes -

Globally unique identifier

order_attribute_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

id string Yes -

Globally unique identifier

attribute io.flow.experience.internal.v0.models.order_attribute:0.8.16 Yes -

order_fulfillment_deleted

Example Json: Minimal | Full

A fulfillment was deleted (this is always an administrative event)

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

key string Yes -

Unique key identifying this fulfillment.

order_fulfillment_upserted

Example Json: Minimal | Full

An order fulfillment was created or updated

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

key string Yes -

Unique key identifying this fulfillment.

order_number string Yes -

Order number

items [io.flow.order.management.v0.models.fulfillment_item:0.8.80] Yes -

Items making up this fulfillment

center io.flow.fulfillment.v0.models.center_summary:0.8.80 No -

The fulfillment center we expect this order to be fulfilled from.

order_placed

Example Json: Minimal | Full

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_rates_data_v3

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
organization string Yes -

Refers to your organization’s account identifier

order_id string Yes -

order_number string Yes -

order_total io.flow.catalog.v0.models.localized_total:0.8.80 Yes -

rates [io.flow.currency.internal.v0.models.rate_data_v3:0.8.16] Yes -

order_rates_published_v3

Example Json: Minimal | Full

The order rates published event captures all of the exchange rates that were used in the submission of an individual order.

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

data order_rates_data_v3 Yes -

order_shipped

Example Json: Minimal | Full

Indicates that all currently open fulfillments for an order have either been shipped or cancelled and at least one product was shipped out

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] Yes -

Current state of all fulfillments for this order

shipment_trackings [fulfillment_shipment_tracking] Yes -

organization_boolean_value

Example Json: Minimal | Full

The organization boolean value determines the value of a given feature flag for a given organization (assuming no other context)

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

organization io.flow.common.v0.models.organization_reference:0.8.80 Yes -

Refers to your organization’s account identifier

feature feature_id_reference Yes -

value boolean Yes -

organization_boolean_value_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

value organization_boolean_value Yes -

organization_boolean_value_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

value organization_boolean_value Yes -

organization_currency_settings_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_currency_settings io.flow.currency.internal.v0.models.organization_currency_settings:0.8.16 Yes -

organization_currency_settings_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization_currency_settings io.flow.currency.internal.v0.models.organization_currency_settings:0.8.16 Yes -

paypal_execution_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

execution paypal_internal_execution Yes -

paypal_execution_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

execution paypal_internal_execution Yes -

paypal_internal_execution

Example Json: Minimal | Full

Stores the results of authorize requests

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

currency string Yes -

total decimal Yes -

intent string Yes -

payer object Yes -

transactions [object] Yes -

state string Yes -

sale_id string No -

experience_profile_id string No -

note_to_payer string No -

Maximum: 165

redirect_urls [object] Yes -

failure_reason string No -

create_time date-time-iso8601 Yes -

update_time date-time-iso8601 Yes -

links [object] Yes -

paypal_payment_id string Yes -

Reference authorizations.id

paypal_payer_id string Yes -

Reference authorizations.id

flow_payment_id string Yes -

Reference payments.id

flow_authorization_id string Yes -

Reference authorizations.id

paypal_internal_payment

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

currency string Yes -

total decimal Yes -

intent string Yes -

payer object Yes -

transactions [object] Yes -

state string Yes -

experience_profile_id string No -

note_to_payer string No -

Maximum: 165

redirect_urls [object] Yes -

failure_reason string No -

create_time date-time-iso8601 Yes -

update_time date-time-iso8601 Yes -

links [object] Yes -

flow_payment_id string Yes -

Reference payments.id

paypal_internal_refund

Example Json: Minimal | Full

Records the refund response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

paypal_execution_id string Yes -

Reference payal.executions.id

flow_refund_id string Yes -

Reference refunds.id

amount object Yes -

state string Yes -

sale_id string Yes -

invoice_number string Yes -

capture_id string No -

parent_payment string No -

reason_code string No -

refund_reason_code string No -

refund_funding_type string No -

create_time date-time-iso8601 Yes -

update_time date-time-iso8601 No -

response object Yes -

Full paypal response

paypal_payment_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

payment paypal_internal_payment Yes -

paypal_payment_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

payment paypal_internal_payment Yes -

paypal_refund_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund paypal_internal_refund Yes -

paypal_refund_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund paypal_internal_refund Yes -

phrase_classified

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

phrase_id string Yes -

phrase_propagated

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

phrase_id string Yes -

pregenerated_quote_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

pregenerated_quote io.flow.fulfillment.internal.v0.models.pregenerated_quote:0.8.16 Yes -

pregenerated_quote_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

pregenerated_quote io.flow.fulfillment.internal.v0.models.pregenerated_quote:0.8.16 Yes -

pregenerated_request_event

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

quote_request quote_request Yes -

processing_transaction_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

processing_transaction io.flow.billing.internal.v0.models.processing_transaction:0.8.16 Yes -

processing_transaction_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

processing_transaction io.flow.billing.internal.v0.models.processing_transaction:0.8.16 Yes -

quote_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

request_type quote_request_type Yes -

experience_keys [string] No -

item_numbers [string] No -

rates [io.flow.currency.internal.v0.models.rate:0.8.16] No -

countries [io.flow.reference.v0.models.country:0.8.80] No -

reason string No -

rate_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

rate_id string Yes -

rate_deleted_v2

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

rate io.flow.currency.internal.v0.models.rate:0.8.16 Yes -

rate_refill_request

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
phrase_id string Yes -

hs6_code string Yes -

destinations [io.flow.reference.v0.models.country:0.8.80] Yes -

origin io.flow.reference.v0.models.country:0.8.80 Yes -

organization_id string No -

rate_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
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 -

spot_rate decimal Yes -

The actual spot rate

flow_margin decimal Yes -

Example: 5.9

flow_rate decimal Yes -

organization_margin decimal Yes -

Example: 5.9

organization_rate decimal Yes -

rate_lock_unit string Yes -

unit of time

rate_lock_value long Yes -

Minimum: 0

rate_upserted_v2

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

rate io.flow.currency.internal.v0.models.rate:0.8.16 Yes -

ratecard_lane_aggregate_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

ratecard_aggregate io.flow.ratecard.internal.v0.models.ratecard_lane_aggregate:0.8.16 Yes -

ratecard_lane_aggregate_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

ratecard_aggregate io.flow.ratecard.internal.v0.models.ratecard_lane_aggregate:0.8.16 Yes -

ratecard_lanes_import_request

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

data io.flow.ratecard.v0.models.ratecard_lanes_import_request_data:0.8.80 Yes -

ratecard_standard_configuration_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

id string Yes -

Globally unique identifier

ratecard_standard_configuration_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

configuration io.flow.ratecard.internal.v0.models.ratecard_standard_configuration:0.8.16 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 [io.flow.order.management.event.v0.models.fulfillment_item_allocation_details:0.8.80] No -

Allocations condensed and associated with each included fulfillment

resync_by_destinations

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
destinations [io.flow.reference.v0.models.country:0.8.80] Yes -

resync_by_hs6_destinations

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
hs6_code string Yes -

destinations [io.flow.reference.v0.models.country:0.8.80] Yes -

shipped_item_value

Example Json: Minimal | Full

Details about how value is allocated within a shipment.

Field Type Required? Default Description Annotations
item io.flow.common.v0.models.catalog_item_reference:0.8.80 Yes -

taxes io.flow.common.v0.models.price_with_base:0.8.80 Yes -

Represents all taxes paid on a shipped item

duties io.flow.common.v0.models.price_with_base:0.8.80 Yes -

Represents all duties paid on a shipped item

total io.flow.common.v0.models.price_with_base:0.8.80 Yes -

Represents the total price paid on a shipped item

shopify_experience_short_id_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

short_id io.flow.shopify.internal.v0.models.shopify_experience_short_id:0.8.16 Yes -

shopify_experience_short_id_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

short_id io.flow.shopify.internal.v0.models.shopify_experience_short_id:0.8.16 Yes -

shopify_shop_deleted

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

shopify_shop_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

shop io.flow.shopify.internal.v0.models.shop:0.8.16 Yes -

spot_rate_deleted

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

spot_rate_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

spot_rate io.flow.currency.internal.v0.models.spot_rate:0.8.16 Yes -

stripe_authorization_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

authorization stripe_internal_authorization Yes -

stripe_authorization_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

authorization stripe_internal_authorization Yes -

stripe_capture_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

capture stripe_internal_capture Yes -

stripe_capture_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

capture stripe_internal_capture Yes -

stripe_internal_authorization

Example Json: Minimal | Full

Stores the results of authorize requests

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_authorization_id string Yes -

account_name string Yes -

charge_id string Yes -

request object Yes -

response object Yes -

post_payment_success_redirect_url string No -

post_payment_failure_redirect_url string No -

payment_redirect_url string No -

stripe_internal_capture

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_capture_id string Yes -

account_name string Yes -

charge_id string Yes -

request object Yes -

response object Yes -

stripe_internal_refund

Example Json: Minimal | Full

Records the refund response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_refund_id string Yes -

account_name string Yes -

refund_id string Yes -

charge_id string Yes -

request object Yes -

response object Yes -

stripe_internal_reversal

Example Json: Minimal | Full

Records the cancel response

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

flow_authorization_id string Yes -

account_name string Yes -

refund_id string Yes -

request object Yes -

response object Yes -

stripe_refund_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund stripe_internal_refund Yes -

stripe_refund_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

refund stripe_internal_refund Yes -

stripe_reversal_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

reversal stripe_internal_reversal Yes -

stripe_reversal_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

reversal stripe_internal_reversal Yes -

submitted_order_upserted

Example Json: Minimal | Full

Submitted order upserted is raised when an order is submitted. This event was introduce to provide a lower volume stream for events that need to happen quickly (e.g. clearing carts post order submission).

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 io.flow.experience.v0.models.order:0.8.80 Yes -

session experience_session_reference No -

svb_virtual_card_clearing

Example Json: Minimal | Full

Silicon Valley Bank Virtual Card Clearings

Field Type Required? Default Description Annotations
id string Yes -

Globally unique identifier

virtual_card_id string Yes -

Flow virtual card ID

number string Yes -

Silicon Valley Bank virtual card ID

amount integer Yes -

currency string Yes -

date date-time-iso8601 Yes -

clearing_type string Yes -

exchange_rate string Yes -

SVB rate, not used by flow

mcc string Yes -

mcc_description string Yes -

merchant_amount integer Yes -

merchant_currency string Yes -

merchant_id string Yes -

merchant_name string Yes -

settlement_date date-time-iso8601 Yes -

svb_virtual_card_clearing_deleted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

svb_virtual_card_clearing svb_virtual_card_clearing Yes -

svb_virtual_card_clearing_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

svb_virtual_card_clearing svb_virtual_card_clearing Yes -

tax_remittance_transaction_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

id string Yes -

Globally unique identifier

tax_remittance_transaction_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

transaction io.flow.billing.internal.v0.models.tax_remittance_transaction:0.8.16 Yes -

tracking_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

tracking io.flow.tracking.v0.models.tracking:0.8.80 Yes -

tracking_label_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

tracking_label export_tracking_label Yes -

tracking_label_event_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

tracking_label_event export_tracking_label_event Yes -

tracking_label_event_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

tracking_label_event export_tracking_label_event Yes -

tracking_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

tracking_label export_tracking_label Yes -

tracking_request_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

tracking_request io.flow.tracking.internal.v0.models.tracking_request:0.8.16 Yes -

tracking_response_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

tracking_response io.flow.tracking.internal.v0.models.tracking_response:0.8.16 Yes -

tracking_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

tracking io.flow.tracking.v0.models.tracking:0.8.80 Yes -

transfer_transaction_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

transfer_transaction io.flow.billing.internal.v0.models.transfer_transaction:0.8.16 Yes -

transfer_transaction_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

transfer_transaction io.flow.billing.internal.v0.models.transfer_transaction:0.8.16 Yes -

unharmonized_items_export

Example Json: Minimal | Full

Export unharmonized items.

Field Type Required? Default Description Annotations
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

export_id string Yes -

user_deleted_v2

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

user io.flow.common.v0.models.user:0.8.80 Yes -

user_upserted_v2

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
event_id string Yes -

timestamp date-time-iso8601 Yes -

user io.flow.common.v0.models.user:0.8.80 Yes -

Unions

event

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
adyen_authorization_deleted adyen_authorization_deleted Minimal | Full

adyen_authorization_upserted adyen_authorization_upserted Minimal | Full

adyen_cancel_deleted adyen_cancel_deleted Minimal | Full

adyen_cancel_upserted adyen_cancel_upserted Minimal | Full

adyen_capture_deleted adyen_capture_deleted Minimal | Full

adyen_capture_upserted adyen_capture_upserted Minimal | Full

adyen_refund_deleted adyen_refund_deleted Minimal | Full

adyen_refund_upserted adyen_refund_upserted Minimal | Full

billing_statement_upserted billing_statement_upserted Minimal | Full

billing_statement_deleted billing_statement_deleted Minimal | Full

tax_remittance_transaction_upserted tax_remittance_transaction_upserted Minimal | Full

tax_remittance_transaction_deleted tax_remittance_transaction_deleted Minimal | Full

account_transactions_export_request account_transactions_export_request Minimal | Full

account_orders_export_request account_orders_export_request Minimal | Full

master_transaction_upserted master_transaction_upserted Minimal | Full

master_transaction_deleted master_transaction_deleted Minimal | Full

transfer_transaction_upserted transfer_transaction_upserted Minimal | Full

transfer_transaction_deleted transfer_transaction_deleted Minimal | Full

processing_transaction_upserted processing_transaction_upserted Minimal | Full

processing_transaction_deleted processing_transaction_deleted Minimal | Full

bank_payment_upserted bank_payment_upserted Minimal | Full

bank_payment_deleted bank_payment_deleted Minimal | Full

carrier_account_upserted carrier_account_upserted Minimal | Full

catalog_import_request catalog_import_request Minimal | Full

catalog_item_region_availabilities_published catalog_item_region_availabilities_published Minimal | Full

checkout_configuration_upserted checkout_configuration_upserted Minimal | Full

checkout_configuration_deleted checkout_configuration_deleted Minimal | Full

localized_content_upserted localized_content_upserted Minimal | Full

localization_upserted localization_upserted Minimal | Full

rate_deleted rate_deleted Minimal | Full

rate_upserted rate_upserted Minimal | Full

spot_rate_deleted spot_rate_deleted Minimal | Full

spot_rate_upserted spot_rate_upserted Minimal | Full

organization_currency_settings_upserted organization_currency_settings_upserted Minimal | Full

organization_currency_settings_deleted organization_currency_settings_deleted Minimal | Full

rate_deleted_v2 rate_deleted_v2 Minimal | Full

rate_upserted_v2 rate_upserted_v2 Minimal | Full

customs_description_import customs_description_import Minimal | Full

customs_description_tariffs_import customs_description_tariffs_import Minimal | Full

item_dimension_estimate_upserted_v2 item_dimension_estimate_upserted_v2 Minimal | Full

item_dimension_estimate_deleted_v2 item_dimension_estimate_deleted_v2 Minimal | Full

duty_rate_request duty_rate_request Minimal | Full

duty_rate_bulk_request duty_rate_bulk_request Minimal | Full

duty_raw_upserted duty_raw_upserted Minimal | Full

duty_raw_bulk_upserted duty_raw_bulk_upserted Minimal | Full

duty_rate_upserted duty_rate_upserted Minimal | Full

duty_rate_response duty_rate_response Minimal | Full

duty_rate_bulk_response duty_rate_bulk_response Minimal | Full

item_sales_margin_deleted item_sales_margin_deleted Minimal | Full

item_sales_margin_upserted item_sales_margin_upserted Minimal | Full

order_attribute_deleted order_attribute_deleted Minimal | Full

order_attribute_upserted order_attribute_upserted Minimal | Full

experience_export_request experience_export_request Minimal | Full

experience_import_request experience_import_request Minimal | Full

submitted_order_upserted submitted_order_upserted Minimal | Full

experiment_upserted experiment_upserted Minimal | Full

experiment_deleted experiment_deleted Minimal | Full

experiment_results_upserted experiment_results_upserted Minimal | Full

experiment_results_deleted experiment_results_deleted Minimal | Full

export_completed export_completed Minimal | Full

export_failed export_failed Minimal | Full

feature_upserted feature_upserted Minimal | Full

feature_deleted feature_deleted Minimal | Full

organization_boolean_value_upserted organization_boolean_value_upserted Minimal | Full

organization_boolean_value_deleted organization_boolean_value_deleted Minimal | Full

fraud_review_upserted fraud_review_upserted Minimal | Full

fraud_review_deleted fraud_review_deleted Minimal | Full

fraud_pending_review_upserted fraud_pending_review_upserted Minimal | Full

fraud_pending_review_deleted fraud_pending_review_deleted Minimal | Full

fraud_review_decision_upserted fraud_review_decision_upserted Minimal | Full

fraud_review_decision_deleted fraud_review_decision_deleted Minimal | Full

ftp_file_upserted ftp_file_upserted Minimal | Full

ftp_file_deleted ftp_file_deleted Minimal | Full

ftp_file_to_process_uploaded ftp_file_to_process_uploaded Minimal | Full

pregenerated_quote_upserted pregenerated_quote_upserted Minimal | Full

pregenerated_quote_deleted pregenerated_quote_deleted Minimal | Full

pregenerated_request_event pregenerated_request_event Minimal | Full

blacklisted_item_created blacklisted_item_created Minimal | Full

blacklisted_item_updated blacklisted_item_updated Minimal | Full

blacklisted_item_deleted blacklisted_item_deleted Minimal | Full

all_items_export all_items_export Minimal | Full

harmonized_items_hs6_export harmonized_items_hs6_export Minimal | Full

unharmonized_items_export unharmonized_items_export Minimal | Full

dutied_items_export dutied_items_export Minimal | Full

landed_cost_export landed_cost_export Minimal | Full

harmonization_phrase_suggestion_request_import harmonization_phrase_suggestion_request_import Minimal | Full

harmonization_codes_import harmonization_codes_import Minimal | Full

customs_description_sugestion_created customs_description_sugestion_created Minimal | Full

item_classification_created item_classification_created Minimal | Full

harmonize_fully_with_rate harmonize_fully_with_rate Minimal | Full

item_harmonized item_harmonized Minimal | Full

harmonize_fully_request harmonize_fully_request Minimal | Full

import_completed import_completed Minimal | Full

import_failed import_failed Minimal | Full

issuer_upserted issuer_upserted Minimal | Full

issuer_deleted issuer_deleted Minimal | Full

item_form_import_request item_form_import_request Minimal | Full

localized_item_upserted_v2 localized_item_upserted_v2 Minimal | Full

localized_item_deleted localized_item_deleted Minimal | Full

deprecated:

Use localized_item_deleted_v2

localized_item_deleted_v2 localized_item_deleted_v2 Minimal | Full

localized_item_snapshot localized_item_snapshot Minimal | Full

localized_item_prices_export_request localized_item_prices_export_request Minimal | Full

optin_prompt_upserted optin_prompt_upserted Minimal | Full

optin_prompt_deleted optin_prompt_deleted Minimal | Full

order_fulfillment_deleted order_fulfillment_deleted Minimal | Full

order_fulfillment_upserted order_fulfillment_upserted Minimal | Full

order_placed order_placed Minimal | Full

ready_to_fulfill ready_to_fulfill Minimal | Full

fulfillment_cancel fulfillment_cancel Minimal | Full

order_shipped order_shipped Minimal | Full

items_shipped items_shipped Minimal | Full

internal_authorization_upserted internal_authorization_upserted Minimal | Full

internal_authorization_deleted internal_authorization_deleted Minimal | Full

afterpay_authorization_upserted afterpay_authorization_upserted Minimal | Full

afterpay_authorization_deleted afterpay_authorization_deleted Minimal | Full

afterpay_capture_upserted afterpay_capture_upserted Minimal | Full

afterpay_capture_deleted afterpay_capture_deleted Minimal | Full

afterpay_refund_upserted afterpay_refund_upserted Minimal | Full

afterpay_refund_deleted afterpay_refund_deleted Minimal | Full

adyen_merchant_account_upserted adyen_merchant_account_upserted Minimal | Full

adyen_merchant_account_deleted adyen_merchant_account_deleted Minimal | Full

chargeback_upserted chargeback_upserted Minimal | Full

chargeback_deleted chargeback_deleted Minimal | Full

paypal_payment_deleted paypal_payment_deleted Minimal | Full

paypal_payment_upserted paypal_payment_upserted Minimal | Full

paypal_execution_deleted paypal_execution_deleted Minimal | Full

paypal_execution_upserted paypal_execution_upserted Minimal | Full

paypal_refund_deleted paypal_refund_deleted Minimal | Full

paypal_refund_upserted paypal_refund_upserted Minimal | Full

order_rates_published_v3 order_rates_published_v3 Minimal | Full

ratecard_lanes_import_request ratecard_lanes_import_request Minimal | Full

ratecard_standard_configuration_upserted ratecard_standard_configuration_upserted Minimal | Full

ratecard_standard_configuration_deleted ratecard_standard_configuration_deleted Minimal | Full

ratecard_lane_aggregate_upserted ratecard_lane_aggregate_upserted Minimal | Full

ratecard_lane_aggregate_deleted ratecard_lane_aggregate_deleted Minimal | Full

batch_rate_refill_request batch_rate_refill_request Minimal | Full

rate_refill_request rate_refill_request Minimal | Full

resync_by_hs6_destinations resync_by_hs6_destinations Minimal | Full

resync_by_destinations resync_by_destinations Minimal | Full

shopify_shop_upserted shopify_shop_upserted Minimal | Full

shopify_shop_deleted shopify_shop_deleted Minimal | Full

shopify_experience_short_id_upserted shopify_experience_short_id_upserted Minimal | Full

shopify_experience_short_id_deleted shopify_experience_short_id_deleted Minimal | Full

stripe_authorization_deleted stripe_authorization_deleted Minimal | Full

stripe_authorization_upserted stripe_authorization_upserted Minimal | Full

stripe_reversal_deleted stripe_reversal_deleted Minimal | Full

stripe_reversal_upserted stripe_reversal_upserted Minimal | Full

stripe_capture_deleted stripe_capture_deleted Minimal | Full

stripe_capture_upserted stripe_capture_upserted Minimal | Full

stripe_refund_deleted stripe_refund_deleted Minimal | Full

stripe_refund_upserted stripe_refund_upserted Minimal | Full

svb_virtual_card_clearing_upserted svb_virtual_card_clearing_upserted Minimal | Full

svb_virtual_card_clearing_deleted svb_virtual_card_clearing_deleted Minimal | Full

tracking_label_event_upserted_v2 tracking_label_event_upserted_v2 Minimal | Full

tracking_label_event_deleted_v2 tracking_label_event_deleted_v2 Minimal | Full

tracking_label_upserted tracking_label_upserted Minimal | Full

tracking_label_deleted tracking_label_deleted Minimal | Full

tracking_upserted tracking_upserted Minimal | Full

tracking_deleted tracking_deleted Minimal | Full

tracking_request_upserted tracking_request_upserted Minimal | Full

tracking_response_upserted tracking_response_upserted Minimal | Full

user_upserted_v2 user_upserted_v2 Minimal | Full

user_deleted_v2 user_deleted_v2 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].