Name | Value | Description |
---|---|---|
not_shown | not_shown |
|
opted_in | opted_in |
|
opted_out | opted_out |
|
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 |
|
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 |
|
targeting_item_upserted | targeting_item_upserted |
|
targeting_item_upserted_v2 | targeting_item_upserted_v2 |
|
targeting_item_deleted | targeting_item_deleted |
|
targeting_item_deleted_v3 | targeting_item_deleted_v3 |
|
tracking_label_event_upserted | tracking_label_event_upserted |
|
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
|
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
|
|
allocation | io.flow.experience.v0.models.allocation_v2:0.8.26 | Yes | - |
|
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 | - |
|
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
|
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 | - |
|
|
label | string | Yes | - |
|
|
intent | string | No | - |
|
|
type | string | Yes | - |
|
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
|
|
attribute | io.flow.catalog.v0.models.attribute:0.7.58 | Yes | - |
|
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
|
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 | - | The authorization id
|
|
authorization | io.flow.payment.v0.unions.authorization:0.7.58 | Yes | - |
|
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
|
|
experience_key | string | Yes | - |
|
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
|
|
available_promotion | io.flow.experience.v0.models.available_promotion:0.8.26 | Yes | - |
|
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
|
|
experience_key | string | Yes | - |
|
|
available_promotions | [object] | Yes | - |
|
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
|
|
available_promotion | io.flow.experience.v0.models.available_promotion:0.8.26 | Yes | - |
|
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
|
|
b2b_credit_memo | io.flow.consumer.invoice.v0.models.b2b_credit_memo:0.8.24 | Yes | - |
|
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
|
|
b2b_credit_memo | io.flow.consumer.invoice.v0.models.b2b_credit_memo:0.8.24 | Yes | - |
|
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
|
|
b2b_invoice | io.flow.consumer.invoice.v0.models.b2b_invoice:0.8.24 | Yes | - |
|
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
|
|
b2b_invoice | io.flow.consumer.invoice.v0.models.b2b_invoice:0.8.24 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
id | string | Yes | - | Globally unique identifier
|
|
session_id | string | Yes | - |
|
|
optin_responses | [optin_response] | Yes | - |
|
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
|
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
|
|
browse_optin_responses | browse_optin_responses | Yes | - |
|
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
|
|
capture | io.flow.payment.v0.models.capture:0.7.58 | Yes | - |
|
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
|
|
identifier | io.flow.payment.v0.models.capture_identifier:0.7.58 | Yes | - |
|
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
|
|
identifier | io.flow.payment.v0.models.capture_identifier:0.7.58 | Yes | - |
|
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
|
|
capture | io.flow.payment.v0.models.capture:0.7.58 | Yes | - |
|
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.7.58 | Yes | - |
|
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.7.58 | Yes | - |
|
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
|
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.7.58 | Yes | - |
|
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.7.58 | Yes | - |
|
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
|
|
catalog | string | Yes | - |
Example: master |
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 |
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
|
|
item | io.flow.catalog.v0.models.item:0.7.58 | Yes | - |
|
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 |
|
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 | - |
|
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
|
|
item | io.flow.catalog.v0.models.item:0.7.58 | Yes | - |
|
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
|
|
catalog | string | Yes | - |
Example: master |
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
|
|
center | io.flow.fulfillment.v0.models.center:0.7.98 | Yes | - |
|
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
|
|
center | io.flow.fulfillment.v0.models.center:0.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
id | string | Yes | - | Globally unique identifier
|
|
order_number | string | Yes | - |
|
|
session_id | string | Yes | - |
|
|
optin_responses | [optin_response] | Yes | - |
|
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
|
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
|
|
checkout_optin_responses | checkout_optin_responses | Yes | - |
|
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
|
|
consumer_invoice | io.flow.consumer.invoice.v0.models.consumer_invoice:0.8.24 | Yes | - |
|
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
|
|
consumer_invoice | io.flow.consumer.invoice.v0.models.consumer_invoice:0.8.24 | Yes | - |
|
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
|
|
credit_memo | io.flow.consumer.invoice.v0.models.credit_memo:0.8.24 | Yes | - |
|
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
|
|
credit_memo | io.flow.consumer.invoice.v0.models.credit_memo:0.8.24 | Yes | - |
|
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
|
|
crossdock_shipment | io.flow.label.v0.models.crossdock_shipment:0.8.24 | Yes | - |
|
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
|
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
|
|
experience_key | string | Yes | - |
|
|
symbol | io.flow.common.v0.enums.currency_symbol_format:0.7.58 | Yes | - |
|
|
label_formatters | [io.flow.common.v0.enums.currency_label_formatter:0.7.58] | Yes | - |
|
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
|
|
customer_address_book_contact | io.flow.customer.v0.models.customer_address_book_contact:0.7.61 | Yes | - |
|
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
|
|
customer_address_book_contact | io.flow.customer.v0.models.customer_address_book_contact:0.7.61 | Yes | - |
|
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
|
|
customer | io.flow.customer.v0.models.customer:0.7.61 | Yes | - |
|
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
|
|
customer | io.flow.customer.v0.models.customer:0.7.61 | Yes | - |
|
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
|
|
ecommerce_platform | io.flow.organization.v0.models.ecommerce_platform:0.7.96 | Yes | - |
|
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
|
|
ecommerce_platform | io.flow.organization.v0.models.ecommerce_platform:0.7.96 | Yes | - |
|
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 | io.flow.consumer.email.v0.models.email_notification:0.8.57 | Yes | - |
|
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 | io.flow.consumer.email.v0.models.email_notification:0.8.57 | Yes | - |
|
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 | - |
|
|
subcatalog_id | string | Yes | - |
|
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
|
|
experience | io.flow.experience.v0.models.experience:0.8.26 | Yes | - |
|
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
|
|
logistics_settings | io.flow.experience.v0.models.experience_logistics_settings:0.8.26 | Yes | - |
|
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
|
|
logistics_settings | io.flow.experience.v0.models.experience_logistics_settings:0.8.26 | Yes | - |
|
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
|
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
|
|
experience_price_book_mapping | io.flow.experience.v0.models.experience_price_book_mapping:0.8.26 | Yes | - |
|
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 | - |
|
|
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 | - |
|
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
|
|
experience | io.flow.experience.v0.models.experience:0.8.26 | Yes | - |
|
Event emitted when the fraud status for an order changes.
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.26 | Yes | - | The order reference details.
|
|
status | io.flow.fraud.v0.enums.fraud_status:0.7.58 | Yes | - | The updated fraud status.
|
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 | Annotations |
---|---|---|---|---|---|
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.7.58 | Yes | - | Represents all taxes and duties paid on an item
|
|
total | io.flow.common.v0.models.price_with_base:0.7.58 | Yes | - | Represents the total price of this fulfillment line.
|
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 | Annotations |
---|---|---|---|---|---|
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.7.88] | Yes | - | Landed costs for all the lanes for which a result exists in Harmonization.
|
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 | - | The harmonizaed landed cost item id
|
|
landed_cost | io.flow.harmonization.v0.models.harmonized_landed_cost:0.7.88 | Yes | - |
|
Event raised whenever an HS-10 code is unassigned from an item
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
|
|
origin | string | Yes | - | ISO 3166 3 character code for country of origin
|
|
destination | string | Yes | - | ISO 3166 3 character code for destination country
|
Event raised whenever an HS-10 code is assigned to an item
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
|
|
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 |
Event raised whenever an HS-6 code is deleted
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
|
Event raised whenever an HS-6 code is assigned to an item
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
|
|
code | string | Yes | - |
Example: 620941 |
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
item_margin_id | string | Yes | - |
|
|
organization_id | string | Yes | - |
|
|
experience_key | string | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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 | - |
|
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
|
|
origin | string | Yes | - | ISO 3166 3 character code for country of origin
|
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 | 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
|
|
origin | string | Yes | - | ISO 3166 3 character code for country of origin
|
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 | - |
|
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 | - |
|
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
|
|
experience_key | string | Yes | - |
|
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
|
|
experience_key | string | Yes | - |
|
|
format | string | Yes | - |
|
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.7.98 | Yes | - |
|
|
origin | io.flow.fulfillment.v0.models.shipping_address:0.7.98 | Yes | - |
|
|
carrier | string | Yes | - |
|
|
service | string | Yes | - |
|
|
zpl | string | No | - |
|
|
string | No | - |
|
||
png | string | No | - |
|
|
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.24 | No | - |
|
|
package | io.flow.label.v0.models.shipping_label_package:0.8.24 | 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.
|
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
|
|
local_item | io.flow.item.v0.models.local_item:0.7.58 | Yes | - |
|
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
|
|
local_item | io.flow.item.v0.models.local_item:0.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
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
|
|
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.
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
membership | io.flow.organization.v0.models.membership:0.7.96 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
membership | io.flow.organization.v0.models.membership:0.7.96 | Yes | - |
|
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.7.98 | Yes | - |
|
|
origin | io.flow.fulfillment.v0.models.shipping_address:0.7.98 | Yes | - |
|
|
carrier | string | Yes | - |
|
|
service | string | Yes | - |
|
|
order | string | Yes | - |
|
|
package | io.flow.label.v0.models.shipping_label_package:0.8.24 | Yes | - |
|
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.7.98 | Yes | - |
|
|
origin | io.flow.fulfillment.v0.models.shipping_address:0.7.98 | Yes | - |
|
|
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.24 | Yes | - |
|
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.7.58 | Yes | - |
|
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.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
key | string | Yes | - |
|
|
value | optin_response_type | Yes | - |
|
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
|
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.26 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
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
|
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
|
|
number | string | Yes | - | Client’s unique identifier for this object
|
|
order_number | string | Yes | - |
|
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_number | string | Yes | - |
|
|
identifier | string | Yes | - |
|
|
primary | boolean | Yes | - |
|
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
|
|
identifier | io.flow.experience.v0.models.order_identifier:0.8.26 | Yes | - |
|
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.26 | Yes | - | The order as submitted
|
|
allocation | io.flow.experience.v0.models.allocation_v2:0.8.26 | Yes | - | Order prices allocated among the items of this order.
|
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_placed | io.flow.order.management.v0.models.order_placed_details:0.7.61 | Yes | - |
|
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
|
|
request | io.flow.experience.v0.models.order_service_change_request_data:0.8.26 | Yes | - |
|
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.26 | Yes | - |
|
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
|
|
default_configurations | io.flow.organization.v0.models.organization_default_configurations:0.7.96 | Yes | - |
|
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
|
|
default_configurations | io.flow.organization.v0.models.organization_default_configurations:0.7.96 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization | io.flow.common.v0.models.organization:0.7.58 | Yes | - | Refers to your organization’s account identifier
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
rates | [io.flow.currency.v0.models.rate:0.7.58] | Yes | - |
|
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 | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization | string | Yes | - | Refers to your organization’s account identifier
|
|
data | organization_rates_data | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization_short_id | io.flow.organization.v0.models.organization_short_id:0.7.96 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization_short_id | io.flow.organization.v0.models.organization_short_id:0.7.96 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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 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 |
|
default_country | string | No | - | ISO 3166 3-character country code. See https://api.flow.io/reference/countries
Minimum: 3 |
|
default_language | string | No | - | ISO 639 2-character language code. See https://api.flow.io/reference/languages
Minimum: 2 |
|
default_locale | string | No | - | The ID of the default locale for this organization. See https://api.flow.io/reference/locales
Minimum: 2 |
|
default_timezone | string | No | - | The name of the default timezone for this organization. See https://api.flow.io/reference/timezones
Minimum: 3 |
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization | io.flow.common.v0.models.organization:0.7.58 | Yes | - | Refers to your organization’s account identifier
|
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
|
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
|
|
payment | io.flow.payment.v0.unions.payment:0.7.58 | Yes | - |
|
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
|
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
|
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
|
|
price_book_item | io.flow.price.v0.models.price_book_item:0.7.58 | Yes | - |
|
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
|
|
price_book | io.flow.price.v0.models.price_book:0.7.58 | Yes | - |
|
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
|
|
experience_key | string | Yes | - |
|
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
|
|
experience_key | string | Yes | - |
|
|
vat | string | Yes | - |
|
|
duty | string | Yes | - |
|
|
rounding_type | string | No | - |
|
|
rounding_method | string | No | - |
|
|
rounding_value | decimal | No | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
rate_id | string | Yes | - |
|
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
|
|
rate | io.flow.currency.v0.models.rate:0.7.58 | Yes | - |
|
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 | - |
|
|
value | decimal | Yes | - | The actual conversion rate after all margins have been applied.
|
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
|
|
rate | io.flow.currency.v0.models.rate:0.7.58 | Yes | - |
|
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 | io.flow.ratecard.v0.models.ratecard:0.8.17 | Yes | - |
|
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
|
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_lane | io.flow.ratecard.v0.models.ratecard_lane:0.8.17 | Yes | - |
|
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 | io.flow.ratecard.v0.models.ratecard:0.8.17 | Yes | - |
|
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.26 | Yes | - | The order as submitted
|
|
fulfillments | [io.flow.order.management.v0.models.fulfillment:0.7.61] | 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
|
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
|
|
refund_capture | io.flow.payment.v0.models.refund_capture:0.7.58 | Yes | - |
|
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
|
|
refund | io.flow.payment.v0.models.refund:0.7.58 | Yes | - |
|
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
|
|
identifier | io.flow.payment.v0.models.refund_identifier:0.7.58 | Yes | - |
|
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
|
|
identifier | io.flow.payment.v0.models.refund_identifier:0.7.58 | Yes | - |
|
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
|
|
refund | io.flow.payment.v0.models.refund:0.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
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.7.98 | Yes | - |
|
|
items | [io.flow.return.v0.models.return_line_item:0.7.58] | Yes | - |
|
|
key | string | Yes | - |
|
|
labels | [io.flow.label.v0.models.shipping_label:0.8.24] | Yes | - |
|
|
service | string | Yes | - |
|
|
origin | io.flow.fulfillment.v0.models.shipping_address:0.7.98 | Yes | - |
|
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
|
|
reversal | io.flow.payment.v0.models.reversal:0.7.58 | Yes | - |
|
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
|
|
reversal | io.flow.payment.v0.models.reversal:0.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
organization_id | string | Yes | - |
|
|
rule | io.flow.inventory.v0.models.inventory_rule:0.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
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
|
|
serial | io.flow.inventory.v0.models.serial:0.7.58 | Yes | - |
|
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
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.98 | Yes | - |
|
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
|
|
shipping_configuration | io.flow.fulfillment.v0.models.shipping_configuration:0.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
shipping_lane | io.flow.fulfillment.v0.models.shipping_lane:0.7.98 | Yes | - |
|
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
|
|
shipping_lane | io.flow.fulfillment.v0.models.shipping_lane:0.7.98 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
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.7.58 | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
snapshot_id | string | Yes | - |
|
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
|
|
snapshot_id | string | Yes | - |
|
|
available | long | Yes | - |
|
|
center_key | string | Yes | - |
|
|
item_number | string | Yes | - |
|
|
quantity | long | Yes | - |
|
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
|
|
catalog | string | Yes | - |
Example: master |
|
subcatalog_id | string | Yes | - |
|
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 |
|
subcatalog_id | string | Yes | - |
|
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 |
|
subcatalog_id | string | Yes | - |
|
|
status | string | Yes | - |
|
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
|
|
catalog | string | Yes | - |
Example: master |
|
subcatalog_id | string | Yes | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
event_id | string | Yes | - |
|
|
timestamp | date-time-iso8601 | Yes | - |
|
|
id | string | Yes | - | Globally unique identifier
|
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
|
Indiciates that a given item has been targeted by the query q producing an outcome. The item number is unique within its targeting_id.
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
|
|
targeting_id | string | Yes | - |
|
|
item_number | string | Yes | - |
|
|
q | string | Yes | - |
|
|
outcome_id | string | Yes | - |
|
|
catalog_id | string | Yes | - |
|
|
key | string | Yes | - |
|
|
subcatalog_id | string | No | - |
|
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
|
|
targeting_item | io.flow.catalog.v0.models.targeting_item:0.7.58 | Yes | - |
|
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
|
|
tier | io.flow.fulfillment.v0.models.tier:0.7.98 | Yes | - |
|
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
|
|
tier | io.flow.fulfillment.v0.models.tier:0.7.98 | Yes | - |
|
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.7.58 | Yes | - | 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 | 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 | - |
|
Field | Type | Required? | Default | Description | Annotations |
---|---|---|---|---|---|
origin_country | string | Yes | - |
|
|
destination_country | string | Yes | - |
|
|
from | long | Yes | - | min transit
Minimum: 0 |
|
to | long | Yes | - | max transit
Minimum: 0 |
Event emitted when a previous virtual card capture has been deleted.
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
|
Emitted when a capture event occurs against an existing virtual credit card.
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
|
|
capture | io.flow.payment.v0.models.virtual_card_capture:0.7.58 | Yes | - |
|
Event emitted when a previous virtual card refund has been deleted.
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
|
Emitted when a refund event occurs against an existing virtual credit card.
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
|
|
refund | io.flow.payment.v0.models.virtual_card_refund:0.7.58 | Yes | - |
|
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.
Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].