@flowio/types 11.19.23 → 11.19.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1923,1119 +1923,990 @@ declare namespace io.flow.experience.v0.unions {
1923
1923
  | io.flow.experience.v0.models.Discount;
1924
1924
  }
1925
1925
 
1926
- declare namespace io.flow.ratecard.v0.models {
1927
- interface CrossdockRatecardFee {
1928
- readonly discriminator: 'crossdock_ratecard_fee';
1929
- readonly amount: io.flow.common.v0.models.Money;
1930
- }
1926
+ declare namespace io.flow.error.v0.enums {
1927
+ type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
1928
+ }
1931
1929
 
1932
- interface DdpRatecardFee {
1933
- readonly discriminator: 'ddp_ratecard_fee';
1934
- readonly amount: number;
1930
+ declare namespace io.flow.error.v0.models {
1931
+ interface GenericError {
1932
+ readonly code: io.flow.error.v0.enums.GenericErrorCode;
1933
+ readonly messages: string[];
1935
1934
  }
1935
+ }
1936
1936
 
1937
- interface DimensionEstimate {
1938
- readonly id: string;
1939
- readonly q: string;
1940
- readonly dimensions: io.flow.ratecard.v0.models.EstimatedDimensions;
1941
- readonly position: number;
1937
+ declare namespace io.flow.price.v0.enums {
1938
+ type LevyComponent = 'goods' | 'duty' | 'insurance' | 'freight' | 'vat';
1939
+ type LevyStrategy = 'minimum' | 'average' | 'maximum';
1940
+ type PriceAccuracy = 'calculated' | 'estimated_from_partial_destination';
1941
+ type PriceDetailComponentKey =
1942
+ | 'base_price'
1943
+ | 'discount'
1944
+ | 'currency_margin'
1945
+ | 'percent_item_margin'
1946
+ | 'fixed_item_margin'
1947
+ | 'duties_item_price'
1948
+ | 'duties_added_margin'
1949
+ | 'duties_rounding'
1950
+ | 'duties_deminimis'
1951
+ | 'vat_item_price'
1952
+ | 'vat_added_margin'
1953
+ | 'vat_rounding'
1954
+ | 'vat_duties_item_price'
1955
+ | 'vat_duties_added_margin'
1956
+ | 'vat_duties_rounding'
1957
+ | 'vat_deminimis'
1958
+ | 'item_price_percent_sales_margin'
1959
+ | 'margins_percent_sales_margin'
1960
+ | 'rounding_percent_sales_margin'
1961
+ | 'vat_percent_sales_margin'
1962
+ | 'vat_duty_percent_sales_margin'
1963
+ | 'duty_percent_sales_margin';
1964
+ type PriceDetailKey =
1965
+ | 'item_price'
1966
+ | 'margins'
1967
+ | 'vat'
1968
+ | 'duty'
1969
+ | 'rounding'
1970
+ | 'adjustment';
1971
+ type PricingLevySetting = 'included' | 'displayed' | 'ignored';
1972
+ }
1973
+
1974
+ declare namespace io.flow.price.v0.models {
1975
+ interface CurrencyFormat {
1976
+ readonly symbol: io.flow.common.v0.enums.CurrencySymbolFormat;
1977
+ readonly label_formatters: io.flow.common.v0.enums.CurrencyLabelFormatter[];
1942
1978
  }
1943
1979
 
1944
- interface DimensionEstimateForm {
1945
- readonly q: string;
1946
- readonly dimensions: io.flow.ratecard.v0.models.EstimatedDimensions;
1947
- readonly position?: number;
1980
+ interface DeminimisPerItem {
1981
+ readonly discriminator: 'deminimis_per_item';
1982
+ readonly currency: string;
1983
+ readonly minimum?: number;
1984
+ readonly maximum?: number;
1948
1985
  }
1949
1986
 
1950
- interface DimensionEstimateVersion {
1951
- readonly id: string;
1952
- readonly timestamp: string;
1953
- readonly type: io.flow.common.v0.enums.ChangeType;
1954
- readonly dimension_estimate: io.flow.ratecard.v0.models.DimensionEstimate;
1987
+ interface DeminimisSimple {
1988
+ readonly discriminator: 'deminimis_simple';
1989
+ readonly value?: number;
1990
+ readonly currency: string;
1991
+ readonly components: io.flow.price.v0.enums.LevyComponent[];
1992
+ readonly minimum?: number;
1955
1993
  }
1956
1994
 
1957
- interface DutiesTaxesPaidSurchargeRatecardFee {
1958
- readonly discriminator: 'duties_taxes_paid_surcharge_ratecard_fee';
1959
- readonly amount: io.flow.common.v0.models.Money;
1960
- readonly starts_at?: string;
1961
- readonly ends_at?: string;
1995
+ interface Duty {
1996
+ readonly rate: number;
1997
+ readonly components: io.flow.price.v0.enums.LevyComponent[];
1998
+ readonly deminimis?: io.flow.price.v0.unions.Deminimis;
1999
+ readonly name?: string;
1962
2000
  }
1963
2001
 
1964
- interface DutiesTaxesPaidSurchargeServiceFee {
1965
- readonly discriminator: 'duties_taxes_paid_surcharge_service_fee';
1966
- readonly amount: io.flow.common.v0.models.Money;
1967
- readonly starts_at?: string;
1968
- readonly ends_at?: string;
2002
+ interface LocalPriceDetails {
2003
+ readonly base: io.flow.price.v0.models.PriceDetails;
2004
+ readonly local: io.flow.price.v0.models.PriceDetails;
2005
+ readonly discount?: io.flow.price.v0.models.PriceDetail;
2006
+ readonly local_before_discount?: io.flow.price.v0.models.PriceDetail;
1969
2007
  }
1970
2008
 
1971
- interface EmergencySituationSurchargeRatecardFee {
1972
- readonly discriminator: 'emergency_situation_surcharge_ratecard_fee';
1973
- readonly amount: io.flow.common.v0.models.Money;
2009
+ interface PriceBook {
2010
+ readonly id: string;
2011
+ readonly key: string;
2012
+ readonly currency: string;
2013
+ readonly name: string;
2014
+ readonly includes: io.flow.common.v0.models.IncludedLevies;
2015
+ readonly status: io.flow.common.v0.enums.PriceBookStatus;
1974
2016
  }
1975
2017
 
1976
- interface EmergencySituationSurchargeServiceFee {
1977
- readonly discriminator: 'emergency_situation_surcharge_service_fee';
1978
- readonly amount: io.flow.common.v0.models.Money;
1979
- readonly origin_region?: io.flow.ratecard.v0.models.RatecardRegionReference;
1980
- readonly destination_region?: io.flow.ratecard.v0.models.RatecardRegionReference;
1981
- readonly interval_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
2018
+ interface PriceBookForm {
2019
+ readonly currency: string;
2020
+ readonly name: string;
2021
+ readonly includes: io.flow.common.v0.enums.IncludedLevyKey;
2022
+ readonly status?: io.flow.common.v0.enums.PriceBookStatus;
1982
2023
  }
1983
2024
 
1984
- interface EstimatedDimensions {
1985
- readonly depth: io.flow.common.v0.models.Measurement;
1986
- readonly length: io.flow.common.v0.models.Measurement;
1987
- readonly weight: io.flow.common.v0.models.Measurement;
1988
- readonly width: io.flow.common.v0.models.Measurement;
2025
+ interface PriceBookItem {
2026
+ readonly id: string;
2027
+ readonly key: string;
2028
+ readonly price_book: io.flow.price.v0.models.PriceBookReference;
2029
+ readonly price: io.flow.common.v0.models.Price;
2030
+ readonly item_number: string;
2031
+ readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2032
+ readonly item_attributes?: Record<string, string>;
1989
2033
  }
1990
2034
 
1991
- interface FeeWeight {
1992
- readonly weight: number;
1993
- readonly unit: io.flow.common.v0.enums.UnitOfMeasurement;
2035
+ interface PriceBookItemForm {
2036
+ readonly price_book_key: string;
2037
+ readonly item_number: string;
2038
+ readonly amount: number;
2039
+ readonly schedule?: io.flow.price.v0.models.PriceBookItemSchedule;
2040
+ readonly item_attributes?: Record<string, string>;
1994
2041
  }
1995
2042
 
1996
- interface FuelSurchargeRatecardFee {
1997
- readonly discriminator: 'fuel_surcharge_ratecard_fee';
1998
- readonly amount: io.flow.common.v0.models.Money;
2043
+ interface PriceBookItemQueryForm {
2044
+ readonly price_book_key: string;
2045
+ readonly item_query: string;
2046
+ readonly amount: number;
2047
+ readonly schedule?: io.flow.price.v0.models.PriceBookItemSchedule;
2048
+ readonly item_attributes?: Record<string, string>;
1999
2049
  }
2000
2050
 
2001
- interface FuelSurchargeServiceFee {
2002
- readonly discriminator: 'fuel_surcharge_service_fee';
2003
- readonly percent: number;
2051
+ interface PriceBookItemSchedule {
2052
+ readonly starts_at: string;
2053
+ readonly ends_at?: string;
2004
2054
  }
2005
2055
 
2006
- interface Hop {
2007
- readonly hop_number: number;
2008
- readonly hop_estimate: io.flow.ratecard.v0.models.HopEstimate;
2056
+ interface PriceBookReference {
2057
+ readonly id: string;
2058
+ readonly key: string;
2009
2059
  }
2010
2060
 
2011
- interface HopEstimate {
2012
- readonly origin_address: io.flow.fulfillment.v0.models.ShippingAddress;
2013
- readonly destination_address: io.flow.fulfillment.v0.models.ShippingAddress;
2014
- readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
2015
- readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
2016
- readonly currency: string;
2017
- readonly amount: number;
2018
- readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
2019
- readonly total: number;
2061
+ interface PriceCheck {
2062
+ readonly display: io.flow.price.v0.models.LocalPriceDetails;
2063
+ readonly final: io.flow.price.v0.models.LocalPriceDetails;
2020
2064
  }
2021
2065
 
2022
- interface OversizedShipmentRatecardFee {
2023
- readonly discriminator: 'oversized_shipment_ratecard_fee';
2024
- readonly weight_threshold: number;
2025
- readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2026
- readonly margin?: number;
2027
- readonly amount?: number;
2066
+ interface PriceDetail {
2067
+ readonly key: io.flow.price.v0.enums.PriceDetailKey;
2068
+ readonly components: io.flow.price.v0.models.PriceDetailComponent[];
2069
+ readonly amount: number;
2070
+ readonly label: string;
2071
+ readonly name?: string;
2072
+ readonly basis?: number;
2028
2073
  }
2029
2074
 
2030
- interface PeakSurchargeByWeightServiceFee {
2031
- readonly discriminator: 'peak_surcharge_by_weight_service_fee';
2032
- readonly amount: io.flow.common.v0.models.Money;
2033
- readonly weight: io.flow.ratecard.v0.models.FeeWeight;
2034
- readonly regions?: string[];
2035
- readonly starts_at?: string;
2036
- readonly ends_at?: string;
2075
+ interface PriceDetailComponent {
2076
+ readonly key: io.flow.price.v0.enums.PriceDetailComponentKey;
2077
+ readonly amount: number;
2078
+ readonly label: string;
2079
+ readonly name?: string;
2037
2080
  }
2038
2081
 
2039
- interface PeakSurchargeRatecardFee {
2040
- readonly discriminator: 'peak_surcharge_ratecard_fee';
2041
- readonly amount: io.flow.common.v0.models.Money;
2042
- readonly starts_at?: string;
2043
- readonly ends_at?: string;
2082
+ interface PriceDetails {
2083
+ readonly currency: string;
2084
+ readonly item_price: io.flow.price.v0.models.PriceDetail;
2085
+ readonly margins: io.flow.price.v0.models.PriceDetail;
2086
+ readonly vat: io.flow.price.v0.models.PriceDetail;
2087
+ readonly duty: io.flow.price.v0.models.PriceDetail;
2088
+ readonly rounding: io.flow.price.v0.models.PriceDetail;
2089
+ readonly price: io.flow.common.v0.models.Price;
2090
+ readonly total: io.flow.common.v0.models.Price;
2091
+ readonly adjustment?: io.flow.price.v0.models.PriceDetail;
2044
2092
  }
2045
2093
 
2046
- interface PeakSurchargeServiceFee {
2047
- readonly discriminator: 'peak_surcharge_service_fee';
2048
- readonly amount: io.flow.common.v0.models.Money;
2049
- readonly starts_at?: string;
2050
- readonly ends_at?: string;
2094
+ interface PriceEquation {
2095
+ readonly contracted_rate: number;
2096
+ readonly rate: number;
2097
+ readonly pricing: io.flow.price.v0.models.Pricing;
2098
+ readonly base_price: number;
2099
+ readonly discount: number;
2100
+ readonly fixed_margin: number;
2101
+ readonly percent_margin: number;
2102
+ readonly insurance: number;
2103
+ readonly freight: number;
2104
+ readonly duty?: io.flow.price.v0.models.Duty;
2105
+ readonly tax?: io.flow.price.v0.models.Tax;
2106
+ readonly percent_sales_margin: number;
2051
2107
  }
2052
2108
 
2053
- interface Ratecard {
2054
- readonly id: string;
2055
- readonly number: string;
2056
- readonly direction: io.flow.label.v0.enums.Direction;
2057
- readonly effective_at: string;
2058
- readonly origination_zones: io.flow.common.v0.models.Zone[];
2059
- readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
2060
- readonly published_at?: string;
2061
- readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
2109
+ interface Pricing {
2110
+ readonly vat: io.flow.price.v0.enums.PricingLevySetting;
2111
+ readonly duty: io.flow.price.v0.enums.PricingLevySetting;
2112
+ readonly rounding?: io.flow.common.v0.models.Rounding;
2062
2113
  }
2063
2114
 
2064
- interface RatecardCarrierSummary {
2065
- readonly id: string;
2115
+ interface Tax {
2066
2116
  readonly name: string;
2117
+ readonly rate: number;
2118
+ readonly components: io.flow.price.v0.enums.LevyComponent[];
2119
+ readonly deminimis?: io.flow.price.v0.unions.Deminimis;
2067
2120
  }
2121
+ }
2068
2122
 
2069
- interface RatecardEstimateFormV1 {
2070
- readonly discriminator: 'ratecard_estimate_form_v1';
2071
- readonly origin?: string;
2072
- readonly destination?: string;
2073
- readonly weight_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
2074
- readonly distance_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
2075
- readonly service?: string;
2076
- readonly weight?: number;
2077
- readonly length?: number;
2078
- readonly width?: number;
2079
- readonly depth?: number;
2080
- readonly delivered_duty?: io.flow.common.v0.enums.DeliveredDuty;
2081
- readonly line_items?: io.flow.common.v0.models.LineItemForm[];
2082
- }
2083
-
2084
- interface RatecardEstimateFormV2 {
2085
- readonly discriminator: 'ratecard_estimate_form_v2';
2086
- readonly origin_address: io.flow.common.v0.models.Address;
2087
- readonly destination_address: io.flow.common.v0.models.Address;
2088
- readonly weight_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
2089
- readonly distance_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
2090
- readonly service?: string;
2091
- readonly weight?: number;
2092
- readonly length?: number;
2093
- readonly width?: number;
2094
- readonly depth?: number;
2095
- readonly delivered_duty?: io.flow.common.v0.enums.DeliveredDuty;
2096
- readonly line_items?: io.flow.common.v0.models.LineItemForm[];
2097
- readonly center_id?: string;
2098
- }
2099
-
2100
- interface RatecardEstimateSummaryForm {
2101
- readonly origin?: string;
2102
- readonly destination?: string;
2103
- readonly service?: string;
2104
- readonly center_key?: string;
2105
- }
2106
-
2107
- interface RatecardEstimateV1 {
2108
- readonly discriminator: 'ratecard_estimate_v1';
2109
- readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
2110
- readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
2111
- readonly currency: string;
2112
- readonly amount: number;
2113
- readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
2114
- readonly total: number;
2115
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2116
- readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
2117
- readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
2118
- readonly line_items?: io.flow.common.v0.models.LineItemForm[];
2119
- }
2120
-
2121
- interface RatecardEstimateV2 {
2122
- readonly discriminator: 'ratecard_estimate_v2';
2123
- readonly hops: io.flow.ratecard.v0.models.Hop[];
2124
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2125
- readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
2126
- readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
2127
- readonly line_items?: io.flow.common.v0.models.LineItemForm[];
2128
- readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
2129
- }
2123
+ declare namespace io.flow.price.v0.unions {
2124
+ type Deminimis =
2125
+ | io.flow.price.v0.models.DeminimisSimple
2126
+ | io.flow.price.v0.models.DeminimisPerItem;
2127
+ }
2130
2128
 
2131
- interface RatecardEstimateV3 {
2132
- readonly discriminator: 'ratecard_estimate_v3';
2133
- readonly hops: io.flow.ratecard.v0.models.Hop[];
2134
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2135
- readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
2136
- readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
2137
- readonly line_items?: io.flow.common.v0.models.LineItemForm[];
2138
- readonly ratecard: io.flow.ratecard.v0.models.RatecardSummary;
2139
- }
2129
+ declare namespace io.flow.reference.v0.enums {
2130
+ type PaymentMethodCapability = 'credit' | 'debit';
2131
+ type PaymentMethodType = 'card' | 'online' | 'offline';
2132
+ type PostalType = 'eircode' | 'pin' | 'postal' | 'zip';
2133
+ type ProvinceType =
2134
+ | 'area'
2135
+ | 'city'
2136
+ | 'county'
2137
+ | 'department'
2138
+ | 'dependency'
2139
+ | 'district'
2140
+ | 'do_si'
2141
+ | 'emirate'
2142
+ | 'entity'
2143
+ | 'island'
2144
+ | 'municipality'
2145
+ | 'oblast'
2146
+ | 'outlying_area'
2147
+ | 'parish'
2148
+ | 'prefecture'
2149
+ | 'province'
2150
+ | 'state'
2151
+ | 'territory'
2152
+ | 'other';
2153
+ }
2140
2154
 
2141
- interface RatecardForm {
2142
- readonly direction: io.flow.label.v0.enums.Direction;
2143
- readonly effective_at: string;
2144
- readonly origination_zones: io.flow.common.v0.models.Zone[];
2145
- readonly service: string;
2146
- readonly number?: string;
2147
- readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
2155
+ declare namespace io.flow.reference.v0.models {
2156
+ interface Carrier {
2157
+ readonly id: string;
2158
+ readonly name: string;
2159
+ readonly tracking_url: string;
2148
2160
  }
2149
2161
 
2150
- interface RatecardLane {
2162
+ interface CarrierService {
2151
2163
  readonly id: string;
2152
- readonly ratecard: io.flow.ratecard.v0.models.RatecardSummary;
2153
- readonly currency: string;
2154
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2155
- readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
2156
- readonly destination: io.flow.common.v0.models.Zone;
2157
- readonly dim_factor: number;
2158
- readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
2159
- readonly origin: io.flow.common.v0.models.Zone;
2160
- readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
2161
- readonly rates: io.flow.ratecard.v0.models.RatecardRate[];
2162
- readonly rounding: io.flow.common.v0.models.Rounding;
2163
- readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2164
- readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2164
+ readonly carrier: io.flow.reference.v0.models.Carrier;
2165
+ readonly name: string;
2165
2166
  }
2166
2167
 
2167
- interface RatecardLaneForm {
2168
- readonly ratecard_id: string;
2169
- readonly currency: string;
2170
- readonly destination: io.flow.common.v0.models.Zone;
2171
- readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
2172
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2173
- readonly dim_factor: number;
2174
- readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
2175
- readonly origin: io.flow.common.v0.models.Zone;
2176
- readonly rounding: io.flow.common.v0.models.Rounding;
2177
- readonly rates: io.flow.ratecard.v0.models.RatecardRateForm[];
2178
- readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2179
- readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2168
+ interface Country {
2169
+ readonly name: string;
2170
+ readonly iso_3166_2: string;
2171
+ readonly iso_3166_3: string;
2172
+ readonly languages: string[];
2173
+ readonly measurement_system: string;
2174
+ readonly default_currency?: string;
2175
+ readonly default_language?: string;
2176
+ readonly timezones: string[];
2177
+ readonly default_delivered_duty?: string;
2180
2178
  }
2181
2179
 
2182
- interface RatecardLaneImportForm {
2183
- readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
2184
- readonly service: string;
2185
- readonly currency: string;
2186
- readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
2187
- readonly origin: io.flow.common.v0.models.Zone;
2188
- readonly destination: io.flow.common.v0.models.Zone;
2189
- readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
2190
- readonly dim_factor: number;
2191
- readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2192
- readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
2193
- readonly rates: io.flow.ratecard.v0.models.RatecardRateForm[];
2180
+ interface Currency {
2181
+ readonly name: string;
2182
+ readonly iso_4217_3: string;
2183
+ readonly number_decimals: number;
2184
+ readonly symbols?: io.flow.reference.v0.models.CurrencySymbols;
2185
+ readonly default_locale?: string;
2194
2186
  }
2195
2187
 
2196
- interface RatecardLaneVersion {
2197
- readonly id: string;
2198
- readonly timestamp: string;
2199
- readonly type: io.flow.common.v0.enums.ChangeType;
2200
- readonly ratecard_lane: io.flow.ratecard.v0.models.RatecardLane;
2188
+ interface CurrencySymbols {
2189
+ readonly primary: string;
2190
+ readonly narrow?: string;
2201
2191
  }
2202
2192
 
2203
- interface RatecardLanesImportRequestData {
2204
- readonly id: string;
2205
- readonly source_url: string;
2206
- readonly filename?: string;
2193
+ interface Language {
2194
+ readonly name: string;
2195
+ readonly iso_639_2: string;
2207
2196
  }
2208
2197
 
2209
- interface RatecardRate {
2198
+ interface Locale {
2210
2199
  readonly id: string;
2211
- readonly amount: number;
2212
- readonly weight: number;
2200
+ readonly name: string;
2201
+ readonly country: string;
2202
+ readonly language: string;
2203
+ readonly numbers: io.flow.reference.v0.models.LocaleNumbers;
2213
2204
  }
2214
2205
 
2215
- interface RatecardRateForm {
2216
- readonly amount: number;
2217
- readonly weight: number;
2206
+ interface LocaleNumbers {
2207
+ readonly decimal: string;
2208
+ readonly group: string;
2218
2209
  }
2219
2210
 
2220
- interface RatecardRateVersion {
2221
- readonly id: string;
2222
- readonly timestamp: string;
2223
- readonly type: io.flow.common.v0.enums.ChangeType;
2224
- readonly ratecard_rate: io.flow.ratecard.v0.models.RatecardRate;
2211
+ interface LocalizedTranslation {
2212
+ readonly locale: io.flow.reference.v0.models.Locale;
2213
+ readonly name: string;
2225
2214
  }
2226
2215
 
2227
- interface RatecardReference {
2216
+ interface PaymentMethod {
2228
2217
  readonly id: string;
2218
+ readonly type: io.flow.reference.v0.enums.PaymentMethodType;
2219
+ readonly name: string;
2220
+ readonly images: io.flow.reference.v0.models.PaymentMethodImages;
2221
+ readonly regions: string[];
2222
+ readonly capabilities?: io.flow.reference.v0.enums.PaymentMethodCapability[];
2229
2223
  }
2230
2224
 
2231
- interface RatecardRegionReference {
2232
- readonly id: string;
2225
+ interface PaymentMethodImage {
2226
+ readonly url: string;
2227
+ readonly width: number;
2228
+ readonly height: number;
2233
2229
  }
2234
2230
 
2235
- interface RatecardServiceSummary {
2236
- readonly id: string;
2237
- readonly name: string;
2238
- readonly carrier: io.flow.ratecard.v0.models.RatecardCarrierSummary;
2231
+ interface PaymentMethodImages {
2232
+ readonly small: io.flow.reference.v0.models.PaymentMethodImage;
2233
+ readonly medium: io.flow.reference.v0.models.PaymentMethodImage;
2234
+ readonly large: io.flow.reference.v0.models.PaymentMethodImage;
2239
2235
  }
2240
2236
 
2241
- interface RatecardSummary {
2237
+ interface Province {
2242
2238
  readonly id: string;
2243
- readonly number: string;
2244
- readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
2239
+ readonly iso_3166_2: string;
2240
+ readonly name: string;
2241
+ readonly country: string;
2242
+ readonly province_type: io.flow.reference.v0.enums.ProvinceType;
2243
+ readonly translations?: io.flow.reference.v0.models.LocalizedTranslation[];
2245
2244
  }
2246
2245
 
2247
- interface RatecardVersion {
2246
+ interface Region {
2248
2247
  readonly id: string;
2249
- readonly timestamp: string;
2250
- readonly type: io.flow.common.v0.enums.ChangeType;
2251
- readonly ratecard: io.flow.ratecard.v0.models.Ratecard;
2248
+ readonly name: string;
2249
+ readonly countries: string[];
2250
+ readonly currencies: string[];
2251
+ readonly languages: string[];
2252
+ readonly measurement_systems: string[];
2253
+ readonly timezones: string[];
2252
2254
  }
2253
2255
 
2254
- interface RemoteAreaRatecardFee {
2255
- readonly discriminator: 'remote_area_ratecard_fee';
2256
- readonly amount: io.flow.common.v0.models.Money;
2256
+ interface Timezone {
2257
+ readonly name: string;
2258
+ readonly description: string;
2259
+ readonly offset: number;
2257
2260
  }
2261
+ }
2258
2262
 
2259
- interface RemoteAreaServiceFee {
2260
- readonly discriminator: 'remote_area_service_fee';
2261
- readonly amount: io.flow.common.v0.models.Money;
2262
- }
2263
-
2264
- interface ReturnPackageRatecardFee {
2265
- readonly discriminator: 'return_package_ratecard_fee';
2266
- readonly amount: number;
2267
- }
2268
-
2269
- interface ShipmentWindow {
2270
- readonly from: number;
2271
- readonly to: number;
2272
- }
2273
- }
2274
-
2275
- declare namespace io.flow.ratecard.v0.unions {
2276
- type RatecardEstimate =
2277
- | io.flow.ratecard.v0.models.RatecardEstimateV1
2278
- | io.flow.ratecard.v0.models.RatecardEstimateV2
2279
- | io.flow.ratecard.v0.models.RatecardEstimateV3;
2280
- type RatecardEstimateForm =
2281
- | io.flow.ratecard.v0.models.RatecardEstimateFormV1
2282
- | io.flow.ratecard.v0.models.RatecardEstimateFormV2;
2283
- type RatecardFee =
2284
- | io.flow.ratecard.v0.models.DdpRatecardFee
2285
- | io.flow.ratecard.v0.models.FuelSurchargeRatecardFee
2286
- | io.flow.ratecard.v0.models.OversizedShipmentRatecardFee
2287
- | io.flow.ratecard.v0.models.ReturnPackageRatecardFee
2288
- | io.flow.ratecard.v0.models.CrossdockRatecardFee
2289
- | io.flow.ratecard.v0.models.RemoteAreaRatecardFee
2290
- | io.flow.ratecard.v0.models.EmergencySituationSurchargeRatecardFee
2291
- | io.flow.ratecard.v0.models.PeakSurchargeRatecardFee
2292
- | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeRatecardFee;
2293
- type ServiceFee =
2294
- | io.flow.ratecard.v0.models.FuelSurchargeServiceFee
2295
- | io.flow.ratecard.v0.models.RemoteAreaServiceFee
2296
- | io.flow.ratecard.v0.models.EmergencySituationSurchargeServiceFee
2297
- | io.flow.ratecard.v0.models.PeakSurchargeServiceFee
2298
- | io.flow.ratecard.v0.models.PeakSurchargeByWeightServiceFee
2299
- | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeServiceFee;
2300
- }
2301
-
2302
- declare namespace io.flow.error.v0.enums {
2303
- type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
2304
- }
2305
-
2306
- declare namespace io.flow.error.v0.models {
2307
- interface GenericError {
2308
- readonly code: io.flow.error.v0.enums.GenericErrorCode;
2309
- readonly messages: string[];
2310
- }
2311
- }
2312
-
2313
- declare namespace io.flow.price.v0.enums {
2314
- type LevyComponent = 'goods' | 'duty' | 'insurance' | 'freight' | 'vat';
2315
- type LevyStrategy = 'minimum' | 'average' | 'maximum';
2316
- type PriceAccuracy = 'calculated' | 'estimated_from_partial_destination';
2317
- type PriceDetailComponentKey =
2318
- | 'base_price'
2319
- | 'discount'
2320
- | 'currency_margin'
2321
- | 'percent_item_margin'
2322
- | 'fixed_item_margin'
2323
- | 'duties_item_price'
2324
- | 'duties_added_margin'
2325
- | 'duties_rounding'
2326
- | 'duties_deminimis'
2327
- | 'vat_item_price'
2328
- | 'vat_added_margin'
2329
- | 'vat_rounding'
2330
- | 'vat_duties_item_price'
2331
- | 'vat_duties_added_margin'
2332
- | 'vat_duties_rounding'
2333
- | 'vat_deminimis'
2334
- | 'item_price_percent_sales_margin'
2335
- | 'margins_percent_sales_margin'
2336
- | 'rounding_percent_sales_margin'
2337
- | 'vat_percent_sales_margin'
2338
- | 'vat_duty_percent_sales_margin'
2339
- | 'duty_percent_sales_margin';
2340
- type PriceDetailKey =
2341
- | 'item_price'
2342
- | 'margins'
2343
- | 'vat'
2344
- | 'duty'
2345
- | 'rounding'
2346
- | 'adjustment';
2347
- type PricingLevySetting = 'included' | 'displayed' | 'ignored';
2263
+ declare namespace io.flow.tracking.v0.enums {
2264
+ type TrackingStatus =
2265
+ | 'label_created'
2266
+ | 'pending'
2267
+ | 'info_received'
2268
+ | 'picked_up'
2269
+ | 'in_transit'
2270
+ | 'out_for_delivery'
2271
+ | 'attempt_fail'
2272
+ | 'delivered'
2273
+ | 'exception'
2274
+ | 'returned'
2275
+ | 'expired';
2348
2276
  }
2349
2277
 
2350
- declare namespace io.flow.price.v0.models {
2351
- interface CurrencyFormat {
2352
- readonly symbol: io.flow.common.v0.enums.CurrencySymbolFormat;
2353
- readonly label_formatters: io.flow.common.v0.enums.CurrencyLabelFormatter[];
2354
- }
2355
-
2356
- interface DeminimisPerItem {
2357
- readonly discriminator: 'deminimis_per_item';
2358
- readonly currency: string;
2359
- readonly minimum?: number;
2360
- readonly maximum?: number;
2278
+ declare namespace io.flow.tracking.v0.models {
2279
+ interface Tracking {
2280
+ readonly id: string;
2281
+ readonly labels: io.flow.tracking.v0.models.TrackingLabel[];
2282
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2283
+ readonly attributes: Record<string, string>;
2284
+ readonly url: string;
2285
+ readonly window?: io.flow.common.v0.models.DatetimeRange;
2286
+ readonly order_number?: string;
2361
2287
  }
2362
2288
 
2363
- interface DeminimisSimple {
2364
- readonly discriminator: 'deminimis_simple';
2365
- readonly value?: number;
2366
- readonly currency: string;
2367
- readonly components: io.flow.price.v0.enums.LevyComponent[];
2368
- readonly minimum?: number;
2289
+ interface TrackingEvent {
2290
+ readonly id: string;
2291
+ readonly address: io.flow.common.v0.models.Address;
2292
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2293
+ readonly timestamp: string;
2294
+ readonly description?: string;
2369
2295
  }
2370
2296
 
2371
- interface Duty {
2372
- readonly rate: number;
2373
- readonly components: io.flow.price.v0.enums.LevyComponent[];
2374
- readonly deminimis?: io.flow.price.v0.unions.Deminimis;
2375
- readonly name?: string;
2297
+ interface TrackingEventForm {
2298
+ readonly tracking_label_id: string;
2299
+ readonly timestamp: string;
2300
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2301
+ readonly description?: string;
2302
+ readonly address?: string;
2376
2303
  }
2377
2304
 
2378
- interface LocalPriceDetails {
2379
- readonly base: io.flow.price.v0.models.PriceDetails;
2380
- readonly local: io.flow.price.v0.models.PriceDetails;
2381
- readonly discount?: io.flow.price.v0.models.PriceDetail;
2382
- readonly local_before_discount?: io.flow.price.v0.models.PriceDetail;
2305
+ interface TrackingEventSummary {
2306
+ readonly id: string;
2307
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2308
+ readonly timestamp: string;
2383
2309
  }
2384
2310
 
2385
- interface PriceBook {
2311
+ interface TrackingEventVersion {
2386
2312
  readonly id: string;
2387
- readonly key: string;
2388
- readonly currency: string;
2389
- readonly name: string;
2390
- readonly includes: io.flow.common.v0.models.IncludedLevies;
2391
- readonly status: io.flow.common.v0.enums.PriceBookStatus;
2313
+ readonly timestamp: string;
2314
+ readonly type: io.flow.common.v0.enums.ChangeType;
2315
+ readonly tracking_event: io.flow.tracking.v0.models.TrackingEventSummary;
2392
2316
  }
2393
2317
 
2394
- interface PriceBookForm {
2395
- readonly currency: string;
2396
- readonly name: string;
2397
- readonly includes: io.flow.common.v0.enums.IncludedLevyKey;
2398
- readonly status?: io.flow.common.v0.enums.PriceBookStatus;
2318
+ interface TrackingForm {
2319
+ readonly status?: io.flow.tracking.v0.enums.TrackingStatus;
2320
+ readonly order_number?: string;
2321
+ readonly attributes?: Record<string, string>;
2322
+ readonly window?: io.flow.common.v0.models.DatetimeRange;
2399
2323
  }
2400
2324
 
2401
- interface PriceBookItem {
2325
+ interface TrackingLabel {
2402
2326
  readonly id: string;
2403
- readonly key: string;
2404
- readonly price_book: io.flow.price.v0.models.PriceBookReference;
2405
- readonly price: io.flow.common.v0.models.Price;
2406
- readonly item_number: string;
2407
- readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2408
- readonly item_attributes?: Record<string, string>;
2327
+ readonly carrier: string;
2328
+ readonly carrier_tracking_number: string;
2329
+ readonly events: io.flow.tracking.v0.models.TrackingEvent[];
2330
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2331
+ readonly timestamp: string;
2332
+ readonly delivery_estimate?: string;
2333
+ readonly description?: string;
2409
2334
  }
2410
2335
 
2411
- interface PriceBookItemForm {
2412
- readonly price_book_key: string;
2413
- readonly item_number: string;
2414
- readonly amount: number;
2415
- readonly schedule?: io.flow.price.v0.models.PriceBookItemSchedule;
2416
- readonly item_attributes?: Record<string, string>;
2336
+ interface TrackingLabelForm {
2337
+ readonly tracking_id: string;
2338
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2339
+ readonly carrier: string;
2340
+ readonly carrier_tracking_number: string;
2341
+ readonly delivery_estimate?: string;
2342
+ readonly description?: string;
2343
+ readonly timestamp?: string;
2344
+ readonly parent_id?: string;
2417
2345
  }
2418
2346
 
2419
- interface PriceBookItemQueryForm {
2420
- readonly price_book_key: string;
2421
- readonly item_query: string;
2422
- readonly amount: number;
2423
- readonly schedule?: io.flow.price.v0.models.PriceBookItemSchedule;
2424
- readonly item_attributes?: Record<string, string>;
2347
+ interface TrackingLabelSummary {
2348
+ readonly id: string;
2349
+ readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
2350
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2351
+ readonly carrier: string;
2352
+ readonly tracking_number: string;
2425
2353
  }
2426
2354
 
2427
- interface PriceBookItemSchedule {
2428
- readonly starts_at: string;
2429
- readonly ends_at?: string;
2355
+ interface TrackingLabelVersion {
2356
+ readonly id: string;
2357
+ readonly timestamp: string;
2358
+ readonly type: io.flow.common.v0.enums.ChangeType;
2359
+ readonly tracking_label: io.flow.tracking.v0.models.TrackingLabelSummary;
2430
2360
  }
2431
2361
 
2432
- interface PriceBookReference {
2362
+ interface TrackingSummary {
2433
2363
  readonly id: string;
2434
- readonly key: string;
2364
+ readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2365
+ readonly order_number?: string;
2435
2366
  }
2436
2367
 
2437
- interface PriceCheck {
2438
- readonly display: io.flow.price.v0.models.LocalPriceDetails;
2439
- readonly final: io.flow.price.v0.models.LocalPriceDetails;
2368
+ interface TrackingVersion {
2369
+ readonly id: string;
2370
+ readonly timestamp: string;
2371
+ readonly type: io.flow.common.v0.enums.ChangeType;
2372
+ readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
2440
2373
  }
2374
+ }
2441
2375
 
2442
- interface PriceDetail {
2443
- readonly key: io.flow.price.v0.enums.PriceDetailKey;
2444
- readonly components: io.flow.price.v0.models.PriceDetailComponent[];
2445
- readonly amount: number;
2446
- readonly label: string;
2447
- readonly name?: string;
2448
- readonly basis?: number;
2449
- }
2376
+ declare namespace io.flow.RESERVED_WORD_export.v0.enums {
2377
+ type ExportStatus = 'created' | 'processing' | 'completed' | 'failed';
2378
+ type ItemIdentifier = 'item_number' | 'sku';
2379
+ }
2450
2380
 
2451
- interface PriceDetailComponent {
2452
- readonly key: io.flow.price.v0.enums.PriceDetailComponentKey;
2453
- readonly amount: number;
2454
- readonly label: string;
2455
- readonly name?: string;
2456
- }
2381
+ declare namespace io.flow.RESERVED_WORD_export.v0.models {
2382
+ interface AccountOrdersExportType {
2383
+ readonly discriminator: 'account_orders_export_type';
2384
+ readonly statement_id?: string;
2385
+ readonly transaction_summary_id?: string;
2386
+ readonly transaction_created_from?: string;
2387
+ readonly transaction_created_to?: string;
2388
+ readonly transaction_created_on_or_after?: string;
2389
+ readonly transaction_created_after?: string;
2390
+ readonly transaction_created_on_or_before?: string;
2391
+ readonly transaction_created_before?: string;
2392
+ readonly transaction_posted_from?: string;
2393
+ readonly transaction_posted_to?: string;
2394
+ readonly transaction_posted_on_or_after?: string;
2395
+ readonly transaction_posted_after?: string;
2396
+ readonly transaction_posted_on_or_before?: string;
2397
+ readonly transaction_posted_before?: string;
2398
+ }
2457
2399
 
2458
- interface PriceDetails {
2459
- readonly currency: string;
2460
- readonly item_price: io.flow.price.v0.models.PriceDetail;
2461
- readonly margins: io.flow.price.v0.models.PriceDetail;
2462
- readonly vat: io.flow.price.v0.models.PriceDetail;
2463
- readonly duty: io.flow.price.v0.models.PriceDetail;
2464
- readonly rounding: io.flow.price.v0.models.PriceDetail;
2465
- readonly price: io.flow.common.v0.models.Price;
2466
- readonly total: io.flow.common.v0.models.Price;
2467
- readonly adjustment?: io.flow.price.v0.models.PriceDetail;
2400
+ interface AccountTransactionsExportType {
2401
+ readonly discriminator: 'account_transactions_export_type';
2402
+ readonly statement_id?: string;
2403
+ readonly transaction_summary_id?: string;
2404
+ readonly created_from?: string;
2405
+ readonly created_to?: string;
2406
+ readonly created_on_or_after?: string;
2407
+ readonly created_after?: string;
2408
+ readonly created_on_or_before?: string;
2409
+ readonly created_before?: string;
2410
+ readonly posted_from?: string;
2411
+ readonly posted_to?: string;
2412
+ readonly posted_on_or_after?: string;
2413
+ readonly posted_after?: string;
2414
+ readonly posted_on_or_before?: string;
2415
+ readonly posted_before?: string;
2468
2416
  }
2469
2417
 
2470
- interface PriceEquation {
2471
- readonly contracted_rate: number;
2472
- readonly rate: number;
2473
- readonly pricing: io.flow.price.v0.models.Pricing;
2474
- readonly base_price: number;
2475
- readonly discount: number;
2476
- readonly fixed_margin: number;
2477
- readonly percent_margin: number;
2478
- readonly insurance: number;
2479
- readonly freight: number;
2480
- readonly duty?: io.flow.price.v0.models.Duty;
2481
- readonly tax?: io.flow.price.v0.models.Tax;
2482
- readonly percent_sales_margin: number;
2418
+ interface AnalyticsExportType {
2419
+ readonly discriminator: 'analytics_export_type';
2420
+ readonly from?: string;
2421
+ readonly to?: string;
2422
+ readonly region?: string;
2423
+ readonly interval?: io.flow.common.v0.enums.UnitOfTime;
2483
2424
  }
2484
2425
 
2485
- interface Pricing {
2486
- readonly vat: io.flow.price.v0.enums.PricingLevySetting;
2487
- readonly duty: io.flow.price.v0.enums.PricingLevySetting;
2488
- readonly rounding?: io.flow.common.v0.models.Rounding;
2426
+ interface CatalogItemExportType {
2427
+ readonly discriminator: 'catalog_item_export_type';
2428
+ readonly numbers?: string[];
2429
+ readonly q?: string;
2430
+ readonly sort?: string;
2489
2431
  }
2490
2432
 
2491
- interface Tax {
2492
- readonly name: string;
2493
- readonly rate: number;
2494
- readonly components: io.flow.price.v0.enums.LevyComponent[];
2495
- readonly deminimis?: io.flow.price.v0.unions.Deminimis;
2433
+ interface CsvPriceBookItemExportRowByItemNumber {
2434
+ readonly item_number: string;
2435
+ readonly price_book_key: string;
2436
+ readonly price_book_item_key: string;
2437
+ readonly item_name: string;
2438
+ readonly amount: number;
2439
+ readonly item_attributes?: Record<string, string>;
2440
+ readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2496
2441
  }
2497
- }
2498
2442
 
2499
- declare namespace io.flow.price.v0.unions {
2500
- type Deminimis =
2501
- | io.flow.price.v0.models.DeminimisSimple
2502
- | io.flow.price.v0.models.DeminimisPerItem;
2503
- }
2443
+ interface CsvPriceBookItemExportRowBySku {
2444
+ readonly sku: string;
2445
+ readonly price_book_key: string;
2446
+ readonly price_book_item_key: string;
2447
+ readonly item_name: string;
2448
+ readonly amount: number;
2449
+ readonly item_attributes?: Record<string, string>;
2450
+ readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2451
+ }
2504
2452
 
2505
- declare namespace io.flow.reference.v0.enums {
2506
- type PaymentMethodCapability = 'credit' | 'debit';
2507
- type PaymentMethodType = 'card' | 'online' | 'offline';
2508
- type PostalType = 'eircode' | 'pin' | 'postal' | 'zip';
2509
- type ProvinceType =
2510
- | 'area'
2511
- | 'city'
2512
- | 'county'
2513
- | 'department'
2514
- | 'dependency'
2515
- | 'district'
2516
- | 'do_si'
2517
- | 'emirate'
2518
- | 'entity'
2519
- | 'island'
2520
- | 'municipality'
2521
- | 'oblast'
2522
- | 'outlying_area'
2523
- | 'parish'
2524
- | 'prefecture'
2525
- | 'province'
2526
- | 'state'
2527
- | 'territory'
2528
- | 'other';
2529
- }
2453
+ interface ExclusionRulesExportType {
2454
+ readonly discriminator: 'exclusion_rules_export_type';
2455
+ readonly states?: io.flow.catalog.exclusion.v0.enums.ExclusionRuleState[];
2456
+ readonly sort?: string;
2457
+ }
2530
2458
 
2531
- declare namespace io.flow.reference.v0.models {
2532
- interface Carrier {
2533
- readonly id: string;
2534
- readonly name: string;
2535
- readonly tracking_url: string;
2459
+ interface ExperienceExportType {
2460
+ readonly discriminator: 'experience_export_type';
2461
+ readonly organization_id: string;
2462
+ readonly ids?: string[];
2463
+ readonly keys?: string[];
2536
2464
  }
2537
2465
 
2538
- interface CarrierService {
2466
+ interface Export {
2539
2467
  readonly id: string;
2540
- readonly carrier: io.flow.reference.v0.models.Carrier;
2541
- readonly name: string;
2468
+ readonly type: io.flow.RESERVED_WORD_export.v0.unions.ExportType;
2469
+ readonly status: io.flow.RESERVED_WORD_export.v0.enums.ExportStatus;
2470
+ readonly organization_q: string;
2471
+ readonly created_at: string;
2472
+ readonly started_at?: string;
2473
+ readonly completed_at?: string;
2474
+ readonly url?: string;
2475
+ readonly deliveries: io.flow.RESERVED_WORD_export.v0.unions.ExportDelivery[];
2542
2476
  }
2543
2477
 
2544
- interface Country {
2545
- readonly name: string;
2546
- readonly iso_3166_2: string;
2547
- readonly iso_3166_3: string;
2548
- readonly languages: string[];
2549
- readonly measurement_system: string;
2550
- readonly default_currency?: string;
2551
- readonly default_language?: string;
2552
- readonly timezones: string[];
2553
- readonly default_delivered_duty?: string;
2478
+ interface ExportDeliveryEmail {
2479
+ readonly discriminator: 'export_delivery_email';
2480
+ readonly email: string;
2554
2481
  }
2555
2482
 
2556
- interface Currency {
2557
- readonly name: string;
2558
- readonly iso_4217_3: string;
2559
- readonly number_decimals: number;
2560
- readonly symbols?: io.flow.reference.v0.models.CurrencySymbols;
2561
- readonly default_locale?: string;
2483
+ interface ExportForm {
2484
+ readonly type: io.flow.RESERVED_WORD_export.v0.unions.ExportType;
2485
+ readonly emails?: string[];
2486
+ readonly organization_q?: string;
2562
2487
  }
2563
2488
 
2564
- interface CurrencySymbols {
2565
- readonly primary: string;
2566
- readonly narrow?: string;
2489
+ interface ExportLocalizedItemPrices {
2490
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
2491
+ readonly experience: io.flow.common.v0.models.ExperienceSummary;
2492
+ readonly item: io.flow.common.v0.models.CatalogItemReference;
2493
+ readonly prices: io.flow.RESERVED_WORD_export.v0.models.ExportLocalizedItemPricesDetail;
2494
+ readonly status?: io.flow.catalog.v0.enums.SubcatalogItemStatus;
2495
+ readonly rates?: io.flow.currency.v0.models.Rate[];
2567
2496
  }
2568
2497
 
2569
- interface Language {
2570
- readonly name: string;
2571
- readonly iso_639_2: string;
2498
+ interface ExportLocalizedItemPricesDetail {
2499
+ readonly item: io.flow.catalog.v0.models.LocalizedItemPrice;
2500
+ readonly vat?: io.flow.catalog.v0.models.LocalizedItemVat;
2501
+ readonly duty?: io.flow.catalog.v0.models.LocalizedItemDuty;
2502
+ readonly price_attributes: Record<
2503
+ string,
2504
+ io.flow.common.v0.models.PriceWithBase
2505
+ >;
2572
2506
  }
2573
2507
 
2574
- interface Locale {
2508
+ interface ExportVersion {
2575
2509
  readonly id: string;
2576
- readonly name: string;
2577
- readonly country: string;
2578
- readonly language: string;
2579
- readonly numbers: io.flow.reference.v0.models.LocaleNumbers;
2510
+ readonly timestamp: string;
2511
+ readonly type: io.flow.common.v0.enums.ChangeType;
2512
+ readonly export: io.flow.RESERVED_WORD_export.v0.models.Export;
2580
2513
  }
2581
2514
 
2582
- interface LocaleNumbers {
2583
- readonly decimal: string;
2584
- readonly group: string;
2515
+ interface HarmonizationHs10ExportType {
2516
+ readonly discriminator: 'harmonization_hs10_export_type';
2517
+ readonly origin?: string;
2518
+ readonly destination?: string;
2519
+ readonly numbers?: string[];
2520
+ readonly has_codes?: boolean;
2521
+ readonly has_origins?: boolean;
2522
+ readonly sort?: string;
2585
2523
  }
2586
2524
 
2587
- interface LocalizedTranslation {
2588
- readonly locale: io.flow.reference.v0.models.Locale;
2589
- readonly name: string;
2525
+ interface HarmonizationHs6ExportType {
2526
+ readonly discriminator: 'harmonization_hs6_export_type';
2527
+ readonly numbers?: string[];
2528
+ readonly has_codes?: boolean;
2529
+ readonly sort?: string;
2590
2530
  }
2591
2531
 
2592
- interface PaymentMethod {
2593
- readonly id: string;
2594
- readonly type: io.flow.reference.v0.enums.PaymentMethodType;
2595
- readonly name: string;
2596
- readonly images: io.flow.reference.v0.models.PaymentMethodImages;
2597
- readonly regions: string[];
2598
- readonly capabilities?: io.flow.reference.v0.enums.PaymentMethodCapability[];
2532
+ interface HarmonizationOverviewExportType {
2533
+ readonly discriminator: 'harmonization_overview_export_type';
2534
+ readonly origin?: string;
2535
+ readonly destination?: string;
2536
+ readonly sort?: string;
2599
2537
  }
2600
2538
 
2601
- interface PaymentMethodImage {
2602
- readonly url: string;
2603
- readonly width: number;
2604
- readonly height: number;
2539
+ interface HarmonizationTariffCodesExportType {
2540
+ readonly discriminator: 'harmonization_tariff_codes_export_type';
2541
+ readonly sort?: string;
2605
2542
  }
2606
2543
 
2607
- interface PaymentMethodImages {
2608
- readonly small: io.flow.reference.v0.models.PaymentMethodImage;
2609
- readonly medium: io.flow.reference.v0.models.PaymentMethodImage;
2610
- readonly large: io.flow.reference.v0.models.PaymentMethodImage;
2544
+ interface LandedCostItem {
2545
+ readonly number: string;
2546
+ readonly origin: string;
2547
+ readonly destination: string;
2611
2548
  }
2612
2549
 
2613
- interface Province {
2614
- readonly id: string;
2615
- readonly iso_3166_2: string;
2616
- readonly name: string;
2617
- readonly country: string;
2618
- readonly province_type: io.flow.reference.v0.enums.ProvinceType;
2619
- readonly translations?: io.flow.reference.v0.models.LocalizedTranslation[];
2550
+ interface LocalizedItemPricesExportType {
2551
+ readonly discriminator: 'localized_item_prices_export_type';
2552
+ readonly since?: string;
2620
2553
  }
2621
2554
 
2622
- interface Region {
2623
- readonly id: string;
2624
- readonly name: string;
2625
- readonly countries: string[];
2626
- readonly currencies: string[];
2627
- readonly languages: string[];
2628
- readonly measurement_systems: string[];
2629
- readonly timezones: string[];
2555
+ interface MarketingFeedsExportType {
2556
+ readonly discriminator: 'marketing_feeds_export_type';
2557
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
2558
+ readonly feed_ids: string[];
2630
2559
  }
2631
2560
 
2632
- interface Timezone {
2633
- readonly name: string;
2634
- readonly description: string;
2635
- readonly offset: number;
2561
+ interface OrderExportType {
2562
+ readonly discriminator: 'order_export_type';
2563
+ readonly numbers?: string[];
2564
+ readonly min_hours_since_submitted_at?: number;
2565
+ readonly submitted_on_or_before?: string;
2566
+ readonly submitted_on_or_after?: string;
2567
+ readonly status?: io.flow.experience.v0.enums.OrderStatus;
2568
+ readonly has_tracking_label?: boolean;
2569
+ readonly sort?: string;
2636
2570
  }
2637
- }
2638
2571
 
2639
- declare namespace io.flow.tracking.v0.enums {
2640
- type TrackingStatus =
2641
- | 'label_created'
2642
- | 'pending'
2643
- | 'info_received'
2644
- | 'picked_up'
2645
- | 'in_transit'
2646
- | 'out_for_delivery'
2647
- | 'attempt_fail'
2648
- | 'delivered'
2649
- | 'exception'
2650
- | 'returned'
2651
- | 'expired';
2652
- }
2572
+ interface PriceBookItemExportType {
2573
+ readonly discriminator: 'price_book_item_export_type';
2574
+ readonly price_book_key?: string;
2575
+ readonly item_numbers?: string[];
2576
+ readonly start_date?: string;
2577
+ readonly end_date?: string;
2578
+ readonly item_identifier?: io.flow.RESERVED_WORD_export.v0.enums.ItemIdentifier;
2579
+ }
2653
2580
 
2654
- declare namespace io.flow.tracking.v0.models {
2655
- interface Tracking {
2581
+ interface ScheduledExport {
2656
2582
  readonly id: string;
2657
- readonly labels: io.flow.tracking.v0.models.TrackingLabel[];
2658
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2659
- readonly attributes: Record<string, string>;
2660
- readonly url: string;
2661
- readonly window?: io.flow.common.v0.models.DatetimeRange;
2662
- readonly order_number?: string;
2583
+ readonly user: io.flow.common.v0.models.UserReference;
2584
+ readonly organization_q: string;
2585
+ readonly hour: number;
2586
+ readonly minute: number;
2587
+ readonly timezone: string;
2588
+ readonly types: io.flow.RESERVED_WORD_export.v0.unions.ExportType[];
2589
+ readonly last_sent_at?: string;
2663
2590
  }
2664
2591
 
2665
- interface TrackingEvent {
2666
- readonly id: string;
2667
- readonly address: io.flow.common.v0.models.Address;
2668
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2669
- readonly timestamp: string;
2670
- readonly description?: string;
2592
+ interface ScheduledExportForm {
2593
+ readonly user_id: string;
2594
+ readonly organization_q: string;
2595
+ readonly hour: number;
2596
+ readonly minute: number;
2597
+ readonly timezone: string;
2598
+ readonly types: io.flow.RESERVED_WORD_export.v0.unions.ExportType[];
2671
2599
  }
2672
2600
 
2673
- interface TrackingEventForm {
2674
- readonly tracking_label_id: string;
2675
- readonly timestamp: string;
2676
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2677
- readonly description?: string;
2678
- readonly address?: string;
2601
+ interface SolidusProductExportType {
2602
+ readonly discriminator: 'solidus_product_export_type';
2603
+ readonly numbers?: string[];
2604
+ readonly sort?: string;
2679
2605
  }
2680
2606
 
2681
- interface TrackingEventSummary {
2682
- readonly id: string;
2683
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2684
- readonly timestamp: string;
2607
+ interface SolidusVariantExportType {
2608
+ readonly discriminator: 'solidus_variant_export_type';
2609
+ readonly numbers?: string[];
2610
+ readonly sort?: string;
2685
2611
  }
2686
2612
 
2687
- interface TrackingEventVersion {
2688
- readonly id: string;
2689
- readonly timestamp: string;
2690
- readonly type: io.flow.common.v0.enums.ChangeType;
2691
- readonly tracking_event: io.flow.tracking.v0.models.TrackingEventSummary;
2613
+ interface UnharmonizedItemExportType {
2614
+ readonly discriminator: 'unharmonized_item_export_type';
2615
+ readonly sort?: string;
2692
2616
  }
2617
+ }
2693
2618
 
2694
- interface TrackingForm {
2695
- readonly status?: io.flow.tracking.v0.enums.TrackingStatus;
2696
- readonly order_number?: string;
2697
- readonly attributes?: Record<string, string>;
2698
- readonly window?: io.flow.common.v0.models.DatetimeRange;
2619
+ declare namespace io.flow.RESERVED_WORD_export.v0.unions {
2620
+ type ExportDelivery = io.flow.RESERVED_WORD_export.v0.models.ExportDeliveryEmail;
2621
+ type ExportType =
2622
+ | io.flow.RESERVED_WORD_export.v0.models.AccountTransactionsExportType
2623
+ | io.flow.RESERVED_WORD_export.v0.models.AccountOrdersExportType
2624
+ | io.flow.RESERVED_WORD_export.v0.models.AnalyticsExportType
2625
+ | io.flow.RESERVED_WORD_export.v0.models.CatalogItemExportType
2626
+ | io.flow.RESERVED_WORD_export.v0.models.ExperienceExportType
2627
+ | io.flow.RESERVED_WORD_export.v0.models.HarmonizationOverviewExportType
2628
+ | io.flow.RESERVED_WORD_export.v0.models.HarmonizationHs6ExportType
2629
+ | io.flow.RESERVED_WORD_export.v0.models.HarmonizationHs10ExportType
2630
+ | io.flow.RESERVED_WORD_export.v0.models.HarmonizationTariffCodesExportType
2631
+ | io.flow.RESERVED_WORD_export.v0.models.UnharmonizedItemExportType
2632
+ | io.flow.RESERVED_WORD_export.v0.models.OrderExportType
2633
+ | io.flow.RESERVED_WORD_export.v0.models.PriceBookItemExportType
2634
+ | io.flow.RESERVED_WORD_export.v0.models.SolidusProductExportType
2635
+ | io.flow.RESERVED_WORD_export.v0.models.SolidusVariantExportType
2636
+ | io.flow.RESERVED_WORD_export.v0.models.LocalizedItemPricesExportType
2637
+ | io.flow.RESERVED_WORD_export.v0.models.MarketingFeedsExportType
2638
+ | io.flow.RESERVED_WORD_export.v0.models.ExclusionRulesExportType;
2639
+ }
2640
+
2641
+ declare namespace io.flow.flexe.v0.enums {
2642
+ type FlexeAttachmentType =
2643
+ | 'shipping_label'
2644
+ | 'packing_slip'
2645
+ | 'packing_slip_letter';
2646
+ type FlexeNotification = 'receipt' | 'shipment';
2647
+ type FlexeShipmentType =
2648
+ | 'fulfillment_order'
2649
+ | 'retail_fulfillment_order'
2650
+ | 'carton_pick_delivery'
2651
+ | 'delivery'
2652
+ | 'container_delivery';
2653
+ type FlexeStatus = 'in_transit' | 'completed';
2654
+ }
2655
+
2656
+ declare namespace io.flow.flexe.v0.models {
2657
+ interface BillOfLading {
2658
+ readonly type: string;
2659
+ readonly gs1us?: io.flow.flexe.v0.models.Gs1Us;
2699
2660
  }
2700
2661
 
2701
- interface TrackingLabel {
2702
- readonly id: string;
2703
- readonly carrier: string;
2704
- readonly carrier_tracking_number: string;
2705
- readonly events: io.flow.tracking.v0.models.TrackingEvent[];
2706
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2707
- readonly timestamp: string;
2708
- readonly delivery_estimate?: string;
2709
- readonly description?: string;
2662
+ interface BillTo {
2663
+ readonly name: string;
2664
+ readonly address_1: string;
2665
+ readonly locality: string;
2666
+ readonly region: string;
2667
+ readonly postal_code: string;
2668
+ readonly country: string;
2669
+ readonly address_2?: string;
2670
+ readonly address_3?: string;
2710
2671
  }
2711
2672
 
2712
- interface TrackingLabelForm {
2713
- readonly tracking_id: string;
2714
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2715
- readonly carrier: string;
2716
- readonly carrier_tracking_number: string;
2717
- readonly delivery_estimate?: string;
2718
- readonly description?: string;
2719
- readonly timestamp?: string;
2720
- readonly parent_id?: string;
2673
+ interface CartonPickDeliveryDetails {
2674
+ readonly shipment_uuid?: string;
2675
+ readonly carrier?: string;
2676
+ readonly carrier_id?: string;
2721
2677
  }
2722
2678
 
2723
- interface TrackingLabelSummary {
2724
- readonly id: string;
2725
- readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
2726
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2727
- readonly carrier: string;
2728
- readonly tracking_number: string;
2679
+ interface ContainerDeliveryDetails {
2680
+ readonly purchase_order: string;
2681
+ readonly container_number?: string;
2682
+ readonly seal_number?: string;
2683
+ readonly vendor?: string;
2684
+ readonly expected_inventory: io.flow.flexe.v0.models.InventoryDetails[];
2685
+ readonly received_inventory: io.flow.flexe.v0.models.InventoryDetails[];
2686
+ readonly damaged_inventory: io.flow.flexe.v0.models.InventoryDetails[];
2687
+ readonly quantities_by_inventory: Record<
2688
+ string,
2689
+ io.flow.flexe.v0.models.QuantityByInventory
2690
+ >;
2729
2691
  }
2730
2692
 
2731
- interface TrackingLabelVersion {
2732
- readonly id: string;
2733
- readonly timestamp: string;
2734
- readonly type: io.flow.common.v0.enums.ChangeType;
2735
- readonly tracking_label: io.flow.tracking.v0.models.TrackingLabelSummary;
2693
+ interface DeliveryDetails {
2694
+ readonly shipment_uuid?: string;
2695
+ readonly trailer_number?: string;
2696
+ readonly pallets: io.flow.flexe.v0.models.Pallet[];
2697
+ readonly quantities_by_inventory: Record<
2698
+ string,
2699
+ io.flow.flexe.v0.models.QuantityByInventory
2700
+ >;
2736
2701
  }
2737
2702
 
2738
- interface TrackingSummary {
2739
- readonly id: string;
2740
- readonly status: io.flow.tracking.v0.enums.TrackingStatus;
2741
- readonly order_number?: string;
2703
+ interface Error {
2704
+ readonly url: string;
2705
+ readonly client_request_id: string;
2706
+ readonly generated_at: string;
2707
+ readonly error: string;
2742
2708
  }
2743
2709
 
2744
- interface TrackingVersion {
2745
- readonly id: string;
2746
- readonly timestamp: string;
2747
- readonly type: io.flow.common.v0.enums.ChangeType;
2748
- readonly tracking: io.flow.tracking.v0.models.TrackingSummary;
2710
+ interface FlexeAttachment {
2711
+ readonly type: io.flow.flexe.v0.enums.FlexeAttachmentType;
2712
+ readonly display_name: string;
2713
+ readonly url: string;
2749
2714
  }
2750
- }
2751
2715
 
2752
- declare namespace io.flow.RESERVED_WORD_export.v0.enums {
2753
- type ExportStatus = 'created' | 'processing' | 'completed' | 'failed';
2754
- type ItemIdentifier = 'item_number' | 'sku';
2755
- }
2716
+ interface FlexeEcommerceFulfillment {
2717
+ readonly url: string;
2718
+ readonly client_request_id: string;
2719
+ readonly generated_at: string;
2720
+ readonly data: io.flow.flexe.v0.models.FlexeEcommerceFulfillmentData;
2721
+ readonly errors: io.flow.flexe.v0.models.FlexeEcommerceFulfillmentErrors[];
2722
+ }
2756
2723
 
2757
- declare namespace io.flow.RESERVED_WORD_export.v0.models {
2758
- interface AccountOrdersExportType {
2759
- readonly discriminator: 'account_orders_export_type';
2760
- readonly statement_id?: string;
2761
- readonly transaction_summary_id?: string;
2762
- readonly transaction_created_from?: string;
2763
- readonly transaction_created_to?: string;
2764
- readonly transaction_created_on_or_after?: string;
2765
- readonly transaction_created_after?: string;
2766
- readonly transaction_created_on_or_before?: string;
2767
- readonly transaction_created_before?: string;
2768
- readonly transaction_posted_from?: string;
2769
- readonly transaction_posted_to?: string;
2770
- readonly transaction_posted_on_or_after?: string;
2771
- readonly transaction_posted_after?: string;
2772
- readonly transaction_posted_on_or_before?: string;
2773
- readonly transaction_posted_before?: string;
2774
- }
2775
-
2776
- interface AccountTransactionsExportType {
2777
- readonly discriminator: 'account_transactions_export_type';
2778
- readonly statement_id?: string;
2779
- readonly transaction_summary_id?: string;
2780
- readonly created_from?: string;
2781
- readonly created_to?: string;
2782
- readonly created_on_or_after?: string;
2783
- readonly created_after?: string;
2784
- readonly created_on_or_before?: string;
2785
- readonly created_before?: string;
2786
- readonly posted_from?: string;
2787
- readonly posted_to?: string;
2788
- readonly posted_on_or_after?: string;
2789
- readonly posted_after?: string;
2790
- readonly posted_on_or_before?: string;
2791
- readonly posted_before?: string;
2792
- }
2793
-
2794
- interface AnalyticsExportType {
2795
- readonly discriminator: 'analytics_export_type';
2796
- readonly from?: string;
2797
- readonly to?: string;
2798
- readonly region?: string;
2799
- readonly interval?: io.flow.common.v0.enums.UnitOfTime;
2724
+ interface FlexeEcommerceFulfillmentData {
2725
+ readonly import_id: string;
2726
+ readonly succeeded_uuids: string[];
2727
+ readonly failed_uuids: string[];
2728
+ readonly errors: string[];
2800
2729
  }
2801
2730
 
2802
- interface CatalogItemExportType {
2803
- readonly discriminator: 'catalog_item_export_type';
2804
- readonly numbers?: string[];
2805
- readonly q?: string;
2806
- readonly sort?: string;
2731
+ interface FlexeEcommerceFulfillmentErrors {
2732
+ readonly status: string;
2733
+ readonly title: string;
2734
+ readonly detail: string;
2735
+ readonly source?: string;
2807
2736
  }
2808
2737
 
2809
- interface CsvPriceBookItemExportRowByItemNumber {
2810
- readonly item_number: string;
2811
- readonly price_book_key: string;
2812
- readonly price_book_item_key: string;
2813
- readonly item_name: string;
2814
- readonly amount: number;
2815
- readonly item_attributes?: Record<string, string>;
2816
- readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2738
+ interface FlexeEcommerceFulfillmentForm {
2739
+ readonly reservation_id: number;
2740
+ readonly client_request_id: string;
2741
+ readonly request: io.flow.flexe.v0.models.Orders;
2817
2742
  }
2818
2743
 
2819
- interface CsvPriceBookItemExportRowBySku {
2744
+ interface FlexeInventoryData {
2820
2745
  readonly sku: string;
2821
- readonly price_book_key: string;
2822
- readonly price_book_item_key: string;
2823
- readonly item_name: string;
2824
- readonly amount: number;
2825
- readonly item_attributes?: Record<string, string>;
2826
- readonly schedule: io.flow.price.v0.models.PriceBookItemSchedule;
2746
+ readonly quantity: string;
2747
+ readonly unit: string;
2827
2748
  }
2828
2749
 
2829
- interface ExclusionRulesExportType {
2830
- readonly discriminator: 'exclusion_rules_export_type';
2831
- readonly states?: io.flow.catalog.exclusion.v0.enums.ExclusionRuleState[];
2832
- readonly sort?: string;
2750
+ interface FlexeRetailAttachment {
2751
+ readonly display_name: string;
2752
+ readonly url: string;
2833
2753
  }
2834
2754
 
2835
- interface ExperienceExportType {
2836
- readonly discriminator: 'experience_export_type';
2837
- readonly organization_id: string;
2838
- readonly ids?: string[];
2839
- readonly keys?: string[];
2755
+ interface FlexeRetailFulfillment {
2756
+ readonly url: string;
2757
+ readonly client_request_id: string;
2758
+ readonly generated_at: string;
2759
+ readonly data: io.flow.flexe.v0.models.FlexeRetailFulfillmentData;
2760
+ readonly errors?: io.flow.flexe.v0.models.FlexeRetailFulfillmentErrors[];
2840
2761
  }
2841
2762
 
2842
- interface Export {
2763
+ interface FlexeRetailFulfillmentData {
2843
2764
  readonly id: string;
2844
- readonly type: io.flow.RESERVED_WORD_export.v0.unions.ExportType;
2845
- readonly status: io.flow.RESERVED_WORD_export.v0.enums.ExportStatus;
2846
- readonly organization_q: string;
2847
- readonly created_at: string;
2848
- readonly started_at?: string;
2849
- readonly completed_at?: string;
2850
- readonly url?: string;
2851
- readonly deliveries: io.flow.RESERVED_WORD_export.v0.unions.ExportDelivery[];
2765
+ readonly purchase_order_uuid: string;
2766
+ readonly status: string;
2852
2767
  }
2853
2768
 
2854
- interface ExportDeliveryEmail {
2855
- readonly discriminator: 'export_delivery_email';
2856
- readonly email: string;
2769
+ interface FlexeRetailFulfillmentErrors {
2770
+ readonly type: string;
2771
+ readonly message: string;
2857
2772
  }
2858
2773
 
2859
- interface ExportForm {
2860
- readonly type: io.flow.RESERVED_WORD_export.v0.unions.ExportType;
2861
- readonly emails?: string[];
2862
- readonly organization_q?: string;
2774
+ interface FlexeRetailFulfillmentForm {
2775
+ readonly reservation_id: number;
2776
+ readonly client_request_id?: string;
2777
+ readonly request: io.flow.flexe.v0.models.RetailOrder;
2863
2778
  }
2864
2779
 
2865
- interface ExportLocalizedItemPrices {
2866
- readonly organization: io.flow.common.v0.models.OrganizationReference;
2867
- readonly experience: io.flow.common.v0.models.ExperienceSummary;
2868
- readonly item: io.flow.common.v0.models.CatalogItemReference;
2869
- readonly prices: io.flow.RESERVED_WORD_export.v0.models.ExportLocalizedItemPricesDetail;
2870
- readonly status?: io.flow.catalog.v0.enums.SubcatalogItemStatus;
2871
- readonly rates?: io.flow.currency.v0.models.Rate[];
2780
+ interface FulfillmentOrderDetails {
2781
+ readonly shipment_uuid: string;
2782
+ readonly carrier?: string;
2783
+ readonly carrier_id?: string;
2872
2784
  }
2873
2785
 
2874
- interface ExportLocalizedItemPricesDetail {
2875
- readonly item: io.flow.catalog.v0.models.LocalizedItemPrice;
2876
- readonly vat?: io.flow.catalog.v0.models.LocalizedItemVat;
2877
- readonly duty?: io.flow.catalog.v0.models.LocalizedItemDuty;
2878
- readonly price_attributes: Record<
2879
- string,
2880
- io.flow.common.v0.models.PriceWithBase
2881
- >;
2786
+ interface Gs1Us {
2787
+ readonly number: string;
2788
+ readonly ship_to?: io.flow.flexe.v0.models.Gs1UsShipTo;
2789
+ readonly bill_to?: io.flow.flexe.v0.models.BillTo;
2882
2790
  }
2883
2791
 
2884
- interface ExportVersion {
2885
- readonly id: string;
2886
- readonly timestamp: string;
2887
- readonly type: io.flow.common.v0.enums.ChangeType;
2888
- readonly export: io.flow.RESERVED_WORD_export.v0.models.Export;
2792
+ interface Gs1UsShipTo {
2793
+ readonly cid_number?: string;
2794
+ readonly location_number?: string;
2795
+ readonly free_on_board?: boolean;
2889
2796
  }
2890
2797
 
2891
- interface HarmonizationHs10ExportType {
2892
- readonly discriminator: 'harmonization_hs10_export_type';
2893
- readonly origin?: string;
2894
- readonly destination?: string;
2895
- readonly numbers?: string[];
2896
- readonly has_codes?: boolean;
2897
- readonly has_origins?: boolean;
2898
- readonly sort?: string;
2798
+ interface Inventory {
2799
+ readonly url: string;
2800
+ readonly client_request_id: string;
2801
+ readonly generated_at: string;
2802
+ readonly data: Record<string, io.flow.flexe.v0.models.InventoryDetails>;
2899
2803
  }
2900
2804
 
2901
- interface HarmonizationHs6ExportType {
2902
- readonly discriminator: 'harmonization_hs6_export_type';
2903
- readonly numbers?: string[];
2904
- readonly has_codes?: boolean;
2905
- readonly sort?: string;
2805
+ interface InventoryCount {
2806
+ readonly amount: number;
2807
+ readonly unit: string;
2906
2808
  }
2907
2809
 
2908
- interface HarmonizationOverviewExportType {
2909
- readonly discriminator: 'harmonization_overview_export_type';
2910
- readonly origin?: string;
2911
- readonly destination?: string;
2912
- readonly sort?: string;
2810
+ interface InventoryData {
2811
+ readonly pallet: io.flow.flexe.v0.models.InventoryCount;
2812
+ readonly carton?: io.flow.flexe.v0.models.InventoryCount;
2813
+ readonly each?: io.flow.flexe.v0.models.InventoryCount;
2913
2814
  }
2914
2815
 
2915
- interface HarmonizationTariffCodesExportType {
2916
- readonly discriminator: 'harmonization_tariff_codes_export_type';
2917
- readonly sort?: string;
2816
+ interface InventoryDetails {
2817
+ readonly key: Record<string, io.flow.flexe.v0.models.Sku>;
2918
2818
  }
2919
2819
 
2920
- interface LandedCostItem {
2921
- readonly number: string;
2922
- readonly origin: string;
2923
- readonly destination: string;
2820
+ interface LadingQuantity {
2821
+ readonly num_pallets: number;
2924
2822
  }
2925
2823
 
2926
- interface LocalizedItemPricesExportType {
2927
- readonly discriminator: 'localized_item_prices_export_type';
2928
- readonly since?: string;
2824
+ interface Order {
2825
+ readonly shipment_uuid: string;
2826
+ readonly purchase_order: string;
2827
+ readonly carrier: string;
2828
+ readonly service_type: string;
2829
+ readonly carrier_assigned_id: string;
2830
+ readonly name: string;
2831
+ readonly address_1: string;
2832
+ readonly address_2?: string;
2833
+ readonly address_3?: string;
2834
+ readonly city: string;
2835
+ readonly state: string;
2836
+ readonly postal_code: string;
2837
+ readonly phone?: string;
2838
+ readonly instructions?: string;
2839
+ readonly inventory_data: io.flow.flexe.v0.models.FlexeInventoryData[];
2840
+ readonly attachments: io.flow.flexe.v0.models.FlexeAttachment[];
2929
2841
  }
2930
2842
 
2931
- interface MarketingFeedsExportType {
2932
- readonly discriminator: 'marketing_feeds_export_type';
2933
- readonly organization: io.flow.common.v0.models.OrganizationReference;
2934
- readonly feed_ids: string[];
2843
+ interface Orders {
2844
+ readonly orders: io.flow.flexe.v0.models.Order[];
2935
2845
  }
2936
2846
 
2937
- interface OrderExportType {
2938
- readonly discriminator: 'order_export_type';
2939
- readonly numbers?: string[];
2940
- readonly min_hours_since_submitted_at?: number;
2941
- readonly submitted_on_or_before?: string;
2942
- readonly submitted_on_or_after?: string;
2943
- readonly status?: io.flow.experience.v0.enums.OrderStatus;
2944
- readonly has_tracking_label?: boolean;
2945
- readonly sort?: string;
2847
+ interface Pallet {
2848
+ readonly pallet_id: string;
2849
+ readonly sku: string;
2850
+ readonly quantity: number;
2851
+ readonly packaging: string;
2946
2852
  }
2947
2853
 
2948
- interface PriceBookItemExportType {
2949
- readonly discriminator: 'price_book_item_export_type';
2950
- readonly price_book_key?: string;
2951
- readonly item_numbers?: string[];
2952
- readonly start_date?: string;
2953
- readonly end_date?: string;
2954
- readonly item_identifier?: io.flow.RESERVED_WORD_export.v0.enums.ItemIdentifier;
2854
+ interface PurchaseOrder {
2855
+ readonly retail_fulfillment_order_id: string;
2856
+ readonly bill_of_lading_number: string;
2857
+ readonly purchase_order_uuid: string;
2858
+ readonly pickup_window_start: string;
2859
+ readonly pickup_window_end: string;
2860
+ readonly tags: string[];
2955
2861
  }
2956
2862
 
2957
- interface ScheduledExport {
2958
- readonly id: string;
2959
- readonly user: io.flow.common.v0.models.UserReference;
2960
- readonly organization_q: string;
2961
- readonly hour: number;
2962
- readonly minute: number;
2963
- readonly timezone: string;
2964
- readonly types: io.flow.RESERVED_WORD_export.v0.unions.ExportType[];
2965
- readonly last_sent_at?: string;
2863
+ interface QuantityByInventory {
2864
+ readonly received: io.flow.flexe.v0.models.InventoryData;
2865
+ readonly expected?: io.flow.flexe.v0.models.InventoryData;
2866
+ readonly damaged?: io.flow.flexe.v0.models.InventoryData;
2966
2867
  }
2967
2868
 
2968
- interface ScheduledExportForm {
2969
- readonly user_id: string;
2970
- readonly organization_q: string;
2971
- readonly hour: number;
2972
- readonly minute: number;
2973
- readonly timezone: string;
2974
- readonly types: io.flow.RESERVED_WORD_export.v0.unions.ExportType[];
2869
+ interface ReceiptNotification {
2870
+ readonly shipment_id: string;
2871
+ readonly shipment_type: io.flow.flexe.v0.enums.FlexeShipmentType;
2872
+ readonly reservation_id: string;
2873
+ readonly status: io.flow.flexe.v0.enums.FlexeStatus;
2874
+ readonly delivery_details?: io.flow.flexe.v0.models.DeliveryDetails;
2875
+ readonly container_delivery_details?: io.flow.flexe.v0.models.ContainerDeliveryDetails;
2975
2876
  }
2976
2877
 
2977
- interface SolidusProductExportType {
2978
- readonly discriminator: 'solidus_product_export_type';
2979
- readonly numbers?: string[];
2980
- readonly sort?: string;
2878
+ interface RetailFulfillmentOrderDetails {
2879
+ readonly master_bill_of_lading_number: string;
2880
+ readonly scac: string;
2881
+ readonly pro_number: string;
2882
+ readonly purchase_orders: io.flow.flexe.v0.models.PurchaseOrder[];
2883
+ readonly lading_quantity: io.flow.flexe.v0.models.LadingQuantity;
2981
2884
  }
2982
2885
 
2983
- interface SolidusVariantExportType {
2984
- readonly discriminator: 'solidus_variant_export_type';
2985
- readonly numbers?: string[];
2986
- readonly sort?: string;
2886
+ interface RetailInventoryData {
2887
+ readonly sku: string;
2888
+ readonly quantity: number;
2889
+ readonly unit: string;
2890
+ readonly attachments?: io.flow.flexe.v0.models.FlexeRetailAttachment[];
2987
2891
  }
2988
2892
 
2989
- interface UnharmonizedItemExportType {
2990
- readonly discriminator: 'unharmonized_item_export_type';
2991
- readonly sort?: string;
2893
+ interface RetailOrder {
2894
+ readonly order: io.flow.flexe.v0.models.RetailOrderData;
2992
2895
  }
2993
- }
2994
-
2995
- declare namespace io.flow.RESERVED_WORD_export.v0.unions {
2996
- type ExportDelivery = io.flow.RESERVED_WORD_export.v0.models.ExportDeliveryEmail;
2997
- type ExportType =
2998
- | io.flow.RESERVED_WORD_export.v0.models.AccountTransactionsExportType
2999
- | io.flow.RESERVED_WORD_export.v0.models.AccountOrdersExportType
3000
- | io.flow.RESERVED_WORD_export.v0.models.AnalyticsExportType
3001
- | io.flow.RESERVED_WORD_export.v0.models.CatalogItemExportType
3002
- | io.flow.RESERVED_WORD_export.v0.models.ExperienceExportType
3003
- | io.flow.RESERVED_WORD_export.v0.models.HarmonizationOverviewExportType
3004
- | io.flow.RESERVED_WORD_export.v0.models.HarmonizationHs6ExportType
3005
- | io.flow.RESERVED_WORD_export.v0.models.HarmonizationHs10ExportType
3006
- | io.flow.RESERVED_WORD_export.v0.models.HarmonizationTariffCodesExportType
3007
- | io.flow.RESERVED_WORD_export.v0.models.UnharmonizedItemExportType
3008
- | io.flow.RESERVED_WORD_export.v0.models.OrderExportType
3009
- | io.flow.RESERVED_WORD_export.v0.models.PriceBookItemExportType
3010
- | io.flow.RESERVED_WORD_export.v0.models.SolidusProductExportType
3011
- | io.flow.RESERVED_WORD_export.v0.models.SolidusVariantExportType
3012
- | io.flow.RESERVED_WORD_export.v0.models.LocalizedItemPricesExportType
3013
- | io.flow.RESERVED_WORD_export.v0.models.MarketingFeedsExportType
3014
- | io.flow.RESERVED_WORD_export.v0.models.ExclusionRulesExportType;
3015
- }
3016
-
3017
- declare namespace io.flow.flexe.v0.enums {
3018
- type FlexeAttachmentType =
3019
- | 'shipping_label'
3020
- | 'packing_slip'
3021
- | 'packing_slip_letter';
3022
- type FlexeNotification = 'receipt' | 'shipment';
3023
- type FlexeShipmentType =
3024
- | 'fulfillment_order'
3025
- | 'retail_fulfillment_order'
3026
- | 'carton_pick_delivery'
3027
- | 'delivery'
3028
- | 'container_delivery';
3029
- type FlexeStatus = 'in_transit' | 'completed';
3030
- }
3031
2896
 
3032
- declare namespace io.flow.flexe.v0.models {
3033
- interface BillOfLading {
3034
- readonly type: string;
3035
- readonly gs1us?: io.flow.flexe.v0.models.Gs1Us;
2897
+ interface RetailOrderData {
2898
+ readonly purchase_order_uuid: string;
2899
+ readonly bill_of_lading: io.flow.flexe.v0.models.BillOfLading;
2900
+ readonly inventory_data: io.flow.flexe.v0.models.RetailInventoryData[];
2901
+ readonly ship_within: io.flow.flexe.v0.models.ShipWithin;
2902
+ readonly ship_to: io.flow.flexe.v0.models.ShipTo;
2903
+ readonly build_by?: string;
2904
+ readonly instrunctions?: string;
2905
+ readonly routing_details_id?: string;
2906
+ readonly destination_type?: string;
3036
2907
  }
3037
2908
 
3038
- interface BillTo {
2909
+ interface ShipTo {
3039
2910
  readonly name: string;
3040
2911
  readonly address_1: string;
3041
2912
  readonly locality: string;
@@ -3046,285 +2917,38 @@ declare namespace io.flow.flexe.v0.models {
3046
2917
  readonly address_3?: string;
3047
2918
  }
3048
2919
 
3049
- interface CartonPickDeliveryDetails {
3050
- readonly shipment_uuid?: string;
3051
- readonly carrier?: string;
3052
- readonly carrier_id?: string;
3053
- }
3054
-
3055
- interface ContainerDeliveryDetails {
3056
- readonly purchase_order: string;
3057
- readonly container_number?: string;
3058
- readonly seal_number?: string;
3059
- readonly vendor?: string;
3060
- readonly expected_inventory: io.flow.flexe.v0.models.InventoryDetails[];
3061
- readonly received_inventory: io.flow.flexe.v0.models.InventoryDetails[];
3062
- readonly damaged_inventory: io.flow.flexe.v0.models.InventoryDetails[];
3063
- readonly quantities_by_inventory: Record<
3064
- string,
3065
- io.flow.flexe.v0.models.QuantityByInventory
3066
- >;
2920
+ interface ShipWithin {
2921
+ readonly start: string;
2922
+ readonly end: string;
3067
2923
  }
3068
2924
 
3069
- interface DeliveryDetails {
2925
+ interface ShipmentDeliveryDetails {
3070
2926
  readonly shipment_uuid?: string;
3071
- readonly trailer_number?: string;
3072
- readonly pallets: io.flow.flexe.v0.models.Pallet[];
3073
- readonly quantities_by_inventory: Record<
3074
- string,
3075
- io.flow.flexe.v0.models.QuantityByInventory
3076
- >;
3077
- }
3078
-
3079
- interface Error {
3080
- readonly url: string;
3081
- readonly client_request_id: string;
3082
- readonly generated_at: string;
3083
- readonly error: string;
3084
- }
3085
-
3086
- interface FlexeAttachment {
3087
- readonly type: io.flow.flexe.v0.enums.FlexeAttachmentType;
3088
- readonly display_name: string;
3089
- readonly url: string;
3090
- }
3091
-
3092
- interface FlexeEcommerceFulfillment {
3093
- readonly url: string;
3094
- readonly client_request_id: string;
3095
- readonly generated_at: string;
3096
- readonly data: io.flow.flexe.v0.models.FlexeEcommerceFulfillmentData;
3097
- readonly errors: io.flow.flexe.v0.models.FlexeEcommerceFulfillmentErrors[];
3098
- }
3099
-
3100
- interface FlexeEcommerceFulfillmentData {
3101
- readonly import_id: string;
3102
- readonly succeeded_uuids: string[];
3103
- readonly failed_uuids: string[];
3104
- readonly errors: string[];
3105
- }
3106
-
3107
- interface FlexeEcommerceFulfillmentErrors {
3108
- readonly status: string;
3109
- readonly title: string;
3110
- readonly detail: string;
3111
- readonly source?: string;
3112
2927
  }
3113
2928
 
3114
- interface FlexeEcommerceFulfillmentForm {
3115
- readonly reservation_id: number;
3116
- readonly client_request_id: string;
3117
- readonly request: io.flow.flexe.v0.models.Orders;
2929
+ interface ShipmentNotification {
2930
+ readonly shipment_id: string;
2931
+ readonly shipment_type: io.flow.flexe.v0.enums.FlexeShipmentType;
2932
+ readonly reservation_id: string;
2933
+ readonly status: io.flow.flexe.v0.enums.FlexeStatus;
2934
+ readonly fulfillment_order_details?: io.flow.flexe.v0.models.FulfillmentOrderDetails;
2935
+ readonly retail_fulfillment_order_details?: io.flow.flexe.v0.models.RetailFulfillmentOrderDetails;
2936
+ readonly delivery_details?: io.flow.flexe.v0.models.ShipmentDeliveryDetails;
2937
+ readonly carton_pick_delivery_details?: io.flow.flexe.v0.models.CartonPickDeliveryDetails;
3118
2938
  }
3119
2939
 
3120
- interface FlexeInventoryData {
2940
+ interface Sku {
3121
2941
  readonly sku: string;
3122
- readonly quantity: string;
3123
- readonly unit: string;
3124
- }
3125
-
3126
- interface FlexeRetailAttachment {
3127
- readonly display_name: string;
3128
- readonly url: string;
3129
- }
3130
-
3131
- interface FlexeRetailFulfillment {
3132
- readonly url: string;
3133
- readonly client_request_id: string;
3134
- readonly generated_at: string;
3135
- readonly data: io.flow.flexe.v0.models.FlexeRetailFulfillmentData;
3136
- readonly errors?: io.flow.flexe.v0.models.FlexeRetailFulfillmentErrors[];
3137
- }
3138
-
3139
- interface FlexeRetailFulfillmentData {
3140
- readonly id: string;
3141
- readonly purchase_order_uuid: string;
3142
- readonly status: string;
3143
- }
3144
-
3145
- interface FlexeRetailFulfillmentErrors {
3146
- readonly type: string;
3147
- readonly message: string;
3148
- }
3149
-
3150
- interface FlexeRetailFulfillmentForm {
3151
- readonly reservation_id: number;
3152
- readonly client_request_id?: string;
3153
- readonly request: io.flow.flexe.v0.models.RetailOrder;
3154
- }
3155
-
3156
- interface FulfillmentOrderDetails {
3157
- readonly shipment_uuid: string;
3158
- readonly carrier?: string;
3159
- readonly carrier_id?: string;
3160
- }
3161
-
3162
- interface Gs1Us {
3163
- readonly number: string;
3164
- readonly ship_to?: io.flow.flexe.v0.models.Gs1UsShipTo;
3165
- readonly bill_to?: io.flow.flexe.v0.models.BillTo;
3166
- }
3167
-
3168
- interface Gs1UsShipTo {
3169
- readonly cid_number?: string;
3170
- readonly location_number?: string;
3171
- readonly free_on_board?: boolean;
3172
- }
3173
-
3174
- interface Inventory {
3175
- readonly url: string;
3176
- readonly client_request_id: string;
3177
- readonly generated_at: string;
3178
- readonly data: Record<string, io.flow.flexe.v0.models.InventoryDetails>;
2942
+ readonly description: string;
2943
+ readonly summary: Record<string, io.flow.flexe.v0.models.SkuSummary>;
3179
2944
  }
3180
2945
 
3181
- interface InventoryCount {
3182
- readonly amount: number;
2946
+ interface SkuSummary {
2947
+ readonly key: string;
2948
+ readonly quantity: number;
3183
2949
  readonly unit: string;
3184
2950
  }
3185
-
3186
- interface InventoryData {
3187
- readonly pallet: io.flow.flexe.v0.models.InventoryCount;
3188
- readonly carton?: io.flow.flexe.v0.models.InventoryCount;
3189
- readonly each?: io.flow.flexe.v0.models.InventoryCount;
3190
- }
3191
-
3192
- interface InventoryDetails {
3193
- readonly key: Record<string, io.flow.flexe.v0.models.Sku>;
3194
- }
3195
-
3196
- interface LadingQuantity {
3197
- readonly num_pallets: number;
3198
- }
3199
-
3200
- interface Order {
3201
- readonly shipment_uuid: string;
3202
- readonly purchase_order: string;
3203
- readonly carrier: string;
3204
- readonly service_type: string;
3205
- readonly carrier_assigned_id: string;
3206
- readonly name: string;
3207
- readonly address_1: string;
3208
- readonly address_2?: string;
3209
- readonly address_3?: string;
3210
- readonly city: string;
3211
- readonly state: string;
3212
- readonly postal_code: string;
3213
- readonly phone?: string;
3214
- readonly instructions?: string;
3215
- readonly inventory_data: io.flow.flexe.v0.models.FlexeInventoryData[];
3216
- readonly attachments: io.flow.flexe.v0.models.FlexeAttachment[];
3217
- }
3218
-
3219
- interface Orders {
3220
- readonly orders: io.flow.flexe.v0.models.Order[];
3221
- }
3222
-
3223
- interface Pallet {
3224
- readonly pallet_id: string;
3225
- readonly sku: string;
3226
- readonly quantity: number;
3227
- readonly packaging: string;
3228
- }
3229
-
3230
- interface PurchaseOrder {
3231
- readonly retail_fulfillment_order_id: string;
3232
- readonly bill_of_lading_number: string;
3233
- readonly purchase_order_uuid: string;
3234
- readonly pickup_window_start: string;
3235
- readonly pickup_window_end: string;
3236
- readonly tags: string[];
3237
- }
3238
-
3239
- interface QuantityByInventory {
3240
- readonly received: io.flow.flexe.v0.models.InventoryData;
3241
- readonly expected?: io.flow.flexe.v0.models.InventoryData;
3242
- readonly damaged?: io.flow.flexe.v0.models.InventoryData;
3243
- }
3244
-
3245
- interface ReceiptNotification {
3246
- readonly shipment_id: string;
3247
- readonly shipment_type: io.flow.flexe.v0.enums.FlexeShipmentType;
3248
- readonly reservation_id: string;
3249
- readonly status: io.flow.flexe.v0.enums.FlexeStatus;
3250
- readonly delivery_details?: io.flow.flexe.v0.models.DeliveryDetails;
3251
- readonly container_delivery_details?: io.flow.flexe.v0.models.ContainerDeliveryDetails;
3252
- }
3253
-
3254
- interface RetailFulfillmentOrderDetails {
3255
- readonly master_bill_of_lading_number: string;
3256
- readonly scac: string;
3257
- readonly pro_number: string;
3258
- readonly purchase_orders: io.flow.flexe.v0.models.PurchaseOrder[];
3259
- readonly lading_quantity: io.flow.flexe.v0.models.LadingQuantity;
3260
- }
3261
-
3262
- interface RetailInventoryData {
3263
- readonly sku: string;
3264
- readonly quantity: number;
3265
- readonly unit: string;
3266
- readonly attachments?: io.flow.flexe.v0.models.FlexeRetailAttachment[];
3267
- }
3268
-
3269
- interface RetailOrder {
3270
- readonly order: io.flow.flexe.v0.models.RetailOrderData;
3271
- }
3272
-
3273
- interface RetailOrderData {
3274
- readonly purchase_order_uuid: string;
3275
- readonly bill_of_lading: io.flow.flexe.v0.models.BillOfLading;
3276
- readonly inventory_data: io.flow.flexe.v0.models.RetailInventoryData[];
3277
- readonly ship_within: io.flow.flexe.v0.models.ShipWithin;
3278
- readonly ship_to: io.flow.flexe.v0.models.ShipTo;
3279
- readonly build_by?: string;
3280
- readonly instrunctions?: string;
3281
- readonly routing_details_id?: string;
3282
- readonly destination_type?: string;
3283
- }
3284
-
3285
- interface ShipTo {
3286
- readonly name: string;
3287
- readonly address_1: string;
3288
- readonly locality: string;
3289
- readonly region: string;
3290
- readonly postal_code: string;
3291
- readonly country: string;
3292
- readonly address_2?: string;
3293
- readonly address_3?: string;
3294
- }
3295
-
3296
- interface ShipWithin {
3297
- readonly start: string;
3298
- readonly end: string;
3299
- }
3300
-
3301
- interface ShipmentDeliveryDetails {
3302
- readonly shipment_uuid?: string;
3303
- }
3304
-
3305
- interface ShipmentNotification {
3306
- readonly shipment_id: string;
3307
- readonly shipment_type: io.flow.flexe.v0.enums.FlexeShipmentType;
3308
- readonly reservation_id: string;
3309
- readonly status: io.flow.flexe.v0.enums.FlexeStatus;
3310
- readonly fulfillment_order_details?: io.flow.flexe.v0.models.FulfillmentOrderDetails;
3311
- readonly retail_fulfillment_order_details?: io.flow.flexe.v0.models.RetailFulfillmentOrderDetails;
3312
- readonly delivery_details?: io.flow.flexe.v0.models.ShipmentDeliveryDetails;
3313
- readonly carton_pick_delivery_details?: io.flow.flexe.v0.models.CartonPickDeliveryDetails;
3314
- }
3315
-
3316
- interface Sku {
3317
- readonly sku: string;
3318
- readonly description: string;
3319
- readonly summary: Record<string, io.flow.flexe.v0.models.SkuSummary>;
3320
- }
3321
-
3322
- interface SkuSummary {
3323
- readonly key: string;
3324
- readonly quantity: number;
3325
- readonly unit: string;
3326
- }
3327
- }
2951
+ }
3328
2952
 
3329
2953
  declare namespace io.flow.payment.v0.enums {
3330
2954
  type AuthorizationDeclineCode =
@@ -8313,6 +7937,7 @@ declare namespace io.flow.shopify.markets.v0.models {
8313
7937
  readonly transactions?: io.flow.shopify.markets.v0.models.ShopifyOrderTransaction[];
8314
7938
  readonly send_receipt?: boolean;
8315
7939
  readonly metafields?: io.flow.shopify.markets.v0.models.ShopifyOrderMetafield[];
7940
+ readonly payment_request_id?: string;
8316
7941
  }
8317
7942
 
8318
7943
  interface ShopifyOrderAddress {
@@ -9462,119 +9087,593 @@ declare namespace io.flow.order.management.event.v0.models {
9462
9087
  readonly total: io.flow.common.v0.models.PriceWithBase;
9463
9088
  }
9464
9089
 
9465
- interface OrderPlaced {
9466
- readonly discriminator: 'order_placed';
9467
- readonly event_id: string;
9090
+ interface OrderPlaced {
9091
+ readonly discriminator: 'order_placed';
9092
+ readonly event_id: string;
9093
+ readonly timestamp: string;
9094
+ readonly organization: string;
9095
+ readonly order_number: string;
9096
+ readonly order: io.flow.experience.v0.models.Order;
9097
+ readonly allocation: io.flow.experience.v0.models.AllocationV2;
9098
+ }
9099
+
9100
+ interface OrderPlacedV2 {
9101
+ readonly discriminator: 'order_placed_v2';
9102
+ readonly event_id: string;
9103
+ readonly timestamp: string;
9104
+ readonly organization: string;
9105
+ readonly order_placed: io.flow.order.management.v0.models.OrderPlacedDetails;
9106
+ }
9107
+
9108
+ interface ReadyToFulfill {
9109
+ readonly discriminator: 'ready_to_fulfill';
9110
+ readonly event_id: string;
9111
+ readonly timestamp: string;
9112
+ readonly organization: string;
9113
+ readonly order_number: string;
9114
+ readonly order: io.flow.experience.v0.models.Order;
9115
+ readonly fulfillments?: io.flow.order.management.v0.models.Fulfillment[];
9116
+ readonly fulfillment_item_allocation_details?: io.flow.order.management.event.v0.models.FulfillmentItemAllocationDetails[];
9117
+ }
9118
+
9119
+ interface ReadyToFulfillDetails {
9120
+ readonly id: string;
9121
+ readonly order_number: string;
9122
+ readonly order: io.flow.experience.v0.models.Order;
9123
+ readonly fulfillments?: io.flow.order.management.v0.models.Fulfillment[];
9124
+ readonly fulfillment_item_allocation_details?: io.flow.order.management.event.v0.models.FulfillmentItemAllocationDetails[];
9125
+ }
9126
+
9127
+ interface ReadyToFulfillV2 {
9128
+ readonly discriminator: 'ready_to_fulfill_v2';
9129
+ readonly event_id: string;
9130
+ readonly timestamp: string;
9131
+ readonly organization: string;
9132
+ readonly ready_to_fulfill: io.flow.order.management.event.v0.models.ReadyToFulfillDetails;
9133
+ }
9134
+ }
9135
+
9136
+ declare namespace io.flow.order.management.event.v0.unions {
9137
+ type OrderManagementEvent =
9138
+ | io.flow.order.management.event.v0.models.OrderPlaced
9139
+ | io.flow.order.management.event.v0.models.OrderPlacedV2
9140
+ | io.flow.order.management.event.v0.models.ReadyToFulfill
9141
+ | io.flow.order.management.event.v0.models.ReadyToFulfillV2;
9142
+ }
9143
+
9144
+ declare namespace io.flow.ftp.v0.enums {
9145
+ type FtpFileSource = 'flow' | 'organization';
9146
+ }
9147
+
9148
+ declare namespace io.flow.ftp.v0.models {
9149
+ interface FtpAccount {
9150
+ readonly server: io.flow.ftp.v0.models.FtpServer;
9151
+ readonly user: io.flow.ftp.v0.models.FtpUser;
9152
+ }
9153
+
9154
+ interface FtpFile {
9155
+ readonly id: string;
9156
+ readonly source: io.flow.ftp.v0.enums.FtpFileSource;
9157
+ readonly name: string;
9158
+ readonly directory: string;
9159
+ readonly url: string;
9160
+ readonly created_at: string;
9161
+ }
9162
+
9163
+ interface FtpFileForm {
9164
+ readonly url: string;
9165
+ readonly directory: string;
9166
+ readonly name?: string;
9167
+ }
9168
+
9169
+ interface FtpFolder {
9170
+ readonly id: string;
9171
+ readonly path: string;
9172
+ readonly webhook: boolean;
9173
+ readonly description?: string;
9174
+ }
9175
+
9176
+ interface FtpFolderForm {
9177
+ readonly path: string;
9178
+ readonly webhook: boolean;
9179
+ readonly description?: string;
9180
+ }
9181
+
9182
+ interface FtpOrganizationSettings {
9183
+ readonly enabled: boolean;
9184
+ readonly emails: string[];
9185
+ readonly account?: io.flow.ftp.v0.models.FtpAccount;
9186
+ }
9187
+
9188
+ interface FtpOrganizationSettingsForm {
9189
+ readonly enabled: boolean;
9190
+ readonly emails: string[];
9191
+ }
9192
+
9193
+ interface FtpServer {
9194
+ readonly hostname: string;
9195
+ }
9196
+
9197
+ interface FtpUser {
9198
+ readonly username: string;
9199
+ readonly password?: string;
9200
+ }
9201
+ }
9202
+
9203
+ declare namespace io.flow.ratecard.v0.models {
9204
+ interface CrossdockRatecardFee {
9205
+ readonly discriminator: 'crossdock_ratecard_fee';
9206
+ readonly amount: io.flow.common.v0.models.Money;
9207
+ }
9208
+
9209
+ interface DdpRatecardFee {
9210
+ readonly discriminator: 'ddp_ratecard_fee';
9211
+ readonly amount: number;
9212
+ }
9213
+
9214
+ interface DimensionEstimate {
9215
+ readonly id: string;
9216
+ readonly q: string;
9217
+ readonly dimensions: io.flow.ratecard.v0.models.EstimatedDimensions;
9218
+ readonly position: number;
9219
+ }
9220
+
9221
+ interface DimensionEstimateForm {
9222
+ readonly q: string;
9223
+ readonly dimensions: io.flow.ratecard.v0.models.EstimatedDimensions;
9224
+ readonly position?: number;
9225
+ }
9226
+
9227
+ interface DimensionEstimateVersion {
9228
+ readonly id: string;
9229
+ readonly timestamp: string;
9230
+ readonly type: io.flow.common.v0.enums.ChangeType;
9231
+ readonly dimension_estimate: io.flow.ratecard.v0.models.DimensionEstimate;
9232
+ }
9233
+
9234
+ interface DutiesTaxesPaidSurchargeRatecardFee {
9235
+ readonly discriminator: 'duties_taxes_paid_surcharge_ratecard_fee';
9236
+ readonly amount: io.flow.common.v0.models.Money;
9237
+ readonly starts_at?: string;
9238
+ readonly ends_at?: string;
9239
+ }
9240
+
9241
+ interface DutiesTaxesPaidSurchargeServiceFee {
9242
+ readonly discriminator: 'duties_taxes_paid_surcharge_service_fee';
9243
+ readonly amount: io.flow.common.v0.models.Money;
9244
+ readonly starts_at?: string;
9245
+ readonly ends_at?: string;
9246
+ }
9247
+
9248
+ interface EmergencySituationSurchargeRatecardFee {
9249
+ readonly discriminator: 'emergency_situation_surcharge_ratecard_fee';
9250
+ readonly amount: io.flow.common.v0.models.Money;
9251
+ }
9252
+
9253
+ interface EmergencySituationSurchargeServiceFee {
9254
+ readonly discriminator: 'emergency_situation_surcharge_service_fee';
9255
+ readonly amount: io.flow.common.v0.models.Money;
9256
+ readonly origin_region?: io.flow.ratecard.v0.models.RatecardRegionReference;
9257
+ readonly destination_region?: io.flow.ratecard.v0.models.RatecardRegionReference;
9258
+ readonly interval_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
9259
+ }
9260
+
9261
+ interface EstimatedDimensions {
9262
+ readonly depth: io.flow.common.v0.models.Measurement;
9263
+ readonly length: io.flow.common.v0.models.Measurement;
9264
+ readonly weight: io.flow.common.v0.models.Measurement;
9265
+ readonly width: io.flow.common.v0.models.Measurement;
9266
+ }
9267
+
9268
+ interface FeeWeight {
9269
+ readonly weight: number;
9270
+ readonly unit: io.flow.common.v0.enums.UnitOfMeasurement;
9271
+ }
9272
+
9273
+ interface FuelSurchargeRatecardFee {
9274
+ readonly discriminator: 'fuel_surcharge_ratecard_fee';
9275
+ readonly amount: io.flow.common.v0.models.Money;
9276
+ }
9277
+
9278
+ interface FuelSurchargeServiceFee {
9279
+ readonly discriminator: 'fuel_surcharge_service_fee';
9280
+ readonly percent: number;
9281
+ }
9282
+
9283
+ interface Hop {
9284
+ readonly hop_number: number;
9285
+ readonly hop_estimate: io.flow.ratecard.v0.models.HopEstimate;
9286
+ }
9287
+
9288
+ interface HopEstimate {
9289
+ readonly origin_address: io.flow.fulfillment.v0.models.ShippingAddress;
9290
+ readonly destination_address: io.flow.fulfillment.v0.models.ShippingAddress;
9291
+ readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
9292
+ readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
9293
+ readonly currency: string;
9294
+ readonly amount: number;
9295
+ readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
9296
+ readonly total: number;
9297
+ }
9298
+
9299
+ interface OversizedShipmentRatecardFee {
9300
+ readonly discriminator: 'oversized_shipment_ratecard_fee';
9301
+ readonly weight_threshold: number;
9302
+ readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9303
+ readonly margin?: number;
9304
+ readonly amount?: number;
9305
+ }
9306
+
9307
+ interface PeakSurchargeByWeightServiceFee {
9308
+ readonly discriminator: 'peak_surcharge_by_weight_service_fee';
9309
+ readonly amount: io.flow.common.v0.models.Money;
9310
+ readonly weight: io.flow.ratecard.v0.models.FeeWeight;
9311
+ readonly regions?: string[];
9312
+ readonly starts_at?: string;
9313
+ readonly ends_at?: string;
9314
+ }
9315
+
9316
+ interface PeakSurchargeRatecardFee {
9317
+ readonly discriminator: 'peak_surcharge_ratecard_fee';
9318
+ readonly amount: io.flow.common.v0.models.Money;
9319
+ readonly starts_at?: string;
9320
+ readonly ends_at?: string;
9321
+ }
9322
+
9323
+ interface PeakSurchargeServiceFee {
9324
+ readonly discriminator: 'peak_surcharge_service_fee';
9325
+ readonly amount: io.flow.common.v0.models.Money;
9326
+ readonly starts_at?: string;
9327
+ readonly ends_at?: string;
9328
+ }
9329
+
9330
+ interface Ratecard {
9331
+ readonly id: string;
9332
+ readonly number: string;
9333
+ readonly direction: io.flow.label.v0.enums.Direction;
9334
+ readonly effective_at: string;
9335
+ readonly origination_zones: io.flow.common.v0.models.Zone[];
9336
+ readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
9337
+ readonly published_at?: string;
9338
+ readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
9339
+ }
9340
+
9341
+ interface RatecardCarrierSummary {
9342
+ readonly id: string;
9343
+ readonly name: string;
9344
+ }
9345
+
9346
+ interface RatecardEstimateFormV1 {
9347
+ readonly discriminator: 'ratecard_estimate_form_v1';
9348
+ readonly origin?: string;
9349
+ readonly destination?: string;
9350
+ readonly weight_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
9351
+ readonly distance_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
9352
+ readonly service?: string;
9353
+ readonly weight?: number;
9354
+ readonly length?: number;
9355
+ readonly width?: number;
9356
+ readonly depth?: number;
9357
+ readonly delivered_duty?: io.flow.common.v0.enums.DeliveredDuty;
9358
+ readonly line_items?: io.flow.common.v0.models.LineItemForm[];
9359
+ }
9360
+
9361
+ interface RatecardEstimateFormV2 {
9362
+ readonly discriminator: 'ratecard_estimate_form_v2';
9363
+ readonly origin_address: io.flow.common.v0.models.Address;
9364
+ readonly destination_address: io.flow.common.v0.models.Address;
9365
+ readonly weight_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
9366
+ readonly distance_unit?: io.flow.common.v0.enums.UnitOfMeasurement;
9367
+ readonly service?: string;
9368
+ readonly weight?: number;
9369
+ readonly length?: number;
9370
+ readonly width?: number;
9371
+ readonly depth?: number;
9372
+ readonly delivered_duty?: io.flow.common.v0.enums.DeliveredDuty;
9373
+ readonly line_items?: io.flow.common.v0.models.LineItemForm[];
9374
+ readonly center_id?: string;
9375
+ }
9376
+
9377
+ interface RatecardEstimateSummaryForm {
9378
+ readonly origin?: string;
9379
+ readonly destination?: string;
9380
+ readonly service?: string;
9381
+ readonly center_key?: string;
9382
+ }
9383
+
9384
+ interface RatecardEstimateV1 {
9385
+ readonly discriminator: 'ratecard_estimate_v1';
9386
+ readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
9387
+ readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
9388
+ readonly currency: string;
9389
+ readonly amount: number;
9390
+ readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
9391
+ readonly total: number;
9392
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9393
+ readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
9394
+ readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
9395
+ readonly line_items?: io.flow.common.v0.models.LineItemForm[];
9396
+ }
9397
+
9398
+ interface RatecardEstimateV2 {
9399
+ readonly discriminator: 'ratecard_estimate_v2';
9400
+ readonly hops: io.flow.ratecard.v0.models.Hop[];
9401
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9402
+ readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
9403
+ readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
9404
+ readonly line_items?: io.flow.common.v0.models.LineItemForm[];
9405
+ readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
9406
+ }
9407
+
9408
+ interface RatecardEstimateV3 {
9409
+ readonly discriminator: 'ratecard_estimate_v3';
9410
+ readonly hops: io.flow.ratecard.v0.models.Hop[];
9411
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9412
+ readonly dimensional_weight?: io.flow.common.v0.models.Measurement;
9413
+ readonly gravitational_weight?: io.flow.common.v0.models.Measurement;
9414
+ readonly line_items?: io.flow.common.v0.models.LineItemForm[];
9415
+ readonly ratecard: io.flow.ratecard.v0.models.RatecardSummary;
9416
+ }
9417
+
9418
+ interface RatecardForm {
9419
+ readonly direction: io.flow.label.v0.enums.Direction;
9420
+ readonly effective_at: string;
9421
+ readonly origination_zones: io.flow.common.v0.models.Zone[];
9422
+ readonly service: string;
9423
+ readonly number?: string;
9424
+ readonly ratecard_owner?: io.flow.fulfillment.v0.enums.RatecardOwner;
9425
+ }
9426
+
9427
+ interface RatecardLane {
9428
+ readonly id: string;
9429
+ readonly ratecard: io.flow.ratecard.v0.models.RatecardSummary;
9430
+ readonly currency: string;
9431
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9432
+ readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
9433
+ readonly destination: io.flow.common.v0.models.Zone;
9434
+ readonly dim_factor: number;
9435
+ readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
9436
+ readonly origin: io.flow.common.v0.models.Zone;
9437
+ readonly service: io.flow.ratecard.v0.models.RatecardServiceSummary;
9438
+ readonly rates: io.flow.ratecard.v0.models.RatecardRate[];
9439
+ readonly rounding: io.flow.common.v0.models.Rounding;
9440
+ readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9441
+ readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9442
+ }
9443
+
9444
+ interface RatecardLaneForm {
9445
+ readonly ratecard_id: string;
9446
+ readonly currency: string;
9447
+ readonly destination: io.flow.common.v0.models.Zone;
9448
+ readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
9449
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9450
+ readonly dim_factor: number;
9451
+ readonly fees: io.flow.ratecard.v0.unions.RatecardFee[];
9452
+ readonly origin: io.flow.common.v0.models.Zone;
9453
+ readonly rounding: io.flow.common.v0.models.Rounding;
9454
+ readonly rates: io.flow.ratecard.v0.models.RatecardRateForm[];
9455
+ readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9456
+ readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9457
+ }
9458
+
9459
+ interface RatecardLaneImportForm {
9460
+ readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
9461
+ readonly service: string;
9462
+ readonly currency: string;
9463
+ readonly delivered_duty: io.flow.common.v0.enums.DeliveredDuty;
9464
+ readonly origin: io.flow.common.v0.models.Zone;
9465
+ readonly destination: io.flow.common.v0.models.Zone;
9466
+ readonly shipment_window: io.flow.ratecard.v0.models.ShipmentWindow;
9467
+ readonly dim_factor: number;
9468
+ readonly weight_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9469
+ readonly distance_unit: io.flow.common.v0.enums.UnitOfMeasurement;
9470
+ readonly rates: io.flow.ratecard.v0.models.RatecardRateForm[];
9471
+ }
9472
+
9473
+ interface RatecardLaneVersion {
9474
+ readonly id: string;
9468
9475
  readonly timestamp: string;
9469
- readonly organization: string;
9470
- readonly order_number: string;
9471
- readonly order: io.flow.experience.v0.models.Order;
9472
- readonly allocation: io.flow.experience.v0.models.AllocationV2;
9476
+ readonly type: io.flow.common.v0.enums.ChangeType;
9477
+ readonly ratecard_lane: io.flow.ratecard.v0.models.RatecardLane;
9473
9478
  }
9474
9479
 
9475
- interface OrderPlacedV2 {
9476
- readonly discriminator: 'order_placed_v2';
9477
- readonly event_id: string;
9478
- readonly timestamp: string;
9479
- readonly organization: string;
9480
- readonly order_placed: io.flow.order.management.v0.models.OrderPlacedDetails;
9480
+ interface RatecardLanesImportRequestData {
9481
+ readonly id: string;
9482
+ readonly source_url: string;
9483
+ readonly filename?: string;
9481
9484
  }
9482
9485
 
9483
- interface ReadyToFulfill {
9484
- readonly discriminator: 'ready_to_fulfill';
9485
- readonly event_id: string;
9486
+ interface RatecardRate {
9487
+ readonly id: string;
9488
+ readonly amount: number;
9489
+ readonly weight: number;
9490
+ }
9491
+
9492
+ interface RatecardRateForm {
9493
+ readonly amount: number;
9494
+ readonly weight: number;
9495
+ }
9496
+
9497
+ interface RatecardRateVersion {
9498
+ readonly id: string;
9486
9499
  readonly timestamp: string;
9487
- readonly organization: string;
9488
- readonly order_number: string;
9489
- readonly order: io.flow.experience.v0.models.Order;
9490
- readonly fulfillments?: io.flow.order.management.v0.models.Fulfillment[];
9491
- readonly fulfillment_item_allocation_details?: io.flow.order.management.event.v0.models.FulfillmentItemAllocationDetails[];
9500
+ readonly type: io.flow.common.v0.enums.ChangeType;
9501
+ readonly ratecard_rate: io.flow.ratecard.v0.models.RatecardRate;
9492
9502
  }
9493
9503
 
9494
- interface ReadyToFulfillDetails {
9504
+ interface RatecardReference {
9495
9505
  readonly id: string;
9496
- readonly order_number: string;
9497
- readonly order: io.flow.experience.v0.models.Order;
9498
- readonly fulfillments?: io.flow.order.management.v0.models.Fulfillment[];
9499
- readonly fulfillment_item_allocation_details?: io.flow.order.management.event.v0.models.FulfillmentItemAllocationDetails[];
9500
9506
  }
9501
9507
 
9502
- interface ReadyToFulfillV2 {
9503
- readonly discriminator: 'ready_to_fulfill_v2';
9504
- readonly event_id: string;
9508
+ interface RatecardRegionReference {
9509
+ readonly id: string;
9510
+ }
9511
+
9512
+ interface RatecardServiceSummary {
9513
+ readonly id: string;
9514
+ readonly name: string;
9515
+ readonly carrier: io.flow.ratecard.v0.models.RatecardCarrierSummary;
9516
+ }
9517
+
9518
+ interface RatecardSummary {
9519
+ readonly id: string;
9520
+ readonly number: string;
9521
+ readonly ratecard_owner: io.flow.fulfillment.v0.enums.RatecardOwner;
9522
+ }
9523
+
9524
+ interface RatecardVersion {
9525
+ readonly id: string;
9505
9526
  readonly timestamp: string;
9506
- readonly organization: string;
9507
- readonly ready_to_fulfill: io.flow.order.management.event.v0.models.ReadyToFulfillDetails;
9527
+ readonly type: io.flow.common.v0.enums.ChangeType;
9528
+ readonly ratecard: io.flow.ratecard.v0.models.Ratecard;
9508
9529
  }
9509
- }
9510
9530
 
9511
- declare namespace io.flow.order.management.event.v0.unions {
9512
- type OrderManagementEvent =
9513
- | io.flow.order.management.event.v0.models.OrderPlaced
9514
- | io.flow.order.management.event.v0.models.OrderPlacedV2
9515
- | io.flow.order.management.event.v0.models.ReadyToFulfill
9516
- | io.flow.order.management.event.v0.models.ReadyToFulfillV2;
9531
+ interface RemoteAreaRatecardFee {
9532
+ readonly discriminator: 'remote_area_ratecard_fee';
9533
+ readonly amount: io.flow.common.v0.models.Money;
9534
+ }
9535
+
9536
+ interface RemoteAreaServiceFee {
9537
+ readonly discriminator: 'remote_area_service_fee';
9538
+ readonly amount: io.flow.common.v0.models.Money;
9539
+ }
9540
+
9541
+ interface ReturnPackageRatecardFee {
9542
+ readonly discriminator: 'return_package_ratecard_fee';
9543
+ readonly amount: number;
9544
+ }
9545
+
9546
+ interface ShipmentWindow {
9547
+ readonly from: number;
9548
+ readonly to: number;
9549
+ }
9517
9550
  }
9518
9551
 
9519
- declare namespace io.flow.ftp.v0.enums {
9520
- type FtpFileSource = 'flow' | 'organization';
9552
+ declare namespace io.flow.ratecard.v0.unions {
9553
+ type RatecardEstimate =
9554
+ | io.flow.ratecard.v0.models.RatecardEstimateV1
9555
+ | io.flow.ratecard.v0.models.RatecardEstimateV2
9556
+ | io.flow.ratecard.v0.models.RatecardEstimateV3;
9557
+ type RatecardEstimateForm =
9558
+ | io.flow.ratecard.v0.models.RatecardEstimateFormV1
9559
+ | io.flow.ratecard.v0.models.RatecardEstimateFormV2;
9560
+ type RatecardFee =
9561
+ | io.flow.ratecard.v0.models.DdpRatecardFee
9562
+ | io.flow.ratecard.v0.models.FuelSurchargeRatecardFee
9563
+ | io.flow.ratecard.v0.models.OversizedShipmentRatecardFee
9564
+ | io.flow.ratecard.v0.models.ReturnPackageRatecardFee
9565
+ | io.flow.ratecard.v0.models.CrossdockRatecardFee
9566
+ | io.flow.ratecard.v0.models.RemoteAreaRatecardFee
9567
+ | io.flow.ratecard.v0.models.EmergencySituationSurchargeRatecardFee
9568
+ | io.flow.ratecard.v0.models.PeakSurchargeRatecardFee
9569
+ | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeRatecardFee;
9570
+ type ServiceFee =
9571
+ | io.flow.ratecard.v0.models.FuelSurchargeServiceFee
9572
+ | io.flow.ratecard.v0.models.RemoteAreaServiceFee
9573
+ | io.flow.ratecard.v0.models.EmergencySituationSurchargeServiceFee
9574
+ | io.flow.ratecard.v0.models.PeakSurchargeServiceFee
9575
+ | io.flow.ratecard.v0.models.PeakSurchargeByWeightServiceFee
9576
+ | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeServiceFee;
9521
9577
  }
9522
9578
 
9523
- declare namespace io.flow.ftp.v0.models {
9524
- interface FtpAccount {
9525
- readonly server: io.flow.ftp.v0.models.FtpServer;
9526
- readonly user: io.flow.ftp.v0.models.FtpUser;
9579
+ declare namespace io.flow.token.v0.models {
9580
+ interface ChannelToken {
9581
+ readonly discriminator: 'channel_token';
9582
+ readonly id: string;
9583
+ readonly channel: io.flow.common.v0.models.ChannelReference;
9584
+ readonly user: io.flow.common.v0.models.UserReference;
9585
+ readonly partial: string;
9586
+ readonly created_at: string;
9587
+ readonly description?: string;
9527
9588
  }
9528
9589
 
9529
- interface FtpFile {
9590
+ interface ChannelTokenReference {
9591
+ readonly discriminator: 'channel_token_reference';
9530
9592
  readonly id: string;
9531
- readonly source: io.flow.ftp.v0.enums.FtpFileSource;
9532
- readonly name: string;
9533
- readonly directory: string;
9534
- readonly url: string;
9593
+ readonly channel: io.flow.common.v0.models.ChannelReference;
9594
+ readonly user: io.flow.common.v0.models.UserReference;
9595
+ }
9596
+
9597
+ interface Cleartext {
9598
+ readonly value: string;
9599
+ }
9600
+
9601
+ interface OrganizationToken {
9602
+ readonly discriminator: 'organization_token';
9603
+ readonly id: string;
9604
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
9605
+ readonly user: io.flow.common.v0.models.UserReference;
9606
+ readonly environment: io.flow.common.v0.enums.Environment;
9607
+ readonly partial: string;
9535
9608
  readonly created_at: string;
9609
+ readonly description?: string;
9536
9610
  }
9537
9611
 
9538
- interface FtpFileForm {
9539
- readonly url: string;
9540
- readonly directory: string;
9541
- readonly name?: string;
9612
+ interface OrganizationTokenForm {
9613
+ readonly environment: io.flow.common.v0.enums.Environment;
9614
+ readonly description?: string;
9542
9615
  }
9543
9616
 
9544
- interface FtpFolder {
9617
+ interface OrganizationTokenReference {
9618
+ readonly discriminator: 'organization_token_reference';
9545
9619
  readonly id: string;
9546
- readonly path: string;
9547
- readonly webhook: boolean;
9620
+ readonly organization: io.flow.common.v0.models.OrganizationReference;
9621
+ readonly environment: io.flow.common.v0.enums.Environment;
9622
+ readonly user: io.flow.common.v0.models.UserReference;
9623
+ }
9624
+
9625
+ interface PartnerToken {
9626
+ readonly discriminator: 'partner_token';
9627
+ readonly id: string;
9628
+ readonly partner: io.flow.token.v0.models.TokenPartnerReference;
9629
+ readonly user: io.flow.common.v0.models.UserReference;
9630
+ readonly environment: io.flow.common.v0.enums.Environment;
9631
+ readonly partial: string;
9632
+ readonly created_at: string;
9548
9633
  readonly description?: string;
9549
9634
  }
9550
9635
 
9551
- interface FtpFolderForm {
9552
- readonly path: string;
9553
- readonly webhook: boolean;
9636
+ interface PartnerTokenForm {
9637
+ readonly environment: io.flow.common.v0.enums.Environment;
9554
9638
  readonly description?: string;
9555
9639
  }
9556
9640
 
9557
- interface FtpOrganizationSettings {
9558
- readonly enabled: boolean;
9559
- readonly emails: string[];
9560
- readonly account?: io.flow.ftp.v0.models.FtpAccount;
9641
+ interface PartnerTokenReference {
9642
+ readonly discriminator: 'partner_token_reference';
9643
+ readonly id: string;
9644
+ readonly partner: io.flow.token.v0.models.TokenPartnerReference;
9645
+ readonly environment: io.flow.common.v0.enums.Environment;
9646
+ readonly user: io.flow.common.v0.models.UserReference;
9561
9647
  }
9562
9648
 
9563
- interface FtpOrganizationSettingsForm {
9564
- readonly enabled: boolean;
9565
- readonly emails: string[];
9649
+ interface TokenAuthenticationForm {
9650
+ readonly token: string;
9566
9651
  }
9567
9652
 
9568
- interface FtpServer {
9569
- readonly hostname: string;
9653
+ interface TokenPartnerReference {
9654
+ readonly id: string;
9570
9655
  }
9571
9656
 
9572
- interface FtpUser {
9573
- readonly username: string;
9574
- readonly password?: string;
9657
+ interface TokenValidation {
9658
+ readonly status: string;
9659
+ }
9660
+
9661
+ interface TokenValidationForm {
9662
+ readonly token: string;
9575
9663
  }
9576
9664
  }
9577
9665
 
9666
+ declare namespace io.flow.token.v0.unions {
9667
+ type Token =
9668
+ | io.flow.token.v0.models.ChannelToken
9669
+ | io.flow.token.v0.models.OrganizationToken
9670
+ | io.flow.token.v0.models.PartnerToken;
9671
+ type TokenReference =
9672
+ | io.flow.token.v0.models.ChannelTokenReference
9673
+ | io.flow.token.v0.models.OrganizationTokenReference
9674
+ | io.flow.token.v0.models.PartnerTokenReference;
9675
+ }
9676
+
9578
9677
  declare namespace io.flow.catalog.exclusion.v0.enums {
9579
9678
  type ExclusionRuleState = 'current' | 'deleting' | 'updating';
9580
9679
  }
@@ -12097,6 +12196,12 @@ declare namespace io.flow.internal.v0.enums {
12097
12196
  | 'tax_remittance'
12098
12197
  | 'fully_subsidized_order'
12099
12198
  | 'credit_payment';
12199
+ type BlazeCheckoutEvent =
12200
+ | 'begin_checkout'
12201
+ | 'select_promotion'
12202
+ | 'add_shipping_info'
12203
+ | 'add_payment_info'
12204
+ | 'purchase';
12100
12205
  type BlazeCheckoutStep = 'customer_info' | 'delivery' | 'payment';
12101
12206
  type BrowserBundleErrorCode = 'generic_error' | 'country_invalid';
12102
12207
  type CarrierLabelGenerationMethod = 'direct' | 'easypost';
@@ -12394,7 +12499,14 @@ declare namespace io.flow.internal.v0.enums {
12394
12499
  type DeliveredDutyOptionMessageType = 'warning' | 'notification';
12395
12500
  type DeminimisAdjustmentType = 'none' | 'duty' | 'vat' | 'vat_and_duty';
12396
12501
  type DiscountRequestOrderEntitlementKey = 'subtotal';
12502
+ type DisputeCategory = 'friendly_fraud' | 'true_fraud' | 'processing_error';
12397
12503
  type DisputeEvidence = 'proof_of_delivery' | 'proof_of_fulfillment' | 'other';
12504
+ type DisputeImportStatus = 'new' | 'processing' | 'completed' | 'failed';
12505
+ type DisputeImportType = 'adyen_dispute';
12506
+ type DisputeProcessor = 'adyen' | 'paypal';
12507
+ type DisputeResponsibleParty = 'flow' | 'organization';
12508
+ type DisputeStatus = 'pending' | 'won' | 'lost' | 'expired';
12509
+ type DisputeType = 'chargeback';
12398
12510
  type DutyCompoundExpressionType = 'sum' | 'max' | 'min';
12399
12511
  type DutyExemptItemTypes =
12400
12512
  | 'gift_card'
@@ -13807,6 +13919,23 @@ declare namespace io.flow.internal.v0.models {
13807
13919
  readonly tax?: number;
13808
13920
  }
13809
13921
 
13922
+ interface BlazeCheckoutEventMessage {
13923
+ readonly discriminator: 'checkout_event';
13924
+ readonly event_type: io.flow.internal.v0.enums.BlazeCheckoutEvent;
13925
+ readonly affiliation: string;
13926
+ readonly order_number: string;
13927
+ readonly lines: io.flow.internal.v0.models.BlazeCheckoutLine[];
13928
+ readonly country: string;
13929
+ readonly language: string;
13930
+ readonly geo_currency: string;
13931
+ readonly currency: string;
13932
+ readonly promotions?: string[];
13933
+ readonly duty?: number;
13934
+ readonly tax?: number;
13935
+ readonly shipping?: number;
13936
+ readonly revenue?: number;
13937
+ }
13938
+
13810
13939
  interface BlazeCheckoutItem {
13811
13940
  readonly attributes: Record<string, string>;
13812
13941
  readonly item_number: string;
@@ -14054,6 +14183,13 @@ declare namespace io.flow.internal.v0.models {
14054
14183
  readonly name: string;
14055
14184
  }
14056
14185
 
14186
+ interface Channel {
14187
+ readonly id: string;
14188
+ readonly name: string;
14189
+ readonly environment: io.flow.common.v0.enums.Environment;
14190
+ readonly organization_id_prefix?: string;
14191
+ }
14192
+
14057
14193
  interface ChannelCurrencySetting {
14058
14194
  readonly id: string;
14059
14195
  readonly channel_id: string;
@@ -14083,6 +14219,12 @@ declare namespace io.flow.internal.v0.models {
14083
14219
  readonly channel_currency_setting: io.flow.internal.v0.models.ChannelCurrencySetting;
14084
14220
  }
14085
14221
 
14222
+ interface ChannelForm {
14223
+ readonly name: string;
14224
+ readonly environment: io.flow.common.v0.enums.Environment;
14225
+ readonly organization_id_prefix?: string;
14226
+ }
14227
+
14086
14228
  interface ChannelServiceFee {
14087
14229
  readonly tiers: io.flow.internal.v0.models.ChannelServiceFeeTier[];
14088
14230
  }
@@ -14092,6 +14234,10 @@ declare namespace io.flow.internal.v0.models {
14092
14234
  readonly amount: number;
14093
14235
  }
14094
14236
 
14237
+ interface ChannelTokenForm {
14238
+ readonly description?: string;
14239
+ }
14240
+
14095
14241
  interface ChannelTransaction {
14096
14242
  readonly id: string;
14097
14243
  readonly organization_id: string;
@@ -16711,6 +16857,52 @@ declare namespace io.flow.internal.v0.models {
16711
16857
  readonly order_entitlement_forms: io.flow.internal.v0.models.DiscountRequestOrderEntitlementForm[];
16712
16858
  }
16713
16859
 
16860
+ interface Dispute {
16861
+ readonly id: string;
16862
+ readonly processor: io.flow.internal.v0.enums.DisputeProcessor;
16863
+ readonly key: string;
16864
+ readonly type: io.flow.internal.v0.enums.DisputeType;
16865
+ readonly category: io.flow.internal.v0.enums.DisputeCategory;
16866
+ readonly reason: string;
16867
+ readonly status: io.flow.internal.v0.enums.DisputeStatus;
16868
+ readonly responsible?: io.flow.internal.v0.enums.DisputeResponsibleParty;
16869
+ readonly details: io.flow.internal.v0.unions.DisputeDetails;
16870
+ readonly expires_at?: string;
16871
+ readonly created_at: string;
16872
+ }
16873
+
16874
+ interface DisputeDetailsAdyen {
16875
+ readonly discriminator: 'adyen';
16876
+ readonly psp_reference: string;
16877
+ }
16878
+
16879
+ interface DisputeDetailsPaypal {
16880
+ readonly discriminator: 'paypal';
16881
+ readonly placeholder?: string;
16882
+ }
16883
+
16884
+ interface DisputeImport {
16885
+ readonly id: string;
16886
+ readonly type: io.flow.internal.v0.enums.DisputeImportType;
16887
+ readonly status: io.flow.internal.v0.enums.DisputeImportStatus;
16888
+ readonly url: string;
16889
+ readonly errors?: io.flow.internal.v0.models.DisputeImportErrors;
16890
+ readonly created_at: string;
16891
+ }
16892
+
16893
+ interface DisputeImportError {
16894
+ readonly message: string;
16895
+ }
16896
+
16897
+ interface DisputeImportErrors {
16898
+ readonly count: number;
16899
+ }
16900
+
16901
+ interface DisputeImportForm {
16902
+ readonly url: string;
16903
+ readonly type: io.flow.internal.v0.enums.DisputeImportType;
16904
+ }
16905
+
16714
16906
  interface DutiedItemsExport {
16715
16907
  readonly discriminator: 'dutied_items_export';
16716
16908
  readonly event_id: string;
@@ -19116,6 +19308,14 @@ declare namespace io.flow.internal.v0.models {
19116
19308
  readonly region: string;
19117
19309
  }
19118
19310
 
19311
+ interface LevyRateSummary {
19312
+ readonly id: string;
19313
+ readonly number: string;
19314
+ readonly destination: io.flow.common.v0.models.Address;
19315
+ readonly items: io.flow.harmonization.v0.models.HarmonizedLandedCostItem[];
19316
+ readonly tax_registration?: io.flow.harmonization.v0.models.TaxRegistration;
19317
+ }
19318
+
19119
19319
  interface Liability {
19120
19320
  readonly delivery_key: string;
19121
19321
  readonly tax_jurisdiction: string;
@@ -22474,6 +22674,7 @@ declare namespace io.flow.internal.v0.unions {
22474
22674
  type BlazeProviderMessage =
22475
22675
  | io.flow.internal.v0.models.BlazeCheckoutCompleteMessage
22476
22676
  | io.flow.internal.v0.models.BlazeCheckoutProgressMessage
22677
+ | io.flow.internal.v0.models.BlazeCheckoutEventMessage
22477
22678
  | io.flow.internal.v0.models.BlazeStartCheckoutMessage
22478
22679
  | io.flow.internal.v0.models.BlazeExitCheckoutMessage
22479
22680
  | io.flow.internal.v0.models.BlazeRedirectConfirmationMessage
@@ -22806,6 +23007,9 @@ declare namespace io.flow.internal.v0.unions {
22806
23007
  | io.flow.internal.v0.models.ContentLabel
22807
23008
  | io.flow.internal.v0.models.Load;
22808
23009
  type DiscountRequestOfferForm = io.flow.internal.v0.models.DiscountRequestOfferFixedAmountForm;
23010
+ type DisputeDetails =
23011
+ | io.flow.internal.v0.models.DisputeDetailsAdyen
23012
+ | io.flow.internal.v0.models.DisputeDetailsPaypal;
22809
23013
  type DutyExpression =
22810
23014
  | io.flow.internal.v0.models.DutyCompoundExpression
22811
23015
  | io.flow.internal.v0.models.DutySimpleExpression;
@@ -23379,6 +23583,8 @@ export type BlazeAddToCartMessage = io.flow.internal.v0.models.BlazeAddToCartMes
23379
23583
  export type BlazeApplepayAvailabilityRequest = io.flow.internal.v0.models.BlazeApplepayAvailabilityRequest;
23380
23584
  export type BlazeApplepayAvailabilityResponse = io.flow.internal.v0.models.BlazeApplepayAvailabilityResponse;
23381
23585
  export type BlazeCheckoutCompleteMessage = io.flow.internal.v0.models.BlazeCheckoutCompleteMessage;
23586
+ export type BlazeCheckoutEvent = io.flow.internal.v0.enums.BlazeCheckoutEvent;
23587
+ export type BlazeCheckoutEventMessage = io.flow.internal.v0.models.BlazeCheckoutEventMessage;
23382
23588
  export type BlazeCheckoutItem = io.flow.internal.v0.models.BlazeCheckoutItem;
23383
23589
  export type BlazeCheckoutLine = io.flow.internal.v0.models.BlazeCheckoutLine;
23384
23590
  export type BlazeCheckoutProgressMessage = io.flow.internal.v0.models.BlazeCheckoutProgressMessage;
@@ -23428,12 +23634,15 @@ export type CatalogItemRegionAvailabilitiesData = io.flow.internal.v0.models.Cat
23428
23634
  export type CatalogItemRegionAvailabilitiesPublished = io.flow.internal.v0.models.CatalogItemRegionAvailabilitiesPublished;
23429
23635
  export type CenterQueryBuilder = io.flow.internal.v0.models.CenterQueryBuilder;
23430
23636
  export type ChangeSettingsIndexTask = io.flow.internal.v0.models.ChangeSettingsIndexTask;
23637
+ export type Channel = io.flow.internal.v0.models.Channel;
23431
23638
  export type ChannelCurrencySetting = io.flow.internal.v0.models.ChannelCurrencySetting;
23432
23639
  export type ChannelCurrencySettingDeleted = io.flow.internal.v0.models.ChannelCurrencySettingDeleted;
23433
23640
  export type ChannelCurrencySettingForm = io.flow.internal.v0.models.ChannelCurrencySettingForm;
23434
23641
  export type ChannelCurrencySettingUpserted = io.flow.internal.v0.models.ChannelCurrencySettingUpserted;
23642
+ export type ChannelForm = io.flow.internal.v0.models.ChannelForm;
23435
23643
  export type ChannelServiceFee = io.flow.internal.v0.models.ChannelServiceFee;
23436
23644
  export type ChannelServiceFeeTier = io.flow.internal.v0.models.ChannelServiceFeeTier;
23645
+ export type ChannelTokenForm = io.flow.internal.v0.models.ChannelTokenForm;
23437
23646
  export type ChannelTransaction = io.flow.internal.v0.models.ChannelTransaction;
23438
23647
  export type ChannelTransactionDeleted = io.flow.internal.v0.models.ChannelTransactionDeleted;
23439
23648
  export type ChannelTransactionUpserted = io.flow.internal.v0.models.ChannelTransactionUpserted;
@@ -24037,7 +24246,22 @@ export type DiscountRequestOfferForm = io.flow.internal.v0.unions.DiscountReques
24037
24246
  export type DiscountRequestOrderEntitlementForm = io.flow.internal.v0.models.DiscountRequestOrderEntitlementForm;
24038
24247
  export type DiscountRequestOrderEntitlementKey = io.flow.internal.v0.enums.DiscountRequestOrderEntitlementKey;
24039
24248
  export type DiscountRequestOrderForm = io.flow.internal.v0.models.DiscountRequestOrderForm;
24249
+ export type Dispute = io.flow.internal.v0.models.Dispute;
24250
+ export type DisputeCategory = io.flow.internal.v0.enums.DisputeCategory;
24251
+ export type DisputeDetails = io.flow.internal.v0.unions.DisputeDetails;
24252
+ export type DisputeDetailsAdyen = io.flow.internal.v0.models.DisputeDetailsAdyen;
24253
+ export type DisputeDetailsPaypal = io.flow.internal.v0.models.DisputeDetailsPaypal;
24040
24254
  export type DisputeEvidence = io.flow.internal.v0.enums.DisputeEvidence;
24255
+ export type DisputeImport = io.flow.internal.v0.models.DisputeImport;
24256
+ export type DisputeImportError = io.flow.internal.v0.models.DisputeImportError;
24257
+ export type DisputeImportErrors = io.flow.internal.v0.models.DisputeImportErrors;
24258
+ export type DisputeImportForm = io.flow.internal.v0.models.DisputeImportForm;
24259
+ export type DisputeImportStatus = io.flow.internal.v0.enums.DisputeImportStatus;
24260
+ export type DisputeImportType = io.flow.internal.v0.enums.DisputeImportType;
24261
+ export type DisputeProcessor = io.flow.internal.v0.enums.DisputeProcessor;
24262
+ export type DisputeResponsibleParty = io.flow.internal.v0.enums.DisputeResponsibleParty;
24263
+ export type DisputeStatus = io.flow.internal.v0.enums.DisputeStatus;
24264
+ export type DisputeType = io.flow.internal.v0.enums.DisputeType;
24041
24265
  export type DutiedItemsExport = io.flow.internal.v0.models.DutiedItemsExport;
24042
24266
  export type Duties = io.flow.internal.v0.models.Duties;
24043
24267
  export type DutyCompoundExpression = io.flow.internal.v0.models.DutyCompoundExpression;
@@ -24378,6 +24602,7 @@ export type LabeledContent = io.flow.internal.v0.models.LabeledContent;
24378
24602
  export type LabelsPrediction = io.flow.internal.v0.models.LabelsPrediction;
24379
24603
  export type LandedCostItem = io.flow.internal.v0.models.LandedCostItem;
24380
24604
  export type Landmark = io.flow.internal.v0.models.Landmark;
24605
+ export type LevyRateSummary = io.flow.internal.v0.models.LevyRateSummary;
24381
24606
  export type Liability = io.flow.internal.v0.models.Liability;
24382
24607
  export type LiabilityItem = io.flow.internal.v0.models.LiabilityItem;
24383
24608
  export type LiabilityMoney = io.flow.internal.v0.models.LiabilityMoney;