@epcc-sdk/sdks-shopper 0.0.33 → 0.0.34

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.
@@ -1893,27 +1893,6 @@ type CatalogReleaseCreateData = {
1893
1893
  include_organization_resources?: boolean | null;
1894
1894
  };
1895
1895
  };
1896
- type CartsRequest = {
1897
- /**
1898
- * The cart description.
1899
- */
1900
- description?: string;
1901
- discount_settings?: DiscountSettings;
1902
- /**
1903
- * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.
1904
- */
1905
- name?: string;
1906
- contact?: CartContact;
1907
- /**
1908
- * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.
1909
- */
1910
- snapshot_date?: string;
1911
- custom_attributes?: CustomAttributes;
1912
- /**
1913
- * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.
1914
- */
1915
- payment_intent_id?: string;
1916
- };
1917
1896
  type CartContact = {
1918
1897
  /**
1919
1898
  * The email address attached to a cart.
@@ -1930,25 +1909,68 @@ type DiscountSettings = {
1930
1909
  */
1931
1910
  use_rule_promotions?: boolean;
1932
1911
  };
1912
+ type InventorySettings = {
1913
+ /**
1914
+ * This parameter enables deferring inventory checks on the cart. This allows items to be added to or updating in the cart without checking stock levels. Inventory checks are still performed as normal on checkout
1915
+ */
1916
+ defer_inventory_check?: boolean;
1917
+ };
1918
+ /**
1919
+ * Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.
1920
+ *
1921
+ * Example:
1922
+ * ```
1923
+ * "custom_attributes": {
1924
+ * "is_member": {
1925
+ * "type": "boolean",
1926
+ * "value": true
1927
+ * },
1928
+ * "membership_level": {
1929
+ * "type": "string",
1930
+ * "value": "premium"
1931
+ * }
1932
+ * }
1933
+ * ```
1934
+ *
1935
+ */
1933
1936
  type CustomAttributes = {
1937
+ [key: string]: unknown;
1938
+ };
1939
+ type FormattedPriceData = {
1934
1940
  /**
1935
- * Specifies the custom attributes for the cart object. The attribute can be any string, numerical, and underscore. A cart can have maximum of 20 custom attributes.
1941
+ * The raw total.
1936
1942
  */
1937
- custom_attributes?: {
1938
- /**
1939
- * Specifies the attribute `type` and `value`.
1940
- */
1941
- attribute?: {
1942
- /**
1943
- * Specifies the type of the attribute such as string, integer, boolean, and float.
1944
- */
1945
- type?: string;
1946
- /**
1947
- * Specifies the value of the attribute.
1948
- */
1949
- value?: string | number | boolean;
1950
- };
1951
- };
1943
+ amount?: number;
1944
+ /**
1945
+ * The currency set for this amount.
1946
+ */
1947
+ currency?: string;
1948
+ /**
1949
+ * The formatted total based on the amount and currency.
1950
+ */
1951
+ formatted?: string;
1952
+ };
1953
+ /**
1954
+ * Relationship data entry
1955
+ */
1956
+ type RelationshipItem = {
1957
+ /**
1958
+ * The type of related resource.
1959
+ */
1960
+ type?: string;
1961
+ /**
1962
+ * The ID of the related resource.
1963
+ */
1964
+ id?: string;
1965
+ };
1966
+ /**
1967
+ * Array of relationships
1968
+ */
1969
+ type RelationshipArray = {
1970
+ /**
1971
+ * Individual relationships
1972
+ */
1973
+ data?: Array<RelationshipItem>;
1952
1974
  };
