API Event 0.3.58

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

Resources

No resources

Headers

No headers

Imports

https://app.apibuilder.io/flow/catalog/latest/service.json
https://app.apibuilder.io/flow/payment/latest/service.json

Enums

event_type

attribute_upserted
attribute_deleted
catalog_upserted
catalog_deleted
subcatalog_upserted
subcatalog_deleted
catalog_item_upserted
catalog_item_deleted
subcatalog_item_upserted
subcatalog_item_deleted
rate_deleted
rate_upserted
available_promotions_upserted
available_promotions_deleted
allocation_deleted
allocation_upserted
experience_deleted
experience_upserted
item_margin_deleted
item_margin_upserted
item_sales_margin_deleted
item_sales_margin_upserted
label_format_deleted
label_format_upserted
order_deleted
order_upserted
order_identifier_deleted
order_identifier_upserted
pricing_deleted
pricing_upserted
tier_upserted
tier_deleted
hs6_code_upserted
hs6_code_deleted
hs10_code_upserted
hs10_code_deleted
item_origin_upserted
item_origin_deleted
harmonized_item_upserted
harmonized_item_deleted
snapshot_upserted
snapshot_deleted
label_upserted
notification_upserted
notification_deleted
localized_item_upserted
localized_item_upserted_v2
localized_item_deleted
localized_item_deleted_v2
localized_item_snapshot
membership_upserted
membership_deleted
organization_upserted
organization_deleted
authorization_upserted
authorization_deleted
authorization_deleted_v2
authorization_status_changed
card_authorization_upserted
card_authorization_upserted_v2
online_authorization_upserted
online_authorization_upserted_v2
capture_upserted
capture_upserted_v2
card_upserted
card_upserted_v2
card_deleted
payment_upserted
payment_deleted
refund_upserted
refund_upserted_v2
return_upserted
return_deleted
targeting_item_upserted
targeting_item_deleted
tracking_label_event_upserted

Models

allocation_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

allocation_upserted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

organization string Yes -

Refers to your organization’s account identifier

order_id string Yes -

order_number string Yes -

details [object] Yes -

attribute_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

attribute_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

label string Yes -

intent string No -

type string Yes -

authorization_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

authorization_deleted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

authorization_status_changed

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

The authorization id

authorization io.flow.payment.v0.unions.authorization:0.3.47 Yes -

authorization_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

order_number string No -

card object Yes -

amount decimal Yes -

currency string Yes -

customer object Yes -

attributes map[string] Yes -

destination object No -

result object Yes -

ip string No -

created_at date-time-iso8601 Yes -

available_promotions_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

available_promotions_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

available_promotions [object] Yes -

capture_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

authorization_key string Yes -

amount decimal Yes -

currency string Yes -

created_at date-time-iso8601 Yes -

capture_upserted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

capture io.flow.payment.v0.models.capture:0.3.47 Yes -

card_authorization_upserted

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field Type Required? Default Description
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.3.47 Yes -

card_authorization_upserted_v2

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

authorization io.flow.payment.v0.models.card_authorization:0.3.47 Yes -

card_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

card_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

type string Yes -

expiration object Yes -

iin string Yes -

last4 string Yes -

name string Yes -

address object No -

card_upserted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

card io.flow.payment.v0.models.card:0.3.47 Yes -

catalog_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

catalog string Yes -

Example: master

catalog_item_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

catalog_item_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

locale string Yes -

name string Yes -

currency string Yes -

price double Yes -

categories [string] Yes -

description string No -

attributes map[string] Yes -

dimensions object Yes -

images [object] Yes -

catalog_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

catalog string Yes -

Example: master

experience_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

subcatalog_id string Yes -

experience_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

name string Yes -

delivered_duty string Yes -

subcatalog_id string Yes -

region_id string Yes -

country string Yes -

currency string Yes -

language string Yes -

measurement_system string Yes -

position long Yes -

harmonized_item_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

harmonized_item_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

name string Yes -

categories [string] Yes -

attributes map[string] Yes -

description string No -

hs10_code_deleted

Example Json: Minimal | Full

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

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

origin string Yes -

ISO 3166 3 character code for country of origin

destination string Yes -

ISO 3166 3 character code for destination country

hs10_code_upserted

Example Json: Minimal | Full

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

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

origin string Yes -

ISO 3166 3 character code for country of origin

destination string Yes -

ISO 3166 3 character code for destination country

code string Yes -

Example: 6209410000

hs6_code_deleted