1953
1975
  type CartResponse = {
1954
1976
  /**
@@ -1969,10 +1991,12 @@ type CartResponse = {
1969
1991
  description?: string;
1970
1992
  contact?: CartContact;
1971
1993
  discount_settings?: DiscountSettings;
1994
+ inventory_settings?: InventorySettings;
1972
1995
  /**
1973
1996
  * Stripe-assigned unique identifier for the linked Payment Intent
1974
1997
  */
1975
1998
  payment_intent_id?: string;
1999
+ custom_attributes?: CustomAttributes;
1976
2000
  links?: {
1977
2001
  /**
1978
2002
  * A link to that specific resource.
@@ -1992,64 +2016,170 @@ type CartResponse = {
1992
2016
  };
1993
2017
  relationships?: {
1994
2018
  customers?: RelationshipArray;
1995
- items?: RelationshipArray;
2019
+ items?: RelationshipArray | {
2020
+ data?: null;
2021
+ };
1996
2022
  accounts?: RelationshipArray;
1997
2023
  custom_discounts?: RelationshipArray;
1998
2024
  promotions?: RelationshipArray;
1999
2025
  };
2000
2026
  };
2001
- type CartItemsObjectRequest = CartItemObject | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
2002
- type CartItemsObjectResponse = CartItemResponseObject | SubscriptionItemResponseObject | CustomItemResponseObject | PromotionItemResponseObject;
2003
- type CartItemResponseObject = CartItemObjectData & CartItemResponse;
2004
- type SubscriptionItemResponseObject = SubscriptionItemObjectData & CartItemResponse;
2005
- type CustomItemResponseObject = CustomItemObjectData & {
2027
+ type ResponsePageLinks = {
2006
2028
  /**
2007
- * Specifies the ID of the custom cart item
2029
+ * Always the current page.
2008
2030
  */
2009
- id: string;
2010
- readonly image?: {
2031
+ current?: string;
2032
+ /**
2033
+ * Always the first page.
2034
+ */
2035
+ first?: string;
2036
+ /**
2037
+ * If there is only one page, it is `null`.
2038
+ */
2039
+ last?: string;
2040
+ /**
2041
+ * If there is only one page, it is `null`.
2042
+ */
2043
+ next?: string;
2044
+ /**
2045
+ * if the user is on the first page, it is `null`.
2046
+ */
2047
+ prev?: string;
2048
+ };
2049
+ type ResponsePaginationPage = {
2050
+ /**
2051
+ * The current page.
2052
+ */
2053
+ current?: number;
2054
+ /**
2055
+ * The maximum number of records per page for this response. You can set this value up to 100.
2056
+ */
2057
+ limit?: number;
2058
+ /**
2059
+ * The current offset by number of records, not pages. Offset is zero-based.
2060
+ */
2061
+ offset?: number;
2062
+ /**
2063
+ * The total page count.
2064
+ */
2065
+ total?: number;
2066
+ };
2067
+ type ResponsePaginationResults = {
2068
+ /**
2069
+ * The total page count.
2070
+ */
2071
+ total?: number;
2072
+ };
2073
+ type ResponseMetaCarts = {
2074
+ page?: ResponsePaginationPage;
2075
+ results?: ResponsePaginationResults;
2076
+ };
2077
+ type CartCollectionResponse = {
2078
+ data: Array<CartResponse>;
2079
+ links?: ResponsePageLinks;
2080
+ meta?: ResponseMetaCarts;
2081
+ };
2082
+ type ResponseErrorItem = {
2083
+ /**
2084
+ * A brief summary of the error.
2085
+ */
2086
+ title: string;
2087
+ /**
2088
+ * The HTTP response code of the error.
2089
+ */
2090
+ status: number;
2091
+ /**
2092
+ * Optional additional detail about the error.
2093
+ */
2094
+ detail?: string;
2095
+ meta?: {
2011
2096
  /**
2012
- * The MIME type for the uploaded file.
2097
+ * The resource id associated with the error
2013
2098
  */
2014
- readonly mime_type?: string;
2099
+ id?: string;
2100
+ ids?: Array<string>;
2101
+ item_ids?: Array<string>;
2015
2102
  /**
2016
- * The name of the image file that was uploaded.
2103
+ * The shipping group id associated with the error
2017
2104
  */
2018
- readonly file_name?: string;
2105
+ shipping_group_id?: string;
2106
+ shipping_group_ids?: Array<string>;
2019
2107
  /**
2020
- * The link to the image.
2108
+ * The cart id associated with the error
2021
2109
  */
2022
- readonly href?: string;
2023
- };
2024
- readonly manage_stock?: boolean;
2025
- unit_price?: ItemPriceData;
2026
- value?: ItemPriceData;
2027
- readonly links?: {
2028
- [key: string]: unknown;
2029
- };
2030
- readonly meta?: {
2031
- display_price?: {
2032
- with_tax?: FormattedPriceData;
2033
- without_tax?: FormattedPriceData;
2034
- tax?: FormattedPriceData;
2035
- discount?: FormattedPriceData;
2036
- without_discount?: FormattedPriceData;
2037
- };
2038
- timestamps?: CartCheckoutTimestamps;
2110
+ cart_id?: string;
2111
+ /**
2112
+ * The code associated with the error.
2113
+ */
2114
+ code?: string;
2115
+ /**
2116
+ * The order id associated with the error.
2117
+ */
2118
+ order_id?: string;
2119
+ /**
2120
+ * The value associated with the error.
2121
+ */
2122
+ value?: Array<unknown> | Array<unknown> | Array<unknown> | Array<unknown> | Array<unknown>;
2039
2123
  };
2040
2124
  };
2041
- type PromotionItemResponseObject = PromotionItemObjectData & {
2042
- /**
2043
- * Specifies the ID of the promotion cart item
2044
- */
2045
- id: string;
2046
- /**
2047
- * The name of the promotion item.
2048
- */
2049
- name?: string;
2125
+ type ResponseErrorResponse = {
2126
+ errors: Array<ResponseErrorItem>;
2127
+ };
2128
+ type CartsRequest = {
2129
+ data?: {
2130
+ /**
2131
+ * The cart description.
2132
+ */
2133
+ description?: string;
2134
+ discount_settings?: DiscountSettings;
2135
+ inventory_settings?: InventorySettings;
2136
+ /**
2137
+ * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.
2138
+ */
2139
+ name?: string;
2140
+ contact?: CartContact;
2141
+ /**
2142
+ * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.
2143
+ */
2144
+ snapshot_date?: string;
2145
+ /**
2146
+ * Specifies custom attributes for cart objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.
2147
+ *
2148
+ * Attribute types include:
2149
+ * - string
2150
+ * - boolean
2151
+ * - integer
2152
+ * - float
2153
+ *
2154
+ * Multiple custom attributes may be submitted together. A cart can have a maximum of 20 custom attributes.
2155
+ *
2156
+ * Example:
2157
+ * ```
2158
+ * "custom_attributes": {
2159
+ * "is_member": {
2160
+ * "type": "boolean",
2161
+ * "value": true
2162
+ * },
2163
+ * "membership_level": {
2164
+ * "type": "string",
2165
+ * "value": "premium"
2166
+ * }
2167
+ * }
2168
+ * ```
2169
+ *
2170
+ * Updating an existing cart with new custom attributes clears previously-saved attributes. In order to maintain existing custom attributes on a cart, please include them in the update request along with any new attributes.
2171
+ *
2172
+ */
2173
+ custom_attributes?: CustomAttributes;
2174
+ /**
2175
+ * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.
2176
+ */
2177
+ payment_intent_id?: string;
2178
+ };
2050
2179
  };
2051
- type CartItemObject = {
2052
- data?: CartItemObjectData & CartItemResponse;
2180
+ type CartEntityResponse = {
2181
+ data: CartResponse;
2182
+ included?: CartIncluded;
2053
2183
  };
2054
2184
  /**
2055
2185
  * The type of object being returned.
@@ -2102,78 +2232,140 @@ type CartItemObjectData = {
2102
2232
  */
2103
2233
  location?: string;
2104
2234
  };
2105
- type SubscriptionItemObject = {
2106
- data?: SubscriptionItemObjectData & CartItemResponse;
2107
- };
2108
- type SubscriptionItemObjectData = {
2109
- /**
2110
- * The type of object being returned.
2111
- */
2112
- type: "subscription_item";
2235
+ type ItemPriceData = {
2113
2236
  /**
2114
- * The number of items added to the cart.
2237
+ * The amount for this item as an integer.
2115
2238
  */
2116
- quantity: number;
2239
+ readonly amount?: number;
2117
2240
  /**
2118
- * Specifies the ID of the subscription offering you want to add to cart.
2241
+ * The currency this item was added to the cart as.
2119
2242
  */
2120
- id: string;
2243
+ readonly currency?: string;
2121
2244
  /**
2122
- * Specifies how the subscription offering should be configured.
2245
+ * Whether or not this price is tax inclusive.
2123
2246
  */
2124
- subscription_configuration: {
2125
- /**
2126
- * The ID of the plan within the offering to use for the subscription.
2127
- */
2128
- plan: string;
2129
- };
2130
- };
2131
- type CartMergeObjectRequest = {
2132
- data?: Array<CartMergeObject>;
2133
- options?: AddAllOrNothingOptionsObject;
2247
+ readonly includes_tax?: boolean;
2134
2248
  };
2135
- type CartMergeObject = {
2249
+ type CartItemFormattedPriceData = {
2136
2250
  /**
2137
- * The type of object being returned. Must be `cart_items`.
2251
+ * The amount per each single unit.
2138
2252
  */
2139
- type: "cart_items";
2253
+ unit?: FormattedPriceData;
2140
2254
  /**
2141
- * The original cart to be merged from.
2255
+ * The total amount of the item (i.e., unit * quantity).
2142
2256
  */
2143
- cart_id: string;
2144
- };
2145
- type CustomItemObject = {
2146
- data?: CustomItemObjectData;
2257
+ value?: FormattedPriceData;
2147
2258
  };
2148
- type CustomItemObjectData = {
2259
+ type CartItemResponse = {
2149
2260
  /**
2150
- * The type of object being returned. Must be `custom_item`.
2261
+ * The unique ID of the product.
2151
2262
  */
2152
- type: "custom_item";
2263
+ readonly product_id?: string;
2153
2264
  /**
2154
- * The number of custom items to add to cart.
2265
+ * The unique ID of the subscription offering for subscription items.
2155
2266
  */
2156
- quantity: number;
2157
- price: {
2158
- /**
2159
- * The unit price of the custom item.
2160
- */
2161
- amount: number;
2162
- /**
2163
- * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
2164
- */
2165
- includes_tax?: boolean;
2166
- };
2267
+ readonly subscription_offering_id?: string;
2167
2268
  /**
2168
- * A description of the custom item.
2269
+ * The name of this item
2169
2270
  */
2170
- description?: string;
2271
+ readonly name?: string;
2171
2272
  /**
2172
- * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.
2273
+ * A description of the cart item.
2173
2274
  */
2174
- sku?: string;
2275
+ readonly description?: string;
2175
2276
  /**
2176
- * The name of the custom item.
2277
+ * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
2278
+ */
2279
+ readonly catalog_id?: string;
2280
+ /**
2281
+ * The catalog source. Always `pim` or `legacy`.
2282
+ */
2283
+ readonly catalog_source?: string;
2284
+ readonly image?: {
2285
+ /**
2286
+ * The MIME type for the uploaded file.
2287
+ */
2288
+ readonly mime_type?: string;
2289
+ /**
2290
+ * The name of the image file that was uploaded.
2291
+ */
2292
+ readonly file_name?: string;
2293
+ /**
2294
+ * The link to the image.
2295
+ */
2296
+ readonly href?: string;
2297
+ };
2298
+ /**
2299
+ * Whether or not the quantity of the item will be checked against inventory.
2300
+ */
2301
+ readonly manage_stock?: boolean;
2302
+ /**
2303
+ * The unit price of the item.
2304
+ */
2305
+ unit_price?: ItemPriceData;
2306
+ /**
2307
+ * The total price of the item (i.e., unit * quantity).
2308
+ */
2309
+ value?: ItemPriceData;
2310
+ readonly links?: {
2311
+ /**
2312
+ * A URL related to the resource.
2313
+ */
2314
+ product?: string;
2315
+ };
2316
+ readonly meta?: {
2317
+ display_price?: {
2318
+ /**
2319
+ * The amount of this item after discounts and taxes are applied.
2320
+ */
2321
+ with_tax?: CartItemFormattedPriceData;
2322
+ /**
2323
+ * The amount of this item after discounts are applied and before taxes.
2324
+ */
2325
+ without_tax?: CartItemFormattedPriceData;
2326
+ /**
2327
+ * The amount of taxes applied to this item.
2328
+ */
2329
+ tax?: CartItemFormattedPriceData;
2330
+ /**
2331
+ * The amount of the discount applied to this item.
2332
+ */
2333
+ discount?: CartItemFormattedPriceData;
2334
+ without_discount?: CartItemFormattedPriceData;
2335
+ };
2336
+ timestamps?: CartCheckoutTimestamps;
2337
+ };
2338
+ };
2339
+ type CartItemObject = CartItemObjectData & CartItemResponse;
2340
+ type CustomItemObjectData = {
2341
+ /**
2342
+ * The type of object being returned. Must be `custom_item`.
2343
+ */
2344
+ type: "custom_item";
2345
+ /**
2346
+ * The number of custom items to add to cart.
2347
+ */
2348
+ quantity: number;
2349
+ price: {
2350
+ /**
2351
+ * The unit price of the custom item.
2352
+ */
2353
+ amount: number;
2354
+ /**
2355
+ * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
2356
+ */
2357
+ includes_tax?: boolean;
2358
+ };
2359
+ /**
2360
+ * A description of the custom item.
2361
+ */
2362
+ description?: string;
2363
+ /**
2364
+ * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.
2365
+ */
2366
+ sku?: string;
2367
+ /**
2368
+ * The name of the custom item.
2177
2369
  */
2178
2370
  name: string;
2179
2371
  /**
@@ -2187,25 +2379,38 @@ type CustomItemObjectData = {
2187
2379
  */
2188
2380
  shipping_group_id?: string;
2189
2381
  };
2190
- type ReOrderObjectRequest = {
2191
- data?: ReOrderObject;
2192
- options?: AddAllOrNothingOptionsObject;
2382
+ type CustomItemObject = {
2383
+ data?: CustomItemObjectData;
2193
2384
  };
2194
- type ReOrderObject = {
2385
+ type SubscriptionItemObjectData = {
2195
2386
  /**
2196
- * The type of resource being returned. Use `order_items`.
2387
+ * The type of object being returned.
2197
2388
  */
2198
- type: "order_items";
2389
+ type: "subscription_item";
2199
2390
  /**
2200
- * The unique identifier of the order.
2391
+ * The number of items added to the cart.
2201
2392
  */
2202
- order_id: string;
2203
- };
2204
- type BulkAddItemsRequest = {
2205
- data?: CartItemsObjectRequest | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
2393
+ quantity: number;
2394
+ /**
2395
+ * Specifies the ID of the subscription offering you want to add to cart.
2396
+ */
2397
+ id: string;
2398
+ /**
2399
+ * Specifies how the subscription offering should be configured.
2400
+ */
2401
+ subscription_configuration: {
2402
+ /**
2403
+ * The ID of the pricing option within the offering to use for the subscription.
2404
+ */
2405
+ pricing_option: string;
2406
+ /**
2407
+ * The ID of the plan within the offering to use for the subscription.
2408
+ */
2409
+ plan: string;
2410
+ };
2206
2411
  };
2207
- type PromotionItemObject = {
2208
- data?: PromotionItemObjectData;
2412
+ type SubscriptionItemObject = {
2413
+ data?: SubscriptionItemObjectData & CartItemResponse;
2209
2414
  };
2210
2415
  type PromotionItemObjectData = {
2211
2416
  /**
@@ -2217,6 +2422,18 @@ type PromotionItemObjectData = {
2217
2422
  */
2218
2423
  code: string;
2219
2424
  };
2425
+ type PromotionItemObject = {
2426
+ data?: PromotionItemObjectData;
2427
+ };
2428
+ type CartItemsResponse = {
2429
+ data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
2430
+ };
2431
+ type UpdateAllOrNothingOptionsObject = {
2432
+ /**
2433
+ * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.
2434
+ */
2435
+ update_all_or_nothing?: boolean;
2436
+ };
2220
2437
  type BulkUpdateCartsItems = {
2221
2438
  data?: Array<{
2222
2439
  /**
@@ -2236,8 +2453,78 @@ type BulkUpdateCartsItems = {
2236
2453
  }>;
2237
2454
  options?: UpdateAllOrNothingOptionsObject;
2238
2455
  };
2456
+ type CartItemObjectRequest = {
2457
+ data?: CartItemObject;
2458
+ };
2459
+ type CartMergeObject = {
2460
+ /**
2461
+ * The type of object being returned. Must be `cart_items`.
2462
+ */
2463
+ type: "cart_items";
2464
+ /**
2465
+ * The original cart to be merged from.
2466
+ */
2467
+ cart_id: string;
2468
+ };
2469
+ type AddAllOrNothingOptionsObject = {
2470
+ /**
2471
+ * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.
2472
+ */
2473
+ add_all_or_nothing?: boolean;
2474
+ };
2475
+ type CartMergeObjectRequest = {
2476
+ data?: CartMergeObject;
2477
+ options?: AddAllOrNothingOptionsObject;
2478
+ };
2479
+ type ReOrderObject = {
2480
+ /**
2481
+ * The type of resource being returned. Use `order_items`.
2482
+ */
2483
+ type: "order_items";
2484
+ /**
2485
+ * The unique identifier of the order.
2486
+ */
2487
+ order_id: string;
2488
+ };
2489
+ type ReOrderObjectRequest = {
2490
+ data?: ReOrderObject;
2491
+ options?: AddAllOrNothingOptionsObject;
2492
+ };
2493
+ type BulkAddItemsRequest = {
2494
+ data?: Array<CartItemObjectData | CartMergeObject | CustomItemObjectData | ReOrderObject | PromotionItemObjectData>;
2495
+ options?: AddAllOrNothingOptionsObject;
2496
+ };
2497
+ type CartTimestamps = {
2498
+ created_at?: string;
2499
+ updated_at?: unknown;
2500
+ expires_at?: unknown;
2501
+ };
2502
+ type CartsResponse = {
2503
+ data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
2504
+ meta?: {
2505
+ display_price?: {
2506
+ with_tax?: FormattedPriceData;
2507
+ without_tax?: FormattedPriceData;
2508
+ tax?: FormattedPriceData;
2509
+ discount?: FormattedPriceData;
2510
+ without_discount?: FormattedPriceData;
2511
+ discounts?: {
2512
+ [key: string]: {
2513
+ amount?: number;
2514
+ currency?: string;
2515
+ formatted?: string;
2516
+ };
2517
+ };
2518
+ };
2519
+ timestamps?: CartTimestamps;
2520
+ };
2521
+ };
2239
2522
  type UpdateCartsItems = {
2240
2523
  data?: {
2524
+ /**
2525
+ * The type of the cart item.
2526
+ */
2527
+ type?: "cart_item";
2241
2528
  /**
2242
2529
  * The unique identifier of the cart item.
2243
2530
  */
@@ -2258,176 +2545,89 @@ type UpdateCartsItems = {
2258
2545
  shipping_group_id?: string;
2259
2546
  };
2260
2547
  };
2261
- type AddAllOrNothingOptionsObject = {
2262
- /**
2263
- * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.
2264
- */
2265
- add_all_or_nothing?: boolean;
2548
+ type CartsRelationshipsAccountsData = {
2549
+ data?: Array<{
2550
+ /**
2551
+ * The ID of the account.
2552
+ */
2553
+ id?: string;
2554
+ /**
2555
+ * The type of related object. Ensure that it is account.
2556
+ */
2557
+ type?: string;
2558
+ }>;
2266
2559
  };
2267
- type UpdateAllOrNothingOptionsObject = {
2560
+ type CartsRelationshipsCustomersData = {
2561
+ data?: Array<{
2562
+ /**
2563
+ * The ID of the customer.
2564
+ */
2565
+ id?: string;
2566
+ /**
2567
+ * The type of related object. Ensure that it is customer.
2568
+ */
2569
+ type?: string;
2570
+ }>;
2571
+ };
2572
+ type CartsItemsTaxesObject = {
2268
2573
  /**
2269
- * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.
2574
+ * A unique tax code in this jurisdiction.
2270
2575
  */
2271
- update_all_or_nothing?: boolean;
2272
- };
2273
- type CartItemResponse = {
2576
+ code?: string;
2274
2577
  /**
2275
- * The unique ID of the product.
2578
+ * The relevant tax jurisdiction.
2276
2579
  */
2277
- readonly product_id?: string;
2580
+ jurisdiction?: string;
2278
2581
  /**
2279
- * The unique ID of the subscription offering for subscription items.
2582
+ * The name of the tax item.
2280
2583
  */
2281
- readonly subscription_offering_id?: string;
2584
+ name?: string;
2282
2585
  /**
2283
- * The name of this item
2586
+ * The tax rate represented as a decimal (12.5% -> 0.125). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.
2284
2587
  */
2285
- readonly name?: string;
2588
+ rate?: number;
2286
2589
  /**
2287
- * A description of the cart item.
2590
+ * The tax rate represented as a number ($10 -> 1000). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.
2288
2591
  */
2289
- readonly description?: string;
2592
+ amount?: number;
2290
2593
  /**
2291
- * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
2594
+ * The type of object being returned. Use `tax_item`.
2292
2595
  */
2293
- readonly catalog_id?: string;
2596
+ type: string;
2294
2597
  /**
2295
- * The catalog source. Always `pim` or `legacy`.
2598
+ * The unique identifier for this tax item.
2296
2599
  */
2297
- readonly catalog_source?: string;
2298
- readonly image?: {
2299
- /**
2300
- * The MIME type for the uploaded file.
2301
- */
2302
- readonly mime_type?: string;
2303
- /**
2304
- * The name of the image file that was uploaded.
2305
- */
2306
- readonly file_name?: string;
2307
- /**
2308
- * The link to the image.
2309
- */
2310
- readonly href?: string;
2311
- };
2312
- readonly manage_stock?: boolean;
2313
- unit_price?: ItemPriceData;
2314
- value?: ItemPriceData;
2315
- readonly links?: {
2316
- /**
2317
- * A URL related to the resource.
2318
- */
2319
- product?: string;
2320
- };
2321
- readonly meta?: {
2322
- display_price?: {
2323
- with_tax?: FormattedPriceData;
2324
- without_tax?: FormattedPriceData;
2325
- tax?: FormattedPriceData;
2326
- discount?: FormattedPriceData;
2327
- without_discount?: FormattedPriceData;
2328
- };
2329
- timestamps?: CartCheckoutTimestamps;
2330
- };
2600
+ readonly id?: string;
2331
2601
  };
2332
- type CartsResponse = {
2333
- data?: Array<CartItemsObjectResponse>;
2334
- meta?: {
2335
- display_price?: {
2336
- with_tax?: FormattedPriceData;
2337
- without_tax?: FormattedPriceData;
2338
- tax?: FormattedPriceData;
2339
- discount?: FormattedPriceData;
2340
- without_discount?: FormattedPriceData;
2341
- discounts?: {
2342
- [key: string]: {
2343
- amount?: number;
2344
- currency?: string;
2345
- formatted?: string;
2346
- };
2602
+ type CartItemTaxesEntityResponse = {
2603
+ data: CartsItemsTaxesObject;
2604
+ };
2605
+ type CartItemRelationship = {
2606
+ relationships?: {
2607
+ order?: {
2608
+ data?: {
2609
+ /**
2610
+ * This specifies the type of item.
2611
+ */
2612
+ type?: string;
2613
+ /**
2614
+ * This specifies the ID of the cart_item or custom_item in the cart.
2615
+ */
2616
+ id?: string;
2347
2617
  };
2348
2618
  };
2349
- timestamps?: CartTimestamps;
2350
2619
  };
2351
2620
  };
2352
- type ItemPriceData = {
2353
- /**
2354
- * The amount for this item as an integer.
2355
- */
2356
- readonly amount?: number;
2357
- /**
2358
- * The currency this item was added to the cart as.
2359
- */
2360
- readonly currency?: string;
2361
- /**
2362
- * Whether or not this price is tax inclusive.
2363
- */
2364
- readonly includes_tax?: boolean;
2365
- };
2366
- type CartsRelationshipsAccountsData = {
2367
- data?: Array<{
2368
- /**
2369
- * The ID of the account.
2370
- */
2371
- id?: string;
2372
- /**
2373
- * The type of related object. Ensure that it is account.
2374
- */
2375
- type?: string;
2376
- }>;
2377
- };
2378
- type CartsRelationshipsCustomersData = {
2379
- data?: Array<{
2380
- /**
2381
- * The ID of the customer.
2382
- */
2383
- id?: string;
2384
- /**
2385
- * The type of related object. Ensure that it is customer.
2386
- */
2387
- type?: string;
2388
- }>;
2389
- };
2390
- type CartsItemsTaxesObject = {
2391
- /**
2392
- * A unique tax code in this jurisdiction.
2393
- */
2394
- code?: string;
2395
- /**
2396
- * The relevant tax jurisdiction.
2397
- */
2398
- jurisdiction?: string;
2399
- /**
2400
- * The name of the tax item.
2401
- */
2402
- name?: string;
2403
- /**
2404
- * The tax rate represented as a decimal (12.5% -> 0.125).
2405
- */
2406
- rate: number;
2407
- /**
2408
- * The type of object being returned. Use `tax_item`.
2409
- */
2410
- type: string;
2411
- /**
2412
- * The unique identifier for this tax item.
2413
- */
2414
- readonly id?: string;
2415
- };
2416
- type CartsBulkCustomDiscounts = {
2417
- data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>;
2418
- options?: AddAllOrNothingOptionsObject;
2419
- };
2420
- type CartsBulkCustomDiscountsResponse = {
2421
- data?: Array<CartsCustomDiscountsResponse & CartItemBulkCustomDiscountResponse>;
2621
+ type CartsBulkTaxes = {
2622
+ data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
2422
2623
  options?: AddAllOrNothingOptionsObject;
2423
2624
  };
2424
- type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject & CustomDiscountRelationshipsCartItemRequest;
2425
- type CartItemBulkCustomDiscountResponse = CartsCustomDiscountsResponse & CustomDiscountRelationshipsCartItemRequest;
2426
2625
  type CartsCustomDiscountsObject = {
2427
- /**
2428
- * Specifies an amount to be applied for the custom discount. It must be less than zero.
2429
- */
2430
- amount: number;
2626
+ amount: number | {
2627
+ amount?: number;
2628
+ currency?: string;
2629
+ formatted?: string;
2630
+ };
2431
2631
  /**
2432
2632
  * Specifies a description for the custom discount.
2433
2633
  */
@@ -2449,7 +2649,36 @@ type CartsCustomDiscountsObject = {
2449
2649
  */
2450
2650
  type: string;
2451
2651
  };
2452
- type CartsCustomDiscountsResponse = {
2652
+ type CustomDiscountRelationshipsCartItemRequest = {
2653
+ relationships?: {
2654
+ item?: {
2655
+ data?: {
2656
+ /**
2657
+ * Specifies the type of item. For example, `custom_item` or `cart_item`.
2658
+ */
2659
+ type?: string;
2660
+ /**
2661
+ * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
2662
+ */
2663
+ id?: string;
2664
+ };
2665
+ };
2666
+ };
2667
+ };
2668
+ type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject & CustomDiscountRelationshipsCartItemRequest;
2669
+ type CartsBulkCustomDiscounts = {
2670
+ data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>;
2671
+ options?: AddAllOrNothingOptionsObject;
2672
+ };
2673
+ type CartsBulkCustomDiscountsResponse = {
2674
+ data?: CartsCustomDiscountsObject;
2675
+ options?: AddAllOrNothingOptionsObject;
2676
+ };
2677
+ type CartsBulkCustomDiscountsCollectionResponse = {
2678
+ data?: Array<CartsCustomDiscountsObject>;
2679
+ options?: AddAllOrNothingOptionsObject;
2680
+ };
2681
+ type CartsCustomDiscountsResponseObject = {
2453
2682
  amount?: {
2454
2683
  /**
2455
2684
  * Specifies an amount to be applied for the custom discount. It must be less than zero.
@@ -2489,144 +2718,177 @@ type CartsCustomDiscountsResponse = {
2489
2718
  */
2490
2719
  readonly id?: string;
2491
2720
  };
2492
- type CustomDiscountRelationshipsCartItemRequest = {
2493
- relationships?: {
2494
- item?: {
2495
- data?: {
2496
- /**
2497
- * Specifies the type of item. For example, `custom_item` or `cart_item`.
2498
- */
2499
- type?: string;
2500
- /**
2501
- * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
2502
- */
2503
- id?: string;
2504
- };
2505
- };
2506
- };
2507
- };
2508
- type CartItemRelationship = {
2509
- relationships?: {
2510
- order?: {
2511
- data?: {
2512
- /**
2513
- * This specifies the type of item.
2514
- */
2515
- type?: string;
2516
- /**
2517
- * This specifies the ID of the cart_item or custom_item in the cart.
2518
- */
2519
- id?: string;
2520
- };
2521
- };
2522
- };
2721
+ type CartsCustomDiscountsEntityRequest = {
2722
+ data?: CartsCustomDiscountsResponseObject;
2523
2723
  };
2524
- type CartsBulkTaxes = {
2525
- data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
2526
- options?: AddAllOrNothingOptionsObject;
2724
+ type CartsCustomDiscountsEntityResponse = {
2725
+ data?: CartsCustomDiscountsObject;
2527
2726
  };
2528
- type OrdersAnonymizeRequest = {
2529
- data?: OrdersAnonymizeData;
2727
+ type CartsCustomDiscountsCollectionResponse = {
2728
+ data?: Array<CartsCustomDiscountsObject>;
2530
2729
  };
2531
- type OrdersAnonymizeData = {
2730
+ type ShippingAddress = {
2532
2731
  /**
2533
- * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
2732
+ * First name of the shipping recipient.
2534
2733
  */
2535
- order_ids?: Array<string>;
2734
+ first_name: string;
2735
+ /**
2736
+ * Last name of the shipping recipient.
2737
+ */
2738
+ last_name: string;
2739
+ /**
2740
+ * Phone number of the shipping recipient.
2741
+ */
2742
+ phone_number: string;
2743
+ /**
2744
+ * Company of the shipping recipient.
2745
+ */
2746
+ company_name: string;
2747
+ /**
2748
+ * First line of the shipping address.
2749
+ */
2750
+ line_1: string;
2751
+ /**
2752
+ * Second line of the shipping address.
2753
+ */
2754
+ line_2: string;
2755
+ /**
2756
+ * City of the shipping address.
2757
+ */
2758
+ city: string;
2759
+ /**
2760
+ * Post code of the shipping address.
2761
+ */
2762
+ postcode: string;
2763
+ /**
2764
+ * County of the shipping address.
2765
+ */
2766
+ county: string;
2767
+ /**
2768
+ * Country of the shipping address.
2769
+ */
2770
+ country: string;
2771
+ /**
2772
+ * State, province, or region of the shipping address.
2773
+ */
2774
+ region?: string;
2775
+ /**
2776
+ * Delivery instructions.
2777
+ */
2778
+ instructions: string;
2536
2779
  };
2537
- type OrdersUpdateRequest = {
2538
- data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
2780
+ type DeliveryEstimate = {
2781
+ start?: Date;
2782
+ end?: Date;
2539
2783
  };
2540
- type OrdersAddressData = {
2784
+ type Money = {
2541
2785
  /**
2542
- * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
2786
+ * Amount in minor currency units (e.g., cents).
2543
2787
  */
2544
- order_number?: string;
2788
+ amount: number;
2545
2789
  /**
2546
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2790
+ * ISO 4217 currency code (e.g., "USD").
2547
2791
  */
2548
- external_ref?: string;
2549
- shipping_address: {
2550
- /**
2551
- * Specifies the first name of the address holder.
2552
- */
2553
- first_name?: string;
2554
- /**
2555
- * Specifies the last name of the address holder.
2556
- */
2557
- last_name?: string;
2558
- /**
2559
- * Specifies the phone number of the address holder.
2560
- */
2561
- phone_number?: string;
2562
- /**
2563
- * Specifies the company name.
2564
- */
2565
- company_name?: string;
2566
- /**
2567
- * Specifies the first line of the address.
2568
- */
2569
- line_1?: string;
2570
- /**
2571
- * Specifies the second line of the address.
2572
- */
2573
- line_2?: string;
2574
- /**
2575
- * Specifies the name of the city in the shipping address.
2576
- */
2577
- city?: string;
2578
- /**
2579
- * Specifies the county of the shipping address.
2580
- */
2581
- county?: string;
2582
- /**
2583
- * Specifies the state, province, or region of the shipping address.
2584
- */
2585
- region?: string;
2586
- /**
2587
- * Specifies the postcode or ZIP code of the address.
2588
- */
2589
- postcode?: string;
2590
- /**
2591
- * Specifies the country in the shipping address.
2592
- */
2593
- country?: string;
2594
- /**
2595
- * Specifies any instructions provided with the shipping address.
2596
- */
2597
- instructions?: string;
2598
- };
2599
- };
2600
- type OrdersCancelData = {
2792
+ currency: string;
2601
2793
  /**
2602
- * The status of the order. You can only update the status to `cancelled`.
2794
+ * Whether the amount includes tax.
2603
2795
  */
2604
- status: string;
2796
+ includes_tax: boolean;
2797
+ };
2798
+ type Discount = {
2799
+ amount: Money;
2605
2800
  /**
2606
- * The type of the resource. You must use order.
2801
+ * The discount code used, if applicable.
2607
2802
  */
2608
- type: string;
2803
+ code?: string;
2609
2804
  /**
2610
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2805
+ * Unique identifier for the discount.
2611
2806
  */
2612
- external_ref?: string;
2613
- };
2614
- type OrdersFulfilledData = {
2807
+ id: string;
2615
2808
  /**
2616
- * The shipping status of the order. You can only update the shipping status to `fulfilled`.
2809
+ * The source or origin of the promotion, if applicable.
2617
2810
  */
2618
- shipping: string;
2811
+ promotion_source?: string;
2619
2812
  /**
2620
- * The type of the resource. You must use order.
2813
+ * Indicates whether the discount applies to the entire cart.
2621
2814
  */
2622
- type: string;
2815
+ is_cart_discount?: boolean;
2623
2816
  /**
2624
- * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2817
+ * Order in which the discount was applied.
2625
2818
  */
2626
- external_ref?: string;
2819
+ ordinal?: number;
2627
2820
  };
2628
- type PaymentsRequest = {
2629
- data?: DataPaymentObject;
2821
+ type Discounts = Array<Discount>;
2822
+ type ShippingPriceResponse = {
2823
+ total: FormattedPriceData;
2824
+ base: FormattedPriceData;
2825
+ tax?: FormattedPriceData;
2826
+ fees?: FormattedPriceData;
2827
+ discount?: FormattedPriceData;
2828
+ };
2829
+ type OrderPriceWrapperMeta = {
2830
+ with_tax: FormattedPriceData;
2831
+ without_tax: FormattedPriceData;
2832
+ tax: FormattedPriceData;
2833
+ discount: FormattedPriceData;
2834
+ balance_owing: FormattedPriceData;
2835
+ paid: FormattedPriceData;
2836
+ authorized: FormattedPriceData;
2837
+ without_discount: FormattedPriceData;
2838
+ shipping: FormattedPriceData;
2839
+ shipping_discount: FormattedPriceData;
2840
+ };
2841
+ type ShippingGroupMeta = {
2842
+ shipping_display_price?: ShippingPriceResponse;
2843
+ total_display_price?: OrderPriceWrapperMeta;
2844
+ };
2845
+ type ShippingGroupResponse = {
2846
+ type?: "shipping_group";
2847
+ id?: string;
2848
+ relation?: string;
2849
+ cart_id?: string;
2850
+ order_id?: string;
2851
+ shipping_type?: string;
2852
+ tracking_reference?: string;
2853
+ address?: ShippingAddress;
2854
+ delivery_estimate?: DeliveryEstimate;
2855
+ createdAt?: Date;
2856
+ updatedAt?: Date;
2857
+ relationships?: {
2858
+ cart?: RelationshipItem;
2859
+ order?: RelationshipItem;
2860
+ };
2861
+ discounts?: Discounts;
2862
+ meta?: ShippingGroupMeta;
2863
+ };
2864
+ type ShippingPriceRequest = {
2865
+ total?: number;
2866
+ base?: number;
2867
+ tax?: number;
2868
+ fees?: number;
2869
+ discount?: number;
2870
+ };
2871
+ type CreateShippingGroupRequest = {
2872
+ data?: {
2873
+ type?: "shipping_group";
2874
+ shipping_type?: string;
2875
+ tracking_reference?: string;
2876
+ shipping_price?: ShippingPriceRequest;
2877
+ address?: ShippingAddress;
2878
+ includes_tax?: boolean;
2879
+ delivery_estimate?: DeliveryEstimate;
2880
+ };
2881
+ };
2882
+ type UpdateCartShippingGroupRequest = {
2883
+ data?: {
2884
+ type?: "shipping_group";
2885
+ shipping_type?: string;
2886
+ tracking_reference?: string;
2887
+ shipping_price?: ShippingPriceRequest;
2888
+ address?: ShippingAddress;
2889
+ includes_tax?: boolean;
2890
+ delivery_estimate?: DeliveryEstimate;
2891
+ };
2630
2892
  };
2631
2893
  type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents";
2632
2894
  /**
@@ -2644,376 +2906,373 @@ type DataBasePayments = {
2644
2906
  */
2645
2907
  amount?: number;
2646
2908
  };
2647
- type DataAdyenPayment = DataBasePayments & {
2648
- /**
2649
- * Specifies the gateway. You must use `adyen`.
2650
- */
2651
- gateway: "adyen";
2652
- options?: {
2909
+ type ElasticPathPaymentsPoweredByStripePayment = {
2910
+ data?: DataBasePayments & {
2653
2911
  /**
2654
- * The shopper reference token associated with the saved payment method.
2912
+ * Specifies the gateway. You must use `elastic_path_payments_stripe`.
2655
2913
  */
2656
- shopper_reference?: string;
2914
+ gateway?: "elastic_path_payments_stripe";
2915
+ options?: {
2916
+ /**
2917
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2918
+ */
2919
+ receipt_email?: string;
2920
+ /**
2921
+ * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.
2922
+ */
2923
+ automatic_payment_methods?: {
2924
+ /**
2925
+ * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.
2926
+ */
2927
+ enabled?: boolean;
2928
+ };
2929
+ };
2657
2930
  /**
2658
- * Enter CardOnFile for a one-time purchase.
2931
+ * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).
2659
2932
  */
2660
- recurring_processing_model?: string;
2661
- };
2662
- /**
2663
- * The Adyen recurringDetailReference payment method identifier.
2664
- */
2665
- payment: string;
2666
- };
2667
- type DataAuthorizeNetPayment = DataBasePayments & {
2668
- /**
2669
- * Specifies the gateway. You must use `authorize_net`.
2670
- */
2671
- gateway: "authorize_net";
2672
- options?: {
2933
+ payment_method_types?: Array<string>;
2673
2934
  /**
2674
- * The Authorize.net customer payment profile ID.
2935
+ * Specifies the Stripe token or source.
2675
2936
  */
2676
- customer_payment_profile_id?: string;
2937
+ payment?: string;
2677
2938
  };
2678
- /**
2679
- * The Authorize.net customer profile ID.
2680
- */
2681
- payment: string;
2682
2939
  };
2683
- type DataBraintreePayment = DataBasePayments & {
2940
+ type CartPaymentUpdate = {
2941
+ data: {
2942
+ gateway: string;
2943
+ method: string;
2944
+ payment_method_types: Array<string>;
2945
+ amount: number;
2946
+ options?: {
2947
+ [key: string]: unknown;
2948
+ };
2949
+ };
2950
+ };
2951
+ type BillingAddress = {
2684
2952
  /**
2685
- * Specifies the gateway. You must use `braintree`.
2953
+ * First name of the billing recipient.
2686
2954
  */
2687
- gateway: "braintree";
2955
+ first_name: string;
2688
2956
  /**
2689
- * The Braintree Customer ID that you want to bill.
2957
+ * Last name of the billing recipient.
2690
2958
  */
2691
- payment: string;
2692
- };
2693
- type DataCardConnectPayment = DataBasePayments & {
2959
+ last_name: string;
2694
2960
  /**
2695
- * Specifies the gateway. You must use `card_connect`.
2961
+ * Company name of the billing recipient.
2696
2962
  */
2697
- gateway: "card_connect";
2963
+ company_name: string;
2698
2964
  /**
2699
- * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.
2965
+ * First line of the billing address.
2700
2966
  */
2701
- payment: string;
2702
- };
2703
- type DataCyberSourcePayment = DataBasePayments & {
2967
+ line_1: string;
2704
2968
  /**
2705
- * Specifies the gateway. You must use `cyber_source`.
2969
+ * Second line of the billing address.
2706
2970
  */
2707
- gateway: "cyber_source";
2971
+ line_2: string;
2708
2972
  /**
2709
- * The CyberSource token.
2973
+ * City of the billing address.
2710
2974
  */
2711
- payment: string;
2712
- };
2713
- type ElasticPathPaymentsPoweredByStripePayment = DataBasePayments & {
2975
+ city: string;
2714
2976
  /**
2715
- * Specifies the gateway. You must use `elastic_path_payments_stripe`.
2977
+ * Postcode of the billing address.
2716
2978
  */
2717
- gateway: "elastic_path_payments_stripe";
2718
- options?: {
2719
- /**
2720
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2721
- */
2722
- receipt_email?: string;
2723
- /**
2724
- * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.
2725
- */
2726
- automatic_payment_methods?: {
2727
- /**
2728
- * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.
2729
- */
2730
- enabled?: boolean;
2731
- };
2732
- };
2979
+ postcode: string;
2733
2980
  /**
2734
- * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).
2981
+ * County of the billing address.
2735
2982
  */
2736
- payment_method_types?: Array<string>;
2983
+ county: string;
2737
2984
  /**
2738
- * Specifies the Stripe token or source.
2985
+ * Country of the billing address.
2739
2986
  */
2740
- payment?: string;
2741
- };
2742
- type DataManualPayment = DataBasePayments & {
2987
+ country: string;
2743
2988
  /**
2744
- * Specifies the type of payment gateway. You must use `manual`.
2989
+ * State, province, or region of the billing address.
2745
2990
  */
2746
- gateway: "manual";
2747
- paymentmethod_meta?: {
2748
- /**
2749
- * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.
2750
- */
2751
- custom_reference?: string;
2752
- /**
2753
- * A custom name associated with the payment method.
2754
- */
2755
- name?: string;
2756
- };
2991
+ region?: string;
2757
2992
  };
2758
- type DataPayPalExpressCheckoutPayment = DataBasePayments & {
2759
- /**
2760
- * Specifies the type of payment gateway. You must use `paypal_express_checkout`.
2761
- */
2762
- gateway: "paypal_express_checkout";
2763
- options?: {
2993
+ type CustomerCheckout = {
2994
+ data?: {
2764
2995
  /**
2765
- * The description for the payment.
2996
+ * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
2766
2997
  */
2767
- description?: string;
2998
+ order_number?: string;
2768
2999
  /**
2769
- * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.
3000
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2770
3001
  */
2771
- soft_descriptor?: string;
2772
- application_context?: {
3002
+ external_ref?: string;
3003
+ customer?: {
2773
3004
  /**
2774
- * The label that overrides the business name in the PayPal account on the PayPal site.
3005
+ * The ID of the customer.
2775
3006
  */
2776
- brand_name?: string;
3007
+ id?: string;
2777
3008
  /**
2778
- * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.
3009
+ * The email of the customer.
2779
3010
  */
2780
- locale?: string;
3011
+ email?: string;
2781
3012
  /**
2782
- * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.
3013
+ * The name of the customer.
2783
3014
  */
2784
- landing_page?: string;
3015
+ name?: string;
3016
+ };
3017
+ billing_address?: BillingAddress;
3018
+ shipping_address?: ShippingAddress;
3019
+ };
3020
+ };
3021
+ type AccountCheckout = {
3022
+ data?: {
3023
+ /**
3024
+ * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3025
+ */
3026
+ order_number?: string;
3027
+ /**
3028
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3029
+ */
3030
+ external_ref?: string;
3031
+ account?: {
2785
3032
  /**
2786
- * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.
3033
+ * The account ID.
2787
3034
  */
2788
- shipping_preference?: string;
3035
+ id?: string;
2789
3036
  /**
2790
- * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.
3037
+ * The account member ID.
2791
3038
  */
2792
- user_action?: string;
3039
+ member_id?: string;
3040
+ };
3041
+ contact?: {
2793
3042
  /**
2794
- * The callback URL for PayPal to redirect the user in the case of approved payment.
3043
+ * The name of the account member.
2795
3044
  */
2796
- return_url?: string;
3045
+ name?: string;
2797
3046
  /**
2798
- * The callback URL for PayPal to redirect user in the case a cancelled payment.
3047
+ * The email address of the account member.
2799
3048
  */
2800
- cancel_url?: string;
3049
+ email?: string;
2801
3050
  };
3051
+ billing_address?: BillingAddress;
3052
+ shipping_address?: ShippingAddress;
2802
3053
  };
2803
3054
  };
2804
- type DataStripePayment = DataBasePayments & {
2805
- /**
2806
- * Specifies the type of payment gateway. You must use `stripe`.
2807
- */
2808
- gateway: "stripe";
2809
- options?: {
2810
- /**
2811
- * The option to provide an email for Stripe receipts. Specify live mode to access this feature.
2812
- */
2813
- receipt_email?: string;
3055
+ type OrderMeta = {
3056
+ timestamps?: CartCheckoutTimestamps;
3057
+ display_price?: {
3058
+ with_tax?: FormattedPriceData;
3059
+ without_tax?: FormattedPriceData;
3060
+ tax?: FormattedPriceData;
3061
+ discount?: FormattedPriceData;
3062
+ balance_owing?: FormattedPriceData;
3063
+ paid?: FormattedPriceData;
3064
+ authorized?: FormattedPriceData;
3065
+ without_discount?: FormattedPriceData;
3066
+ shipping?: FormattedPriceData;
3067
+ shipping_discount?: FormattedPriceData;
2814
3068
  };
2815
- /**
2816
- * The Stripe token or source.
2817
- */
2818
- payment?: string;
2819
3069
  };
2820
- type DataStripeConnectPayment = DataBasePayments & {
3070
+ type Contact = {
2821
3071
  /**
2822
- * Specifies the type of payment gateway. You must use `stripe_connect`.
3072
+ * The email address of the contact.
2823
3073
  */
2824
- gateway: "stripe_connect";
2825
- options?: {
2826
- /**
2827
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2828
- */
2829
- receipt_email?: string;
2830
- };
3074
+ email?: string;
2831
3075
  /**
2832
- * Specifies the Stripe token or source.
3076
+ * The name of the contact.
2833
3077
  */
2834
- payment?: string;
3078
+ name?: string;
2835
3079
  };
2836
- type DataStripePaymentIntentsPayment = DataBasePayments & {
2837
- /**
2838
- * Specifies the type of payment gateway. You must use `stripe_payment_intents`.
2839
- */
2840
- gateway: "stripe_payment_intents";
2841
- options?: {
2842
- /**
2843
- * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
2844
- */
2845
- receipt_email?: string;
2846
- };
2847
- /**
2848
- * Specifies the Stripe token or source.
2849
- */
2850
- payment?: string;
3080
+ /**
3081
+ * Single relationship
3082
+ */
3083
+ type SingleRelationship = {
3084
+ data?: RelationshipItem;
2851
3085
  };
2852
- type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripeConnectPayment | DataStripePaymentIntentsPayment;
2853
- type TransactionResponse = {
2854
- /**
2855
- * The ID of the transaction.
2856
- */
2857
- readonly id?: string;
3086
+ /**
3087
+ * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
3088
+ */
3089
+ type Status = "complete" | "incomplete" | "cancelled" | "processing";
3090
+ /**
3091
+ * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
3092
+ */
3093
+ type Payment = "authorized" | "paid" | "unpaid" | "refunded" | "partially_paid" | "partially_authorized";
3094
+ /**
3095
+ * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
3096
+ */
3097
+ type Shipping = "unfulfilled" | "fulfilled";
3098
+ type OrderResponse = {
2858
3099
  /**
2859
- * The payment gateway reference.
3100
+ * Specifies the type of object being returned. You must use `order`.
2860
3101
  */
2861
- reference?: string;
3102
+ type?: "order";
2862
3103
  /**
2863
- * A custom name associated with the payment method.
3104
+ * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
2864
3105
  */
2865
- name?: string;
3106
+ order_number?: string;
2866
3107
  /**
2867
- * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
3108
+ * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2868
3109
  */
2869
- custom_reference?: string;
3110
+ external_ref?: string;
2870
3111
  /**
2871
- * The name of the payment gateway used.
3112
+ * Specifies the unique identifier of the order.
2872
3113
  */
2873
- gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents";
3114
+ readonly id?: string;
2874
3115
  /**
2875
- * The amount for this transaction.
3116
+ * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
2876
3117
  */
2877
- amount?: number;
3118
+ status?: "complete" | "incomplete" | "cancelled" | "processing";
2878
3119
  /**
2879
- * The refunded amount.
3120
+ * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
2880
3121
  */
2881
- refunded_amount?: number;
3122
+ payment?: "authorized" | "paid" | "unpaid" | "refunded" | "partially_paid" | "partially_authorized";
2882
3123
  /**
2883
- * The transaction currency.
3124
+ * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
2884
3125
  */
2885
- currency?: string;
3126
+ shipping?: "unfulfilled" | "fulfilled";
2886
3127
  /**
2887
- * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
3128
+ * Specifies if the order is anonymized.
2888
3129
  */
2889
- "transaction-type"?: string;
3130
+ anonymized?: boolean;
2890
3131
  /**
2891
- * The status provided by the gateway for this transaction, such as `complete` or `failed`.
3132
+ * Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.
2892
3133
  */
2893
- status?: string;
3134
+ payment_intent_id?: string;
3135
+ custom_attributes?: CustomAttributes;
3136
+ meta?: OrderMeta;
3137
+ billing_address?: BillingAddress;
3138
+ contact?: Contact;
3139
+ customer?: Contact;
3140
+ shipping_address?: ShippingAddress;
2894
3141
  relationships?: {
2895
- order?: {
2896
- data?: {
2897
- /**
2898
- * Represents the type of the object being returned. It is always `order`.
2899
- */
2900
- type?: string;
2901
- /**
2902
- * The ID of the order.
2903
- */
2904
- id?: string;
2905
- };
2906
- };
2907
- };
2908
- meta?: {
2909
- display_price?: FormattedPriceData;
2910
- display_refunded_amount?: FormattedPriceData;
2911
- timestamps?: CartCheckoutTimestamps;
3142
+ items?: RelationshipArray;
3143
+ custom_discounts?: RelationshipArray;
3144
+ promotions?: RelationshipArray;
3145
+ customer?: SingleRelationship;
3146
+ account?: SingleRelationship;
3147
+ account_member?: SingleRelationship;
2912
3148
  };
2913
3149
  };
2914
- type OrdersTransactionsConfirmRequest = {
2915
- data?: {
2916
- [key: string]: unknown;
2917
- };
3150
+ type OrderEntityResponse = {
3151
+ data?: OrderResponse;
2918
3152
  };
2919
- type OrdersTransactionsCaptureRequest = {
2920
- data?: {
2921
- options?: {
2922
- soft_descriptor?: string;
2923
- note_to_payer?: string;
2924
- };
2925
- };
3153
+ type ResponseMetaOrders = {
3154
+ page?: ResponsePaginationPage;
3155
+ results?: ResponsePaginationResults;
2926
3156
  };
2927
- type OrdersTransactionsRefundRequest = {
2928
- data?: {
3157
+ type OrderCollectionResponse = {
3158
+ data?: Array<OrderResponse>;
3159
+ links?: ResponsePageLinks;
3160
+ meta?: ResponseMetaOrders;
3161
+ };
3162
+ type OrdersAddressData = {
3163
+ /**
3164
+ * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
3165
+ */
3166
+ order_number?: string;
3167
+ /**
3168
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3169
+ */
3170
+ external_ref?: string;
3171
+ shipping_address: {
2929
3172
  /**
2930
- * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.
3173
+ * Specifies the first name of the address holder.
2931
3174
  */
2932
- amount?: number;
2933
- options?: {
2934
- /**
2935
- * Provides comments about the refund. It is used by PayPal Express.
2936
- */
2937
- note?: string;
2938
- };
2939
- };
2940
- };
2941
- type OrdersTransactionsCancelRequest = {
2942
- data?: {
2943
- options?: {
2944
- [key: string]: unknown;
2945
- };
3175
+ first_name?: string;
2946
3176
  /**
2947
- * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
3177
+ * Specifies the last name of the address holder.
2948
3178
  */
2949
- reason?: string;
3179
+ last_name?: string;
3180
+ /**
3181
+ * Specifies the phone number of the address holder.
3182
+ */
3183
+ phone_number?: string;
3184
+ /**
3185
+ * Specifies the company name.
3186
+ */
3187
+ company_name?: string;
3188
+ /**
3189
+ * Specifies the first line of the address.
3190
+ */
3191
+ line_1?: string;
3192
+ /**
3193
+ * Specifies the second line of the address.
3194
+ */
3195
+ line_2?: string;
3196
+ /**
3197
+ * Specifies the name of the city in the shipping address.
3198
+ */
3199
+ city?: string;
3200
+ /**
3201
+ * Specifies the county of the shipping address.
3202
+ */
3203
+ county?: string;
3204
+ /**
3205
+ * Specifies the state, province, or region of the shipping address.
3206
+ */
3207
+ region?: string;
3208
+ /**
3209
+ * Specifies the postcode or ZIP code of the address.
3210
+ */
3211
+ postcode?: string;
3212
+ /**
3213
+ * Specifies the country in the shipping address.
3214
+ */
3215
+ country?: string;
3216
+ /**
3217
+ * Specifies any instructions provided with the shipping address.
3218
+ */
3219
+ instructions?: string;
2950
3220
  };
2951
3221
  };
2952
- type OrderPriceData = {
3222
+ type OrdersCancelData = {
2953
3223
  /**
2954
- * The amount for this item.
3224
+ * The status of the order. You can only update the status to `cancelled`.
2955
3225
  */
2956
- amount?: number;
3226
+ status: string;
2957
3227
  /**
2958
- * The currency this item.
3228
+ * The type of the resource. You must use order.
2959
3229
  */
2960
- currency?: string;
3230
+ type: string;
2961
3231
  /**
2962
- * Whether this price is tax inclusive.
3232
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2963
3233
  */
2964
- includes_tax?: boolean;
2965
- };
2966
- /**
2967
- * Relationship data entry
2968
- */
2969
- type RelationshipItem = {
3234
+ external_ref?: string;
3235
+ };
3236
+ type OrdersFulfilledData = {
2970
3237
  /**
2971
- * The type of related resource.
3238
+ * The shipping status of the order. You can only update the shipping status to `fulfilled`.
2972
3239
  */
2973
- type?: string;
3240
+ shipping: string;
2974
3241
  /**
2975
- * The ID of the related resource.
3242
+ * The type of the resource. You must use order.
2976
3243
  */
2977
- id?: string;
2978
- };
2979
- /**
2980
- * Array of relationships
2981
- */
2982
- type RelationshipArray = {
3244
+ type: string;
2983
3245
  /**
2984
- * Individual relationships
3246
+ * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
2985
3247
  */
2986
- data?: Array<RelationshipItem>;
3248
+ external_ref?: string;
2987
3249
  };
2988
- /**
2989
- * Single relationship
2990
- */
2991
- type SingleRelationship = {
2992
- data?: RelationshipItem;
3250
+ type OrdersUpdateRequest = {
3251
+ data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
2993
3252
  };
2994
- type FormattedPriceData = {
3253
+ type OrderPriceData = {
2995
3254
  /**
2996
- * The raw total of this cart.
3255
+ * The amount for this item.
2997
3256
  */
2998
3257
  amount?: number;
2999
3258
  /**
3000
- * The currency set for this cart.
3259
+ * The currency this item.
3001
3260
  */
3002
3261
  currency?: string;
3003
3262
  /**
3004
- * The tax inclusive formatted total based on the currency.
3263
+ * Whether this price is tax inclusive.
3005
3264
  */
3006
- formatted?: string;
3007
- };
3008
- type OrderItemFormattedUnitPriceData = {
3009
- unit?: FormattedPriceData;
3010
- value?: FormattedPriceData;
3265
+ includes_tax?: boolean;
3011
3266
  };
3012
3267
  type DiscountData = {
3013
3268
  amount?: OrderPriceData;
3014
3269
  code?: string;
3015
3270
  readonly id?: string;
3016
3271
  };
3272
+ type OrderItemFormattedUnitPriceData = {
3273
+ unit?: FormattedPriceData;
3274
+ value?: FormattedPriceData;
3275
+ };
3017
3276
  type OrderItemResponse = {
3018
3277
  /**
3019
3278
  * The type represents the object being returned.
@@ -3089,314 +3348,378 @@ type OrderItemResponse = {
3089
3348
  */
3090
3349
  catalog_source?: string;
3091
3350
  };
3092
- type OrderResponse = {
3351
+ type OrderItemCollectionResponse = {
3352
+ data?: Array<OrderItemResponse>;
3353
+ };
3354
+ type OrdersAnonymizeData = {
3093
3355
  /**
3094
- * Specifies the type of object being returned. You must use `order`.
3356
+ * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
3095
3357
  */
3096
- type?: string;
3358
+ order_ids?: Array<string>;
3359
+ };
3360
+ type OrdersAnonymizeRequest = {
3361
+ data?: OrdersAnonymizeData;
3362
+ };
3363
+ type OrdersListResponse = {
3364
+ data: Array<OrderResponse>;
3365
+ };
3366
+ type DataAdyenPayment = DataBasePayments & {
3097
3367
  /**
3098
- * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3368
+ * Specifies the gateway. You must use `adyen`.
3099
3369
  */
3100
- order_number?: string;
3370
+ gateway: "adyen";
3371
+ options?: {
3372
+ /**
3373
+ * The shopper reference token associated with the saved payment method.
3374
+ */
3375
+ shopper_reference?: string;
3376
+ /**
3377
+ * Enter CardOnFile for a one-time purchase.
3378
+ */
3379
+ recurring_processing_model?: string;
3380
+ };
3101
3381
  /**
3102
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3382
+ * The Adyen recurringDetailReference payment method identifier.
3103
3383
  */
3104
- external_ref?: string;
3384
+ payment: string;
3385
+ };
3386
+ type DataAuthorizeNetPayment = DataBasePayments & {
3105
3387
  /**
3106
- * Specifies the unique identifier of the order.
3388
+ * Specifies the gateway. You must use `authorize_net`.
3107
3389
  */
3108
- readonly id?: string;
3390
+ gateway: "authorize_net";
3391
+ options?: {
3392
+ /**
3393
+ * The Authorize.net customer payment profile ID.
3394
+ */
3395
+ customer_payment_profile_id?: string;
3396
+ };
3109
3397
  /**
3110
- * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.
3398
+ * The Authorize.net customer profile ID.
3111
3399
  */
3112
- status?: string;
3400
+ payment: string;
3401
+ };
3402
+ type DataBraintreePayment = DataBasePayments & {
3113
3403
  /**
3114
- * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
3404
+ * Specifies the gateway. You must use `braintree`.
3115
3405
  */
3116
- payment?: string;
3406
+ gateway: "braintree";
3117
3407
  /**
3118
- * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.
3408
+ * The Braintree Customer ID that you want to bill.
3119
3409
  */
3120
- shipping?: string;
3410
+ payment: string;
3411
+ };
3412
+ type DataCardConnectPayment = DataBasePayments & {
3121
3413
  /**
3122
- * Specifies if the order is anonymized.
3414
+ * Specifies the gateway. You must use `card_connect`.
3123
3415
  */
3124
- anonymized?: boolean;
3125
- meta?: OrderMeta;
3126
- billing_address?: BillingAddress;
3127
- contact?: Contact;
3128
- customer?: {
3129
- /**
3130
- * The name of the customer.
3131
- */
3132
- name?: string;
3133
- /**
3134
- * The email address of the customer.
3135
- */
3136
- email?: string;
3137
- };
3138
- shipping_address?: ShippingAddress;
3139
- relationships?: {
3140
- items?: RelationshipArray;
3141
- custom_discounts?: RelationshipArray;
3142
- promotions?: RelationshipArray;
3143
- customer?: SingleRelationship;
3144
- account?: SingleRelationship;
3145
- account_member?: SingleRelationship;
3146
- };
3416
+ gateway: "card_connect";
3417
+ /**
3418
+ * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.
3419
+ */
3420
+ payment: string;
3147
3421
  };
3148
- type OrderMeta = {
3149
- timestamps?: CartCheckoutTimestamps;
3150
- display_price?: {
3151
- with_tax?: FormattedPriceData;
3152
- without_tax?: FormattedPriceData;
3153
- tax?: FormattedPriceData;
3154
- discount?: FormattedPriceData;
3155
- balance_owing?: FormattedPriceData;
3156
- paid?: FormattedPriceData;
3157
- authorized?: FormattedPriceData;
3158
- without_discount?: FormattedPriceData;
3159
- shipping?: FormattedPriceData;
3160
- shipping_discount?: FormattedPriceData;
3161
- };
3422
+ type DataCyberSourcePayment = DataBasePayments & {
3423
+ /**
3424
+ * Specifies the gateway. You must use `cyber_source`.
3425
+ */
3426
+ gateway: "cyber_source";
3427
+ /**
3428
+ * The CyberSource token.
3429
+ */
3430
+ payment: string;
3162
3431
  };
3163
- type CustomerCheckout = {
3164
- data?: {
3432
+ type DataManualPayment = DataBasePayments & {
3433
+ /**
3434
+ * Specifies the type of payment gateway. You must use `manual`.
3435
+ */
3436
+ gateway: "manual";
3437
+ paymentmethod_meta?: {
3165
3438
  /**
3166
- * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3439
+ * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.
3167
3440
  */
3168
- order_number?: string;
3441
+ custom_reference?: string;
3169
3442
  /**
3170
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3443
+ * A custom name associated with the payment method.
3171
3444
  */
3172
- external_ref?: string;
3173
- customer?: {
3174
- /**
3175
- * The ID of the customer.
3176
- */
3177
- id?: string;
3178
- };
3179
- billing_address?: BillingAddress;
3180
- shipping_address?: ShippingAddress;
3445
+ name?: string;
3181
3446
  };
3182
3447
  };
3183
- type AccountCheckout = {
3184
- data?: {
3448
+ type DataPayPalExpressCheckoutPayment = DataBasePayments & {
3449
+ /**
3450
+ * Specifies the type of payment gateway. You must use `paypal_express_checkout`.
3451
+ */
3452
+ gateway: "paypal_express_checkout";
3453
+ options?: {
3185
3454
  /**
3186
- * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
3455
+ * The description for the payment.
3187
3456
  */
3188
- order_number?: string;
3457
+ description?: string;
3189
3458
  /**
3190
- * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
3459
+ * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.
3191
3460
  */
3192
- external_ref?: string;
3193
- account?: {
3461
+ soft_descriptor?: string;
3462
+ application_context?: {
3194
3463
  /**
3195
- * The account ID.
3464
+ * The label that overrides the business name in the PayPal account on the PayPal site.
3196
3465
  */
3197
- id?: string;
3466
+ brand_name?: string;
3198
3467
  /**
3199
- * The account member ID.
3468
+ * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.
3200
3469
  */
3201
- member_id?: string;
3202
- };
3203
- contact?: {
3470
+ locale?: string;
3204
3471
  /**
3205
- * The name of the account member.
3472
+ * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.
3206
3473
  */
3207
- name?: string;
3474
+ landing_page?: string;
3208
3475
  /**
3209
- * The email address of the account member.
3476
+ * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.
3210
3477
  */
3211
- email?: string;
3212
- };
3213
- billing_address?: BillingAddress;
3214
- shipping_address?: ShippingAddress;
3215
- };
3216
- };
3217
- type BillingAddress = {
3218
- /**
3219
- * First name of the billing recipient.
3220
- */
3221
- first_name: string;
3222
- /**
3223
- * Last name of the billing recipient.
3224
- */
3225
- last_name: string;
3226
- /**
3227
- * Company name of the billing recipient.
3228
- */
3229
- company_name: string;
3230
- /**
3231
- * First line of the billing address.
3232
- */
3233
- line_1: string;
3234
- /**
3235
- * Second line of the billing address.
3236
- */
3237
- line_2: string;
3238
- /**
3239
- * City of the billing address.
3240
- */
3241
- city: string;
3242
- /**
3243
- * Postcode of the billing address.
3244
- */
3245
- postcode: string;
3246
- /**
3247
- * County of the billing address.
3248
- */
3249
- county: string;
3478
+ shipping_preference?: string;
3479
+ /**
3480
+ * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.
3481
+ */
3482
+ user_action?: string;
3483
+ /**
3484
+ * The callback URL for PayPal to redirect the user in the case of approved payment.
3485
+ */
3486
+ return_url?: string;
3487
+ /**
3488
+ * The callback URL for PayPal to redirect user in the case a cancelled payment.
3489
+ */
3490
+ cancel_url?: string;
3491
+ };
3492
+ };
3493
+ };
3494
+ type DataStripePayment = DataBasePayments & {
3250
3495
  /**
3251
- * Country of the billing address.
3496
+ * Specifies the type of payment gateway. You must use `stripe`.
3252
3497
  */
3253
- country: string;
3498
+ gateway: "stripe";
3499
+ options?: {
3500
+ /**
3501
+ * The option to provide an email for Stripe receipts. Specify live mode to access this feature.
3502
+ */
3503
+ receipt_email?: string;
3504
+ };
3254
3505
  /**
3255
- * State, province, or region of the billing address.
3506
+ * The Stripe token or source.
3256
3507
  */
3257
- region: string;
3508
+ payment?: string;
3258
3509
  };
3259
- type Contact = {
3510
+ type DataStripeConnectPayment = DataBasePayments & {
3260
3511
  /**
3261
- * The email address of the contact.
3512
+ * Specifies the type of payment gateway. You must use `stripe_connect`.
3262
3513
  */
3263
- email?: string;
3514
+ gateway: "stripe_connect";
3515
+ options?: {
3516
+ /**
3517
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
3518
+ */
3519
+ receipt_email?: string;
3520
+ };
3264
3521
  /**
3265
- * The name of the contact.
3522
+ * Specifies the Stripe token or source.
3266
3523
  */
3267
- name?: string;
3524
+ payment?: string;
3268
3525
  };
3269
- type ShippingAddress = {
3526
+ type DataStripePaymentIntentsPayment = DataBasePayments & {
3270
3527
  /**
3271
- * First name of the shipping recipient.
3528
+ * Specifies the type of payment gateway. You must use `stripe_payment_intents`.
3272
3529
  */
3273
- first_name: string;
3530
+ gateway: "stripe_payment_intents";
3531
+ options?: {
3532
+ /**
3533
+ * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.
3534
+ */
3535
+ receipt_email?: string;
3536
+ };
3274
3537
  /**
3275
- * Last name of the shipping recipient.
3538
+ * Specifies the Stripe token or source.
3276
3539
  */
3277
- last_name: string;
3540
+ payment?: string;
3541
+ };
3542
+ type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripeConnectPayment | DataStripePaymentIntentsPayment;
3543
+ type PaymentsRequest = {
3544
+ data?: DataPaymentObject;
3545
+ };
3546
+ type TransactionResponse = {
3278
3547
  /**
3279
- * Phone number of the shipping recipient.
3548
+ * The ID of the transaction.
3280
3549
  */
3281
- phone_number: string;
3550
+ readonly id?: string;
3282
3551
  /**
3283
- * Company of the shipping recipient.
3552
+ * The payment gateway reference.
3284
3553
  */
3285
- company_name: string;
3554
+ reference?: string;
3286
3555
  /**
3287
- * First line of the shipping address.
3556
+ * A custom name associated with the payment method.
3288
3557
  */
3289
- line_1: string;
3558
+ name?: string;
3290
3559
  /**
3291
- * Second line of the shipping address.
3560
+ * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
3292
3561
  */
3293
- line_2: string;
3562
+ custom_reference?: string;
3294
3563
  /**
3295
- * City of the shipping address.
3564
+ * The name of the payment gateway used.
3296
3565
  */
3297
- city: string;
3566
+ gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_connect" | "stripe_payment_intents" | "stripe_platform_account";
3298
3567
  /**
3299
- * Post code of the shipping address.
3568
+ * The amount for this transaction.
3300
3569
  */
3301
- postcode: string;
3570
+ amount?: number;
3302
3571
  /**
3303
- * County of the shipping address.
3572
+ * The refunded amount.
3304
3573
  */
3305
- county: string;
3574
+ refunded_amount?: number;
3306
3575
  /**
3307
- * Country of the shipping address.
3576
+ * The transaction currency.
3308
3577
  */
3309
- country: string;
3578
+ currency?: string;
3310
3579
  /**
3311
- * State, province, or region of the shipping address.
3580
+ * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
3312
3581
  */
3313
- region: string;
3582
+ "transaction-type"?: string;
3314
3583
  /**
3315
- * Delivery instructions.
3584
+ * The status provided by the gateway for this transaction, such as `complete` or `failed`.
3316
3585
  */
3317
- instructions: string;
3586
+ status?: string;
3587
+ relationships?: {
3588
+ order?: {
3589
+ data?: {
3590
+ /**
3591
+ * Represents the type of the object being returned. It is always `order`.
3592
+ */
3593
+ type?: string;
3594
+ /**
3595
+ * The ID of the order.
3596
+ */
3597
+ id?: string;
3598
+ };
3599
+ };
3600
+ };
3601
+ meta?: {
3602
+ display_price?: FormattedPriceData;
3603
+ display_refunded_amount?: FormattedPriceData;
3604
+ timestamps?: CartCheckoutTimestamps;
3605
+ };
3318
3606
  };
3319
- type ResponseMetaCarts = {
3320
- page?: ResponsePaginationPage;
3321
- results?: ResponsePaginationResults;
3607
+ type TransactionEntityResponse = {
3608
+ data: TransactionResponse;
3322
3609
  };
3323
- type ResponseMetaOrders = {
3324
- page?: ResponsePaginationPage;
3325
- results?: ResponsePaginationResults;
3610
+ type OrdersTransactionsConfirmRequest = {
3611
+ data?: {
3612
+ [key: string]: unknown;
3613
+ };
3326
3614
  };
3327
- type ResponsePaginationPage = {
3328
- /**
3329
- * The current page.
3330
- */
3331
- current?: number;
3332
- /**
3333
- * The maximum number of records per page for this response. You can set this value up to 100.
3334
- */
3335
- limit?: number;
3336
- /**
3337
- * The current offset by number of records, not pages. Offset is zero-based.
3338
- */
3339
- offset?: number;
3615
+ type OrdersTransactionsCaptureRequest = {
3616
+ data?: {
3617
+ options?: {
3618
+ soft_descriptor?: string;
3619
+ note_to_payer?: string;
3620
+ };
3621
+ };
3622
+ };
3623
+ type OrdersTransactionsRefundRequest = {
3624
+ data?: {
3625
+ /**
3626
+ * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.
3627
+ */
3628
+ amount?: number;
3629
+ options?: {
3630
+ /**
3631
+ * Provides comments about the refund. It is used by PayPal Express.
3632
+ */
3633
+ note?: string;
3634
+ };
3635
+ };
3636
+ };
3637
+ type TransactionListResponse = {
3638
+ data: Array<TransactionResponse>;
3639
+ };
3640
+ type ResponseData = {
3641
+ data?: unknown;
3642
+ };
3643
+ type OrdersTransactionsCancelRequest = {
3644
+ data?: {
3645
+ options?: {
3646
+ [key: string]: unknown;
3647
+ };
3648
+ /**
3649
+ * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
3650
+ */
3651
+ reason?: string;
3652
+ };
3653
+ };
3654
+ type UpdateOrderShippingGroupRequest = {
3655
+ data?: {
3656
+ type?: "shipping_group";
3657
+ shipping_type?: string;
3658
+ tracking_reference?: string;
3659
+ address?: ShippingAddress;
3660
+ delivery_estimate?: DeliveryEstimate;
3661
+ };
3662
+ };
3663
+ type CartCheckoutTimestamps = {
3340
3664
  /**
3341
- * The total page count.
3665
+ * The date this was created.
3342
3666
  */
3343
- total?: number;
3344
- };
3345
- type ResponsePaginationResults = {
3667
+ created_at?: string;
3346
3668
  /**
3347
- * The total page count.
3669
+ * The date this was last updated.
3348
3670
  */
3349
- total?: number;
3671
+ updated_at?: unknown;
3350
3672
  };
3351
- type ResponsePageLinks = {
3673
+ type CartIncludedPromotion = {
3352
3674
  /**
3353
- * Always the current page.
3675
+ * The unique identifier of the promotion.
3354
3676
  */
3355
- current?: string;
3677
+ id: string;
3356
3678
  /**
3357
- * Always the first page.
3679
+ * The name of the promotion.
3358
3680
  */
3359
- first?: string;
3681
+ name: string;
3360
3682
  /**
3361
- * If there is only one page, it is `null`.
3683
+ * A description of the promotion.
3362
3684
  */
3363
- last?: string;
3685
+ description?: string;
3364
3686
  /**
3365
- * If there is only one page, it is `null`.
3687
+ * Indicates if the promotion is automatic.
3366
3688
  */
3367
- next?: string;
3689
+ automatic: boolean;
3368
3690
  /**
3369
- * if the user is on the first page, it is `null`.
3691
+ * The source of the promotion.
3370
3692
  */
3371
- prev?: string;
3372
- };
3373
- type ResponseData = {
3374
- data?: unknown;
3375
- };
3376
- type ResponseError = Array<unknown>;
3377
- type CartTimestamps = {
3378
- created_at?: string;
3379
- updated_at?: unknown;
3380
- expires_at?: unknown;
3381
- };
3382
- type CartCheckoutTimestamps = {
3693
+ promotion_source: string;
3383
3694
  /**
3384
- * The date this was created.
3695
+ * The start date and time of the promotion.
3385
3696
  */
3386
- created_at?: string;
3697
+ start: Date;
3387
3698
  /**
3388
- * The date this was last updated.
3699
+ * The end date and time of the promotion.
3389
3700
  */
3390
- updated_at?: unknown;
3701
+ end: Date;
3391
3702
  };
3392
3703
  /**
3393
3704
  * Included is an array of resources that are included in the response.
3394
3705
  */
3395
- type CartInclude = {
3706
+ type CartIncluded = {
3396
3707
  /**
3397
3708
  * The cart items associated with a cart.
3398
3709
  */
3399
- items?: Array<CartItemsObjectResponse>;
3710
+ items?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
3711
+ /**
3712
+ * The tax items associated with a cart.
3713
+ */
3714
+ tax_items?: Array<CartsItemsTaxesObject>;
3715
+ /**
3716
+ * The custom discounts associated with a cart.
3717
+ */
3718
+ custom_discounts?: Array<CartsCustomDiscountsObject>;
3719
+ /**
3720
+ * The promotions associated with a cart.
3721
+ */
3722
+ promotions?: Array<CartIncludedPromotion>;
3400
3723
  };
3401
3724
  /**
3402
3725
  * Whether a pricing option is active on a subscription using that offering. The `active_pricing_option` attribute is null if a pricing option is not active in a subscription.
@@ -3462,7 +3785,7 @@ type LinkObject = {
3462
3785
  /**
3463
3786
  * The status of a subscription, either `active` or `inactive`.
3464
3787
  */
3465
- type Status = "active" | "inactive";
3788
+ type Status2 = "active" | "inactive";
3466
3789
  /**
3467
3790
  * Enumerates a list of resources that are related.
3468
3791
  */
@@ -4356,7 +4679,7 @@ type SubscriptionIncludes = {
4356
4679
  type SubscriptionMeta = {
4357
4680
  owner: OwnerMeta;
4358
4681
  timestamps: SubscriptionTimestamps;
4359
- status: Status;
4682
+ status: Status2;
4360
4683
  state?: SubscriptionState;
4361
4684
  manual_payments: ManualPayments;
4362
4685
  /**
@@ -4514,15 +4837,6 @@ type Import = {
4514
4837
  attributes: ImportAttributes;
4515
4838
  meta: ImportMeta;
4516
4839
  };
4517
- /**
4518
- * The status of job.
4519
- * - **pending** - Commerce has received the request but is currently busy processing other requests.
4520
- * - **started** - Commerce has started processing the job.
4521
- * - **success** - The job has successfully completed.
4522
- * - **failed** - The job has failed.
4523
- *
4524
- */
4525
- type Status2 = "pending" | "started" | "success" | "failed";
4526
4840
  type ImportAttributes = {
4527
4841
  external_ref?: ExternalRef;
4528
4842
  /**
@@ -6134,6 +6448,7 @@ type SelfLink2 = {
6134
6448
  */
6135
6449
  self?: string;
6136
6450
  };
6451
+ type ResponseError = Array<unknown>;
6137
6452
  type File = {
6138
6453
  /**
6139
6454
  * The unique identifier for this file.
@@ -6340,7 +6655,7 @@ type PricebookIdsForPriceSegmentationPreview = Array<string>;
6340
6655
  * Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
6341
6656
  */
6342
6657
  type Tag = string;
6343
- type CartInclude2 = Array<"items">;
6658
+ type CartInclude = Array<"items" | "tax_items" | "custom_discounts" | "promotions">;
6344
6659
  /**
6345
6660
  * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
6346
6661
  */
@@ -8435,23 +8750,26 @@ type GetCartsData = {
8435
8750
  };
8436
8751
  type GetCartsErrors = {
8437
8752
  /**
8438
- * Unauthorized
8753
+ * Bad Request
8439
8754
  */
8440
- 401: ResponseError;
8755
+ 400: {
8756
+ errors?: Array<{
8757
+ detail?: string;
8758
+ title?: string;
8759
+ }>;
8760
+ };
8761
+ /**
8762
+ * Unauthorized call
8763
+ */
8764
+ 403: ResponseErrorResponse;
8441
8765
  };
8442
8766
  type GetCartsError = GetCartsErrors[keyof GetCartsErrors];
8443
8767
  type GetCartsResponses = {
8444
- 200: ResponseData & {
8445
- data?: Array<CartResponse>;
8446
- links?: ResponsePageLinks;
8447
- meta?: ResponseMetaCarts;
8448
- };
8768
+ 200: CartCollectionResponse;
8449
8769
  };
8450
8770
  type GetCartsResponse = GetCartsResponses[keyof GetCartsResponses];
8451
8771
  type CreateACartData = {
8452
- body?: ResponseData & {
8453
- data?: CartsRequest;
8454
- };
8772
+ body?: CartsRequest;
8455
8773
  headers?: {
8456
8774
  /**
8457
8775
  * A customer token to be associated with the cart.
@@ -8464,15 +8782,23 @@ type CreateACartData = {
8464
8782
  };
8465
8783
  type CreateACartErrors = {
8466
8784
  /**
8467
- * Unauthorized
8785
+ * Bad Request
8468
8786
  */
8469
- 401: ResponseError;
8787
+ 400: {
8788
+ errors?: Array<{
8789
+ detail?: string;
8790
+ status?: number;
8791
+ title?: string;
8792
+ }>;
8793
+ };
8794
+ /**
8795
+ * Unauthorized call
8796
+ */
8797
+ 403: ResponseErrorResponse;
8470
8798
  };
8471
8799
  type CreateACartError = CreateACartErrors[keyof CreateACartErrors];
8472
8800
  type CreateACartResponses = {
8473
- 200: ResponseData & {
8474
- data?: CartResponse;
8475
- };
8801
+ 201: CartEntityResponse;
8476
8802
  };
8477
8803
  type CreateACartResponse = CreateACartResponses[keyof CreateACartResponses];
8478
8804
  type DeleteACartData = {
@@ -8488,9 +8814,9 @@ type DeleteACartData = {
8488
8814
  };
8489
8815
  type DeleteACartErrors = {
8490
8816
  /**
8491
- * Unauthorized
8817
+ * Bad Request
8492
8818
  */
8493
- 401: ResponseError;
8819
+ 400: ResponseErrorResponse;
8494
8820
  };
8495
8821
  type DeleteACartError = DeleteACartErrors[keyof DeleteACartErrors];
8496
8822
  type DeleteACartResponses = {
@@ -8500,7 +8826,7 @@ type DeleteACartResponses = {
8500
8826
  204: void;
8501
8827
  };
8502
8828
  type DeleteACartResponse = DeleteACartResponses[keyof DeleteACartResponses];
8503
- type GetCartData = {
8829
+ type GetACartData = {
8504
8830
  body?: never;
8505
8831
  path: {
8506
8832
  /**
@@ -8509,29 +8835,30 @@ type GetCartData = {
8509
8835
  cartID: string;
8510
8836
  };
8511
8837
  query?: {
8512
- include?: Array<"items">;
8838
+ include?: Array<"items" | "tax_items" | "custom_discounts" | "promotions">;
8513
8839
  };
8514
8840
  url: "/v2/carts/{cartID}";
8515
8841
  };
8516
- type GetCartErrors = {
8842
+ type GetACartErrors = {
8517
8843
  /**
8518
- * Unauthorized
8844
+ * Bad Request
8519
8845
  */
8520
- 401: ResponseError;
8846
+ 400: {
8847
+ errors?: Array<{
8848
+ detail?: string;
8849
+ status?: number;
8850
+ title?: string;
8851
+ }>;
8852
+ };
8521
8853
  };
8522
- type GetCartError = GetCartErrors[keyof GetCartErrors];
8523
- type GetCartResponses = {
8854
+ type GetACartError = GetACartErrors[keyof GetACartErrors];
8855
+ type GetACartResponses = {
8524
8856
  /**
8525
8857
  * OK
8526
8858
  */
8527
- 200: ResponseData & {
8528
- data?: CartResponse;
8529
- } & {
8530
- data?: CartResponse;
8531
- included?: CartInclude;
8532
- };
8859
+ 200: CartEntityResponse;
8533
8860
  };
8534
- type GetCartResponse = GetCartResponses[keyof GetCartResponses];
8861
+ type GetACartResponse = GetACartResponses[keyof GetACartResponses];
8535
8862
  type UpdateACartData = {
8536
8863
  body?: CartsRequest;
8537
8864
  path: {
@@ -8545,15 +8872,23 @@ type UpdateACartData = {
8545
8872
  };
8546
8873
  type UpdateACartErrors = {
8547
8874
  /**
8548
- * Unauthorized
8875
+ * Unauthorized call
8549
8876
  */
8550
- 401: ResponseError;
8877
+ 403: ResponseErrorResponse;
8878
+ /**
8879
+ * Unprocessable Content
8880
+ */
8881
+ 422: {
8882
+ errors?: Array<{
8883
+ detail?: string;
8884
+ status?: number;
8885
+ title?: string;
8886
+ }>;
8887
+ };
8551
8888
  };
8552
8889
  type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors];
8553
8890
  type UpdateACartResponses = {
8554
- 200: ResponseData & {
8555
- data?: CartResponse;
8556
- };
8891
+ 200: CartEntityResponse;
8557
8892
  };
8558
8893
  type UpdateACartResponse = UpdateACartResponses[keyof UpdateACartResponses];
8559
8894
  type DeleteAllCartItemsData = {
@@ -8569,9 +8904,9 @@ type DeleteAllCartItemsData = {
8569
8904
  };
8570
8905
  type DeleteAllCartItemsErrors = {
8571
8906
  /**
8572
- * Unauthorized
8907
+ * Unprocessable Entity
8573
8908
  */
8574
- 401: ResponseError;
8909
+ 422: ResponseErrorResponse;
8575
8910
  };
8576
8911
  type DeleteAllCartItemsError = DeleteAllCartItemsErrors[keyof DeleteAllCartItemsErrors];
8577
8912
  type DeleteAllCartItemsResponses = {
@@ -8592,19 +8927,12 @@ type GetCartItemsData = {
8592
8927
  query?: never;
8593
8928
  url: "/v2/carts/{cartID}/items";
8594
8929
  };
8595
- type GetCartItemsErrors = {
8596
- /**
8597
- * Unauthorized
8598
- */
8599
- 401: ResponseError;
8600
- };
8601
- type GetCartItemsError = GetCartItemsErrors[keyof GetCartItemsErrors];
8602
8930
  type GetCartItemsResponses = {
8603
- 200: CartsResponse;
8931
+ 200: CartItemsResponse;
8604
8932
  };
8605
8933
  type GetCartItemsResponse = GetCartItemsResponses[keyof GetCartItemsResponses];
8606
8934
  type ManageCartsData = {
8607
- body?: CartItemsObjectRequest | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject | BulkAddItemsRequest;
8935
+ body?: CartItemObjectRequest | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject | BulkAddItemsRequest;
8608
8936
  path: {
8609
8937
  /**
8610
8938
  * The unique identifier of the cart that you created.
@@ -8616,13 +8944,25 @@ type ManageCartsData = {
8616
8944
  };
8617
8945
  type ManageCartsErrors = {
8618
8946
  /**
8619
- * Unauthorized
8947
+ * Bad Request
8620
8948
  */
8621
- 401: ResponseError;
8949
+ 400: ResponseErrorResponse;
8950
+ /**
8951
+ * Not Found
8952
+ */
8953
+ 404: ResponseErrorResponse;
8954
+ /**
8955
+ * Unprocessable Entity
8956
+ */
8957
+ 422: ResponseErrorResponse;
8958
+ /**
8959
+ * Internal Server Error
8960
+ */
8961
+ 500: ResponseErrorResponse;
8622
8962
  };
8623
8963
  type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors];
8624
8964
  type ManageCartsResponses = {
8625
- 200: CartsResponse;
8965
+ 201: CartsResponse;
8626
8966
  };
8627
8967
  type ManageCartsResponse = ManageCartsResponses[keyof ManageCartsResponses];
8628
8968
  type BulkUpdateItemsInCartData = {
@@ -8638,9 +8978,17 @@ type BulkUpdateItemsInCartData = {
8638
8978
  };
8639
8979
  type BulkUpdateItemsInCartErrors = {
8640
8980
  /**
8641
- * Unauthorized
8981
+ * Insufficient Stock
8642
8982
  */
8643
- 401: ResponseError;
8983
+ 400: ResponseErrorResponse;
8984
+ /**
8985
+ * Not Found
8986
+ */
8987
+ 404: ResponseErrorResponse;
8988
+ /**
8989
+ * Unprocessable Entity
8990
+ */
8991
+ 422: ResponseErrorResponse;
8644
8992
  };
8645
8993
  type BulkUpdateItemsInCartError = BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors];
8646
8994
  type BulkUpdateItemsInCartResponses = {
@@ -8661,18 +9009,8 @@ type DeleteACartItemData = {
8661
9009
  query?: never;
8662
9010
  url: "/v2/carts/{cartID}/items/{cartitemID}";
8663
9011
  };
8664
- type DeleteACartItemErrors = {
8665
- /**
8666
- * Unauthorized
8667
- */
8668
- 401: ResponseError;
8669
- };
8670
- type DeleteACartItemError = DeleteACartItemErrors[keyof DeleteACartItemErrors];
8671
9012
  type DeleteACartItemResponses = {
8672
- /**
8673
- * No Content
8674
- */
8675
- 204: void;
9013
+ 200: CartsResponse;
8676
9014
  };
8677
9015
  type DeleteACartItemResponse = DeleteACartItemResponses[keyof DeleteACartItemResponses];
8678
9016
  type UpdateACartItemData = {
@@ -8692,9 +9030,13 @@ type UpdateACartItemData = {
8692
9030
  };
8693
9031
  type UpdateACartItemErrors = {
8694
9032
  /**
8695
- * Unauthorized
9033
+ * Bad Request
8696
9034
  */
8697
- 401: ResponseError;
9035
+ 400: ResponseErrorResponse;
9036
+ /**
9037
+ * Not Found
9038
+ */
9039
+ 404: ResponseErrorResponse;
8698
9040
  };
8699
9041
  type UpdateACartItemError = UpdateACartItemErrors[keyof UpdateACartItemErrors];
8700
9042
  type UpdateACartItemResponses = {
@@ -8720,9 +9062,13 @@ type DeleteAccountCartAssociationData = {
8720
9062
  };
8721
9063
  type DeleteAccountCartAssociationErrors = {
8722
9064
  /**
8723
- * Unauthorized
9065
+ * Bad Request
8724
9066
  */
8725
- 401: ResponseError;
9067
+ 400: ResponseErrorResponse;
9068
+ /**
9069
+ * Forbidden
9070
+ */
9071
+ 403: ResponseErrorResponse;
8726
9072
  };
8727
9073
  type DeleteAccountCartAssociationError = DeleteAccountCartAssociationErrors[keyof DeleteAccountCartAssociationErrors];
8728
9074
  type DeleteAccountCartAssociationResponses = {
@@ -8751,9 +9097,17 @@ type CreateAccountCartAssociationData = {
8751
9097
  };
8752
9098
  type CreateAccountCartAssociationErrors = {
8753
9099
  /**
8754
- * Unauthorized
9100
+ * Bad Request
8755
9101
  */
8756
- 401: ResponseError;
9102
+ 400: ResponseErrorResponse;
9103
+ /**
9104
+ * Forbidden
9105
+ */
9106
+ 403: ResponseErrorResponse;
9107
+ /**
9108
+ * Unprocessable Entity
9109
+ */
9110
+ 422: ResponseErrorResponse;
8757
9111
  };
8758
9112
  type CreateAccountCartAssociationError = CreateAccountCartAssociationErrors[keyof CreateAccountCartAssociationErrors];
8759
9113
  type CreateAccountCartAssociationResponses = {
@@ -8786,9 +9140,13 @@ type DeleteCustomerCartAssociationData = {
8786
9140
  };
8787
9141
  type DeleteCustomerCartAssociationErrors = {
8788
9142
  /**
8789
- * Unauthorized
9143
+ * Bad Request
8790
9144
  */
8791
- 401: ResponseError;
9145
+ 400: ResponseErrorResponse;
9146
+ /**
9147
+ * Forbidden
9148
+ */
9149
+ 403: ResponseErrorResponse;
8792
9150
  };
8793
9151
  type DeleteCustomerCartAssociationError = DeleteCustomerCartAssociationErrors[keyof DeleteCustomerCartAssociationErrors];
8794
9152
  type DeleteCustomerCartAssociationResponses = {
@@ -8816,10 +9174,18 @@ type CreateCustomerCartAssociationData = {
8816
9174
  url: "/v2/carts/{cartID}/relationships/customers";
8817
9175
  };
8818
9176
  type CreateCustomerCartAssociationErrors = {
9177
+ /**
9178
+ * Bad Request
9179
+ */
9180
+ 400: ResponseErrorResponse;
9181
+ /**
9182
+ * Forbidden
9183
+ */
9184
+ 403: ResponseErrorResponse;
8819
9185
  /**
8820
9186
  * Unauthorized
8821
9187
  */
8822
- 401: ResponseError;
9188
+ 422: ResponseErrorResponse;
8823
9189
  };
8824
9190
  type CreateCustomerCartAssociationError = CreateCustomerCartAssociationErrors[keyof CreateCustomerCartAssociationErrors];
8825
9191
  type CreateCustomerCartAssociationResponses = {
@@ -8827,6 +9193,10 @@ type CreateCustomerCartAssociationResponses = {
8827
9193
  * OK
8828
9194
  */
8829
9195
  200: CartsRelationshipsCustomersData;
9196
+ /**
9197
+ * No Content
9198
+ */
9199
+ 204: void;
8830
9200
  };
8831
9201
  type CreateCustomerCartAssociationResponse = CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses];
8832
9202
  type DeleteAPromotionViaPromotionCodeData = {
@@ -8844,13 +9214,6 @@ type DeleteAPromotionViaPromotionCodeData = {
8844
9214
  query?: never;
8845
9215
  url: "/v2/carts/{cartID}/discounts/{promoCode}";
8846
9216
  };
8847
- type DeleteAPromotionViaPromotionCodeErrors = {
8848
- /**
8849
- * Unauthorized
8850
- */
8851
- 401: ResponseError;
8852
- };
8853
- type DeleteAPromotionViaPromotionCodeError = DeleteAPromotionViaPromotionCodeErrors[keyof DeleteAPromotionViaPromotionCodeErrors];
8854
9217
  type DeleteAPromotionViaPromotionCodeResponses = {
8855
9218
  /**
8856
9219
  * No Content
@@ -8859,9 +9222,7 @@ type DeleteAPromotionViaPromotionCodeResponses = {
8859
9222
  };
8860
9223
  type DeleteAPromotionViaPromotionCodeResponse = DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses];
8861
9224
  type AddTaxItemToCartData = {
8862
- body?: ResponseData & {
8863
- data?: CartsItemsTaxesObject;
8864
- };
9225
+ body?: CartItemTaxesEntityResponse;
8865
9226
  path: {
8866
9227
  /**
8867
9228
  * The unique identifier of the cart.
@@ -8879,17 +9240,15 @@ type AddTaxItemToCartErrors = {
8879
9240
  /**
8880
9241
  * Unauthorized
8881
9242
  */
8882
- 401: ResponseError;
8883
- /**
8884
- * Unauthorized
8885
- */
8886
- 422: ResponseError;
9243
+ 422: ResponseErrorResponse;
8887
9244
  };
8888
9245
  type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
8889
9246
  type AddTaxItemToCartResponses = {
8890
- 200: ResponseData & {
8891
- data?: CartsItemsTaxesObject;
8892
- };
9247
+ 200: CartItemTaxesEntityResponse;
9248
+ /**
9249
+ * Created
9250
+ */
9251
+ 201: CartItemTaxesEntityResponse;
8893
9252
  };
8894
9253
  type AddTaxItemToCartResponse = AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses];
8895
9254
  type BulkDeleteTaxItemsFromCartData = {
@@ -8903,13 +9262,6 @@ type BulkDeleteTaxItemsFromCartData = {
8903
9262
  query?: never;
8904
9263
  url: "/v2/carts/{cartID}/taxes";
8905
9264
  };
8906
- type BulkDeleteTaxItemsFromCartErrors = {
8907
- /**
8908
- * Unauthorized
8909
- */
8910
- 401: ResponseError;
8911
- };
8912
- type BulkDeleteTaxItemsFromCartError = BulkDeleteTaxItemsFromCartErrors[keyof BulkDeleteTaxItemsFromCartErrors];
8913
9265
  type BulkDeleteTaxItemsFromCartResponses = {
8914
9266
  /**
8915
9267
  * No Content
@@ -8930,13 +9282,17 @@ type BulkAddTaxItemsToCartData = {
8930
9282
  };
8931
9283
  type BulkAddTaxItemsToCartErrors = {
8932
9284
  /**
8933
- * Unauthorized
9285
+ * Unprocessable Entity
8934
9286
  */
8935
- 401: ResponseError;
9287
+ 422: ResponseErrorResponse;
8936
9288
  };
8937
9289
  type BulkAddTaxItemsToCartError = BulkAddTaxItemsToCartErrors[keyof BulkAddTaxItemsToCartErrors];
8938
9290
  type BulkAddTaxItemsToCartResponses = {
8939
9291
  200: CartsBulkTaxes;
9292
+ /**
9293
+ * Created
9294
+ */
9295
+ 201: CartsBulkTaxes;
8940
9296
  };
8941
9297
  type BulkAddTaxItemsToCartResponse = BulkAddTaxItemsToCartResponses[keyof BulkAddTaxItemsToCartResponses];
8942
9298
  type DeleteATaxItemData = {
@@ -8958,13 +9314,6 @@ type DeleteATaxItemData = {
8958
9314
  query?: never;
8959
9315
  url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}";
8960
9316
  };
8961
- type DeleteATaxItemErrors = {
8962
- /**
8963
- * Unauthorized
8964
- */
8965
- 401: ResponseError;
8966
- };
8967
- type DeleteATaxItemError = DeleteATaxItemErrors[keyof DeleteATaxItemErrors];
8968
9317
  type DeleteATaxItemResponses = {
8969
9318
  /**
8970
9319
  * No Content
@@ -8973,9 +9322,7 @@ type DeleteATaxItemResponses = {
8973
9322
  };
8974
9323
  type DeleteATaxItemResponse = DeleteATaxItemResponses[keyof DeleteATaxItemResponses];
8975
9324
  type UpdateATaxItemData = {
8976
- body?: ResponseData & {
8977
- data?: CartsItemsTaxesObject;
8978
- };
9325
+ body?: CartItemTaxesEntityResponse;
8979
9326
  path: {
8980
9327
  /**
8981
9328
  * The unique identifier of the cart.
@@ -8993,17 +9340,8 @@ type UpdateATaxItemData = {
8993
9340
  query?: never;
8994
9341
  url: "/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}";
8995
9342
  };
8996
- type UpdateATaxItemErrors = {
8997
- /**
8998
- * Unauthorized
8999
- */
9000
- 401: ResponseError;
9001
- };
9002
- type UpdateATaxItemError = UpdateATaxItemErrors[keyof UpdateATaxItemErrors];
9003
9343
  type UpdateATaxItemResponses = {
9004
- 200: ResponseData & {
9005
- data?: CartsItemsTaxesObject;
9006
- };
9344
+ 200: CartItemTaxesEntityResponse;
9007
9345
  };
9008
9346
  type UpdateATaxItemResponse = UpdateATaxItemResponses[keyof UpdateATaxItemResponses];
9009
9347
  type BulkDeleteCustomDiscountsFromCartData = {
@@ -9017,13 +9355,6 @@ type BulkDeleteCustomDiscountsFromCartData = {
9017
9355
  query?: never;
9018
9356
  url: "/v2/carts/{cartID}/custom-discounts";
9019
9357
  };
9020
- type BulkDeleteCustomDiscountsFromCartErrors = {
9021
- /**
9022
- * Unauthorized
9023
- */
9024
- 401: ResponseError;
9025
- };
9026
- type BulkDeleteCustomDiscountsFromCartError = BulkDeleteCustomDiscountsFromCartErrors[keyof BulkDeleteCustomDiscountsFromCartErrors];
9027
9358
  type BulkDeleteCustomDiscountsFromCartResponses = {
9028
9359
  /**
9029
9360
  * No Content
@@ -9044,13 +9375,17 @@ type BulkAddCustomDiscountsToCartData = {
9044
9375
  };
9045
9376
  type BulkAddCustomDiscountsToCartErrors = {
9046
9377
  /**
9047
- * Unauthorized
9378
+ * Could not apply custom discount
9048
9379
  */
9049
- 401: ResponseError;
9380
+ 400: ResponseErrorResponse;
9381
+ /**
9382
+ * Could not apply custom discount
9383
+ */
9384
+ 422: ResponseErrorResponse;
9050
9385
  };
9051
9386
  type BulkAddCustomDiscountsToCartError = BulkAddCustomDiscountsToCartErrors[keyof BulkAddCustomDiscountsToCartErrors];
9052
9387
  type BulkAddCustomDiscountsToCartResponses = {
9053
- 200: CartsBulkCustomDiscountsResponse;
9388
+ 201: CartsBulkCustomDiscountsResponse | CartsBulkCustomDiscountsCollectionResponse;
9054
9389
  };
9055
9390
  type BulkAddCustomDiscountsToCartResponse = BulkAddCustomDiscountsToCartResponses[keyof BulkAddCustomDiscountsToCartResponses];
9056
9391
  type DeleteCustomDiscountFromCartData = {
@@ -9068,13 +9403,6 @@ type DeleteCustomDiscountFromCartData = {
9068
9403
  query?: never;
9069
9404
  url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}";
9070
9405
  };
9071
- type DeleteCustomDiscountFromCartErrors = {
9072
- /**
9073
- * Unauthorized
9074
- */
9075
- 401: ResponseError;
9076
- };
9077
- type DeleteCustomDiscountFromCartError = DeleteCustomDiscountFromCartErrors[keyof DeleteCustomDiscountFromCartErrors];
9078
9406
  type DeleteCustomDiscountFromCartResponses = {
9079
9407
  /**
9080
9408
  * No Content
@@ -9083,9 +9411,7 @@ type DeleteCustomDiscountFromCartResponses = {
9083
9411
  };
9084
9412
  type DeleteCustomDiscountFromCartResponse = DeleteCustomDiscountFromCartResponses[keyof DeleteCustomDiscountFromCartResponses];
9085
9413
  type UpdateCustomDiscountForCartData = {
9086
- body?: ResponseData & {
9087
- data?: CartsCustomDiscountsObject;
9088
- };
9414
+ body?: CartsCustomDiscountsEntityRequest;
9089
9415
  path: {
9090
9416
  /**
9091
9417
  * Specifies the unique ID for the cart.
@@ -9099,17 +9425,8 @@ type UpdateCustomDiscountForCartData = {
9099
9425
  query?: never;
9100
9426
  url: "/v2/carts/{cartID}/custom-discounts/{customdiscountID}";
9101
9427
  };
9102
- type UpdateCustomDiscountForCartErrors = {
9103
- /**
9104
- * Unauthorized
9105
- */
9106
- 401: ResponseError;
9107
- };
9108
- type UpdateCustomDiscountForCartError = UpdateCustomDiscountForCartErrors[keyof UpdateCustomDiscountForCartErrors];
9109
9428
  type UpdateCustomDiscountForCartResponses = {
9110
- 200: ResponseData & {
9111
- data?: CartsCustomDiscountsResponse;
9112
- };
9429
+ 200: CartsCustomDiscountsEntityResponse;
9113
9430
  };
9114
9431
  type UpdateCustomDiscountForCartResponse = UpdateCustomDiscountForCartResponses[keyof UpdateCustomDiscountForCartResponses];
9115
9432
  type AddCustomDiscountToCartItemData = {
@@ -9129,15 +9446,20 @@ type AddCustomDiscountToCartItemData = {
9129
9446
  };
9130
9447
  type AddCustomDiscountToCartItemErrors = {
9131
9448
  /**
9132
- * Unauthorized
9449
+ * Bad Request
9133
9450
  */
9134
- 401: ResponseError;
9451
+ 400: ResponseErrorResponse;
9452
+ /**
9453
+ * Bad Request
9454
+ */
9455
+ 422: ResponseErrorResponse;
9135
9456
  };
9136
9457
  type AddCustomDiscountToCartItemError = AddCustomDiscountToCartItemErrors[keyof AddCustomDiscountToCartItemErrors];
9137
9458
  type AddCustomDiscountToCartItemResponses = {
9138
- 200: ResponseData & {
9139
- data?: CartsCustomDiscountsResponse;
9140
- };
9459
+ /**
9460
+ * Successful request
9461
+ */
9462
+ 201: CartsCustomDiscountsCollectionResponse | CartsCustomDiscountsEntityResponse;
9141
9463
  };
9142
9464
  type AddCustomDiscountToCartItemResponse = AddCustomDiscountToCartItemResponses[keyof AddCustomDiscountToCartItemResponses];
9143
9465
  type DeleteCustomDiscountFromCartItemData = {
@@ -9159,13 +9481,6 @@ type DeleteCustomDiscountFromCartItemData = {
9159
9481
  query?: never;
9160
9482
  url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
9161
9483
  };
9162
- type DeleteCustomDiscountFromCartItemErrors = {
9163
- /**
9164
- * Unauthorized
9165
- */
9166
- 401: ResponseError;
9167
- };
9168
- type DeleteCustomDiscountFromCartItemError = DeleteCustomDiscountFromCartItemErrors[keyof DeleteCustomDiscountFromCartItemErrors];
9169
9484
  type DeleteCustomDiscountFromCartItemResponses = {
9170
9485
  /**
9171
9486
  * No Content
@@ -9174,39 +9489,181 @@ type DeleteCustomDiscountFromCartItemResponses = {
9174
9489
  };
9175
9490
  type DeleteCustomDiscountFromCartItemResponse = DeleteCustomDiscountFromCartItemResponses[keyof DeleteCustomDiscountFromCartItemResponses];
9176
9491
  type UpdateCustomDiscountForCartItemData = {
9177
- body?: ResponseData & {
9178
- data?: CartsCustomDiscountsObject;
9492
+ body?: CartsCustomDiscountsEntityRequest;
9493
+ path: {
9494
+ /**
9495
+ * Specifies the ID for the cart.
9496
+ */
9497
+ cartID: string;
9498
+ /**
9499
+ * Specifies the ID for the cart item.
9500
+ */
9501
+ cartitemID: string;
9502
+ /**
9503
+ * Specifies the ID for the custom discount to be updated.
9504
+ */
9505
+ customdiscountID: string;
9506
+ };
9507
+ query?: never;
9508
+ url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
9509
+ };
9510
+ type UpdateCustomDiscountForCartItemResponses = {
9511
+ 200: CartsCustomDiscountsEntityResponse;
9512
+ };
9513
+ type UpdateCustomDiscountForCartItemResponse = UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses];
9514
+ type GetShippingGroupsData = {
9515
+ body?: never;
9516
+ path: {
9517
+ /**
9518
+ * The ID of the cart
9519
+ */
9520
+ cartID: string;
9521
+ };
9522
+ query?: never;
9523
+ url: "/v2/carts/{cartID}/shipping-groups";
9524
+ };
9525
+ type GetShippingGroupsErrors = {
9526
+ /**
9527
+ * Cart not found
9528
+ */
9529
+ 404: ResponseErrorResponse;
9530
+ };
9531
+ type GetShippingGroupsError = GetShippingGroupsErrors[keyof GetShippingGroupsErrors];
9532
+ type GetShippingGroupsResponses = {
9533
+ /**
9534
+ * A list of shipping groups
9535
+ */
9536
+ 200: {
9537
+ data?: Array<ShippingGroupResponse>;
9538
+ };
9539
+ };
9540
+ type GetShippingGroupsResponse = GetShippingGroupsResponses[keyof GetShippingGroupsResponses];
9541
+ type CreateShippingGroupData = {
9542
+ body: CreateShippingGroupRequest;
9543
+ path: {
9544
+ /**
9545
+ * The ID of the cart
9546
+ */
9547
+ cartID: string;
9548
+ };
9549
+ query?: never;
9550
+ url: "/v2/carts/{cartID}/shipping-groups";
9551
+ };
9552
+ type CreateShippingGroupErrors = {
9553
+ /**
9554
+ * Invalid request
9555
+ */
9556
+ 400: ResponseErrorResponse;
9557
+ /**
9558
+ * Cart not found
9559
+ */
9560
+ 404: ResponseErrorResponse;
9561
+ };
9562
+ type CreateShippingGroupError = CreateShippingGroupErrors[keyof CreateShippingGroupErrors];
9563
+ type CreateShippingGroupResponses = {
9564
+ /**
9565
+ * Shipping group created successfully
9566
+ */
9567
+ 201: ShippingGroupResponse;
9568
+ };
9569
+ type CreateShippingGroupResponse = CreateShippingGroupResponses[keyof CreateShippingGroupResponses];
9570
+ type DeleteCartShippingGroupData = {
9571
+ body?: never;
9572
+ path: {
9573
+ /**
9574
+ * The ID of the cart
9575
+ */
9576
+ cartId: string;
9577
+ /**
9578
+ * The ID of the shipping group to delete
9579
+ */
9580
+ shippingGroupId: string;
9581
+ };
9582
+ query?: never;
9583
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9584
+ };
9585
+ type DeleteCartShippingGroupErrors = {
9586
+ /**
9587
+ * Cannot delete shipping group that is attached to cart items
9588
+ */
9589
+ 400: ResponseErrorResponse;
9590
+ /**
9591
+ * Cart or shipping group not found
9592
+ */
9593
+ 404: ResponseErrorResponse;
9594
+ };
9595
+ type DeleteCartShippingGroupError = DeleteCartShippingGroupErrors[keyof DeleteCartShippingGroupErrors];
9596
+ type DeleteCartShippingGroupResponses = {
9597
+ /**
9598
+ * Successfully deleted the shipping group
9599
+ */
9600
+ 204: void;
9601
+ };
9602
+ type DeleteCartShippingGroupResponse = DeleteCartShippingGroupResponses[keyof DeleteCartShippingGroupResponses];
9603
+ type GetShippingGroupByIdData = {
9604
+ body?: never;
9605
+ path: {
9606
+ /**
9607
+ * The ID of the cart
9608
+ */
9609
+ cartId: string;
9610
+ /**
9611
+ * The ID of the shipping group
9612
+ */
9613
+ shippingGroupId: string;
9614
+ };
9615
+ query?: never;
9616
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9617
+ };
9618
+ type GetShippingGroupByIdErrors = {
9619
+ /**
9620
+ * Shipping group or cart not found
9621
+ */
9622
+ 404: ResponseErrorResponse;
9623
+ };
9624
+ type GetShippingGroupByIdError = GetShippingGroupByIdErrors[keyof GetShippingGroupByIdErrors];
9625
+ type GetShippingGroupByIdResponses = {
9626
+ /**
9627
+ * Shipping group details
9628
+ */
9629
+ 200: {
9630
+ data?: ShippingGroupResponse;
9179
9631
  };
9632
+ };
9633
+ type GetShippingGroupByIdResponse = GetShippingGroupByIdResponses[keyof GetShippingGroupByIdResponses];
9634
+ type UpdateShippingGroupData = {
9635
+ body: UpdateCartShippingGroupRequest;
9180
9636
  path: {
9181
9637
  /**
9182
- * Specifies the ID for the cart.
9183
- */
9184
- cartID: string;
9185
- /**
9186
- * Specifies the ID for the cart item.
9638
+ * The ID of the cart
9187
9639
  */
9188
- cartitemID: string;
9640
+ cartId: string;
9189
9641
  /**
9190
- * Specifies the ID for the custom discount to be updated.
9642
+ * The ID of the shipping group
9191
9643
  */
9192
- customdiscountID: string;
9644
+ shippingGroupId: string;
9193
9645
  };
9194
9646
  query?: never;
9195
- url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
9647
+ url: "/v2/carts/{cartId}/shipping-groups/{shippingGroupId}";
9196
9648
  };
9197
- type UpdateCustomDiscountForCartItemErrors = {
9649
+ type UpdateShippingGroupErrors = {
9198
9650
  /**
9199
- * Unauthorized
9651
+ * Invalid request
9200
9652
  */
9201
- 401: ResponseError;
9653
+ 400: ResponseErrorResponse;
9654
+ /**
9655
+ * Shipping group or cart not found
9656
+ */
9657
+ 404: ResponseErrorResponse;
9202
9658
  };
9203
- type UpdateCustomDiscountForCartItemError = UpdateCustomDiscountForCartItemErrors[keyof UpdateCustomDiscountForCartItemErrors];
9204
- type UpdateCustomDiscountForCartItemResponses = {
9205
- 200: ResponseData & {
9206
- data?: CartsCustomDiscountsResponse;
9207
- };
9659
+ type UpdateShippingGroupError = UpdateShippingGroupErrors[keyof UpdateShippingGroupErrors];
9660
+ type UpdateShippingGroupResponses = {
9661
+ /**
9662
+ * Shipping group updated successfully
9663
+ */
9664
+ 200: ShippingGroupResponse;
9208
9665
  };
9209
- type UpdateCustomDiscountForCartItemResponse = UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses];
9666
+ type UpdateShippingGroupResponse = UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses];
9210
9667
  type CreateCartPaymentIntentData = {
9211
9668
  body?: ElasticPathPaymentsPoweredByStripePayment;
9212
9669
  path: {
@@ -9218,13 +9675,6 @@ type CreateCartPaymentIntentData = {
9218
9675
  query?: never;
9219
9676
  url: "/v2/carts/{cartID}/payments";
9220
9677
  };
9221
- type CreateCartPaymentIntentErrors = {
9222
- /**
9223
- * Unauthorized
9224
- */
9225
- 401: ResponseError;
9226
- };
9227
- type CreateCartPaymentIntentError = CreateCartPaymentIntentErrors[keyof CreateCartPaymentIntentErrors];
9228
9678
  type CreateCartPaymentIntentResponses = {
9229
9679
  /**
9230
9680
  * Payment Intent created successfully.
@@ -9232,6 +9682,28 @@ type CreateCartPaymentIntentResponses = {
9232
9682
  201: CartResponse;
9233
9683
  };
9234
9684
  type CreateCartPaymentIntentResponse = CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses];
9685
+ type UpdateCartPaymentIntentData = {
9686
+ body: CartPaymentUpdate;
9687
+ path: {
9688
+ /**
9689
+ * The unique identifier of the cart.
9690
+ */
9691
+ cartID: string;
9692
+ /**
9693
+ * The unique identifier of the payment intent.
9694
+ */
9695
+ paymentIntentID: string;
9696
+ };
9697
+ query?: never;
9698
+ url: "/v2/carts/{cartID}/payments/{paymentIntentID}";
9699
+ };
9700
+ type UpdateCartPaymentIntentResponses = {
9701
+ /**
9702
+ * Payment updated successfully
9703
+ */
9704
+ 200: CartResponse;
9705
+ };
9706
+ type UpdateCartPaymentIntentResponse = UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses];
9235
9707
  type CheckoutApiData = {
9236
9708
  body?: CustomerCheckout | AccountCheckout;
9237
9709
  headers?: {
@@ -9251,18 +9723,20 @@ type CheckoutApiData = {
9251
9723
  };
9252
9724
  type CheckoutApiErrors = {
9253
9725
  /**
9254
- * Unauthorized
9726
+ * Bad Request
9255
9727
  */
9256
- 401: ResponseError;
9728
+ 400: ResponseErrorResponse;
9729
+ /**
9730
+ * Internal Server Error
9731
+ */
9732
+ 500: ResponseErrorResponse;
9257
9733
  };
9258
9734
  type CheckoutApiError = CheckoutApiErrors[keyof CheckoutApiErrors];
9259
9735
  type CheckoutApiResponses = {
9260
9736
  /**
9261
9737
  * OK
9262
9738
  */
9263
- 200: ResponseData & {
9264
- data?: OrderResponse;
9265
- };
9739
+ 201: OrderEntityResponse;
9266
9740
  };
9267
9741
  type CheckoutApiResponse = CheckoutApiResponses[keyof CheckoutApiResponses];
9268
9742
  type GetCustomerOrdersData = {
@@ -9274,38 +9748,11 @@ type GetCustomerOrdersData = {
9274
9748
  "x-moltin-customer-token"?: string;
9275
9749
  };
9276
9750
  path?: never;
9277
- query?: {
9278
- /**
9279
- * The number of records to offset the results by.
9280
- */
9281
- "page[offset]"?: BigInt;
9282
- /**
9283
- * The number of records per page. The maximum limit is 100.
9284
- */
9285
- "page[limit]"?: BigInt;
9286
- /**
9287
- * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9288
- */
9289
- include?: string;
9290
- };
9751
+ query?: never;
9291
9752
  url: "/v2/orders";
9292
9753
  };
9293
- type GetCustomerOrdersErrors = {
9294
- /**
9295
- * Unauthorized
9296
- */
9297
- 401: ResponseError;
9298
- };
9299
- type GetCustomerOrdersError = GetCustomerOrdersErrors[keyof GetCustomerOrdersErrors];
9300
9754
  type GetCustomerOrdersResponses = {
9301
- 200: ResponseData & {
9302
- data?: Array<OrderResponse>;
9303
- links?: ResponsePageLinks;
9304
- meta?: ResponseMetaOrders;
9305
- included?: {
9306
- items?: Array<OrderItemResponse>;
9307
- };
9308
- };
9755
+ 200: OrderCollectionResponse;
9309
9756
  };
9310
9757
  type GetCustomerOrdersResponse = GetCustomerOrdersResponses[keyof GetCustomerOrdersResponses];
9311
9758
  type GetAnOrderData = {
@@ -9316,39 +9763,21 @@ type GetAnOrderData = {
9316
9763
  */
9317
9764
  orderID: string;
9318
9765
  };
9319
- query?: {
9320
- /**
9321
- * The number of records to offset the results by.
9322
- */
9323
- "page[offset]"?: BigInt;
9324
- /**
9325
- * The number of records per page. The maximum limit is 100.
9326
- */
9327
- "page[limit]"?: BigInt;
9328
- /**
9329
- * A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
9330
- */
9331
- include?: string;
9332
- };
9766
+ query?: never;
9333
9767
  url: "/v2/orders/{orderID}";
9334
9768
  };
9335
9769
  type GetAnOrderErrors = {
9336
9770
  /**
9337
- * Unauthorized
9771
+ * Not Found
9338
9772
  */
9339
- 401: ResponseError;
9773
+ 404: ResponseErrorResponse;
9340
9774
  };
9341
9775
  type GetAnOrderError = GetAnOrderErrors[keyof GetAnOrderErrors];
9342
9776
  type GetAnOrderResponses = {
9343
9777
  /**
9344
9778
  * OK
9345
9779
  */
9346
- 200: ResponseData & {
9347
- data?: OrderResponse;
9348
- included?: {
9349
- items?: Array<OrderItemResponse>;
9350
- };
9351
- };
9780
+ 200: OrderEntityResponse;
9352
9781
  };
9353
9782
  type GetAnOrderResponse = GetAnOrderResponses[keyof GetAnOrderResponses];
9354
9783
  type UpdateAnOrderData = {
@@ -9364,18 +9793,20 @@ type UpdateAnOrderData = {
9364
9793
  };
9365
9794
  type UpdateAnOrderErrors = {
9366
9795
  /**
9367
- * Unauthorized
9796
+ * Bad Request
9368
9797
  */
9369
- 401: ResponseError;
9798
+ 400: ResponseErrorResponse;
9799
+ /**
9800
+ * Unprocessable Entity
9801
+ */
9802
+ 422: ResponseErrorResponse;
9370
9803
  };
9371
9804
  type UpdateAnOrderError = UpdateAnOrderErrors[keyof UpdateAnOrderErrors];
9372
9805
  type UpdateAnOrderResponses = {
9373
9806
  /**
9374
9807
  * OK
9375
9808
  */
9376
- 200: ResponseData & {
9377
- data?: OrderResponse;
9378
- };
9809
+ 200: OrderEntityResponse;
9379
9810
  };
9380
9811
  type UpdateAnOrderResponse = UpdateAnOrderResponses[keyof UpdateAnOrderResponses];
9381
9812
  type GetOrderItemsData = {
@@ -9389,17 +9820,8 @@ type GetOrderItemsData = {
9389
9820
  query?: never;
9390
9821
  url: "/v2/orders/{orderID}/items";
9391
9822
  };
9392
- type GetOrderItemsErrors = {
9393
- /**
9394
- * Unauthorized
9395
- */
9396
- 401: ResponseError;
9397
- };
9398
- type GetOrderItemsError = GetOrderItemsErrors[keyof GetOrderItemsErrors];
9399
9823
  type GetOrderItemsResponses = {
9400
- 200: ResponseData & {
9401
- data?: Array<OrderItemResponse>;
9402
- };
9824
+ 200: OrderItemCollectionResponse;
9403
9825
  };
9404
9826
  type GetOrderItemsResponse = GetOrderItemsResponses[keyof GetOrderItemsResponses];
9405
9827
  type AnonymizeOrdersData = {
@@ -9410,24 +9832,51 @@ type AnonymizeOrdersData = {
9410
9832
  };
9411
9833
  type AnonymizeOrdersErrors = {
9412
9834
  /**
9413
- * Unauthorized
9414
- */
9415
- 401: ResponseError;
9416
- /**
9417
- * Not Found
9835
+ * Unprocessable Entity
9418
9836
  */
9419
- 422: ResponseError;
9837
+ 422: ResponseErrorResponse;
9420
9838
  };
9421
9839
  type AnonymizeOrdersError = AnonymizeOrdersErrors[keyof AnonymizeOrdersErrors];
9422
9840
  type AnonymizeOrdersResponses = {
9423
9841
  /**
9424
9842
  * OK
9425
9843
  */
9426
- 200: ResponseData & {
9427
- data?: OrderResponse;
9428
- };
9844
+ 200: OrdersListResponse;
9429
9845
  };
9430
9846
  type AnonymizeOrdersResponse = AnonymizeOrdersResponses[keyof AnonymizeOrdersResponses];
9847
+ type ConfirmOrderData = {
9848
+ body?: never;
9849
+ path: {
9850
+ /**
9851
+ * The unique identifier of the order to confirm.
9852
+ */
9853
+ orderID: string;
9854
+ };
9855
+ query?: never;
9856
+ url: "/v2/orders/{orderID}/confirm";
9857
+ };
9858
+ type ConfirmOrderErrors = {
9859
+ /**
9860
+ * Bad Request
9861
+ */
9862
+ 400: ResponseErrorResponse;
9863
+ /**
9864
+ * Not Found
9865
+ */
9866
+ 404: ResponseErrorResponse;
9867
+ /**
9868
+ * Unprocessable Entity
9869
+ */
9870
+ 422: ResponseErrorResponse;
9871
+ };
9872
+ type ConfirmOrderError = ConfirmOrderErrors[keyof ConfirmOrderErrors];
9873
+ type ConfirmOrderResponses = {
9874
+ /**
9875
+ * Order confirmed successfully
9876
+ */
9877
+ 200: OrderResponse;
9878
+ };
9879
+ type ConfirmOrderResponse = ConfirmOrderResponses[keyof ConfirmOrderResponses];
9431
9880
  type PaymentSetupData = {
9432
9881
  body?: PaymentsRequest;
9433
9882
  path: {
@@ -9441,18 +9890,24 @@ type PaymentSetupData = {
9441
9890
  };
9442
9891
  type PaymentSetupErrors = {
9443
9892
  /**
9444
- * Unauthorized
9893
+ * Bad Request
9445
9894
  */
9446
- 401: ResponseError;
9895
+ 400: ResponseErrorResponse;
9896
+ /**
9897
+ * Conflict
9898
+ */
9899
+ 409: ResponseErrorResponse;
9900
+ /**
9901
+ * Unprocessable Entity
9902
+ */
9903
+ 422: ResponseErrorResponse;
9447
9904
  };
9448
9905
  type PaymentSetupError = PaymentSetupErrors[keyof PaymentSetupErrors];
9449
9906
  type PaymentSetupResponses = {
9450
9907
  /**
9451
9908
  * OK
9452
9909
  */
9453
- 200: ResponseData & {
9454
- data?: TransactionResponse;
9455
- };
9910
+ 200: TransactionEntityResponse;
9456
9911
  };
9457
9912
  type PaymentSetupResponse = PaymentSetupResponses[keyof PaymentSetupResponses];
9458
9913
  type ConfirmPaymentData = {
@@ -9472,15 +9927,13 @@ type ConfirmPaymentData = {
9472
9927
  };
9473
9928
  type ConfirmPaymentErrors = {
9474
9929
  /**
9475
- * Unauthorized
9930
+ * Bad Request
9476
9931
  */
9477
- 401: ResponseError;
9932
+ 400: ResponseErrorResponse;
9478
9933
  };
9479
9934
  type ConfirmPaymentError = ConfirmPaymentErrors[keyof ConfirmPaymentErrors];
9480
9935
  type ConfirmPaymentResponses = {
9481
- 200: ResponseData & {
9482
- data?: TransactionResponse;
9483
- };
9936
+ 200: TransactionEntityResponse;
9484
9937
  };
9485
9938
  type ConfirmPaymentResponse = ConfirmPaymentResponses[keyof ConfirmPaymentResponses];
9486
9939
  type CaptureATransactionData = {
@@ -9500,15 +9953,13 @@ type CaptureATransactionData = {
9500
9953
  };
9501
9954
  type CaptureATransactionErrors = {
9502
9955
  /**
9503
- * Unauthorized
9956
+ * Bad Request
9504
9957
  */
9505
- 401: ResponseError;
9958
+ 400: ResponseErrorResponse;
9506
9959
  };
9507
9960
  type CaptureATransactionError = CaptureATransactionErrors[keyof CaptureATransactionErrors];
9508
9961
  type CaptureATransactionResponses = {
9509
- 200: ResponseData & {
9510
- data?: TransactionResponse;
9511
- };
9962
+ 200: TransactionEntityResponse;
9512
9963
  };
9513
9964
  type CaptureATransactionResponse = CaptureATransactionResponses[keyof CaptureATransactionResponses];
9514
9965
  type RefundATransactionData = {
@@ -9528,15 +9979,17 @@ type RefundATransactionData = {
9528
9979
  };
9529
9980
  type RefundATransactionErrors = {
9530
9981
  /**
9531
- * Unauthorized
9982
+ * Bad Request
9532
9983
  */
9533
- 401: ResponseError;
9984
+ 400: ResponseErrorResponse;
9985
+ /**
9986
+ * Unprocessable Entity
9987
+ */
9988
+ 422: ResponseErrorResponse;
9534
9989
  };
9535
9990
  type RefundATransactionError = RefundATransactionErrors[keyof RefundATransactionErrors];
9536
9991
  type RefundATransactionResponses = {
9537
- 200: ResponseData & {
9538
- data?: TransactionResponse;
9539
- };
9992
+ 200: TransactionEntityResponse;
9540
9993
  };
9541
9994
  type RefundATransactionResponse = RefundATransactionResponses[keyof RefundATransactionResponses];
9542
9995
  type GetOrderTransactionsData = {
@@ -9552,15 +10005,13 @@ type GetOrderTransactionsData = {
9552
10005
  };
9553
10006
  type GetOrderTransactionsErrors = {
9554
10007
  /**
9555
- * Unauthorized
10008
+ * Bad Request
9556
10009
  */
9557
- 401: ResponseError;
10010
+ 400: ResponseErrorResponse;
9558
10011
  };
9559
10012
  type GetOrderTransactionsError = GetOrderTransactionsErrors[keyof GetOrderTransactionsErrors];
9560
10013
  type GetOrderTransactionsResponses = {
9561
- 200: ResponseData & {
9562
- data?: Array<TransactionResponse>;
9563
- };
10014
+ 200: TransactionListResponse;
9564
10015
  };
9565
10016
  type GetOrderTransactionsResponse = GetOrderTransactionsResponses[keyof GetOrderTransactionsResponses];
9566
10017
  type GetATransactionData = {
@@ -9578,13 +10029,6 @@ type GetATransactionData = {
9578
10029
  query?: never;
9579
10030
  url: "/v2/orders/{orderID}/transactions/{transactionID}";
9580
10031
  };
9581
- type GetATransactionErrors = {
9582
- /**
9583
- * Unauthorized
9584
- */
9585
- 401: ResponseError;
9586
- };
9587
- type GetATransactionError = GetATransactionErrors[keyof GetATransactionErrors];
9588
10032
  type GetATransactionResponses = {
9589
10033
  200: ResponseData & {
9590
10034
  data?: TransactionResponse;
@@ -9608,17 +10052,174 @@ type CancelATransactionData = {
9608
10052
  };
9609
10053
  type CancelATransactionErrors = {
9610
10054
  /**
9611
- * Unauthorized
10055
+ * Bad Request
9612
10056
  */
9613
- 401: ResponseError;
10057
+ 400: ResponseErrorResponse;
9614
10058
  };
9615
10059
  type CancelATransactionError = CancelATransactionErrors[keyof CancelATransactionErrors];
9616
10060
  type CancelATransactionResponses = {
9617
- 200: ResponseData & {
9618
- data?: TransactionResponse;
9619
- };
10061
+ 200: TransactionEntityResponse;
9620
10062
  };
9621
10063
  type CancelATransactionResponse = CancelATransactionResponses[keyof CancelATransactionResponses];
10064
+ type GetOrderShippingGroupsData = {
10065
+ body?: never;
10066
+ path: {
10067
+ /**
10068
+ * The ID of the order
10069
+ */
10070
+ orderID: string;
10071
+ };
10072
+ query?: never;
10073
+ url: "/v2/orders/{orderID}/shipping-groups";
10074
+ };
10075
+ type GetOrderShippingGroupsErrors = {
10076
+ /**
10077
+ * Order not found
10078
+ */
10079
+ 404: ResponseErrorResponse;
10080
+ };
10081
+ type GetOrderShippingGroupsError = GetOrderShippingGroupsErrors[keyof GetOrderShippingGroupsErrors];
10082
+ type GetOrderShippingGroupsResponses = {
10083
+ /**
10084
+ * A list of shipping groups
10085
+ */
10086
+ 200: {
10087
+ data?: Array<ShippingGroupResponse>;
10088
+ };
10089
+ };
10090
+ type GetOrderShippingGroupsResponse = GetOrderShippingGroupsResponses[keyof GetOrderShippingGroupsResponses];
10091
+ type CreateOrderShippingGroupData = {
10092
+ /**
10093
+ * Shipping group details
10094
+ */
10095
+ body?: {
10096
+ data?: {
10097
+ type: "shipping_group";
10098
+ /**
10099
+ * The shipping type for this group
10100
+ */
10101
+ shipping_type?: string;
10102
+ /**
10103
+ * Tracking reference for the shipment
10104
+ */
10105
+ tracking_reference?: string;
10106
+ address?: {
10107
+ first_name?: string;
10108
+ last_name?: string;
10109
+ phone_number?: string;
10110
+ company_name?: string;
10111
+ line_1?: string;
10112
+ line_2?: string;
10113
+ city?: string;
10114
+ postcode?: string;
10115
+ county?: string;
10116
+ country?: string;
10117
+ region?: string;
10118
+ instructions?: string;
10119
+ };
10120
+ delivery_estimate?: {
10121
+ start?: Date;
10122
+ end?: Date;
10123
+ };
10124
+ };
10125
+ };
10126
+ path: {
10127
+ /**
10128
+ * The ID of the order
10129
+ */
10130
+ orderID: string;
10131
+ };
10132
+ query?: never;
10133
+ url: "/v2/orders/{orderID}/shipping-groups";
10134
+ };
10135
+ type CreateOrderShippingGroupErrors = {
10136
+ /**
10137
+ * Bad Request
10138
+ */
10139
+ 400: ResponseErrorResponse;
10140
+ /**
10141
+ * Order not found
10142
+ */
10143
+ 404: ResponseErrorResponse;
10144
+ /**
10145
+ * Unprocessable Entity
10146
+ */
10147
+ 422: ResponseErrorResponse;
10148
+ };
10149
+ type CreateOrderShippingGroupError = CreateOrderShippingGroupErrors[keyof CreateOrderShippingGroupErrors];
10150
+ type CreateOrderShippingGroupResponses = {
10151
+ /**
10152
+ * Shipping group created
10153
+ */
10154
+ 201: {
10155
+ data?: ShippingGroupResponse;
10156
+ };
10157
+ };
10158
+ type CreateOrderShippingGroupResponse = CreateOrderShippingGroupResponses[keyof CreateOrderShippingGroupResponses];
10159
+ type GetShippingGroupsByIdData = {
10160
+ body?: never;
10161
+ path: {
10162
+ /**
10163
+ * The ID of the order
10164
+ */
10165
+ orderID: string;
10166
+ /**
10167
+ * The ID of the shipping group
10168
+ */
10169
+ shippingGroupID: string;
10170
+ };
10171
+ query?: never;
10172
+ url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
10173
+ };
10174
+ type GetShippingGroupsByIdErrors = {
10175
+ /**
10176
+ * Shipping group or order not found
10177
+ */
10178
+ 404: ResponseErrorResponse;
10179
+ };
10180
+ type GetShippingGroupsByIdError = GetShippingGroupsByIdErrors[keyof GetShippingGroupsByIdErrors];
10181
+ type GetShippingGroupsByIdResponses = {
10182
+ /**
10183
+ * Shipping group details
10184
+ */
10185
+ 200: {
10186
+ data?: ShippingGroupResponse;
10187
+ };
10188
+ };
10189
+ type GetShippingGroupsByIdResponse = GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses];
10190
+ type PutShippingGroupByIdData = {
10191
+ body: UpdateOrderShippingGroupRequest;
10192
+ path: {
10193
+ /**
10194
+ * The ID of the order
10195
+ */
10196
+ orderID: string;
10197
+ /**
10198
+ * The ID of the shipping group
10199
+ */
10200
+ shippingGroupID: string;
10201
+ };
10202
+ query?: never;
10203
+ url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
10204
+ };
10205
+ type PutShippingGroupByIdErrors = {
10206
+ /**
10207
+ * Invalid request
10208
+ */
10209
+ 400: ResponseErrorResponse;
10210
+ /**
10211
+ * Shipping group or order not found
10212
+ */
10213
+ 404: ResponseErrorResponse;
10214
+ };
10215
+ type PutShippingGroupByIdError = PutShippingGroupByIdErrors[keyof PutShippingGroupByIdErrors];
10216
+ type PutShippingGroupByIdResponses = {
10217
+ /**
10218
+ * Shipping group updated successfully
10219
+ */
10220
+ 200: ShippingGroupResponse;
10221
+ };
10222
+ type PutShippingGroupByIdResponse = PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses];
9622
10223
  type ListOfferingsData = {
9623
10224
  body?: never;
9624
10225
  path?: never;
@@ -11222,4 +11823,4 @@ type GetAFileResponses = {
11222
11823
  };
11223
11824
  type GetAFileResponse = GetAFileResponses[keyof GetAFileResponses];
11224
11825
 
11225
- export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, Action, ActivePlan, ActivePricingOption, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressResponse, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, BillingAddress, BillingIntervalType, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartError, BulkDeleteCustomDiscountsFromCartErrors, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartError, BulkDeleteTaxItemsFromCartErrors, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CartCheckoutTimestamps, CartContact, CartInclude, CartInclude2, CartItemBulkCustomDiscountObject, CartItemBulkCustomDiscountResponse, CartItemObject, CartItemObjectData, CartItemRelationship, CartItemResponse, CartItemResponseObject, CartItemsObjectRequest, CartItemsObjectResponse, CartMergeObject, CartMergeObjectRequest, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsObject, CartsCustomDiscountsResponse, CartsItemsTaxesObject, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentError, CreateCartPaymentIntentErrors, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemObject, CustomItemObjectData, CustomItemResponseObject, CustomRelationship, CustomRelationshipLinks, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemError, DeleteACartItemErrors, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeError, DeleteAPromotionViaPromotionCodeErrors, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemError, DeleteATaxItemErrors, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartError, DeleteCustomDiscountFromCartErrors, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemError, DeleteCustomDiscountFromCartItemErrors, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DiffListData, DiscountData, DiscountSettings, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EndBehavior, Error2, ErrorBadRequest, ErrorNotFound, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeaturePlanConfiguration, FeaturePlanConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionError, GetATransactionErrors, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartData, GetCartError, GetCartErrors, GetCartItemsData, GetCartItemsError, GetCartItemsErrors, GetCartItemsResponse, GetCartItemsResponses, GetCartResponse, GetCartResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersError, GetCustomerOrdersErrors, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsError, GetOrderItemsErrors, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Import, ImportAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobReport, JobResponseAttributes, JobTimestamps, JobType, Limit, Link, LinkObject, LinkUri, Links, Links2, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlanPricingOptionsData, ListOfferingPlanPricingOptionsError, ListOfferingPlanPricingOptionsErrors, ListOfferingPlanPricingOptionsResponse, ListOfferingPlanPricingOptionsResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingPricingOptionsData, ListOfferingPricingOptionsError, ListOfferingPricingOptionsErrors, ListOfferingPricingOptionsResponse, ListOfferingPricingOptionsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionPricingOptionsData, ListSubscriptionPricingOptionsError, ListSubscriptionPricingOptionsErrors, ListSubscriptionPricingOptionsResponse, ListSubscriptionPricingOptionsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionPlans, ManualPayments, ManyRelationship, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingBuildConfiguredFeatures, OfferingBuildPlanFeatures, OfferingBuildPlanPricingOptions, OfferingBuildPricingOptionAssociations, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureCreate, OfferingFeatureUpdate, OfferingInclude, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttributes, OfferingPlanCreate, OfferingPlanExternalRefMeta, OfferingPlanExtraAttributes, OfferingPlanPriceForPricingOption, OfferingPlanPrices, OfferingPlanResponseAttributes, OfferingPlanResponseExtraAttributes, OfferingPlanUpdate, OfferingPlanUpdateAttributes, OfferingPlanUpdateExtraAttributes, OfferingPricingOption, OfferingPricingOptionCreate, OfferingPricingOptionMeta, OfferingPricingOptionPriceForPlan, OfferingPricingOptionPrices, OfferingPricingOptionUpdate, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileCreateRequestWrapper, OidcProfileListResponse, OidcProfileResponse, OidcProfileUpdateRequestWrapper, OneTimePasswordTokenRequest, OpenIdConnectRequest, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderResponse, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PasswordProfile, PasswordProfileCreateRequestWrapper, PasswordProfileInfo, PasswordProfileInfoCreateRequest, PasswordProfileInfoCreateRequestWrapper, PasswordProfileInfoListResponse, PasswordProfileInfoResponse, PasswordProfileInfoUpdateRequest, PasswordProfileInfoUpdateRequestWrapper, PasswordProfileListResponse, PasswordProfileResponse, PasswordProfileUpdateRequestWrapper, PasswordRequest, PasswordlessRequest, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, PlanAttributes, PlanAttributesAndSelectedMeta, PlanMeta, PlanResponseAttributes, PlanUpdateAttributes, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemObject, PromotionItemObjectData, PromotionItemResponseObject, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, ShippingAddress, ShopperAttributes, SingleCurrencyPrice, SingleRelationship, Sort, StateMeta, Status, Status2, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionInclude, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionItemResponseObject, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingPricingOptionType, SubscriptionOfferingType, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, Tag, TaxItem, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TransactionCreate, TransactionCreateAttributes, TransactionResponse, TransactionResponseAttributes, Type, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemError, UpdateATaxItemErrors, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartError, UpdateCustomDiscountForCartErrors, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemError, UpdateCustomDiscountForCartItemErrors, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, Variation, VariationOption, WritableParentId, _Error };
11826
+ export type { AcceptLanguage, AccessTokenRequest, AccessTokenResponse, Account, AccountAddressResponse, AccountAddressesError, AccountAddressesErrorResponse, AccountAddressesMetaTimestamps, AccountAuthenticationSettings, AccountAuthenticationSettingsResponse, AccountCheckout, AccountManagementAuthenticationToken, AccountManagementAuthenticationTokenResponse, AccountManagementError, AccountManagementErrorResponse, AccountManagementMetaTimestamps, AccountMember, AccountMemberResponse, AccountMemberSelfManagement, AccountMembership, AccountMembershipResponse, AccountMembershipResponseUsingAccountMemberId, AccountMembershipSettings, AccountResponse, Action, ActivePlan, ActivePricingOption, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressResponse, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, BillingAddress, BillingIntervalType, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CartCheckoutTimestamps, CartCollectionResponse, CartContact, CartEntityResponse, CartInclude, CartIncluded, CartIncludedPromotion, CartItemBulkCustomDiscountObject, CartItemFormattedPriceData, CartItemObject, CartItemObjectData, CartItemObjectRequest, CartItemRelationship, CartItemResponse, CartItemTaxesEntityResponse, CartItemsResponse, CartMergeObject, CartMergeObjectRequest, CartPaymentUpdate, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsCollectionResponse, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsCollectionResponse, CartsCustomDiscountsEntityRequest, CartsCustomDiscountsEntityResponse, CartsCustomDiscountsObject, CartsCustomDiscountsResponseObject, CartsItemsTaxesObject, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, ConfigureByContextProductData, ConfigureByContextProductError, ConfigureByContextProductErrors, ConfigureByContextProductResponse, ConfigureByContextProductResponses, ConfirmOrderData, ConfirmOrderError, ConfirmOrderErrors, ConfirmOrderResponse, ConfirmOrderResponses, ConfirmPaymentData, ConfirmPaymentError, ConfirmPaymentErrors, ConfirmPaymentResponse, ConfirmPaymentResponses, Contact, CreateACartData, CreateACartError, CreateACartErrors, CreateACartResponse, CreateACartResponses, CreateAccountCartAssociationData, CreateAccountCartAssociationError, CreateAccountCartAssociationErrors, CreateAccountCartAssociationResponse, CreateAccountCartAssociationResponses, CreateAnAccessTokenData, CreateAnAccessTokenError, CreateAnAccessTokenErrors, CreateAnAccessTokenResponse, CreateAnAccessTokenResponses, CreateCartPaymentIntentData, CreateCartPaymentIntentResponse, CreateCartPaymentIntentResponses, CreateCatalogData, CreateCatalogError, CreateCatalogErrors, CreateCatalogResponse, CreateCatalogResponses, CreateCustomerCartAssociationData, CreateCustomerCartAssociationError, CreateCustomerCartAssociationErrors, CreateCustomerCartAssociationResponse, CreateCustomerCartAssociationResponses, CreateOneTimePasswordTokenRequestData, CreateOneTimePasswordTokenRequestResponses, CreateOrderShippingGroupData, CreateOrderShippingGroupError, CreateOrderShippingGroupErrors, CreateOrderShippingGroupResponse, CreateOrderShippingGroupResponses, CreateRuleData, CreateRuleError, CreateRuleErrors, CreateRuleResponse, CreateRuleResponses, CreateShippingGroupData, CreateShippingGroupError, CreateShippingGroupErrors, CreateShippingGroupRequest, CreateShippingGroupResponse, CreateShippingGroupResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemObject, CustomItemObjectData, CustomRelationship, CustomRelationshipLinks, CustomerCheckout, DataAdyenPayment, DataAuthorizeNetPayment, DataBasePayments, DataBraintreePayment, DataCardConnectPayment, DataCreateCurrencies, DataCyberSourcePayment, DataManualPayment, DataPayPalExpressCheckoutPayment, DataPaymentObject, DataStripeConnectPayment, DataStripePayment, DataStripePaymentIntentsPayment, DataUpdateCurrencies, DeleteACartData, DeleteACartError, DeleteACartErrors, DeleteACartItemData, DeleteACartItemResponse, DeleteACartItemResponses, DeleteACartResponse, DeleteACartResponses, DeleteAPromotionViaPromotionCodeData, DeleteAPromotionViaPromotionCodeResponse, DeleteAPromotionViaPromotionCodeResponses, DeleteATaxItemData, DeleteATaxItemResponse, DeleteATaxItemResponses, DeleteAccountCartAssociationData, DeleteAccountCartAssociationError, DeleteAccountCartAssociationErrors, DeleteAccountCartAssociationResponse, DeleteAccountCartAssociationResponses, DeleteAllCartItemsData, DeleteAllCartItemsError, DeleteAllCartItemsErrors, DeleteAllCartItemsResponse, DeleteAllCartItemsResponses, DeleteCartShippingGroupData, DeleteCartShippingGroupError, DeleteCartShippingGroupErrors, DeleteCartShippingGroupResponse, DeleteCartShippingGroupResponses, DeleteCatalogByIdData, DeleteCatalogByIdError, DeleteCatalogByIdErrors, DeleteCatalogByIdResponse, DeleteCatalogByIdResponses, DeleteCustomDiscountFromCartData, DeleteCustomDiscountFromCartItemData, DeleteCustomDiscountFromCartItemResponse, DeleteCustomDiscountFromCartItemResponses, DeleteCustomDiscountFromCartResponse, DeleteCustomDiscountFromCartResponses, DeleteCustomerCartAssociationData, DeleteCustomerCartAssociationError, DeleteCustomerCartAssociationErrors, DeleteCustomerCartAssociationResponse, DeleteCustomerCartAssociationResponses, DeleteReleaseByIdData, DeleteReleaseByIdError, DeleteReleaseByIdErrors, DeleteReleaseByIdResponse, DeleteReleaseByIdResponses, DeleteReleasesData, DeleteReleasesError, DeleteReleasesErrors, DeleteReleasesResponse, DeleteReleasesResponses, DeleteRuleByIdData, DeleteRuleByIdError, DeleteRuleByIdErrors, DeleteRuleByIdResponse, DeleteRuleByIdResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DeliveryEstimate, DiffListData, Discount, DiscountData, DiscountSettings, Discounts, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EndBehavior, Error2, ErrorBadRequest, ErrorNotFound, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, Feature, FeatureAccessAttributes, FeatureAttributes, FeatureConfigAccessAttributes, FeatureConfigPromotionAttributes, FeatureConfigUsageAttributes, FeatureConfiguration, FeatureCreate, FeatureMeta, FeaturePlanConfiguration, FeaturePlanConfigurationUpdate, FeaturePromotion, FeaturePromotionAttributes, FeatureResponseAttributes, FeatureTag, FeatureUpdate, FeatureUpdateAttributes, FeatureUsageAttributes, File, FileLink, FileMeta, FileReference, FilesError, FilesErrorResponse, FilesLinks, FilesRelationship, FilesUuid, Filesfilter, FilespageLimit, FilespageOffset, Filter, FilterCatalog, FilterHierarchy, FilterNode, FilterProduct, FilterRule, FormattedPrice, FormattedPriceData, Gateway, GeolocationDetails, GetACartData, GetACartError, GetACartErrors, GetACartResponse, GetACartResponses, GetACurrencyData, GetACurrencyError, GetACurrencyErrors, GetACurrencyResponse, GetACurrencyResponses, GetAFileData, GetAFileError, GetAFileErrors, GetAFileResponse, GetAFileResponses, GetATransactionData, GetATransactionResponse, GetATransactionResponses, GetAllCurrenciesData, GetAllCurrenciesError, GetAllCurrenciesErrors, GetAllCurrenciesResponse, GetAllCurrenciesResponses, GetAllFilesData, GetAllFilesError, GetAllFilesErrors, GetAllFilesResponse, GetAllFilesResponses, GetAllHierarchiesData, GetAllHierarchiesError, GetAllHierarchiesErrors, GetAllHierarchiesResponse, GetAllHierarchiesResponses, GetAllNodesData, GetAllNodesError, GetAllNodesErrors, GetAllNodesResponse, GetAllNodesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllRelatedProductsData, GetAllRelatedProductsError, GetAllRelatedProductsErrors, GetAllRelatedProductsResponse, GetAllRelatedProductsResponses, GetAnOrderData, GetAnOrderError, GetAnOrderErrors, GetAnOrderResponse, GetAnOrderResponses, GetByContextAllHierarchiesData, GetByContextAllHierarchiesError, GetByContextAllHierarchiesErrors, GetByContextAllHierarchiesResponse, GetByContextAllHierarchiesResponses, GetByContextAllNodesData, GetByContextAllNodesError, GetByContextAllNodesErrors, GetByContextAllNodesResponse, GetByContextAllNodesResponses, GetByContextAllProductsData, GetByContextAllProductsError, GetByContextAllProductsErrors, GetByContextAllProductsResponse, GetByContextAllProductsResponses, GetByContextAllRelatedProductsData, GetByContextAllRelatedProductsError, GetByContextAllRelatedProductsErrors, GetByContextAllRelatedProductsResponse, GetByContextAllRelatedProductsResponses, GetByContextChildNodesData, GetByContextChildNodesError, GetByContextChildNodesErrors, GetByContextChildNodesResponse, GetByContextChildNodesResponses, GetByContextChildProductsData, GetByContextChildProductsError, GetByContextChildProductsErrors, GetByContextChildProductsResponse, GetByContextChildProductsResponses, GetByContextComponentProductIdsData, GetByContextComponentProductIdsError, GetByContextComponentProductIdsErrors, GetByContextComponentProductIdsResponse, GetByContextComponentProductIdsResponses, GetByContextHierarchyChildNodesData, GetByContextHierarchyChildNodesError, GetByContextHierarchyChildNodesErrors, GetByContextHierarchyChildNodesResponse, GetByContextHierarchyChildNodesResponses, GetByContextHierarchyData, GetByContextHierarchyError, GetByContextHierarchyErrors, GetByContextHierarchyNodesData, GetByContextHierarchyNodesError, GetByContextHierarchyNodesErrors, GetByContextHierarchyNodesResponse, GetByContextHierarchyNodesResponses, GetByContextHierarchyResponse, GetByContextHierarchyResponses, GetByContextNodeData, GetByContextNodeError, GetByContextNodeErrors, GetByContextNodeResponse, GetByContextNodeResponses, GetByContextProductData, GetByContextProductError, GetByContextProductErrors, GetByContextProductResponse, GetByContextProductResponses, GetByContextProductsForHierarchyData, GetByContextProductsForHierarchyError, GetByContextProductsForHierarchyErrors, GetByContextProductsForHierarchyResponse, GetByContextProductsForHierarchyResponses, GetByContextProductsForNodeData, GetByContextProductsForNodeError, GetByContextProductsForNodeErrors, GetByContextProductsForNodeResponse, GetByContextProductsForNodeResponses, GetByContextReleaseData, GetByContextReleaseError, GetByContextReleaseErrors, GetByContextReleaseResponse, GetByContextReleaseResponses, GetCartItemsData, GetCartItemsResponse, GetCartItemsResponses, GetCartsData, GetCartsError, GetCartsErrors, GetCartsResponse, GetCartsResponses, GetCatalogByIdData, GetCatalogByIdError, GetCatalogByIdErrors, GetCatalogByIdResponse, GetCatalogByIdResponses, GetCatalogsData, GetCatalogsError, GetCatalogsErrors, GetCatalogsResponse, GetCatalogsResponses, GetChildNodesData, GetChildNodesError, GetChildNodesErrors, GetChildNodesResponse, GetChildNodesResponses, GetChildProductsData, GetChildProductsError, GetChildProductsErrors, GetChildProductsResponse, GetChildProductsResponses, GetComponentProductIdsData, GetComponentProductIdsError, GetComponentProductIdsErrors, GetComponentProductIdsResponse, GetComponentProductIdsResponses, GetCustomerOrdersData, GetCustomerOrdersResponse, GetCustomerOrdersResponses, GetFeatureData, GetFeatureError, GetFeatureErrors, GetFeatureResponse, GetFeatureResponses, GetHierarchyChildNodesData, GetHierarchyChildNodesError, GetHierarchyChildNodesErrors, GetHierarchyChildNodesResponse, GetHierarchyChildNodesResponses, GetHierarchyData, GetHierarchyError, GetHierarchyErrors, GetHierarchyNodesData, GetHierarchyNodesError, GetHierarchyNodesErrors, GetHierarchyNodesResponse, GetHierarchyNodesResponses, GetHierarchyResponse, GetHierarchyResponses, GetInvoiceData, GetInvoiceError, GetInvoiceErrors, GetInvoiceResponse, GetInvoiceResponses, GetNodeData, GetNodeError, GetNodeErrors, GetNodeResponse, GetNodeResponses, GetOfferingData, GetOfferingError, GetOfferingErrors, GetOfferingResponse, GetOfferingResponses, GetOrderItemsData, GetOrderItemsResponse, GetOrderItemsResponses, GetOrderShippingGroupsData, GetOrderShippingGroupsError, GetOrderShippingGroupsErrors, GetOrderShippingGroupsResponse, GetOrderShippingGroupsResponses, GetOrderTransactionsData, GetOrderTransactionsError, GetOrderTransactionsErrors, GetOrderTransactionsResponse, GetOrderTransactionsResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetProductsForHierarchyData, GetProductsForHierarchyError, GetProductsForHierarchyErrors, GetProductsForHierarchyResponse, GetProductsForHierarchyResponses, GetProductsForNodeData, GetProductsForNodeError, GetProductsForNodeErrors, GetProductsForNodeResponse, GetProductsForNodeResponses, GetReleaseByIdData, GetReleaseByIdError, GetReleaseByIdErrors, GetReleaseByIdResponse, GetReleaseByIdResponses, GetReleasesData, GetReleasesError, GetReleasesErrors, GetReleasesResponse, GetReleasesResponses, GetRuleByIdData, GetRuleByIdError, GetRuleByIdErrors, GetRuleByIdResponse, GetRuleByIdResponses, GetRulesData, GetRulesError, GetRulesErrors, GetRulesResponse, GetRulesResponses, GetShippingGroupByIdData, GetShippingGroupByIdError, GetShippingGroupByIdErrors, GetShippingGroupByIdResponse, GetShippingGroupByIdResponses, GetShippingGroupsByIdData, GetShippingGroupsByIdError, GetShippingGroupsByIdErrors, GetShippingGroupsByIdResponse, GetShippingGroupsByIdResponses, GetShippingGroupsData, GetShippingGroupsError, GetShippingGroupsErrors, GetShippingGroupsResponse, GetShippingGroupsResponses, GetStockData, GetStockError, GetStockErrors, GetStockResponse, GetStockResponses, GetSubscriptionData, GetSubscriptionError, GetSubscriptionErrors, GetSubscriptionInvoiceData, GetSubscriptionInvoiceError, GetSubscriptionInvoiceErrors, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoicePaymentError, GetSubscriptionInvoicePaymentErrors, GetSubscriptionInvoicePaymentResponse, GetSubscriptionInvoicePaymentResponses, GetSubscriptionInvoiceResponse, GetSubscriptionInvoiceResponses, GetSubscriptionResponse, GetSubscriptionResponses, GetSubscriptionStateData, GetSubscriptionStateError, GetSubscriptionStateErrors, GetSubscriptionStateResponse, GetSubscriptionStateResponses, GetV2AccountAddressData, GetV2AccountAddressError, GetV2AccountAddressErrors, GetV2AccountAddressResponse, GetV2AccountAddressResponses, GetV2AccountAddressesData, GetV2AccountAddressesError, GetV2AccountAddressesErrors, GetV2AccountAddressesResponse, GetV2AccountAddressesResponses, GetV2AccountMembersAccountMemberIdData, GetV2AccountMembersAccountMemberIdError, GetV2AccountMembersAccountMemberIdErrors, GetV2AccountMembersAccountMemberIdResponse, GetV2AccountMembersAccountMemberIdResponses, GetV2AccountMembersData, GetV2AccountMembersError, GetV2AccountMembersErrors, GetV2AccountMembersResponse, GetV2AccountMembersResponses, GetV2AccountsAccountIdAccountMembershipsData, GetV2AccountsAccountIdAccountMembershipsError, GetV2AccountsAccountIdAccountMembershipsErrors, GetV2AccountsAccountIdAccountMembershipsResponse, GetV2AccountsAccountIdAccountMembershipsResponses, GetV2AccountsAccountIdData, GetV2AccountsAccountIdError, GetV2AccountsAccountIdErrors, GetV2AccountsAccountIdResponse, GetV2AccountsAccountIdResponses, GetV2AccountsData, GetV2AccountsError, GetV2AccountsErrors, GetV2AccountsResponse, GetV2AccountsResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Import, ImportAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InventorySettings, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, Job, JobAttributes, JobCreate, JobCreateAttributes, JobMeta, JobReport, JobResponseAttributes, JobTimestamps, JobType, Limit, Link, LinkObject, LinkUri, Links, Links2, ListInvoicesData, ListInvoicesError, ListInvoicesErrors, ListInvoicesResponse, ListInvoicesResponses, ListLocationsData, ListLocationsError, ListLocationsErrors, ListLocationsResponse, ListLocationsResponses, ListOfferingFeaturesData, ListOfferingFeaturesError, ListOfferingFeaturesErrors, ListOfferingFeaturesResponse, ListOfferingFeaturesResponses, ListOfferingPlanPricingOptionsData, ListOfferingPlanPricingOptionsError, ListOfferingPlanPricingOptionsErrors, ListOfferingPlanPricingOptionsResponse, ListOfferingPlanPricingOptionsResponses, ListOfferingPlansData, ListOfferingPlansError, ListOfferingPlansErrors, ListOfferingPlansResponse, ListOfferingPlansResponses, ListOfferingPricingOptionsData, ListOfferingPricingOptionsError, ListOfferingPricingOptionsErrors, ListOfferingPricingOptionsResponse, ListOfferingPricingOptionsResponses, ListOfferingsData, ListOfferingsError, ListOfferingsErrors, ListOfferingsResponse, ListOfferingsResponses, ListSubscriptionInvoicePaymentsData, ListSubscriptionInvoicePaymentsResponse, ListSubscriptionInvoicePaymentsResponses, ListSubscriptionInvoicesData, ListSubscriptionInvoicesError, ListSubscriptionInvoicesErrors, ListSubscriptionInvoicesResponse, ListSubscriptionInvoicesResponses, ListSubscriptionPlansData, ListSubscriptionPlansError, ListSubscriptionPlansErrors, ListSubscriptionPlansResponse, ListSubscriptionPlansResponses, ListSubscriptionPricingOptionsData, ListSubscriptionPricingOptionsError, ListSubscriptionPricingOptionsErrors, ListSubscriptionPricingOptionsResponse, ListSubscriptionPricingOptionsResponses, ListSubscriptionStatesData, ListSubscriptionStatesError, ListSubscriptionStatesErrors, ListSubscriptionStatesResponse, ListSubscriptionStatesResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, Location, LocationAttributes, LocationRequest, LocationUpdateAttributes, LocationUpdateRequest, MainImageRelationship, ManageCartsData, ManageCartsError, ManageCartsErrors, ManageCartsResponse, ManageCartsResponses, ManageSubscriptionPlans, ManualPayments, ManyRelationship, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NullableLocation, NullableLocations, NullablePaymentAuthority, NullablePrice, NullablePriceUnits, Offering, OfferingAttributes, OfferingBuildConfiguredFeatures, OfferingBuildPlanFeatures, OfferingBuildPlanPricingOptions, OfferingBuildPricingOptionAssociations, OfferingCreate, OfferingFeature, OfferingFeatureAttach, OfferingFeatureCreate, OfferingFeatureUpdate, OfferingInclude, OfferingIncludes, OfferingMeta, OfferingPlan, OfferingPlanAttributes, OfferingPlanCreate, OfferingPlanExternalRefMeta, OfferingPlanExtraAttributes, OfferingPlanPriceForPricingOption, OfferingPlanPrices, OfferingPlanResponseAttributes, OfferingPlanResponseExtraAttributes, OfferingPlanUpdate, OfferingPlanUpdateAttributes, OfferingPlanUpdateExtraAttributes, OfferingPricingOption, OfferingPricingOptionCreate, OfferingPricingOptionMeta, OfferingPricingOptionPriceForPlan, OfferingPricingOptionPrices, OfferingPricingOptionUpdate, OfferingRelationships, OfferingResponseAttributes, OfferingUpdate, OfferingUpdateAttributes, OfferingUpdateRelationships, Offset, OidcProfile, OidcProfileCreateRequestWrapper, OidcProfileListResponse, OidcProfileResponse, OidcProfileUpdateRequestWrapper, OneTimePasswordTokenRequest, OpenIdConnectRequest, OrderCollectionResponse, OrderEntityResponse, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersListResponse, OrdersTransactionsCancelRequest, OrdersTransactionsCaptureRequest, OrdersTransactionsConfirmRequest, OrdersTransactionsRefundRequest, OrdersUpdateRequest, Owner, OwnerMeta, PageLimit, PageMeta, PageOffset, PasswordProfile, PasswordProfileCreateRequestWrapper, PasswordProfileInfo, PasswordProfileInfoCreateRequest, PasswordProfileInfoCreateRequestWrapper, PasswordProfileInfoListResponse, PasswordProfileInfoResponse, PasswordProfileInfoUpdateRequest, PasswordProfileInfoUpdateRequestWrapper, PasswordProfileListResponse, PasswordProfileResponse, PasswordProfileUpdateRequestWrapper, PasswordRequest, PasswordlessRequest, Payment, PaymentAuthority, PaymentAuthorityAuthorizeNet, PaymentAuthorityStripe, PaymentFailureDetail, PaymentRetryType, PaymentRetryUnit, PaymentRunReport, PaymentSetupData, PaymentSetupError, PaymentSetupErrors, PaymentSetupResponse, PaymentSetupResponses, PaymentsRequest, PlanAttributes, PlanAttributesAndSelectedMeta, PlanMeta, PlanResponseAttributes, PlanUpdateAttributes, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemObject, PromotionItemObjectData, ProrationEvent, ProrationPolicy, ProrationPolicyAttributes, ProrationPolicyCreate, ProrationPolicyMeta, ProrationPolicyRelationshipAttributes, ProrationPolicyResponseAttributes, ProrationPolicyType, ProrationPolicyUpdate, ProrationPolicyUpdateAttributes, ProrationPolicyUpdateRelationshipAttributes, PublishReleaseData, PublishReleaseError, PublishReleaseErrors, PublishReleaseResponse, PublishReleaseResponses, Purpose, PutShippingGroupByIdData, PutShippingGroupByIdError, PutShippingGroupByIdErrors, PutShippingGroupByIdResponse, PutShippingGroupByIdResponses, PutV2AccountAddressData, PutV2AccountAddressError, PutV2AccountAddressErrors, PutV2AccountAddressResponse, PutV2AccountAddressResponses, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, PutV2AccountsAccountIdErrors, PutV2AccountsAccountIdResponse, PutV2AccountsAccountIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, Shipping, ShippingAddress, ShippingGroupMeta, ShippingGroupResponse, ShippingPriceRequest, ShippingPriceResponse, ShopperAttributes, SingleCurrencyPrice, SingleRelationship, Sort, StateMeta, Status, Status2, StockCreate, StockCreateAttributes, StockLocations, StockMeta, StockResponse, StockResponseAttributes, StockTransactionType, StockType, StockUpdateAttributes, StockUpdateRequest, Subscriber, SubscriberAttributes, SubscriberCreate, SubscriberMeta, SubscriberResponseAttributes, SubscriberUpdate, SubscriberUpdateAttributes, Subscription, SubscriptionAttributes, SubscriptionDunningRuleType, SubscriptionFeatureType, SubscriptionImportError, SubscriptionImportErrorMeta, SubscriptionImportErrorType, SubscriptionImportType, SubscriptionInclude, SubscriptionIncludes, SubscriptionInvoice, SubscriptionInvoiceAttributes, SubscriptionInvoiceItem, SubscriptionInvoiceMeta, SubscriptionInvoicePayment, SubscriptionInvoicePaymentAttributes, SubscriptionInvoicePaymentMeta, SubscriptionInvoicePaymentType, SubscriptionInvoiceType, SubscriptionItemObject, SubscriptionItemObjectData, SubscriptionJobType, SubscriptionMeta, SubscriptionOfferingFeatureType, SubscriptionOfferingPlanType, SubscriptionOfferingPricingOptionType, SubscriptionOfferingType, SubscriptionScheduleType, SubscriptionState, SubscriptionStateAction, SubscriptionStateAttributes, SubscriptionStateType, SubscriptionSubscriberType, SubscriptionTimestamps, SubscriptionType, SubscriptionUpdate, SubscriptionUpdateAttributes, SubscriptionsError, SubscriptionsErrorResponse, SubscriptionsFilter, SubscriptionsPageLimit, SubscriptionsPageOffset, SubscriptionsSingleRelationship, SubscriptionsTimestamps, SubscriptionsUuid, SwitchingAccountRequest, Tag, TaxItem, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TransactionCreate, TransactionCreateAttributes, TransactionEntityResponse, TransactionListResponse, TransactionResponse, TransactionResponseAttributes, Type, Unit, UpdateACartData, UpdateACartError, UpdateACartErrors, UpdateACartItemData, UpdateACartItemError, UpdateACartItemErrors, UpdateACartItemResponse, UpdateACartItemResponses, UpdateACartResponse, UpdateACartResponses, UpdateATaxItemData, UpdateATaxItemResponse, UpdateATaxItemResponses, UpdateAllOrNothingOptionsObject, UpdateAnOrderData, UpdateAnOrderError, UpdateAnOrderErrors, UpdateAnOrderResponse, UpdateAnOrderResponses, UpdateCartPaymentIntentData, UpdateCartPaymentIntentResponse, UpdateCartPaymentIntentResponses, UpdateCartShippingGroupRequest, UpdateCartsItems, UpdateCatalogData, UpdateCatalogError, UpdateCatalogErrors, UpdateCatalogResponse, UpdateCatalogResponses, UpdateCustomDiscountForCartData, UpdateCustomDiscountForCartItemData, UpdateCustomDiscountForCartItemResponse, UpdateCustomDiscountForCartItemResponses, UpdateCustomDiscountForCartResponse, UpdateCustomDiscountForCartResponses, UpdateInvoicePayment, UpdateInvoicePaymentAttributes, UpdateOrderShippingGroupRequest, UpdatePasswordProfileInfoData, UpdatePasswordProfileInfoErrors, UpdatePasswordProfileInfoResponse, UpdatePasswordProfileInfoResponses, UpdateRuleData, UpdateRuleError, UpdateRuleErrors, UpdateRuleResponse, UpdateRuleResponses, UpdateShippingGroupData, UpdateShippingGroupError, UpdateShippingGroupErrors, UpdateShippingGroupResponse, UpdateShippingGroupResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, Variation, VariationOption, WritableParentId, _Error };