Example Json: Minimal | Full

Event raised whenever an HS-6 code is deleted

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

hs6_code_upserted

Example Json: Minimal | Full

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

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

code string Yes -

Example: 620941

item_margin_deleted

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

timestamp date-time-iso8601 Yes -

item_margin_id string Yes -

organization_id string Yes -

experience_key string Yes -

item_margin_upserted

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

timestamp date-time-iso8601 Yes -

item_margin_id string Yes -

organization_id string Yes -

experience_key string Yes -

name string Yes -

q string Yes -

fixed decimal Yes -

percent decimal Yes -

position long Yes -

key string No -

item_origin_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

origin string Yes -

ISO 3166 3 character code for country of origin

item_origin_upserted

Example Json: Minimal | Full

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

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

origin string Yes -

ISO 3166 3 character code for country of origin

item_sales_margin_deleted

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

timestamp date-time-iso8601 Yes -

item_sales_margin_id string Yes -

organization_id string Yes -

experience_key string Yes -

name string Yes -

q string Yes -

fixed decimal Yes -

percent decimal Yes -

position long Yes -

label_format_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

label_format_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

format string Yes -

label_upserted

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

origin object Yes -

carrier string Yes -

service string Yes -

zpl string No -

pdf string No -

png string No -

order string No -

carrier_tracking_number_url string No -

flow_tracking_number_url string No -

localized_item_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

localized_item_deleted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

localized_item_snapshot

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

subcatalog_id string Yes -

url string Yes -

localized_item_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

locale string Yes -

name string Yes -

currency string Yes -

price double Yes -

categories [string] Yes -

description string No -

attributes map[string] Yes -

dimensions object Yes -

images [object] Yes -

local object Yes -

localized_item_upserted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

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

catalog string Yes -

Example: master

membership_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

membership_upserted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

organization string Yes -

Refers to your organization’s account identifier

user_id string Yes -

role string Yes -

notification_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

notification_id string Yes -

carrier_tracking_number string Yes -

flow_tracking_number string Yes -

destination object Yes -

origin object Yes -

carrier string Yes -

service string Yes -

order string Yes -

package object Yes -

notification_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

notification_id string Yes -

carrier_tracking_number string Yes -

flow_tracking_number string Yes -

destination object Yes -

origin object Yes -

carrier string Yes -

service string Yes -

order string Yes -

package object Yes -

online_authorization_upserted

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field Type Required? Default Description
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.3.47 Yes -

online_authorization_upserted_v2

Example Json: Minimal | Full

Represents an authorization for a card payment method

Field Type Required? Default Description
event_id string Yes -

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

authorization io.flow.payment.v0.models.online_authorization:0.3.47 Yes -

order_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

order_identifier_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

order_identifier_upserted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

order_number string Yes -

order_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

environment string Yes -

experience_id string Yes -

expires_at date-time-iso8601 Yes -

customer object Yes -

selections [string] Yes -

items [object] Yes -

destination object Yes -

deliveries [object] Yes -

prices [object] Yes -

payments [object] No -

discount object No -

delivered_duty string No -

total object Yes -

created_at date-time-iso8601 No -

updated_at date-time-iso8601 No -

submitted_at date-time-iso8601 No -

lines [object] No -

attributes map[string] No -

organization_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

organization_upserted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

name string Yes -

environment string Yes -

currencies [string] Yes -

Minimum: 0
deprecated:

Replaced by default base currency

parent_id string No -

default_base_currency string No -

Unless otherwise specified, this is the currency in which all ‘base’ prices will be presented in. Will be made required once deployed.

Minimum: 3
Maximum: 3

default_country string No -

ISO 3166 3-character country code. See https://api.flow.io/reference/countries

Minimum: 3
Maximum: 3

default_language string No -

ISO 639 2-character language code. See https://api.flow.io/reference/languages

Minimum: 2
Maximum: 2

default_locale string No -

The ID of the default locale for this organization. See https://api.flow.io/reference/locales

Minimum: 2
Maximum: 2
Example: en-US

default_timezone string No -

The name of the default timezone for this organization. See https://api.flow.io/reference/timezones

Minimum: 3
Maximum: 3
Example: America/New_York

payment_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

payment_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

payment io.flow.payment.v0.unions.payment:0.3.47 Yes -

pricing_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

pricing_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

experience_key string Yes -

vat string Yes -

duty string Yes -

rounding_type string No -

rounding_method string No -

rounding_value decimal No -

rate_deleted

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

timestamp date-time-iso8601 Yes -

rate_id string Yes -

rate_upserted

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

timestamp date-time-iso8601 Yes -

rate_id string Yes -

organization_id string Yes -

base string Yes -

target string Yes -

effective_at date-time-iso8601 Yes -

value decimal Yes -

The actual conversion rate after all margins have been applied.

refund_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

key string Yes -

authorization_key string Yes -

amount decimal Yes -

currency string Yes -

captures [object] Yes -

created_at date-time-iso8601 Yes -

order_number string No -

rma_key string No -

refund_upserted_v2

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

refund io.flow.payment.v0.models.refund:0.3.47 Yes -

return_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

return_upserted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

organization string Yes -

Refers to your organization’s account identifier

destination object Yes -

items object Yes -

key string Yes -

labels object Yes -

service string Yes -

origin object Yes -

snapshot_deleted

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

timestamp date-time-iso8601 Yes -

snapshot_id string Yes -

snapshot_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

snapshot_id string Yes -

available long Yes -

center_key string Yes -

item_number string Yes -

quantity long Yes -

subcatalog_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

catalog string Yes -

Example: master

subcatalog_id string Yes -

subcatalog_item_deleted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

subcatalog_id string Yes -

subcatalog_item_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

number string Yes -

Client’s unique identifier for this object

catalog string Yes -

Example: master

subcatalog_id string Yes -

status string Yes -

function_id string No -

subcatalog_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

catalog string Yes -

Example: master

subcatalog_id string Yes -

targeting_item_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

targeting_item_upserted

Example Json: Minimal | Full

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

tier_deleted

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

timestamp date-time-iso8601 Yes -

id string Yes -

Globally unique identifier

tier_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

id string Yes -

Globally unique identifier

experience_key string Yes -

integration string Yes -

name string Yes -

rules [object] Yes -

services [object] Yes -

strategy string Yes -

visibility string Yes -

description string No -

tracking_label_event_upserted

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

timestamp date-time-iso8601 Yes -

organization string Yes -

Refers to your organization’s account identifier

address object 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 -

Unions

event

Example Json: Minimal | Full
  • Type discriminator: discriminator
attribute_upserted
attribute_deleted
catalog_upserted
catalog_deleted
subcatalog_upserted
subcatalog_deleted
catalog_item_upserted
catalog_item_deleted
subcatalog_item_upserted
subcatalog_item_deleted
rate_deleted
rate_upserted
available_promotions_upserted
available_promotions_deleted
allocation_deleted
allocation_upserted
experience_deleted
experience_upserted
item_margin_deleted
item_margin_upserted
item_sales_margin_deleted
item_sales_margin_upserted
label_format_deleted
label_format_upserted
order_deleted
order_upserted
order_identifier_deleted
order_identifier_upserted
pricing_deleted
pricing_upserted
tier_upserted
tier_deleted
hs6_code_upserted
hs6_code_deleted
hs10_code_upserted
hs10_code_deleted
item_origin_upserted
item_origin_deleted
harmonized_item_upserted
harmonized_item_deleted
snapshot_upserted
snapshot_deleted
label_upserted
notification_upserted
notification_deleted
localized_item_upserted deprecated:

Use localized_item_upserted_v2

localized_item_upserted_v2
localized_item_deleted deprecated:

Use localized_item_deleted_v2

localized_item_deleted_v2
localized_item_snapshot
membership_upserted
membership_deleted
organization_upserted
organization_deleted
authorization_upserted deprecated:

Use card_authorization_upserted and online_authorization_upserted

authorization_deleted deprecated:

Use authorization_deleted_v2

authorization_deleted_v2
authorization_status_changed

Trigger whenever an auth status changes (e.g. from pending to authorized). Common use case is to subscribe to this event to know when an auth is cleared from fraud review.

card_authorization_upserted deprecated:

Use card_authorization_upserted_v2

card_authorization_upserted_v2
online_authorization_upserted deprecated:

Use online_authorization_upserted_v2

online_authorization_upserted_v2
capture_upserted deprecated:

Use capture_upserted_v2

capture_upserted_v2
card_upserted deprecated:

Use card_upserted_v2

card_upserted_v2
card_deleted
payment_upserted
payment_deleted
refund_upserted deprecated:

Use refund_upserted_v2

refund_upserted_v2
return_upserted
return_deleted
targeting_item_upserted
targeting_item_deleted
tracking_label_event_upserted