@epcc-sdk/sdks-shopper 0.1.0 → 0.2.0
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.
- package/dist/client/@tanstack/react-query.gen.cjs +132 -0
- package/dist/client/@tanstack/react-query.gen.cjs.map +1 -1
- package/dist/client/@tanstack/react-query.gen.d.cts +170 -70
- package/dist/client/@tanstack/react-query.gen.d.ts +170 -70
- package/dist/client/@tanstack/react-query.gen.mjs +128 -0
- package/dist/client/@tanstack/react-query.gen.mjs.map +1 -1
- package/dist/client/index.d.cts +2 -2
- package/dist/client/index.d.ts +2 -2
- package/dist/client/sdk.gen.cjs +126 -0
- package/dist/client/sdk.gen.cjs.map +1 -1
- package/dist/client/sdk.gen.d.cts +248 -77
- package/dist/client/sdk.gen.d.ts +248 -77
- package/dist/client/sdk.gen.mjs +119 -0
- package/dist/client/sdk.gen.mjs.map +1 -1
- package/dist/client/transformers.gen.cjs +98 -34
- package/dist/client/transformers.gen.cjs.map +1 -1
- package/dist/client/transformers.gen.d.cts +7 -3
- package/dist/client/transformers.gen.d.ts +7 -3
- package/dist/client/transformers.gen.mjs +93 -33
- package/dist/client/transformers.gen.mjs.map +1 -1
- package/dist/client/types.gen.cjs.map +1 -1
- package/dist/client/types.gen.d.cts +2272 -822
- package/dist/client/types.gen.d.ts +2272 -822
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/react-query.d.cts +1 -1
- package/dist/react-query.d.ts +1 -1
- package/package.json +1 -1
|
@@ -2092,11 +2092,11 @@ type CartContact = {
|
|
|
2092
2092
|
};
|
|
2093
2093
|
type DiscountSettings = {
|
|
2094
2094
|
/**
|
|
2095
|
-
* This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/
|
|
2095
|
+
* This parameter enables custom discounts for a cart. When set to true and `use_rule_promotions` is not enabled, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/carts/put-v-2-settings-cart).
|
|
2096
2096
|
*/
|
|
2097
2097
|
custom_discounts_enabled?: boolean;
|
|
2098
2098
|
/**
|
|
2099
|
-
* When set to true, this parameter allows the cart to use rule promotions.
|
|
2099
|
+
* When set to true, this parameter allows the cart to use rule promotions. You can enable this setting together with `custom_discounts_enabled`, for example, while transitioning between promotion systems. However, an individual cart can only contain one type of discount at a time.
|
|
2100
2100
|
*/
|
|
2101
2101
|
use_rule_promotions?: boolean;
|
|
2102
2102
|
};
|
|
@@ -2106,6 +2106,16 @@ type InventorySettings = {
|
|
|
2106
2106
|
*/
|
|
2107
2107
|
defer_inventory_check?: boolean;
|
|
2108
2108
|
};
|
|
2109
|
+
type ItemSettings = {
|
|
2110
|
+
/**
|
|
2111
|
+
* When set to true, cart items with the same SKU but different locations are kept as separate line items instead of being merged. When false (default), items with the same SKU are merged and the location is updated to the most recent value.
|
|
2112
|
+
*/
|
|
2113
|
+
separate_items_by_location?: boolean;
|
|
2114
|
+
};
|
|
2115
|
+
/**
|
|
2116
|
+
* The type of the custom attribute value.
|
|
2117
|
+
*/
|
|
2118
|
+
type Type = "string" | "integer" | "boolean" | "float";
|
|
2109
2119
|
/**
|
|
2110
2120
|
* 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.
|
|
2111
2121
|
*
|
|
@@ -2125,7 +2135,16 @@ type InventorySettings = {
|
|
|
2125
2135
|
*
|
|
2126
2136
|
*/
|
|
2127
2137
|
type CustomAttributes = {
|
|
2128
|
-
[key: string]:
|
|
2138
|
+
[key: string]: {
|
|
2139
|
+
/**
|
|
2140
|
+
* The type of the custom attribute value.
|
|
2141
|
+
*/
|
|
2142
|
+
type: "string" | "integer" | "boolean" | "float";
|
|
2143
|
+
/**
|
|
2144
|
+
* The value of the custom attribute.
|
|
2145
|
+
*/
|
|
2146
|
+
value: number;
|
|
2147
|
+
};
|
|
2129
2148
|
};
|
|
2130
2149
|
type FormattedPriceData = {
|
|
2131
2150
|
/**
|
|
@@ -2141,6 +2160,20 @@ type FormattedPriceData = {
|
|
|
2141
2160
|
*/
|
|
2142
2161
|
formatted?: string;
|
|
2143
2162
|
};
|
|
2163
|
+
type CartTimestamps = {
|
|
2164
|
+
/**
|
|
2165
|
+
* The date this was created.
|
|
2166
|
+
*/
|
|
2167
|
+
created_at?: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* The date this was last updated.
|
|
2170
|
+
*/
|
|
2171
|
+
updated_at?: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* The date this expires.
|
|
2174
|
+
*/
|
|
2175
|
+
expires_at?: string;
|
|
2176
|
+
};
|
|
2144
2177
|
/**
|
|
2145
2178
|
* Relationship data entry
|
|
2146
2179
|
*/
|
|
@@ -2148,11 +2181,11 @@ type RelationshipItem = {
|
|
|
2148
2181
|
/**
|
|
2149
2182
|
* The type of related resource.
|
|
2150
2183
|
*/
|
|
2151
|
-
type
|
|
2184
|
+
type: string;
|
|
2152
2185
|
/**
|
|
2153
2186
|
* The ID of the related resource.
|
|
2154
2187
|
*/
|
|
2155
|
-
id
|
|
2188
|
+
id: string;
|
|
2156
2189
|
};
|
|
2157
2190
|
/**
|
|
2158
2191
|
* Array of relationships
|
|
@@ -2163,15 +2196,11 @@ type RelationshipArray = {
|
|
|
2163
2196
|
*/
|
|
2164
2197
|
data?: Array<RelationshipItem>;
|
|
2165
2198
|
};
|
|
2166
|
-
type
|
|
2199
|
+
type BaseCartResponse = {
|
|
2167
2200
|
/**
|
|
2168
2201
|
* The unique identifier for the cart. Use SDK or create it yourself.
|
|
2169
2202
|
*/
|
|
2170
2203
|
id?: string;
|
|
2171
|
-
/**
|
|
2172
|
-
* The type of object being returned.
|
|
2173
|
-
*/
|
|
2174
|
-
type?: string;
|
|
2175
2204
|
/**
|
|
2176
2205
|
* The name of this cart.
|
|
2177
2206
|
*/
|
|
@@ -2183,11 +2212,16 @@ type CartResponse = {
|
|
|
2183
2212
|
contact?: CartContact;
|
|
2184
2213
|
discount_settings?: DiscountSettings;
|
|
2185
2214
|
inventory_settings?: InventorySettings;
|
|
2215
|
+
item_settings?: ItemSettings;
|
|
2186
2216
|
/**
|
|
2187
2217
|
* Stripe-assigned unique identifier for the linked Payment Intent
|
|
2188
2218
|
*/
|
|
2189
2219
|
payment_intent_id?: string;
|
|
2190
2220
|
custom_attributes?: CustomAttributes;
|
|
2221
|
+
/**
|
|
2222
|
+
* The snapshot date for the cart.
|
|
2223
|
+
*/
|
|
2224
|
+
snapshot_date?: Date;
|
|
2191
2225
|
links?: {
|
|
2192
2226
|
/**
|
|
2193
2227
|
* A link to that specific resource.
|
|
@@ -2202,19 +2236,64 @@ type CartResponse = {
|
|
|
2202
2236
|
discount?: FormattedPriceData;
|
|
2203
2237
|
without_discount?: FormattedPriceData;
|
|
2204
2238
|
shipping?: FormattedPriceData;
|
|
2239
|
+
shipping_discount?: FormattedPriceData;
|
|
2205
2240
|
};
|
|
2206
|
-
timestamps?:
|
|
2241
|
+
timestamps?: CartTimestamps;
|
|
2242
|
+
/**
|
|
2243
|
+
* Array of promotion suggestions
|
|
2244
|
+
*/
|
|
2245
|
+
promotion_suggestions?: Array<{
|
|
2246
|
+
/**
|
|
2247
|
+
* Bundle configuration with promotion targets
|
|
2248
|
+
*/
|
|
2249
|
+
bundle?: Array<{
|
|
2250
|
+
/**
|
|
2251
|
+
* Whether to automatically add free gift
|
|
2252
|
+
*/
|
|
2253
|
+
auto_add_free_gift?: boolean;
|
|
2254
|
+
/**
|
|
2255
|
+
* Cart item ID for the target
|
|
2256
|
+
*/
|
|
2257
|
+
cart_item_id?: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Quantity for the promotion
|
|
2260
|
+
*/
|
|
2261
|
+
quantity?: number;
|
|
2262
|
+
/**
|
|
2263
|
+
* Array of target SKUs
|
|
2264
|
+
*/
|
|
2265
|
+
targets?: Array<string>;
|
|
2266
|
+
[key: string]: unknown | boolean | string | number | Array<string> | undefined;
|
|
2267
|
+
}>;
|
|
2268
|
+
code?: string;
|
|
2269
|
+
info?: string;
|
|
2270
|
+
message?: string;
|
|
2271
|
+
promotion_id?: string;
|
|
2272
|
+
}>;
|
|
2207
2273
|
};
|
|
2208
2274
|
relationships?: {
|
|
2209
|
-
customers?: RelationshipArray
|
|
2275
|
+
customers?: RelationshipArray | {
|
|
2276
|
+
[key: string]: unknown;
|
|
2277
|
+
};
|
|
2210
2278
|
items?: RelationshipArray | {
|
|
2211
|
-
data
|
|
2279
|
+
data: null | Array<{
|
|
2280
|
+
id?: string;
|
|
2281
|
+
type?: string;
|
|
2282
|
+
}>;
|
|
2283
|
+
};
|
|
2284
|
+
accounts?: RelationshipArray | {
|
|
2285
|
+
[key: string]: unknown;
|
|
2212
2286
|
};
|
|
2213
|
-
accounts?: RelationshipArray;
|
|
2214
2287
|
custom_discounts?: RelationshipArray;
|
|
2215
2288
|
promotions?: RelationshipArray;
|
|
2216
2289
|
};
|
|
2217
2290
|
};
|
|
2291
|
+
type CartResponse = BaseCartResponse & {
|
|
2292
|
+
/**
|
|
2293
|
+
* The type of object being returned.
|
|
2294
|
+
*/
|
|
2295
|
+
type?: "cart";
|
|
2296
|
+
};
|
|
2218
2297
|
type ResponsePageLinks = {
|
|
2219
2298
|
/**
|
|
2220
2299
|
* Always the current page.
|
|
@@ -2283,6 +2362,13 @@ type ResponseErrorItem = {
|
|
|
2283
2362
|
* Optional additional detail about the error.
|
|
2284
2363
|
*/
|
|
2285
2364
|
detail?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* The field or location that caused the validation error. For JSON schema validation errors, this contains the JSON path to the invalid field (e.g., 'data.name', 'request', 'data.items[0].quantity').
|
|
2367
|
+
*/
|
|
2368
|
+
source?: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* Additional metadata associated with the error. May include arbitrary keys.
|
|
2371
|
+
*/
|
|
2286
2372
|
meta?: {
|
|
2287
2373
|
/**
|
|
2288
2374
|
* The resource id associated with the error
|
|
@@ -2307,10 +2393,28 @@ type ResponseErrorItem = {
|
|
|
2307
2393
|
* The order id associated with the error.
|
|
2308
2394
|
*/
|
|
2309
2395
|
order_id?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* The SKU associated with the error.
|
|
2398
|
+
*/
|
|
2399
|
+
sku?: string;
|
|
2400
|
+
/**
|
|
2401
|
+
* The email address associated with the error.
|
|
2402
|
+
*/
|
|
2403
|
+
email?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* The component product ID associated with the error.
|
|
2406
|
+
*/
|
|
2407
|
+
component_product_id?: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* Custom error metadata key used for additional error context (e.g., in payment rejections).
|
|
2410
|
+
*/
|
|
2411
|
+
"error-meta-key"?: string;
|
|
2310
2412
|
/**
|
|
2311
2413
|
* The value associated with the error.
|
|
2312
2414
|
*/
|
|
2313
|
-
value?:
|
|
2415
|
+
value?: string | number | boolean | {
|
|
2416
|
+
[key: string]: unknown;
|
|
2417
|
+
} | Array<unknown>;
|
|
2314
2418
|
};
|
|
2315
2419
|
};
|
|
2316
2420
|
type ResponseErrorResponse = {
|
|
@@ -2324,6 +2428,7 @@ type CartsRequest = {
|
|
|
2324
2428
|
description?: string;
|
|
2325
2429
|
discount_settings?: DiscountSettings;
|
|
2326
2430
|
inventory_settings?: InventorySettings;
|
|
2431
|
+
item_settings?: ItemSettings;
|
|
2327
2432
|
/**
|
|
2328
2433
|
* 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.
|
|
2329
2434
|
*/
|
|
@@ -2368,60 +2473,110 @@ type CartsRequest = {
|
|
|
2368
2473
|
payment_intent_id?: string;
|
|
2369
2474
|
};
|
|
2370
2475
|
};
|
|
2371
|
-
type
|
|
2372
|
-
data: CartResponse;
|
|
2373
|
-
included?: CartIncluded;
|
|
2374
|
-
};
|
|
2375
|
-
/**
|
|
2376
|
-
* The type of object being returned.
|
|
2377
|
-
*/
|
|
2378
|
-
type Type = "cart_item";
|
|
2379
|
-
type CartItemObjectData = {
|
|
2476
|
+
type CustomDiscountResponse = {
|
|
2380
2477
|
/**
|
|
2381
|
-
*
|
|
2478
|
+
* Specifies the type of the resource. Always `custom_discount`.
|
|
2382
2479
|
*/
|
|
2383
|
-
type
|
|
2480
|
+
type?: "custom_discount";
|
|
2384
2481
|
/**
|
|
2385
|
-
*
|
|
2482
|
+
* Specifies the UUID of the custom discount.
|
|
2386
2483
|
*/
|
|
2387
|
-
|
|
2484
|
+
id?: string;
|
|
2388
2485
|
/**
|
|
2389
|
-
* Specifies
|
|
2486
|
+
* Specifies an external id for the custom discount.
|
|
2390
2487
|
*/
|
|
2391
|
-
|
|
2488
|
+
external_id?: string;
|
|
2392
2489
|
/**
|
|
2393
|
-
* Specifies
|
|
2490
|
+
* Specifies from where the custom discount is applied.
|
|
2491
|
+
*
|
|
2394
2492
|
*/
|
|
2395
|
-
|
|
2493
|
+
discount_engine?: string;
|
|
2396
2494
|
/**
|
|
2397
|
-
* The
|
|
2495
|
+
* The amount of the custom discount.
|
|
2398
2496
|
*/
|
|
2399
|
-
|
|
2400
|
-
|
|
2497
|
+
amount?: FormattedPriceData;
|
|
2498
|
+
/**
|
|
2499
|
+
* Specifies a description for the custom discount.
|
|
2500
|
+
*/
|
|
2501
|
+
description?: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* Specifies the discount code used for the custom discount.
|
|
2504
|
+
*/
|
|
2505
|
+
discount_code?: string;
|
|
2506
|
+
/**
|
|
2507
|
+
* Relationships to other resources like cart items
|
|
2508
|
+
*/
|
|
2509
|
+
relationships?: {
|
|
2510
|
+
item?: {
|
|
2511
|
+
data?: {
|
|
2512
|
+
/**
|
|
2513
|
+
* The cart item ID this discount is related to
|
|
2514
|
+
*/
|
|
2515
|
+
id?: string;
|
|
2516
|
+
type?: "cart_item" | "custom_item";
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2401
2519
|
};
|
|
2520
|
+
};
|
|
2521
|
+
type CondensedPromotionResponse = {
|
|
2402
2522
|
/**
|
|
2403
|
-
*
|
|
2523
|
+
* Specifies the type of the resource. Always `promotion`.
|
|
2404
2524
|
*/
|
|
2405
|
-
|
|
2525
|
+
type?: "promotion";
|
|
2526
|
+
/**
|
|
2527
|
+
* Specifies the UUID of the promotion.
|
|
2528
|
+
*/
|
|
2529
|
+
readonly id?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* The name of the promotion.
|
|
2532
|
+
*/
|
|
2533
|
+
name?: string;
|
|
2534
|
+
/**
|
|
2535
|
+
* The description of the promotion.
|
|
2536
|
+
*/
|
|
2537
|
+
description?: string;
|
|
2538
|
+
/**
|
|
2539
|
+
* Whether the promotion is applied automatically.
|
|
2540
|
+
*/
|
|
2541
|
+
automatic?: boolean;
|
|
2542
|
+
/**
|
|
2543
|
+
* The type of promotion (for v1 promotions).
|
|
2544
|
+
*/
|
|
2545
|
+
promotion_type?: string;
|
|
2546
|
+
/**
|
|
2547
|
+
* The source of the promotion (for rule promotions).
|
|
2548
|
+
*/
|
|
2549
|
+
promotion_source?: string;
|
|
2550
|
+
/**
|
|
2551
|
+
* The start date and time of the promotion.
|
|
2552
|
+
*/
|
|
2553
|
+
start?: Date;
|
|
2554
|
+
/**
|
|
2555
|
+
* The end date and time of the promotion.
|
|
2556
|
+
*/
|
|
2557
|
+
end?: Date;
|
|
2558
|
+
};
|
|
2559
|
+
type CartEntityResponse = {
|
|
2560
|
+
data: CartResponse;
|
|
2561
|
+
/**
|
|
2562
|
+
* Related objects that are included in the response.
|
|
2563
|
+
*/
|
|
2564
|
+
included?: CartIncluded;
|
|
2565
|
+
/**
|
|
2566
|
+
* Additional metadata for the cart response.
|
|
2567
|
+
*/
|
|
2568
|
+
meta?: {
|
|
2406
2569
|
/**
|
|
2407
|
-
*
|
|
2570
|
+
* Payment intent details with nested structure including status and other Stripe payment intent fields
|
|
2408
2571
|
*/
|
|
2409
|
-
|
|
2572
|
+
payment_intent?: {
|
|
2410
2573
|
[key: string]: unknown;
|
|
2411
2574
|
};
|
|
2412
|
-
/**
|
|
2413
|
-
* Array of component products for the selected options.
|
|
2414
|
-
*/
|
|
2415
|
-
component_products?: Array<unknown>;
|
|
2416
2575
|
};
|
|
2417
2576
|
/**
|
|
2418
|
-
*
|
|
2419
|
-
*/
|
|
2420
|
-
shipping_group_id?: string;
|
|
2421
|
-
/**
|
|
2422
|
-
* The slug of a stock location.
|
|
2577
|
+
* Array of error objects, if any errors occurred.
|
|
2423
2578
|
*/
|
|
2424
|
-
|
|
2579
|
+
errors?: Array<ResponseErrorItem>;
|
|
2425
2580
|
};
|
|
2426
2581
|
type ItemPriceData = {
|
|
2427
2582
|
/**
|
|
@@ -2437,6 +2592,47 @@ type ItemPriceData = {
|
|
|
2437
2592
|
*/
|
|
2438
2593
|
readonly includes_tax?: boolean;
|
|
2439
2594
|
};
|
|
2595
|
+
type Money = {
|
|
2596
|
+
/**
|
|
2597
|
+
* Amount in minor currency units (e.g., cents).
|
|
2598
|
+
*/
|
|
2599
|
+
amount: number;
|
|
2600
|
+
/**
|
|
2601
|
+
* ISO 4217 currency code (e.g., "USD").
|
|
2602
|
+
*/
|
|
2603
|
+
currency: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Whether the amount includes tax.
|
|
2606
|
+
*/
|
|
2607
|
+
includes_tax: boolean;
|
|
2608
|
+
};
|
|
2609
|
+
type Discount = {
|
|
2610
|
+
amount: Money;
|
|
2611
|
+
/**
|
|
2612
|
+
* The discount code used, if applicable.
|
|
2613
|
+
*/
|
|
2614
|
+
code?: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* Unique identifier for the discount.
|
|
2617
|
+
*/
|
|
2618
|
+
id: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* The source or origin of the promotion, if applicable.
|
|
2621
|
+
*/
|
|
2622
|
+
promotion_source?: string;
|
|
2623
|
+
/**
|
|
2624
|
+
* Indicates whether the discount applies to the entire cart.
|
|
2625
|
+
*/
|
|
2626
|
+
is_cart_discount?: boolean;
|
|
2627
|
+
/**
|
|
2628
|
+
* Order in which the discount was applied.
|
|
2629
|
+
*/
|
|
2630
|
+
ordinal?: number;
|
|
2631
|
+
/**
|
|
2632
|
+
* Identifies the specific action within a multi-action rule promotion that produced this discount.
|
|
2633
|
+
*/
|
|
2634
|
+
promotion_action_id?: string;
|
|
2635
|
+
};
|
|
2440
2636
|
type CartItemFormattedPriceData = {
|
|
2441
2637
|
/**
|
|
2442
2638
|
* The amount per each single unit.
|
|
@@ -2447,11 +2643,27 @@ type CartItemFormattedPriceData = {
|
|
|
2447
2643
|
*/
|
|
2448
2644
|
value?: FormattedPriceData;
|
|
2449
2645
|
};
|
|
2646
|
+
/**
|
|
2647
|
+
* The source of the promotion (for promotion items).
|
|
2648
|
+
*/
|
|
2649
|
+
type PromotionSource = "rule-promotion";
|
|
2450
2650
|
type CartItemResponse = {
|
|
2451
2651
|
/**
|
|
2452
|
-
* The unique
|
|
2652
|
+
* The unique identifier for the cart item.
|
|
2653
|
+
*/
|
|
2654
|
+
readonly id?: string;
|
|
2655
|
+
/**
|
|
2656
|
+
* The type of cart item.
|
|
2657
|
+
*/
|
|
2658
|
+
type?: "cart_item" | "custom_item" | "subscription_item" | "promotion_item";
|
|
2659
|
+
/**
|
|
2660
|
+
* The unique ID of the product (for cart_item type).
|
|
2453
2661
|
*/
|
|
2454
2662
|
readonly product_id?: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* The unique ID of the promotion (for promotion_item type).
|
|
2665
|
+
*/
|
|
2666
|
+
readonly promotion_id?: string;
|
|
2455
2667
|
/**
|
|
2456
2668
|
* The unique ID of the subscription offering for subscription items.
|
|
2457
2669
|
*/
|
|
@@ -2464,6 +2676,14 @@ type CartItemResponse = {
|
|
|
2464
2676
|
* A description of the cart item.
|
|
2465
2677
|
*/
|
|
2466
2678
|
readonly description?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* The SKU of the cart item.
|
|
2681
|
+
*/
|
|
2682
|
+
readonly sku?: string;
|
|
2683
|
+
/**
|
|
2684
|
+
* The slug of the cart item.
|
|
2685
|
+
*/
|
|
2686
|
+
readonly slug?: string;
|
|
2467
2687
|
/**
|
|
2468
2688
|
* The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
|
|
2469
2689
|
*/
|
|
@@ -2472,6 +2692,66 @@ type CartItemResponse = {
|
|
|
2472
2692
|
* The catalog source. Always `pim` or `legacy`.
|
|
2473
2693
|
*/
|
|
2474
2694
|
readonly catalog_source?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* Configuration for bundle products.
|
|
2697
|
+
*/
|
|
2698
|
+
readonly bundle_configuration?: {
|
|
2699
|
+
selected_options?: {
|
|
2700
|
+
[key: string]: {
|
|
2701
|
+
[key: string]: number;
|
|
2702
|
+
};
|
|
2703
|
+
};
|
|
2704
|
+
/**
|
|
2705
|
+
* Array of component products for bundle configuration
|
|
2706
|
+
*/
|
|
2707
|
+
component_products?: Array<{
|
|
2708
|
+
/**
|
|
2709
|
+
* Product ID
|
|
2710
|
+
*/
|
|
2711
|
+
id?: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* Product type
|
|
2714
|
+
*/
|
|
2715
|
+
type?: string;
|
|
2716
|
+
/**
|
|
2717
|
+
* Product attributes as a generic object
|
|
2718
|
+
*/
|
|
2719
|
+
attributes?: {
|
|
2720
|
+
[key: string]: unknown;
|
|
2721
|
+
};
|
|
2722
|
+
/**
|
|
2723
|
+
* Product meta information as a generic object
|
|
2724
|
+
*/
|
|
2725
|
+
meta?: {
|
|
2726
|
+
[key: string]: unknown;
|
|
2727
|
+
};
|
|
2728
|
+
/**
|
|
2729
|
+
* Product price
|
|
2730
|
+
*/
|
|
2731
|
+
price?: {
|
|
2732
|
+
[key: string]: unknown;
|
|
2733
|
+
};
|
|
2734
|
+
/**
|
|
2735
|
+
* Product relationships as a generic object
|
|
2736
|
+
*/
|
|
2737
|
+
relationships?: {
|
|
2738
|
+
[key: string]: unknown;
|
|
2739
|
+
};
|
|
2740
|
+
}>;
|
|
2741
|
+
};
|
|
2742
|
+
/**
|
|
2743
|
+
* Components of the cart item for bundle products.
|
|
2744
|
+
*/
|
|
2745
|
+
readonly components?: {
|
|
2746
|
+
[key: string]: {
|
|
2747
|
+
name?: string;
|
|
2748
|
+
options?: Array<{
|
|
2749
|
+
id?: string;
|
|
2750
|
+
quantity?: number;
|
|
2751
|
+
type?: string;
|
|
2752
|
+
}>;
|
|
2753
|
+
};
|
|
2754
|
+
};
|
|
2475
2755
|
readonly image?: {
|
|
2476
2756
|
/**
|
|
2477
2757
|
* The MIME type for the uploaded file.
|
|
@@ -2487,22 +2767,57 @@ type CartItemResponse = {
|
|
|
2487
2767
|
readonly href?: string;
|
|
2488
2768
|
};
|
|
2489
2769
|
/**
|
|
2490
|
-
*
|
|
2770
|
+
* The quantity of the cart item.
|
|
2491
2771
|
*/
|
|
2492
|
-
readonly
|
|
2772
|
+
readonly quantity?: number;
|
|
2493
2773
|
/**
|
|
2494
|
-
* The
|
|
2774
|
+
* The quantity automatically added (for gift items).
|
|
2775
|
+
*/
|
|
2776
|
+
readonly auto_add_quantity?: number;
|
|
2777
|
+
/**
|
|
2778
|
+
* Whether or not the quantity of the item will be checked against inventory.
|
|
2779
|
+
*/
|
|
2780
|
+
readonly manage_stock?: boolean;
|
|
2781
|
+
/**
|
|
2782
|
+
* The unit price of the item.
|
|
2495
2783
|
*/
|
|
2496
2784
|
unit_price?: ItemPriceData;
|
|
2497
2785
|
/**
|
|
2498
2786
|
* The total price of the item (i.e., unit * quantity).
|
|
2499
2787
|
*/
|
|
2500
2788
|
value?: ItemPriceData;
|
|
2789
|
+
/**
|
|
2790
|
+
* Array of discounts applied to the cart item.
|
|
2791
|
+
*/
|
|
2792
|
+
readonly discounts?: Array<Discount>;
|
|
2793
|
+
/**
|
|
2794
|
+
* Custom inputs for personalized products.
|
|
2795
|
+
*/
|
|
2796
|
+
readonly custom_inputs?: {
|
|
2797
|
+
[key: string]: unknown;
|
|
2798
|
+
};
|
|
2799
|
+
/**
|
|
2800
|
+
* Configuration for subscription items.
|
|
2801
|
+
*/
|
|
2802
|
+
readonly subscription_configuration?: {
|
|
2803
|
+
/**
|
|
2804
|
+
* The subscription plan ID.
|
|
2805
|
+
*/
|
|
2806
|
+
plan?: string;
|
|
2807
|
+
/**
|
|
2808
|
+
* The subscription pricing option ID.
|
|
2809
|
+
*/
|
|
2810
|
+
pricing_option?: string;
|
|
2811
|
+
};
|
|
2501
2812
|
readonly links?: {
|
|
2502
2813
|
/**
|
|
2503
2814
|
* A URL related to the resource.
|
|
2504
2815
|
*/
|
|
2505
2816
|
product?: string;
|
|
2817
|
+
/**
|
|
2818
|
+
* A URL related to the subscription offering resource.
|
|
2819
|
+
*/
|
|
2820
|
+
subscription_offering?: string;
|
|
2506
2821
|
};
|
|
2507
2822
|
readonly meta?: {
|
|
2508
2823
|
display_price?: {
|
|
@@ -2523,42 +2838,311 @@ type CartItemResponse = {
|
|
|
2523
2838
|
*/
|
|
2524
2839
|
discount?: CartItemFormattedPriceData;
|
|
2525
2840
|
without_discount?: CartItemFormattedPriceData;
|
|
2841
|
+
/**
|
|
2842
|
+
* The product's original catalog price before any catalog-level sales, tiered pricing adjustments, or cart/item level promotions are applied. This value is sourced from the product's `meta.original_display_price` field in the catalog response. See [Get a Product](/docs/api/pxm/catalog/get-by-context-product).
|
|
2843
|
+
*/
|
|
2844
|
+
original_price?: CartItemFormattedPriceData;
|
|
2845
|
+
/**
|
|
2846
|
+
* Detailed discount information.
|
|
2847
|
+
*/
|
|
2848
|
+
discounts?: {
|
|
2849
|
+
[key: string]: {
|
|
2850
|
+
/**
|
|
2851
|
+
* The discount amount.
|
|
2852
|
+
*/
|
|
2853
|
+
amount: number;
|
|
2854
|
+
/**
|
|
2855
|
+
* The currency code.
|
|
2856
|
+
*/
|
|
2857
|
+
currency: string;
|
|
2858
|
+
/**
|
|
2859
|
+
* The formatted discount amount.
|
|
2860
|
+
*/
|
|
2861
|
+
formatted: string;
|
|
2862
|
+
/**
|
|
2863
|
+
* The discount constituents.
|
|
2864
|
+
*/
|
|
2865
|
+
constituents?: {
|
|
2866
|
+
[key: string]: FormattedPriceData;
|
|
2867
|
+
};
|
|
2868
|
+
};
|
|
2869
|
+
};
|
|
2526
2870
|
};
|
|
2527
2871
|
timestamps?: CartCheckoutTimestamps;
|
|
2528
2872
|
};
|
|
2873
|
+
/**
|
|
2874
|
+
* Relationships to other resources.
|
|
2875
|
+
*/
|
|
2876
|
+
readonly relationships?: {
|
|
2877
|
+
/**
|
|
2878
|
+
* Related tax items.
|
|
2879
|
+
*/
|
|
2880
|
+
taxes?: {
|
|
2881
|
+
data?: null | Array<RelationshipItem>;
|
|
2882
|
+
};
|
|
2883
|
+
/**
|
|
2884
|
+
* Related custom discounts.
|
|
2885
|
+
*/
|
|
2886
|
+
custom_discounts?: {
|
|
2887
|
+
data?: null | Array<RelationshipItem>;
|
|
2888
|
+
};
|
|
2889
|
+
/**
|
|
2890
|
+
* Related promotions.
|
|
2891
|
+
*/
|
|
2892
|
+
promotions?: {
|
|
2893
|
+
data?: null | Array<RelationshipItem>;
|
|
2894
|
+
};
|
|
2895
|
+
};
|
|
2896
|
+
/**
|
|
2897
|
+
* The shipping group ID for this item.
|
|
2898
|
+
*/
|
|
2899
|
+
readonly shipping_group_id?: string;
|
|
2900
|
+
/**
|
|
2901
|
+
* The source of the promotion (for promotion items).
|
|
2902
|
+
*/
|
|
2903
|
+
promotion_source?: "rule-promotion";
|
|
2904
|
+
/**
|
|
2905
|
+
* The action ID within the rule promotion that produced this promotion item.
|
|
2906
|
+
*/
|
|
2907
|
+
readonly promotion_action_id?: string;
|
|
2908
|
+
/**
|
|
2909
|
+
* The stock location for this item.
|
|
2910
|
+
*/
|
|
2911
|
+
readonly location?: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Custom attributes attached to the cart item.
|
|
2914
|
+
*/
|
|
2915
|
+
custom_attributes?: CustomAttributes;
|
|
2529
2916
|
};
|
|
2530
|
-
type
|
|
2531
|
-
type CustomItemObjectData = {
|
|
2917
|
+
type TaxItemResponse = {
|
|
2532
2918
|
/**
|
|
2533
|
-
*
|
|
2919
|
+
* Specifies the type of the resource. Always `tax_item`.
|
|
2534
2920
|
*/
|
|
2535
|
-
type
|
|
2921
|
+
type?: "tax_item";
|
|
2536
2922
|
/**
|
|
2537
|
-
*
|
|
2923
|
+
* Specifies the UUID of the tax item.
|
|
2538
2924
|
*/
|
|
2539
|
-
|
|
2540
|
-
|
|
2925
|
+
readonly id?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* The jurisdiction for the tax item.
|
|
2928
|
+
*/
|
|
2929
|
+
jurisdiction?: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* The tax code for the tax item.
|
|
2932
|
+
*/
|
|
2933
|
+
code?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* The name of the tax item.
|
|
2936
|
+
*/
|
|
2937
|
+
name?: string;
|
|
2938
|
+
/**
|
|
2939
|
+
* The tax rate as a decimal (e.g., 0.085 for 8.5%).
|
|
2940
|
+
*/
|
|
2941
|
+
rate?: number;
|
|
2942
|
+
/**
|
|
2943
|
+
* The tax amount in the smallest currency unit.
|
|
2944
|
+
*/
|
|
2945
|
+
amount?: number;
|
|
2946
|
+
};
|
|
2947
|
+
type CartItemCollectionResponse = {
|
|
2948
|
+
data: Array<CartItemResponse>;
|
|
2949
|
+
/**
|
|
2950
|
+
* Related objects that are included in the response.
|
|
2951
|
+
*/
|
|
2952
|
+
included?: {
|
|
2953
|
+
custom_discounts?: Array<CustomDiscountResponse>;
|
|
2954
|
+
promotions?: Array<{
|
|
2955
|
+
automatic?: boolean;
|
|
2956
|
+
description?: string;
|
|
2957
|
+
end?: Date;
|
|
2958
|
+
id?: string;
|
|
2959
|
+
name?: string;
|
|
2960
|
+
promotion_type?: string;
|
|
2961
|
+
/**
|
|
2962
|
+
* The source of the promotion
|
|
2963
|
+
*/
|
|
2964
|
+
promotion_source?: string;
|
|
2965
|
+
start?: Date;
|
|
2966
|
+
type?: "promotion";
|
|
2967
|
+
}>;
|
|
2541
2968
|
/**
|
|
2542
|
-
*
|
|
2969
|
+
* Array of tax items included in the response.
|
|
2543
2970
|
*/
|
|
2544
|
-
|
|
2971
|
+
tax_items?: Array<TaxItemResponse>;
|
|
2972
|
+
};
|
|
2973
|
+
/**
|
|
2974
|
+
* Additional meta information about the cart items collection.
|
|
2975
|
+
*/
|
|
2976
|
+
meta?: {
|
|
2977
|
+
display_price?: {
|
|
2978
|
+
with_tax?: FormattedPriceData;
|
|
2979
|
+
without_tax?: FormattedPriceData;
|
|
2980
|
+
tax?: FormattedPriceData;
|
|
2981
|
+
discount?: FormattedPriceData;
|
|
2982
|
+
without_discount?: FormattedPriceData;
|
|
2983
|
+
shipping?: FormattedPriceData;
|
|
2984
|
+
shipping_discount?: FormattedPriceData;
|
|
2985
|
+
authorized?: FormattedPriceData;
|
|
2986
|
+
balance_owing?: FormattedPriceData;
|
|
2987
|
+
paid?: FormattedPriceData;
|
|
2988
|
+
};
|
|
2989
|
+
timestamps?: CartTimestamps;
|
|
2545
2990
|
/**
|
|
2546
|
-
*
|
|
2991
|
+
* Optional array of informational messages that provide feedback about operations performed on the cart items, such as promotions added or discounts applied. This field is only present when there are relevant messages to display.
|
|
2992
|
+
*
|
|
2547
2993
|
*/
|
|
2548
|
-
|
|
2994
|
+
messages?: Array<{
|
|
2995
|
+
/**
|
|
2996
|
+
* Identifies the cart item that triggered this message
|
|
2997
|
+
*/
|
|
2998
|
+
source?: {
|
|
2999
|
+
/**
|
|
3000
|
+
* The type of the source item
|
|
3001
|
+
*/
|
|
3002
|
+
type: string;
|
|
3003
|
+
/**
|
|
3004
|
+
* The unique identifier of the source item
|
|
3005
|
+
*/
|
|
3006
|
+
id: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* The promotion code (present when source type is promotion)
|
|
3009
|
+
*/
|
|
3010
|
+
code?: string;
|
|
3011
|
+
};
|
|
3012
|
+
/**
|
|
3013
|
+
* A short descriptive title for the message
|
|
3014
|
+
*/
|
|
3015
|
+
title: string;
|
|
3016
|
+
/**
|
|
3017
|
+
* A detailed description of the message
|
|
3018
|
+
*/
|
|
3019
|
+
description: string;
|
|
3020
|
+
}>;
|
|
3021
|
+
/**
|
|
3022
|
+
* Array of promotion suggestions
|
|
3023
|
+
*/
|
|
3024
|
+
promotion_suggestions?: Array<{
|
|
3025
|
+
/**
|
|
3026
|
+
* Bundle configuration with promotion targets
|
|
3027
|
+
*/
|
|
3028
|
+
bundle?: Array<{
|
|
3029
|
+
/**
|
|
3030
|
+
* Whether to automatically add free gift
|
|
3031
|
+
*/
|
|
3032
|
+
auto_add_free_gift?: boolean;
|
|
3033
|
+
/**
|
|
3034
|
+
* Cart item ID for the target
|
|
3035
|
+
*/
|
|
3036
|
+
cart_item_id?: string;
|
|
3037
|
+
/**
|
|
3038
|
+
* Quantity for the promotion
|
|
3039
|
+
*/
|
|
3040
|
+
quantity?: number;
|
|
3041
|
+
/**
|
|
3042
|
+
* Array of target SKUs
|
|
3043
|
+
*/
|
|
3044
|
+
targets?: Array<string>;
|
|
3045
|
+
[key: string]: unknown | boolean | string | number | Array<string> | undefined;
|
|
3046
|
+
}>;
|
|
3047
|
+
code?: string;
|
|
3048
|
+
info?: string;
|
|
3049
|
+
message?: string;
|
|
3050
|
+
promotion_id?: string;
|
|
3051
|
+
/**
|
|
3052
|
+
* Whether this promotion should be automatically added
|
|
3053
|
+
*/
|
|
3054
|
+
auto_add?: boolean;
|
|
3055
|
+
/**
|
|
3056
|
+
* Array of promotion targets (alternative structure)
|
|
3057
|
+
*/
|
|
3058
|
+
targets?: Array<{
|
|
3059
|
+
/**
|
|
3060
|
+
* The cart item ID for this target
|
|
3061
|
+
*/
|
|
3062
|
+
cart_item_id?: string;
|
|
3063
|
+
/**
|
|
3064
|
+
* The quantity for this target
|
|
3065
|
+
*/
|
|
3066
|
+
quantity?: number;
|
|
3067
|
+
/**
|
|
3068
|
+
* Array of SKU codes for this target
|
|
3069
|
+
*/
|
|
3070
|
+
skus?: Array<string>;
|
|
3071
|
+
}>;
|
|
3072
|
+
}>;
|
|
2549
3073
|
};
|
|
2550
3074
|
/**
|
|
2551
|
-
*
|
|
3075
|
+
* Array of error objects, if any errors occurred.
|
|
2552
3076
|
*/
|
|
2553
|
-
|
|
3077
|
+
errors?: Array<ResponseErrorItem>;
|
|
3078
|
+
};
|
|
3079
|
+
type BulkUpdateCartsItemsCommon = {
|
|
2554
3080
|
/**
|
|
2555
|
-
*
|
|
3081
|
+
* Specifies the ID of the cart item that you want to update in cart.
|
|
3082
|
+
*/
|
|
3083
|
+
id?: string;
|
|
3084
|
+
/**
|
|
3085
|
+
* Specifies the amount of items to update in the cart.
|
|
3086
|
+
*/
|
|
3087
|
+
quantity?: number;
|
|
3088
|
+
/**
|
|
3089
|
+
* The type of cart item being updated.
|
|
3090
|
+
*/
|
|
3091
|
+
type?: "cart_item" | "custom_item";
|
|
3092
|
+
/**
|
|
3093
|
+
* Specifies the custom text to be added to a product. See [custom inputs](https://elasticpath.dev/docs/pxm/products/ep-pxm-products-api/update-a-product#using-custom-inputs-attribute).
|
|
3094
|
+
*/
|
|
3095
|
+
custom_inputs?: {
|
|
3096
|
+
[key: string]: unknown;
|
|
3097
|
+
};
|
|
3098
|
+
/**
|
|
3099
|
+
* Specifies custom attributes to be added to the cart item.
|
|
3100
|
+
*/
|
|
3101
|
+
custom_attributes?: CustomAttributes;
|
|
3102
|
+
/**
|
|
3103
|
+
* Specifies the shipping group ID for the cart item.
|
|
3104
|
+
*/
|
|
3105
|
+
shipping_group_id?: string;
|
|
3106
|
+
};
|
|
3107
|
+
type BulkUpdateCartsItemsWithQuantity = BulkUpdateCartsItemsCommon & {
|
|
3108
|
+
quantity: unknown;
|
|
3109
|
+
id: unknown;
|
|
3110
|
+
};
|
|
3111
|
+
type BulkUpdateCartsItemsWithShippingGroup = BulkUpdateCartsItemsCommon & {
|
|
3112
|
+
shipping_group_id: unknown;
|
|
3113
|
+
id: unknown;
|
|
3114
|
+
};
|
|
3115
|
+
type BulkUpdateCartsItemsWithCustomInputs = BulkUpdateCartsItemsCommon & {
|
|
3116
|
+
custom_inputs: unknown;
|
|
3117
|
+
id: unknown;
|
|
3118
|
+
};
|
|
3119
|
+
type UpdateAllOrNothingOptionsObject = {
|
|
3120
|
+
/**
|
|
3121
|
+
* 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`.
|
|
3122
|
+
*/
|
|
3123
|
+
update_all_or_nothing?: boolean;
|
|
3124
|
+
};
|
|
3125
|
+
type BulkUpdateCartsItems = {
|
|
3126
|
+
data?: Array<BulkUpdateCartsItemsWithQuantity | BulkUpdateCartsItemsWithShippingGroup | BulkUpdateCartsItemsWithCustomInputs>;
|
|
3127
|
+
options?: UpdateAllOrNothingOptionsObject;
|
|
3128
|
+
};
|
|
3129
|
+
type BaseItemObjectData = {
|
|
3130
|
+
/**
|
|
3131
|
+
* The number of items to add.
|
|
3132
|
+
*/
|
|
3133
|
+
quantity: number;
|
|
3134
|
+
/**
|
|
3135
|
+
* Specifies the ID of the product you want to add. (use this OR sku)
|
|
3136
|
+
*/
|
|
3137
|
+
id?: string;
|
|
3138
|
+
/**
|
|
3139
|
+
* Specifies the item SKU that you want to add. (use this OR id)
|
|
2556
3140
|
*/
|
|
2557
3141
|
sku?: string;
|
|
2558
3142
|
/**
|
|
2559
|
-
*
|
|
3143
|
+
* Optional name for the product item. If not provided, the product name from catalog will be used.
|
|
2560
3144
|
*/
|
|
2561
|
-
name
|
|
3145
|
+
name?: string;
|
|
2562
3146
|
/**
|
|
2563
3147
|
* The custom text to be added to a product.
|
|
2564
3148
|
*/
|
|
@@ -2566,12 +3150,38 @@ type CustomItemObjectData = {
|
|
|
2566
3150
|
[key: string]: unknown;
|
|
2567
3151
|
};
|
|
2568
3152
|
/**
|
|
2569
|
-
*
|
|
3153
|
+
* Object used to describe the bundle options selected.
|
|
3154
|
+
*/
|
|
3155
|
+
bundle_configuration?: {
|
|
3156
|
+
/**
|
|
3157
|
+
* Specifies selected options.
|
|
3158
|
+
*/
|
|
3159
|
+
selected_options?: {
|
|
3160
|
+
[key: string]: unknown;
|
|
3161
|
+
};
|
|
3162
|
+
/**
|
|
3163
|
+
* Array of component products for the selected options.
|
|
3164
|
+
*/
|
|
3165
|
+
component_products?: Array<unknown>;
|
|
3166
|
+
};
|
|
3167
|
+
/**
|
|
3168
|
+
* Identifier for a Shipping Group
|
|
2570
3169
|
*/
|
|
2571
3170
|
shipping_group_id?: string;
|
|
3171
|
+
/**
|
|
3172
|
+
* The slug of a stock location.
|
|
3173
|
+
*/
|
|
3174
|
+
location?: string;
|
|
3175
|
+
custom_attributes?: CustomAttributes;
|
|
2572
3176
|
};
|
|
2573
|
-
type
|
|
2574
|
-
|
|
3177
|
+
type CartItemObjectData = {
|
|
3178
|
+
/**
|
|
3179
|
+
* The type of object being returned. Must be `cart_item` for cart items.
|
|
3180
|
+
*/
|
|
3181
|
+
type: "cart_item";
|
|
3182
|
+
} & BaseItemObjectData;
|
|
3183
|
+
type CartItemObjectRequest = {
|
|
3184
|
+
data?: CartItemObjectData;
|
|
2575
3185
|
};
|
|
2576
3186
|
type SubscriptionItemObjectData = {
|
|
2577
3187
|
/**
|
|
@@ -2596,6 +3206,7 @@ type SubscriptionItemObjectData = {
|
|
|
2596
3206
|
pricing_option: string;
|
|
2597
3207
|
/**
|
|
2598
3208
|
* The ID of the plan within the offering to use for the subscription.
|
|
3209
|
+
* @deprecated
|
|
2599
3210
|
*/
|
|
2600
3211
|
plan: string;
|
|
2601
3212
|
};
|
|
@@ -2603,69 +3214,71 @@ type SubscriptionItemObjectData = {
|
|
|
2603
3214
|
type SubscriptionItemObject = {
|
|
2604
3215
|
data?: SubscriptionItemObjectData & CartItemResponse;
|
|
2605
3216
|
};
|
|
2606
|
-
type
|
|
3217
|
+
type CartMergeObject = {
|
|
2607
3218
|
/**
|
|
2608
|
-
*
|
|
3219
|
+
* The type of object being returned. Must be `cart_items`.
|
|
2609
3220
|
*/
|
|
2610
|
-
type: "
|
|
3221
|
+
type: "cart_items";
|
|
2611
3222
|
/**
|
|
2612
|
-
*
|
|
3223
|
+
* The original cart to be merged from.
|
|
2613
3224
|
*/
|
|
2614
|
-
|
|
3225
|
+
cart_id: string;
|
|
2615
3226
|
};
|
|
2616
|
-
type
|
|
2617
|
-
|
|
3227
|
+
type AddAllOrNothingOptionsObject = {
|
|
3228
|
+
/**
|
|
3229
|
+
* 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`.
|
|
3230
|
+
*/
|
|
3231
|
+
add_all_or_nothing?: boolean;
|
|
2618
3232
|
};
|
|
2619
|
-
type
|
|
2620
|
-
data?:
|
|
3233
|
+
type CartMergeObjectRequest = {
|
|
3234
|
+
data?: CartMergeObject;
|
|
3235
|
+
options?: AddAllOrNothingOptionsObject;
|
|
2621
3236
|
};
|
|
2622
|
-
type
|
|
3237
|
+
type CustomItemObjectData = {
|
|
2623
3238
|
/**
|
|
2624
|
-
*
|
|
3239
|
+
* The type of object being returned. Must be `custom_item`.
|
|
2625
3240
|
*/
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
*/
|
|
2633
|
-
id?: string;
|
|
3241
|
+
type: "custom_item";
|
|
3242
|
+
/**
|
|
3243
|
+
* The number of custom items to add to cart.
|
|
3244
|
+
*/
|
|
3245
|
+
quantity: number;
|
|
3246
|
+
price: {
|
|
2634
3247
|
/**
|
|
2635
|
-
*
|
|
3248
|
+
* The unit price of the custom item.
|
|
2636
3249
|
*/
|
|
2637
|
-
|
|
3250
|
+
amount: number;
|
|
2638
3251
|
/**
|
|
2639
|
-
*
|
|
3252
|
+
* Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
|
|
2640
3253
|
*/
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
};
|
|
2644
|
-
}>;
|
|
2645
|
-
options?: UpdateAllOrNothingOptionsObject;
|
|
2646
|
-
};
|
|
2647
|
-
type CartItemObjectRequest = {
|
|
2648
|
-
data?: CartItemObject;
|
|
2649
|
-
};
|
|
2650
|
-
type CartMergeObject = {
|
|
3254
|
+
includes_tax?: boolean;
|
|
3255
|
+
};
|
|
2651
3256
|
/**
|
|
2652
|
-
*
|
|
3257
|
+
* A description of the custom item.
|
|
2653
3258
|
*/
|
|
2654
|
-
|
|
3259
|
+
description?: string;
|
|
2655
3260
|
/**
|
|
2656
|
-
* The
|
|
3261
|
+
* 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.
|
|
2657
3262
|
*/
|
|
2658
|
-
|
|
2659
|
-
};
|
|
2660
|
-
type AddAllOrNothingOptionsObject = {
|
|
3263
|
+
sku?: string;
|
|
2661
3264
|
/**
|
|
2662
|
-
*
|
|
3265
|
+
* The name of the custom item.
|
|
2663
3266
|
*/
|
|
2664
|
-
|
|
3267
|
+
name: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* The custom text to be added to a product.
|
|
3270
|
+
*/
|
|
3271
|
+
custom_inputs?: {
|
|
3272
|
+
[key: string]: unknown;
|
|
3273
|
+
};
|
|
3274
|
+
/**
|
|
3275
|
+
* Identifier for a created Cart Shipping Group
|
|
3276
|
+
*/
|
|
3277
|
+
shipping_group_id?: string;
|
|
3278
|
+
custom_attributes?: CustomAttributes;
|
|
2665
3279
|
};
|
|
2666
|
-
type
|
|
2667
|
-
data?:
|
|
2668
|
-
options?: AddAllOrNothingOptionsObject;
|
|
3280
|
+
type CustomItemObject = {
|
|
3281
|
+
data?: CustomItemObjectData;
|
|
2669
3282
|
};
|
|
2670
3283
|
type ReOrderObject = {
|
|
2671
3284
|
/**
|
|
@@ -2681,35 +3294,23 @@ type ReOrderObjectRequest = {
|
|
|
2681
3294
|
data?: ReOrderObject;
|
|
2682
3295
|
options?: AddAllOrNothingOptionsObject;
|
|
2683
3296
|
};
|
|
3297
|
+
type PromotionItemObjectData = {
|
|
3298
|
+
/**
|
|
3299
|
+
* Specifies the type of resource, which is `promotion_item`.
|
|
3300
|
+
*/
|
|
3301
|
+
type: "promotion_item";
|
|
3302
|
+
/**
|
|
3303
|
+
* Specifies the promotion code. For more information about codes[].user[], see the [Create Promotion codes](/docs/api/promotions/create-promotion-codes) section.
|
|
3304
|
+
*/
|
|
3305
|
+
code: string;
|
|
3306
|
+
};
|
|
3307
|
+
type PromotionItemObject = {
|
|
3308
|
+
data?: PromotionItemObjectData;
|
|
3309
|
+
};
|
|
2684
3310
|
type BulkAddItemsRequest = {
|
|
2685
3311
|
data?: Array<CartItemObjectData | CartMergeObject | CustomItemObjectData | ReOrderObject | PromotionItemObjectData>;
|
|
2686
3312
|
options?: AddAllOrNothingOptionsObject;
|
|
2687
3313
|
};
|
|
2688
|
-
type CartTimestamps = {
|
|
2689
|
-
created_at?: string;
|
|
2690
|
-
updated_at?: unknown;
|
|
2691
|
-
expires_at?: unknown;
|
|
2692
|
-
};
|
|
2693
|
-
type CartsResponse = {
|
|
2694
|
-
data?: Array<CartItemObject | CustomItemCartObject | SubscriptionItemCartObject | PromotionItemCartObject>;
|
|
2695
|
-
meta?: {
|
|
2696
|
-
display_price?: {
|
|
2697
|
-
with_tax?: FormattedPriceData;
|
|
2698
|
-
without_tax?: FormattedPriceData;
|
|
2699
|
-
tax?: FormattedPriceData;
|
|
2700
|
-
discount?: FormattedPriceData;
|
|
2701
|
-
without_discount?: FormattedPriceData;
|
|
2702
|
-
discounts?: {
|
|
2703
|
-
[key: string]: {
|
|
2704
|
-
amount?: number;
|
|
2705
|
-
currency?: string;
|
|
2706
|
-
formatted?: string;
|
|
2707
|
-
};
|
|
2708
|
-
};
|
|
2709
|
-
};
|
|
2710
|
-
timestamps?: CartTimestamps;
|
|
2711
|
-
};
|
|
2712
|
-
};
|
|
2713
3314
|
type UpdateCartsItems = {
|
|
2714
3315
|
data?: {
|
|
2715
3316
|
/**
|
|
@@ -2730,6 +3331,10 @@ type UpdateCartsItems = {
|
|
|
2730
3331
|
custom_inputs?: {
|
|
2731
3332
|
[key: string]: unknown;
|
|
2732
3333
|
};
|
|
3334
|
+
/**
|
|
3335
|
+
* Custom attributes to be added to the cart item.
|
|
3336
|
+
*/
|
|
3337
|
+
custom_attributes?: CustomAttributes;
|
|
2733
3338
|
/**
|
|
2734
3339
|
* The unique identifier of the shipping group to be added to the cart.
|
|
2735
3340
|
*/
|
|
@@ -2760,7 +3365,7 @@ type CartsRelationshipsCustomersData = {
|
|
|
2760
3365
|
type?: string;
|
|
2761
3366
|
}>;
|
|
2762
3367
|
};
|
|
2763
|
-
type
|
|
3368
|
+
type CartsItemsTaxesCommon = {
|
|
2764
3369
|
/**
|
|
2765
3370
|
* A unique tax code in this jurisdiction.
|
|
2766
3371
|
*/
|
|
@@ -2774,43 +3379,75 @@ type CartsItemsTaxesObject = {
|
|
|
2774
3379
|
*/
|
|
2775
3380
|
name?: string;
|
|
2776
3381
|
/**
|
|
2777
|
-
* The tax rate
|
|
3382
|
+
* The tax rate as a decimal (12.5% -> 0.125). You must specify either `rate` or `amount`, but not both.
|
|
3383
|
+
*
|
|
2778
3384
|
*/
|
|
2779
3385
|
rate?: number;
|
|
2780
3386
|
/**
|
|
2781
|
-
* The tax
|
|
3387
|
+
* The tax as an absolute amount in the smallest currency unit (e.g., $10 -> 1000). You must specify either `rate` or `amount`, but not both.
|
|
3388
|
+
*
|
|
2782
3389
|
*/
|
|
2783
3390
|
amount?: number;
|
|
2784
3391
|
/**
|
|
2785
3392
|
* The type of object being returned. Use `tax_item`.
|
|
2786
3393
|
*/
|
|
2787
|
-
type:
|
|
3394
|
+
type: "tax_item";
|
|
2788
3395
|
/**
|
|
2789
3396
|
* The unique identifier for this tax item.
|
|
2790
3397
|
*/
|
|
2791
3398
|
readonly id?: string;
|
|
2792
3399
|
};
|
|
3400
|
+
type CartsItemsTaxesWithRate = CartsItemsTaxesCommon & {
|
|
3401
|
+
/**
|
|
3402
|
+
* The tax rate as a decimal (12.5% -> 0.125). Required when using rate-based taxation.
|
|
3403
|
+
*
|
|
3404
|
+
*/
|
|
3405
|
+
rate: number;
|
|
3406
|
+
/**
|
|
3407
|
+
* The tax as an absolute amount. Not allowed when rate is specified.
|
|
3408
|
+
*
|
|
3409
|
+
*/
|
|
3410
|
+
amount?: number;
|
|
3411
|
+
};
|
|
3412
|
+
type CartsItemsTaxesWithAmount = CartsItemsTaxesCommon & {
|
|
3413
|
+
/**
|
|
3414
|
+
* The tax as an absolute amount in the smallest currency unit (e.g., $10 -> 1000). Required when using amount-based taxation.
|
|
3415
|
+
*
|
|
3416
|
+
*/
|
|
3417
|
+
amount: number;
|
|
3418
|
+
/**
|
|
3419
|
+
* The tax rate as a decimal. Not allowed when amount is specified.
|
|
3420
|
+
*
|
|
3421
|
+
*/
|
|
3422
|
+
rate?: number;
|
|
3423
|
+
};
|
|
3424
|
+
/**
|
|
3425
|
+
* A tax item that can be applied to cart items or bundle components. You must specify either a rate (percentage) or an amount (fixed value), but not both.
|
|
3426
|
+
*
|
|
3427
|
+
*/
|
|
3428
|
+
type CartsItemsTaxesObject = CartsItemsTaxesWithRate | CartsItemsTaxesWithAmount;
|
|
2793
3429
|
type CartItemTaxesEntityResponse = {
|
|
2794
3430
|
data: CartsItemsTaxesObject;
|
|
2795
3431
|
};
|
|
2796
3432
|
type CartItemRelationship = {
|
|
2797
3433
|
relationships?: {
|
|
2798
|
-
|
|
2799
|
-
data
|
|
3434
|
+
item: {
|
|
3435
|
+
data: {
|
|
2800
3436
|
/**
|
|
2801
|
-
*
|
|
3437
|
+
* Specifies the type of item. For example, `custom_item` or `cart_item`.
|
|
2802
3438
|
*/
|
|
2803
|
-
type
|
|
3439
|
+
type: string;
|
|
2804
3440
|
/**
|
|
2805
|
-
*
|
|
3441
|
+
* Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
|
|
2806
3442
|
*/
|
|
2807
|
-
id
|
|
3443
|
+
id: string;
|
|
2808
3444
|
};
|
|
2809
3445
|
};
|
|
2810
3446
|
};
|
|
2811
3447
|
};
|
|
2812
3448
|
type CartsBulkTaxes = {
|
|
2813
3449
|
data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
|
|
3450
|
+
errors?: Array<ResponseErrorItem>;
|
|
2814
3451
|
options?: AddAllOrNothingOptionsObject;
|
|
2815
3452
|
};
|
|
2816
3453
|
type CartsCustomDiscountsObject = {
|
|
@@ -2838,7 +3475,25 @@ type CartsCustomDiscountsObject = {
|
|
|
2838
3475
|
/**
|
|
2839
3476
|
* Specifies the type of the resource. Always `custom_discount`.
|
|
2840
3477
|
*/
|
|
2841
|
-
type:
|
|
3478
|
+
type: "custom_discount";
|
|
3479
|
+
/**
|
|
3480
|
+
* Specifies the UUID of the custom discount.
|
|
3481
|
+
*/
|
|
3482
|
+
id?: string;
|
|
3483
|
+
/**
|
|
3484
|
+
* Relationships to other resources like cart items
|
|
3485
|
+
*/
|
|
3486
|
+
relationships?: {
|
|
3487
|
+
item?: {
|
|
3488
|
+
data?: {
|
|
3489
|
+
/**
|
|
3490
|
+
* The item ID this discount is related to
|
|
3491
|
+
*/
|
|
3492
|
+
id?: string;
|
|
3493
|
+
type?: "cart_item" | "custom_item";
|
|
3494
|
+
};
|
|
3495
|
+
};
|
|
3496
|
+
};
|
|
2842
3497
|
};
|
|
2843
3498
|
type CustomDiscountRelationshipsCartItemRequest = {
|
|
2844
3499
|
relationships?: {
|
|
@@ -2847,11 +3502,11 @@ type CustomDiscountRelationshipsCartItemRequest = {
|
|
|
2847
3502
|
/**
|
|
2848
3503
|
* Specifies the type of item. For example, `custom_item` or `cart_item`.
|
|
2849
3504
|
*/
|
|
2850
|
-
type
|
|
3505
|
+
type: string;
|
|
2851
3506
|
/**
|
|
2852
3507
|
* Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
|
|
2853
3508
|
*/
|
|
2854
|
-
id
|
|
3509
|
+
id: string;
|
|
2855
3510
|
};
|
|
2856
3511
|
};
|
|
2857
3512
|
};
|
|
@@ -2863,11 +3518,17 @@ type CartsBulkCustomDiscounts = {
|
|
|
2863
3518
|
};
|
|
2864
3519
|
type CartsBulkCustomDiscountsResponse = {
|
|
2865
3520
|
data?: CartsCustomDiscountsObject;
|
|
2866
|
-
|
|
3521
|
+
/**
|
|
3522
|
+
* Array of validation or processing errors
|
|
3523
|
+
*/
|
|
3524
|
+
errors?: Array<ResponseErrorItem>;
|
|
2867
3525
|
};
|
|
2868
3526
|
type CartsBulkCustomDiscountsCollectionResponse = {
|
|
2869
3527
|
data?: Array<CartsCustomDiscountsObject>;
|
|
2870
|
-
|
|
3528
|
+
/**
|
|
3529
|
+
* Array of validation or processing errors
|
|
3530
|
+
*/
|
|
3531
|
+
errors?: Array<ResponseErrorItem>;
|
|
2871
3532
|
};
|
|
2872
3533
|
type CartsCustomDiscountsResponseObject = {
|
|
2873
3534
|
amount?: {
|
|
@@ -2903,11 +3564,25 @@ type CartsCustomDiscountsResponseObject = {
|
|
|
2903
3564
|
/**
|
|
2904
3565
|
* Specifies the type of the resource. Always `custom_discount`.
|
|
2905
3566
|
*/
|
|
2906
|
-
type?:
|
|
3567
|
+
type?: "custom_discount";
|
|
2907
3568
|
/**
|
|
2908
3569
|
* Specifies the UUID of the custom discount.
|
|
2909
3570
|
*/
|
|
2910
3571
|
readonly id?: string;
|
|
3572
|
+
/**
|
|
3573
|
+
* Relationships to other resources like cart items
|
|
3574
|
+
*/
|
|
3575
|
+
relationships?: {
|
|
3576
|
+
item?: {
|
|
3577
|
+
data?: {
|
|
3578
|
+
/**
|
|
3579
|
+
* The item ID this discount is related to
|
|
3580
|
+
*/
|
|
3581
|
+
id?: string;
|
|
3582
|
+
type?: "cart_item" | "custom_item";
|
|
3583
|
+
};
|
|
3584
|
+
};
|
|
3585
|
+
};
|
|
2911
3586
|
};
|
|
2912
3587
|
type CartsCustomDiscountsEntityRequest = {
|
|
2913
3588
|
data?: CartsCustomDiscountsResponseObject;
|
|
@@ -2918,165 +3593,455 @@ type CartsCustomDiscountsEntityResponse = {
|
|
|
2918
3593
|
type CartsCustomDiscountsCollectionResponse = {
|
|
2919
3594
|
data?: Array<CartsCustomDiscountsObject>;
|
|
2920
3595
|
};
|
|
2921
|
-
type
|
|
3596
|
+
type AddressCommon = {
|
|
2922
3597
|
/**
|
|
2923
|
-
* First name of the
|
|
3598
|
+
* First name of the recipient.
|
|
2924
3599
|
*/
|
|
2925
3600
|
first_name: string;
|
|
2926
3601
|
/**
|
|
2927
|
-
* Last name of the
|
|
3602
|
+
* Last name of the recipient.
|
|
2928
3603
|
*/
|
|
2929
3604
|
last_name: string;
|
|
2930
3605
|
/**
|
|
2931
|
-
*
|
|
3606
|
+
* Company of the recipient.
|
|
2932
3607
|
*/
|
|
2933
|
-
|
|
3608
|
+
company_name?: string;
|
|
2934
3609
|
/**
|
|
2935
|
-
*
|
|
3610
|
+
* First line of the address.
|
|
2936
3611
|
*/
|
|
2937
|
-
|
|
3612
|
+
line_1: string;
|
|
2938
3613
|
/**
|
|
2939
|
-
*
|
|
3614
|
+
* Second line of the address.
|
|
2940
3615
|
*/
|
|
2941
|
-
|
|
3616
|
+
line_2?: string;
|
|
2942
3617
|
/**
|
|
2943
|
-
*
|
|
3618
|
+
* Third line of the address.
|
|
2944
3619
|
*/
|
|
2945
|
-
|
|
3620
|
+
line_3?: string;
|
|
2946
3621
|
/**
|
|
2947
|
-
* City of the
|
|
3622
|
+
* City of the address.
|
|
2948
3623
|
*/
|
|
2949
|
-
city
|
|
3624
|
+
city?: string;
|
|
2950
3625
|
/**
|
|
2951
|
-
* Post code of the
|
|
3626
|
+
* Post code of the address.
|
|
2952
3627
|
*/
|
|
2953
3628
|
postcode: string;
|
|
2954
3629
|
/**
|
|
2955
|
-
* County of the
|
|
3630
|
+
* County of the address.
|
|
2956
3631
|
*/
|
|
2957
|
-
county
|
|
3632
|
+
county?: string;
|
|
2958
3633
|
/**
|
|
2959
|
-
* Country of the
|
|
3634
|
+
* Country of the address.
|
|
2960
3635
|
*/
|
|
2961
3636
|
country: string;
|
|
2962
3637
|
/**
|
|
2963
|
-
* State, province, or region of the
|
|
3638
|
+
* State, province, or region of the address.
|
|
2964
3639
|
*/
|
|
2965
3640
|
region?: string;
|
|
3641
|
+
};
|
|
3642
|
+
type AddressWithRegion = AddressCommon & {
|
|
3643
|
+
/**
|
|
3644
|
+
* State, province, or region of the address.
|
|
3645
|
+
*/
|
|
3646
|
+
region: string;
|
|
3647
|
+
};
|
|
3648
|
+
type AddressWithCounty = AddressCommon & {
|
|
3649
|
+
/**
|
|
3650
|
+
* County of the address.
|
|
3651
|
+
*/
|
|
3652
|
+
county: string;
|
|
3653
|
+
};
|
|
3654
|
+
/**
|
|
3655
|
+
* Shipping address information. You must specify at least one of region (state/province) or county.
|
|
3656
|
+
*
|
|
3657
|
+
*/
|
|
3658
|
+
type ShippingAddress = (AddressWithRegion | AddressWithCounty) & {
|
|
3659
|
+
/**
|
|
3660
|
+
* Phone number of the shipping recipient.
|
|
3661
|
+
*/
|
|
3662
|
+
phone_number?: string;
|
|
2966
3663
|
/**
|
|
2967
3664
|
* Delivery instructions.
|
|
2968
3665
|
*/
|
|
2969
|
-
instructions
|
|
3666
|
+
instructions?: string;
|
|
2970
3667
|
};
|
|
2971
3668
|
type DeliveryEstimate = {
|
|
2972
3669
|
start?: Date;
|
|
2973
3670
|
end?: Date;
|
|
2974
3671
|
};
|
|
2975
|
-
|
|
3672
|
+
/**
|
|
3673
|
+
* Single relationship
|
|
3674
|
+
*/
|
|
3675
|
+
type SingleRelationship = {
|
|
3676
|
+
data?: RelationshipItem;
|
|
3677
|
+
};
|
|
3678
|
+
type Discounts = Array<Discount>;
|
|
3679
|
+
type ShippingPriceResponse = {
|
|
3680
|
+
total: FormattedPriceData;
|
|
3681
|
+
base: FormattedPriceData;
|
|
3682
|
+
tax?: FormattedPriceData;
|
|
3683
|
+
fees?: FormattedPriceData;
|
|
3684
|
+
discount?: FormattedPriceData;
|
|
3685
|
+
};
|
|
3686
|
+
type NonNegativeFormattedPriceData = {
|
|
2976
3687
|
/**
|
|
2977
|
-
*
|
|
3688
|
+
* The raw total. Must be non-negative.
|
|
2978
3689
|
*/
|
|
2979
|
-
amount
|
|
3690
|
+
amount?: number;
|
|
2980
3691
|
/**
|
|
2981
|
-
*
|
|
3692
|
+
* The currency set for this amount.
|
|
3693
|
+
*/
|
|
3694
|
+
currency?: string;
|
|
3695
|
+
/**
|
|
3696
|
+
* The formatted total based on the amount and currency.
|
|
3697
|
+
*/
|
|
3698
|
+
formatted?: string;
|
|
3699
|
+
};
|
|
3700
|
+
type DiscountFormattedPriceData = {
|
|
3701
|
+
/**
|
|
3702
|
+
* The discount amount. Must be non-positive (zero or negative).
|
|
3703
|
+
*/
|
|
3704
|
+
amount?: number;
|
|
3705
|
+
/**
|
|
3706
|
+
* The currency set for this amount.
|
|
3707
|
+
*/
|
|
3708
|
+
currency?: string;
|
|
3709
|
+
/**
|
|
3710
|
+
* The formatted total based on the amount and currency.
|
|
3711
|
+
*/
|
|
3712
|
+
formatted?: string;
|
|
3713
|
+
};
|
|
3714
|
+
/**
|
|
3715
|
+
* Order pricing information.
|
|
3716
|
+
*/
|
|
3717
|
+
type OrderPriceWrapperMeta = {
|
|
3718
|
+
with_tax: NonNegativeFormattedPriceData;
|
|
3719
|
+
without_tax: NonNegativeFormattedPriceData;
|
|
3720
|
+
tax: NonNegativeFormattedPriceData;
|
|
3721
|
+
discount: DiscountFormattedPriceData;
|
|
3722
|
+
balance_owing: NonNegativeFormattedPriceData;
|
|
3723
|
+
paid: NonNegativeFormattedPriceData;
|
|
3724
|
+
authorized: NonNegativeFormattedPriceData;
|
|
3725
|
+
without_discount: NonNegativeFormattedPriceData;
|
|
3726
|
+
shipping: NonNegativeFormattedPriceData;
|
|
3727
|
+
shipping_discount: DiscountFormattedPriceData;
|
|
3728
|
+
};
|
|
3729
|
+
type ShippingGroupMeta = {
|
|
3730
|
+
shipping_display_price?: ShippingPriceResponse;
|
|
3731
|
+
total_display_price?: OrderPriceWrapperMeta;
|
|
3732
|
+
};
|
|
3733
|
+
type ShippingGroupResponse = {
|
|
3734
|
+
type?: "shipping_group";
|
|
3735
|
+
id?: string;
|
|
3736
|
+
relation?: string;
|
|
3737
|
+
cart_id?: string;
|
|
3738
|
+
order_id?: string;
|
|
3739
|
+
shipping_type?: string;
|
|
3740
|
+
tracking_reference?: string;
|
|
3741
|
+
/**
|
|
3742
|
+
* An optional external ID reference for a shipping group. 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.
|
|
3743
|
+
*/
|
|
3744
|
+
external_ref?: string;
|
|
3745
|
+
address?: ShippingAddress;
|
|
3746
|
+
delivery_estimate?: DeliveryEstimate;
|
|
3747
|
+
created_at?: Date;
|
|
3748
|
+
updated_at?: Date;
|
|
3749
|
+
relationships?: {
|
|
3750
|
+
cart?: SingleRelationship;
|
|
3751
|
+
order?: SingleRelationship;
|
|
3752
|
+
/**
|
|
3753
|
+
* The order items shipped by this shipping group. Present on order shipping groups that are associated with at least one order item, when the shipping group is retrieved or updated individually.
|
|
3754
|
+
*/
|
|
3755
|
+
items?: RelationshipArray;
|
|
3756
|
+
};
|
|
3757
|
+
discounts?: Discounts;
|
|
3758
|
+
meta?: ShippingGroupMeta;
|
|
3759
|
+
};
|
|
3760
|
+
type ShippingPriceRequest = {
|
|
3761
|
+
total?: number;
|
|
3762
|
+
base?: number;
|
|
3763
|
+
tax?: number;
|
|
3764
|
+
fees?: number;
|
|
3765
|
+
discount?: number;
|
|
3766
|
+
};
|
|
3767
|
+
type CreateShippingGroupRequest = {
|
|
3768
|
+
data?: {
|
|
3769
|
+
type?: "shipping_group";
|
|
3770
|
+
shipping_type?: string;
|
|
3771
|
+
tracking_reference?: string;
|
|
3772
|
+
/**
|
|
3773
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
3774
|
+
*/
|
|
3775
|
+
external_ref?: string;
|
|
3776
|
+
shipping_price?: ShippingPriceRequest;
|
|
3777
|
+
address?: ShippingAddress;
|
|
3778
|
+
includes_tax?: boolean;
|
|
3779
|
+
delivery_estimate?: DeliveryEstimate;
|
|
3780
|
+
};
|
|
3781
|
+
};
|
|
3782
|
+
type OrderPriceData = {
|
|
3783
|
+
/**
|
|
3784
|
+
* The amount for this item.
|
|
3785
|
+
*/
|
|
3786
|
+
amount?: number;
|
|
3787
|
+
/**
|
|
3788
|
+
* The currency this item.
|
|
3789
|
+
*/
|
|
3790
|
+
currency?: string;
|
|
3791
|
+
/**
|
|
3792
|
+
* Whether this price is tax inclusive.
|
|
3793
|
+
*/
|
|
3794
|
+
includes_tax?: boolean;
|
|
3795
|
+
};
|
|
3796
|
+
type DiscountData = {
|
|
3797
|
+
amount?: OrderPriceData;
|
|
3798
|
+
code?: string;
|
|
3799
|
+
readonly id?: string;
|
|
3800
|
+
/**
|
|
3801
|
+
* The source or origin of the promotion, if applicable.
|
|
3802
|
+
*/
|
|
3803
|
+
promotion_source?: string;
|
|
3804
|
+
/**
|
|
3805
|
+
* Indicates whether the discount applies to the entire cart.
|
|
3806
|
+
*/
|
|
3807
|
+
is_cart_discount?: boolean;
|
|
3808
|
+
/**
|
|
3809
|
+
* Order in which the discount was applied.
|
|
3810
|
+
*/
|
|
3811
|
+
ordinal?: number;
|
|
3812
|
+
/**
|
|
3813
|
+
* Identifies the specific action within a multi-action rule promotion that produced this discount.
|
|
3814
|
+
*/
|
|
3815
|
+
promotion_action_id?: string;
|
|
3816
|
+
};
|
|
3817
|
+
type OrderItemFormattedUnitPriceData = {
|
|
3818
|
+
unit?: FormattedPriceData;
|
|
3819
|
+
value?: FormattedPriceData;
|
|
3820
|
+
};
|
|
3821
|
+
type OrderItemResponse = {
|
|
3822
|
+
/**
|
|
3823
|
+
* The type represents the object being returned.
|
|
3824
|
+
*/
|
|
3825
|
+
type?: string;
|
|
3826
|
+
/**
|
|
3827
|
+
* The unique identifier for this order item.
|
|
3828
|
+
*/
|
|
3829
|
+
readonly id?: string;
|
|
3830
|
+
/**
|
|
3831
|
+
* The quantity of this item were ordered.
|
|
3832
|
+
*/
|
|
3833
|
+
quantity?: number;
|
|
3834
|
+
/**
|
|
3835
|
+
* The unique identifier for this order item.
|
|
3836
|
+
*/
|
|
3837
|
+
readonly product_id?: string;
|
|
3838
|
+
/**
|
|
3839
|
+
* The unique identifier for the subscription offering for this order item.
|
|
3840
|
+
*/
|
|
3841
|
+
readonly subscription_offering_id?: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* The name of this order item.
|
|
3844
|
+
*/
|
|
3845
|
+
name?: string;
|
|
3846
|
+
/**
|
|
3847
|
+
* The SKU code for the order item.
|
|
3848
|
+
*/
|
|
3849
|
+
sku?: string;
|
|
3850
|
+
/**
|
|
3851
|
+
* The stock location for this order item.
|
|
3852
|
+
*/
|
|
3853
|
+
readonly location?: string;
|
|
3854
|
+
unit_price?: OrderPriceData;
|
|
3855
|
+
value?: OrderPriceData;
|
|
3856
|
+
discounts?: Array<DiscountData>;
|
|
3857
|
+
links?: {
|
|
3858
|
+
[key: string]: unknown;
|
|
3859
|
+
};
|
|
3860
|
+
meta?: {
|
|
3861
|
+
display_price?: {
|
|
3862
|
+
with_tax?: OrderItemFormattedUnitPriceData;
|
|
3863
|
+
without_tax?: OrderItemFormattedUnitPriceData;
|
|
3864
|
+
tax?: OrderItemFormattedUnitPriceData;
|
|
3865
|
+
discount?: OrderItemFormattedUnitPriceData;
|
|
3866
|
+
without_discount?: OrderItemFormattedUnitPriceData;
|
|
3867
|
+
discounts?: {
|
|
3868
|
+
[key: string]: {
|
|
3869
|
+
amount?: number;
|
|
3870
|
+
currency?: string;
|
|
3871
|
+
formatted?: string;
|
|
3872
|
+
/**
|
|
3873
|
+
* Detailed breakdown of discount constituents by ID
|
|
3874
|
+
*/
|
|
3875
|
+
constituents?: {
|
|
3876
|
+
[key: string]: {
|
|
3877
|
+
/**
|
|
3878
|
+
* The discount amount
|
|
3879
|
+
*/
|
|
3880
|
+
amount?: number;
|
|
3881
|
+
/**
|
|
3882
|
+
* The currency code
|
|
3883
|
+
*/
|
|
3884
|
+
currency?: string;
|
|
3885
|
+
/**
|
|
3886
|
+
* The formatted discount amount
|
|
3887
|
+
*/
|
|
3888
|
+
formatted?: string;
|
|
3889
|
+
};
|
|
3890
|
+
};
|
|
3891
|
+
};
|
|
3892
|
+
};
|
|
3893
|
+
/**
|
|
3894
|
+
* The product's original catalog price before any catalog-level sales, tiered pricing adjustments, or cart/item level promotions are applied. This value is sourced from the product's `meta.original_display_price` field in the catalog response. See [Get a Product](/docs/api/pxm/catalog/get-by-context-product).
|
|
3895
|
+
*/
|
|
3896
|
+
original_price?: OrderItemFormattedUnitPriceData;
|
|
3897
|
+
};
|
|
3898
|
+
timestamps?: CartCheckoutTimestamps;
|
|
3899
|
+
};
|
|
3900
|
+
relationships?: {
|
|
3901
|
+
cart_item?: {
|
|
3902
|
+
data?: {
|
|
3903
|
+
/**
|
|
3904
|
+
* The type represents the object being returned.
|
|
3905
|
+
*/
|
|
3906
|
+
type?: string;
|
|
3907
|
+
/**
|
|
3908
|
+
* The unique identifier for this item.
|
|
3909
|
+
*/
|
|
3910
|
+
readonly id?: string;
|
|
3911
|
+
};
|
|
3912
|
+
};
|
|
3913
|
+
/**
|
|
3914
|
+
* Related tax items.
|
|
3915
|
+
*/
|
|
3916
|
+
taxes?: {
|
|
3917
|
+
data?: null | Array<RelationshipItem>;
|
|
3918
|
+
};
|
|
3919
|
+
/**
|
|
3920
|
+
* Related promotions.
|
|
3921
|
+
*/
|
|
3922
|
+
promotions?: {
|
|
3923
|
+
data?: null | Array<RelationshipItem>;
|
|
3924
|
+
};
|
|
3925
|
+
};
|
|
3926
|
+
/**
|
|
3927
|
+
* The unique identifier of the catalog associated with the product is shown if `catalog_source=pim` is set.
|
|
3928
|
+
*/
|
|
3929
|
+
catalog_id?: string;
|
|
3930
|
+
/**
|
|
3931
|
+
* The catalog source. Always `pim` or `legacy`.
|
|
3932
|
+
*/
|
|
3933
|
+
catalog_source?: string;
|
|
3934
|
+
/**
|
|
3935
|
+
* Configuration for bundle products.
|
|
3936
|
+
*/
|
|
3937
|
+
bundle_configuration?: {
|
|
3938
|
+
selected_options?: {
|
|
3939
|
+
[key: string]: {
|
|
3940
|
+
[key: string]: number;
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
/**
|
|
3944
|
+
* Array of component products for bundle configuration
|
|
3945
|
+
*/
|
|
3946
|
+
component_products?: Array<{
|
|
3947
|
+
/**
|
|
3948
|
+
* Component product ID
|
|
3949
|
+
*/
|
|
3950
|
+
id?: string;
|
|
3951
|
+
/**
|
|
3952
|
+
* Component product type
|
|
3953
|
+
*/
|
|
3954
|
+
type?: string;
|
|
3955
|
+
/**
|
|
3956
|
+
* Product attributes as a generic object
|
|
3957
|
+
*/
|
|
3958
|
+
attributes?: {
|
|
3959
|
+
[key: string]: unknown;
|
|
3960
|
+
};
|
|
3961
|
+
/**
|
|
3962
|
+
* Product metadata as a generic object
|
|
3963
|
+
*/
|
|
3964
|
+
meta?: {
|
|
3965
|
+
[key: string]: unknown;
|
|
3966
|
+
};
|
|
3967
|
+
/**
|
|
3968
|
+
* Product price information as a generic object
|
|
3969
|
+
*/
|
|
3970
|
+
price?: {
|
|
3971
|
+
[key: string]: unknown;
|
|
3972
|
+
};
|
|
3973
|
+
/**
|
|
3974
|
+
* Product relationships as a generic object
|
|
3975
|
+
*/
|
|
3976
|
+
relationships?: {
|
|
3977
|
+
[key: string]: unknown;
|
|
3978
|
+
};
|
|
3979
|
+
}>;
|
|
3980
|
+
};
|
|
3981
|
+
/**
|
|
3982
|
+
* Components of the bundle product.
|
|
2982
3983
|
*/
|
|
2983
|
-
|
|
3984
|
+
components?: {
|
|
3985
|
+
[key: string]: {
|
|
3986
|
+
name?: string;
|
|
3987
|
+
options?: Array<{
|
|
3988
|
+
id?: string;
|
|
3989
|
+
quantity?: number;
|
|
3990
|
+
type?: string;
|
|
3991
|
+
}>;
|
|
3992
|
+
};
|
|
3993
|
+
};
|
|
2984
3994
|
/**
|
|
2985
|
-
*
|
|
3995
|
+
* Custom inputs for the order item as a generic object
|
|
2986
3996
|
*/
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
amount: Money;
|
|
3997
|
+
custom_inputs?: {
|
|
3998
|
+
[key: string]: unknown;
|
|
3999
|
+
};
|
|
2991
4000
|
/**
|
|
2992
|
-
*
|
|
4001
|
+
* Custom attributes attached to the order item.
|
|
2993
4002
|
*/
|
|
2994
|
-
|
|
4003
|
+
custom_attributes?: CustomAttributes;
|
|
2995
4004
|
/**
|
|
2996
|
-
*
|
|
4005
|
+
* The shipping group ID for the order item
|
|
2997
4006
|
*/
|
|
2998
|
-
|
|
4007
|
+
shipping_group_id?: string;
|
|
2999
4008
|
/**
|
|
3000
|
-
* The source
|
|
4009
|
+
* The promotion source for the order item
|
|
3001
4010
|
*/
|
|
3002
4011
|
promotion_source?: string;
|
|
3003
4012
|
/**
|
|
3004
|
-
*
|
|
4013
|
+
* The action ID within the rule promotion that produced this promotion item.
|
|
3005
4014
|
*/
|
|
3006
|
-
|
|
4015
|
+
readonly promotion_action_id?: string;
|
|
3007
4016
|
/**
|
|
3008
|
-
*
|
|
4017
|
+
* Subscription configuration for the order item
|
|
3009
4018
|
*/
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
};
|
|
3020
|
-
type OrderPriceWrapperMeta = {
|
|
3021
|
-
with_tax: FormattedPriceData;
|
|
3022
|
-
without_tax: FormattedPriceData;
|
|
3023
|
-
tax: FormattedPriceData;
|
|
3024
|
-
discount: FormattedPriceData;
|
|
3025
|
-
balance_owing: FormattedPriceData;
|
|
3026
|
-
paid: FormattedPriceData;
|
|
3027
|
-
authorized: FormattedPriceData;
|
|
3028
|
-
without_discount: FormattedPriceData;
|
|
3029
|
-
shipping: FormattedPriceData;
|
|
3030
|
-
shipping_discount: FormattedPriceData;
|
|
3031
|
-
};
|
|
3032
|
-
type ShippingGroupMeta = {
|
|
3033
|
-
shipping_display_price?: ShippingPriceResponse;
|
|
3034
|
-
total_display_price?: OrderPriceWrapperMeta;
|
|
4019
|
+
subscription_configuration?: {
|
|
4020
|
+
/**
|
|
4021
|
+
* Subscription plan details
|
|
4022
|
+
*/
|
|
4023
|
+
plan?: string;
|
|
4024
|
+
/**
|
|
4025
|
+
* Pricing option for the subscription
|
|
4026
|
+
*/
|
|
4027
|
+
pricing_option?: string;
|
|
4028
|
+
};
|
|
3035
4029
|
};
|
|
3036
|
-
type
|
|
3037
|
-
|
|
3038
|
-
id?: string;
|
|
3039
|
-
relation?: string;
|
|
3040
|
-
cart_id?: string;
|
|
3041
|
-
order_id?: string;
|
|
3042
|
-
shipping_type?: string;
|
|
3043
|
-
tracking_reference?: string;
|
|
4030
|
+
type ShippingGroupEntityResponse = {
|
|
4031
|
+
data?: ShippingGroupResponse;
|
|
3044
4032
|
/**
|
|
3045
|
-
*
|
|
4033
|
+
* Related objects that are included in the response when using the include query parameter.
|
|
3046
4034
|
*/
|
|
3047
|
-
|
|
3048
|
-
address?: ShippingAddress;
|
|
3049
|
-
delivery_estimate?: DeliveryEstimate;
|
|
3050
|
-
createdAt?: Date;
|
|
3051
|
-
updatedAt?: Date;
|
|
3052
|
-
relationships?: {
|
|
3053
|
-
cart?: RelationshipItem;
|
|
3054
|
-
order?: RelationshipItem;
|
|
3055
|
-
};
|
|
3056
|
-
discounts?: Discounts;
|
|
3057
|
-
meta?: ShippingGroupMeta;
|
|
3058
|
-
};
|
|
3059
|
-
type ShippingPriceRequest = {
|
|
3060
|
-
total?: number;
|
|
3061
|
-
base?: number;
|
|
3062
|
-
tax?: number;
|
|
3063
|
-
fees?: number;
|
|
3064
|
-
discount?: number;
|
|
3065
|
-
};
|
|
3066
|
-
type CreateShippingGroupRequest = {
|
|
3067
|
-
data?: {
|
|
3068
|
-
type?: "shipping_group";
|
|
3069
|
-
shipping_type?: string;
|
|
3070
|
-
tracking_reference?: string;
|
|
4035
|
+
included?: {
|
|
3071
4036
|
/**
|
|
3072
|
-
*
|
|
4037
|
+
* Array of order items associated with this shipping group.
|
|
3073
4038
|
*/
|
|
3074
|
-
|
|
3075
|
-
shipping_price?: ShippingPriceRequest;
|
|
3076
|
-
address?: ShippingAddress;
|
|
3077
|
-
includes_tax?: boolean;
|
|
3078
|
-
delivery_estimate?: DeliveryEstimate;
|
|
4039
|
+
items?: Array<OrderItemResponse>;
|
|
3079
4040
|
};
|
|
4041
|
+
/**
|
|
4042
|
+
* Array of validation or processing errors
|
|
4043
|
+
*/
|
|
4044
|
+
errors?: Array<ResponseErrorItem>;
|
|
3080
4045
|
};
|
|
3081
4046
|
type UpdateCartShippingGroupRequest = {
|
|
3082
4047
|
data?: {
|
|
@@ -3093,13 +4058,13 @@ type UpdateCartShippingGroupRequest = {
|
|
|
3093
4058
|
delivery_estimate?: DeliveryEstimate;
|
|
3094
4059
|
};
|
|
3095
4060
|
};
|
|
3096
|
-
type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "
|
|
4061
|
+
type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents";
|
|
3097
4062
|
/**
|
|
3098
4063
|
* Specifies the transaction method, such as `purchase` or `authorize`.
|
|
3099
4064
|
*/
|
|
3100
4065
|
type Method = "authorize" | "purchase" | "purchase_setup" | "authorize_setup";
|
|
3101
4066
|
type DataBasePayments = {
|
|
3102
|
-
gateway: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "
|
|
4067
|
+
gateway: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents";
|
|
3103
4068
|
/**
|
|
3104
4069
|
* Specifies the transaction method, such as `purchase` or `authorize`.
|
|
3105
4070
|
*/
|
|
@@ -3151,48 +4116,11 @@ type CartPaymentUpdate = {
|
|
|
3151
4116
|
};
|
|
3152
4117
|
};
|
|
3153
4118
|
};
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
/**
|
|
3160
|
-
* Last name of the billing recipient.
|
|
3161
|
-
*/
|
|
3162
|
-
last_name: string;
|
|
3163
|
-
/**
|
|
3164
|
-
* Company name of the billing recipient.
|
|
3165
|
-
*/
|
|
3166
|
-
company_name: string;
|
|
3167
|
-
/**
|
|
3168
|
-
* First line of the billing address.
|
|
3169
|
-
*/
|
|
3170
|
-
line_1: string;
|
|
3171
|
-
/**
|
|
3172
|
-
* Second line of the billing address.
|
|
3173
|
-
*/
|
|
3174
|
-
line_2: string;
|
|
3175
|
-
/**
|
|
3176
|
-
* City of the billing address.
|
|
3177
|
-
*/
|
|
3178
|
-
city: string;
|
|
3179
|
-
/**
|
|
3180
|
-
* Postcode of the billing address.
|
|
3181
|
-
*/
|
|
3182
|
-
postcode: string;
|
|
3183
|
-
/**
|
|
3184
|
-
* County of the billing address.
|
|
3185
|
-
*/
|
|
3186
|
-
county: string;
|
|
3187
|
-
/**
|
|
3188
|
-
* Country of the billing address.
|
|
3189
|
-
*/
|
|
3190
|
-
country: string;
|
|
3191
|
-
/**
|
|
3192
|
-
* State, province, or region of the billing address.
|
|
3193
|
-
*/
|
|
3194
|
-
region?: string;
|
|
3195
|
-
};
|
|
4119
|
+
/**
|
|
4120
|
+
* Billing address information. You must specify at least one of region (state/province) or county.
|
|
4121
|
+
*
|
|
4122
|
+
*/
|
|
4123
|
+
type BillingAddress = AddressWithRegion | AddressWithCounty;
|
|
3196
4124
|
type CustomerCheckout = {
|
|
3197
4125
|
data?: {
|
|
3198
4126
|
/**
|
|
@@ -3255,20 +4183,41 @@ type AccountCheckout = {
|
|
|
3255
4183
|
shipping_address?: ShippingAddress;
|
|
3256
4184
|
};
|
|
3257
4185
|
};
|
|
4186
|
+
type OrderTimestamps = {
|
|
4187
|
+
/**
|
|
4188
|
+
* The date this order was created.
|
|
4189
|
+
*/
|
|
4190
|
+
created_at?: string;
|
|
4191
|
+
/**
|
|
4192
|
+
* The date this order was last updated.
|
|
4193
|
+
*/
|
|
4194
|
+
updated_at?: string;
|
|
4195
|
+
/**
|
|
4196
|
+
* The date this order was fully paid. Only present for orders with payment status 'paid'.
|
|
4197
|
+
*/
|
|
4198
|
+
fully_paid_at?: string;
|
|
4199
|
+
};
|
|
3258
4200
|
type OrderMeta = {
|
|
3259
|
-
timestamps?:
|
|
4201
|
+
timestamps?: OrderTimestamps;
|
|
4202
|
+
/**
|
|
4203
|
+
* Order pricing information including amounts, tax, discounts, and payment details.
|
|
4204
|
+
*/
|
|
3260
4205
|
display_price?: {
|
|
3261
|
-
with_tax?:
|
|
3262
|
-
without_tax?:
|
|
3263
|
-
tax?:
|
|
3264
|
-
discount?:
|
|
3265
|
-
balance_owing?:
|
|
3266
|
-
paid?:
|
|
3267
|
-
authorized?:
|
|
3268
|
-
without_discount?:
|
|
3269
|
-
shipping?:
|
|
3270
|
-
shipping_discount?:
|
|
4206
|
+
with_tax?: NonNegativeFormattedPriceData;
|
|
4207
|
+
without_tax?: NonNegativeFormattedPriceData;
|
|
4208
|
+
tax?: NonNegativeFormattedPriceData;
|
|
4209
|
+
discount?: DiscountFormattedPriceData;
|
|
4210
|
+
balance_owing?: NonNegativeFormattedPriceData;
|
|
4211
|
+
paid?: NonNegativeFormattedPriceData;
|
|
4212
|
+
authorized?: NonNegativeFormattedPriceData;
|
|
4213
|
+
without_discount?: NonNegativeFormattedPriceData;
|
|
4214
|
+
shipping?: NonNegativeFormattedPriceData;
|
|
4215
|
+
shipping_discount?: DiscountFormattedPriceData;
|
|
3271
4216
|
};
|
|
4217
|
+
/**
|
|
4218
|
+
* Specifies if the order was created manually.
|
|
4219
|
+
*/
|
|
4220
|
+
is_manual?: boolean;
|
|
3272
4221
|
};
|
|
3273
4222
|
type Contact = {
|
|
3274
4223
|
/**
|
|
@@ -3280,11 +4229,19 @@ type Contact = {
|
|
|
3280
4229
|
*/
|
|
3281
4230
|
name?: string;
|
|
3282
4231
|
};
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
4232
|
+
type Customer = {
|
|
4233
|
+
/**
|
|
4234
|
+
* The name of the customer.
|
|
4235
|
+
*/
|
|
4236
|
+
name?: string;
|
|
4237
|
+
/**
|
|
4238
|
+
* The email address of the customer.
|
|
4239
|
+
*/
|
|
4240
|
+
email?: string;
|
|
4241
|
+
/**
|
|
4242
|
+
* The unique identifier of the customer.
|
|
4243
|
+
*/
|
|
4244
|
+
id?: string;
|
|
3288
4245
|
};
|
|
3289
4246
|
/**
|
|
3290
4247
|
* Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
|
|
@@ -3332,10 +4289,13 @@ type OrderResponse = {
|
|
|
3332
4289
|
*/
|
|
3333
4290
|
payment_intent_id?: string;
|
|
3334
4291
|
custom_attributes?: CustomAttributes;
|
|
4292
|
+
links?: {
|
|
4293
|
+
[key: string]: unknown;
|
|
4294
|
+
};
|
|
3335
4295
|
meta?: OrderMeta;
|
|
3336
4296
|
billing_address?: BillingAddress;
|
|
3337
4297
|
contact?: Contact;
|
|
3338
|
-
customer?:
|
|
4298
|
+
customer?: Customer;
|
|
3339
4299
|
shipping_address?: ShippingAddress;
|
|
3340
4300
|
relationships?: {
|
|
3341
4301
|
items?: RelationshipArray;
|
|
@@ -3344,11 +4304,20 @@ type OrderResponse = {
|
|
|
3344
4304
|
customer?: SingleRelationship;
|
|
3345
4305
|
account?: SingleRelationship;
|
|
3346
4306
|
account_member?: SingleRelationship;
|
|
4307
|
+
store?: SingleRelationship;
|
|
3347
4308
|
};
|
|
3348
4309
|
};
|
|
3349
4310
|
type OrderEntityResponse = {
|
|
3350
4311
|
data?: OrderResponse;
|
|
4312
|
+
/**
|
|
4313
|
+
* Optional included data such as order items, tax items, custom discounts, and promotions.
|
|
4314
|
+
*
|
|
4315
|
+
*/
|
|
3351
4316
|
included?: OrderIncluded;
|
|
4317
|
+
/**
|
|
4318
|
+
* Array of error objects, if any errors occurred.
|
|
4319
|
+
*/
|
|
4320
|
+
errors?: Array<ResponseErrorItem>;
|
|
3352
4321
|
};
|
|
3353
4322
|
type ResponseMetaOrders = {
|
|
3354
4323
|
page?: ResponsePaginationPage;
|
|
@@ -3361,6 +4330,10 @@ type OrderCollectionResponse = {
|
|
|
3361
4330
|
included?: OrdersIncluded;
|
|
3362
4331
|
};
|
|
3363
4332
|
type OrdersAddressData = {
|
|
4333
|
+
/**
|
|
4334
|
+
* The type of the resource. You must use "order".
|
|
4335
|
+
*/
|
|
4336
|
+
type: string;
|
|
3364
4337
|
/**
|
|
3365
4338
|
* 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.
|
|
3366
4339
|
*/
|
|
@@ -3394,6 +4367,10 @@ type OrdersAddressData = {
|
|
|
3394
4367
|
* Specifies the second line of the address.
|
|
3395
4368
|
*/
|
|
3396
4369
|
line_2?: string;
|
|
4370
|
+
/**
|
|
4371
|
+
* Specifies the third line of the address.
|
|
4372
|
+
*/
|
|
4373
|
+
line_3?: string;
|
|
3397
4374
|
/**
|
|
3398
4375
|
* Specifies the name of the city in the shipping address.
|
|
3399
4376
|
*/
|
|
@@ -3451,118 +4428,181 @@ type OrdersFulfilledData = {
|
|
|
3451
4428
|
type OrdersUpdateRequest = {
|
|
3452
4429
|
data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
|
|
3453
4430
|
};
|
|
3454
|
-
type
|
|
4431
|
+
type OrderItemCollectionResponse = {
|
|
4432
|
+
data?: Array<OrderItemResponse>;
|
|
3455
4433
|
/**
|
|
3456
|
-
*
|
|
4434
|
+
* Optional included data such as tax items, custom discounts, and promotions.
|
|
4435
|
+
*
|
|
3457
4436
|
*/
|
|
3458
|
-
|
|
4437
|
+
included?: {
|
|
4438
|
+
/**
|
|
4439
|
+
* Array of tax items included in the response.
|
|
4440
|
+
*/
|
|
4441
|
+
tax_items?: Array<TaxItemResponse>;
|
|
4442
|
+
/**
|
|
4443
|
+
* Array of custom discounts included in the response.
|
|
4444
|
+
*/
|
|
4445
|
+
custom_discounts?: Array<CustomDiscountResponse>;
|
|
4446
|
+
/**
|
|
4447
|
+
* Array of promotions included in the response.
|
|
4448
|
+
*/
|
|
4449
|
+
promotions?: Array<CondensedPromotionResponse>;
|
|
4450
|
+
};
|
|
4451
|
+
};
|
|
4452
|
+
type OrdersAnonymizeData = {
|
|
3459
4453
|
/**
|
|
3460
|
-
* The
|
|
4454
|
+
* The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
|
|
3461
4455
|
*/
|
|
3462
|
-
|
|
4456
|
+
order_ids?: Array<string>;
|
|
4457
|
+
};
|
|
4458
|
+
type OrdersAnonymizeRequest = {
|
|
4459
|
+
data?: OrdersAnonymizeData;
|
|
4460
|
+
};
|
|
4461
|
+
type OrdersListResponse = {
|
|
4462
|
+
data: Array<OrderResponse>;
|
|
4463
|
+
};
|
|
4464
|
+
/**
|
|
4465
|
+
* Non-PII payment failure information from the payment gateway. Only present on failed transactions where the gateway provided structured failure details.
|
|
4466
|
+
*/
|
|
4467
|
+
type FailureDetails = {
|
|
3463
4468
|
/**
|
|
3464
|
-
*
|
|
4469
|
+
* Machine-readable failure or error code from the payment gateway.
|
|
3465
4470
|
*/
|
|
3466
|
-
includes_tax?: boolean;
|
|
3467
|
-
};
|
|
3468
|
-
type DiscountData = {
|
|
3469
|
-
amount?: OrderPriceData;
|
|
3470
4471
|
code?: string;
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
value?: FormattedPriceData;
|
|
4472
|
+
/**
|
|
4473
|
+
* Human-readable failure reason or error message from the payment gateway.
|
|
4474
|
+
*/
|
|
4475
|
+
reason?: string;
|
|
3476
4476
|
};
|
|
3477
|
-
|
|
4477
|
+
/**
|
|
4478
|
+
* The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
|
|
4479
|
+
*/
|
|
4480
|
+
type TransactionType = "purchase" | "authorize" | "capture" | "refund";
|
|
4481
|
+
/**
|
|
4482
|
+
* The mechanism used for capturing the transaction.
|
|
4483
|
+
*/
|
|
4484
|
+
type CaptureMechanism = "automatic" | "manual";
|
|
4485
|
+
/**
|
|
4486
|
+
* The mechanism used for refunding the transaction.
|
|
4487
|
+
*/
|
|
4488
|
+
type RefundMechanism = "automatic" | "manual";
|
|
4489
|
+
type TransactionResponse = {
|
|
3478
4490
|
/**
|
|
3479
|
-
* The
|
|
4491
|
+
* The ID of the transaction.
|
|
4492
|
+
*/
|
|
4493
|
+
readonly id?: string;
|
|
4494
|
+
/**
|
|
4495
|
+
* The payment gateway reference.
|
|
4496
|
+
*/
|
|
4497
|
+
reference?: string;
|
|
4498
|
+
/**
|
|
4499
|
+
* A custom name associated with the payment method.
|
|
4500
|
+
*/
|
|
4501
|
+
name?: string;
|
|
4502
|
+
/**
|
|
4503
|
+
* 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.
|
|
4504
|
+
*/
|
|
4505
|
+
custom_reference?: string;
|
|
4506
|
+
/**
|
|
4507
|
+
* The name of the payment gateway used.
|
|
4508
|
+
*/
|
|
4509
|
+
gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents" | "stripe_platform_account";
|
|
4510
|
+
/**
|
|
4511
|
+
* The amount for this transaction.
|
|
4512
|
+
*/
|
|
4513
|
+
amount?: number;
|
|
4514
|
+
/**
|
|
4515
|
+
* The refunded amount.
|
|
4516
|
+
*/
|
|
4517
|
+
refunded_amount?: number;
|
|
4518
|
+
/**
|
|
4519
|
+
* The transaction currency.
|
|
4520
|
+
*/
|
|
4521
|
+
currency?: string;
|
|
4522
|
+
/**
|
|
4523
|
+
* The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
|
|
4524
|
+
*/
|
|
4525
|
+
transaction_type?: "purchase" | "authorize" | "capture" | "refund";
|
|
4526
|
+
/**
|
|
4527
|
+
* The type of object being returned.
|
|
3480
4528
|
*/
|
|
3481
4529
|
type?: string;
|
|
3482
4530
|
/**
|
|
3483
|
-
* The
|
|
4531
|
+
* The status provided by the gateway for this transaction, such as `complete` or `failed`.
|
|
3484
4532
|
*/
|
|
3485
|
-
|
|
4533
|
+
status?: string;
|
|
3486
4534
|
/**
|
|
3487
|
-
*
|
|
4535
|
+
* Additional payment details specific to the gateway. Present when gateway is paypal_express_checkout.
|
|
3488
4536
|
*/
|
|
3489
|
-
|
|
4537
|
+
payment_details?: {
|
|
4538
|
+
/**
|
|
4539
|
+
* Detailed status information from the payment gateway.
|
|
4540
|
+
*/
|
|
4541
|
+
detailed_status?: string;
|
|
4542
|
+
};
|
|
3490
4543
|
/**
|
|
3491
|
-
*
|
|
4544
|
+
* Non-PII payment failure details from the gateway. Only present on failed transactions where the gateway provided structured failure information.
|
|
4545
|
+
*/
|
|
4546
|
+
failure_details?: FailureDetails;
|
|
4547
|
+
/**
|
|
4548
|
+
* Payment intent details.
|
|
3492
4549
|
*/
|
|
3493
|
-
|
|
4550
|
+
payment_intent?: {
|
|
4551
|
+
[key: string]: unknown;
|
|
4552
|
+
};
|
|
3494
4553
|
/**
|
|
3495
|
-
* The
|
|
4554
|
+
* The mechanism used for capturing the transaction.
|
|
3496
4555
|
*/
|
|
3497
|
-
|
|
4556
|
+
capture_mechanism?: "automatic" | "manual";
|
|
3498
4557
|
/**
|
|
3499
|
-
* The
|
|
4558
|
+
* The mechanism used for refunding the transaction.
|
|
3500
4559
|
*/
|
|
3501
|
-
|
|
4560
|
+
refund_mechanism?: "automatic" | "manual";
|
|
3502
4561
|
/**
|
|
3503
|
-
*
|
|
4562
|
+
* Client parameters required for payment processing. Present when gateway is paypal_express_checkout.
|
|
3504
4563
|
*/
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
without_discount?: OrderItemFormattedUnitPriceData;
|
|
3519
|
-
discounts?: {
|
|
3520
|
-
[key: string]: {
|
|
3521
|
-
amount?: number;
|
|
3522
|
-
currency?: string;
|
|
3523
|
-
formatted?: string;
|
|
3524
|
-
};
|
|
3525
|
-
};
|
|
3526
|
-
};
|
|
3527
|
-
timestamps?: CartCheckoutTimestamps;
|
|
4564
|
+
client_parameters?: {
|
|
4565
|
+
/**
|
|
4566
|
+
* The URL to redirect the customer to complete the payment.
|
|
4567
|
+
*/
|
|
4568
|
+
redirect_url?: string;
|
|
4569
|
+
/**
|
|
4570
|
+
* Client secret for payment processing.
|
|
4571
|
+
*/
|
|
4572
|
+
secret?: string;
|
|
4573
|
+
/**
|
|
4574
|
+
* The token for the payment session.
|
|
4575
|
+
*/
|
|
4576
|
+
token?: string;
|
|
3528
4577
|
};
|
|
4578
|
+
/**
|
|
4579
|
+
* Available actions that can be performed on this transaction. Present when gateway is paypal_express_checkout.
|
|
4580
|
+
*/
|
|
4581
|
+
next_actions?: Array<"cancel" | "capture" | "refund">;
|
|
3529
4582
|
relationships?: {
|
|
3530
|
-
|
|
4583
|
+
order?: {
|
|
3531
4584
|
data?: {
|
|
3532
4585
|
/**
|
|
3533
|
-
*
|
|
4586
|
+
* Represents the type of the object being returned. It is always `order`.
|
|
3534
4587
|
*/
|
|
3535
4588
|
type?: string;
|
|
3536
4589
|
/**
|
|
3537
|
-
* The
|
|
4590
|
+
* The ID of the order.
|
|
3538
4591
|
*/
|
|
3539
|
-
|
|
4592
|
+
id?: string;
|
|
3540
4593
|
};
|
|
3541
4594
|
};
|
|
3542
4595
|
};
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
catalog_source?: string;
|
|
3551
|
-
};
|
|
3552
|
-
type OrderItemCollectionResponse = {
|
|
3553
|
-
data?: Array<OrderItemResponse>;
|
|
3554
|
-
};
|
|
3555
|
-
type OrdersAnonymizeData = {
|
|
3556
|
-
/**
|
|
3557
|
-
* The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
|
|
3558
|
-
*/
|
|
3559
|
-
order_ids?: Array<string>;
|
|
3560
|
-
};
|
|
3561
|
-
type OrdersAnonymizeRequest = {
|
|
3562
|
-
data?: OrdersAnonymizeData;
|
|
4596
|
+
meta?: {
|
|
4597
|
+
display_price?: FormattedPriceData;
|
|
4598
|
+
display_refunded_amount?: {
|
|
4599
|
+
total?: FormattedPriceData;
|
|
4600
|
+
};
|
|
4601
|
+
timestamps?: CartCheckoutTimestamps;
|
|
4602
|
+
};
|
|
3563
4603
|
};
|
|
3564
|
-
type
|
|
3565
|
-
data:
|
|
4604
|
+
type TransactionEntityResponse = {
|
|
4605
|
+
data: TransactionResponse;
|
|
3566
4606
|
};
|
|
3567
4607
|
type DataAdyenPayment = DataBasePayments & {
|
|
3568
4608
|
/**
|
|
@@ -3708,22 +4748,6 @@ type DataStripePayment = DataBasePayments & {
|
|
|
3708
4748
|
*/
|
|
3709
4749
|
payment?: string;
|
|
3710
4750
|
};
|
|
3711
|
-
type DataStripeConnectPayment = DataBasePayments & {
|
|
3712
|
-
/**
|
|
3713
|
-
* Specifies the type of payment gateway. You must use `stripe_connect`.
|
|
3714
|
-
*/
|
|
3715
|
-
gateway: "stripe_connect";
|
|
3716
|
-
options?: {
|
|
3717
|
-
/**
|
|
3718
|
-
* 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.
|
|
3719
|
-
*/
|
|
3720
|
-
receipt_email?: string;
|
|
3721
|
-
};
|
|
3722
|
-
/**
|
|
3723
|
-
* Specifies the Stripe token or source.
|
|
3724
|
-
*/
|
|
3725
|
-
payment?: string;
|
|
3726
|
-
};
|
|
3727
4751
|
type DataStripePaymentIntentsPayment = DataBasePayments & {
|
|
3728
4752
|
/**
|
|
3729
4753
|
* Specifies the type of payment gateway. You must use `stripe_payment_intents`.
|
|
@@ -3740,100 +4764,10 @@ type DataStripePaymentIntentsPayment = DataBasePayments & {
|
|
|
3740
4764
|
*/
|
|
3741
4765
|
payment?: string;
|
|
3742
4766
|
};
|
|
3743
|
-
type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment |
|
|
4767
|
+
type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripePaymentIntentsPayment;
|
|
3744
4768
|
type PaymentsRequest = {
|
|
3745
4769
|
data?: DataPaymentObject;
|
|
3746
4770
|
};
|
|
3747
|
-
type TransactionResponse = {
|
|
3748
|
-
/**
|
|
3749
|
-
* The ID of the transaction.
|
|
3750
|
-
*/
|
|
3751
|
-
readonly id?: string;
|
|
3752
|
-
/**
|
|
3753
|
-
* The payment gateway reference.
|
|
3754
|
-
*/
|
|
3755
|
-
reference?: string;
|
|
3756
|
-
/**
|
|
3757
|
-
* A custom name associated with the payment method.
|
|
3758
|
-
*/
|
|
3759
|
-
name?: string;
|
|
3760
|
-
/**
|
|
3761
|
-
* 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.
|
|
3762
|
-
*/
|
|
3763
|
-
custom_reference?: string;
|
|
3764
|
-
/**
|
|
3765
|
-
* The name of the payment gateway used.
|
|
3766
|
-
*/
|
|
3767
|
-
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";
|
|
3768
|
-
/**
|
|
3769
|
-
* The amount for this transaction.
|
|
3770
|
-
*/
|
|
3771
|
-
amount?: number;
|
|
3772
|
-
/**
|
|
3773
|
-
* The refunded amount.
|
|
3774
|
-
*/
|
|
3775
|
-
refunded_amount?: number;
|
|
3776
|
-
/**
|
|
3777
|
-
* The transaction currency.
|
|
3778
|
-
*/
|
|
3779
|
-
currency?: string;
|
|
3780
|
-
/**
|
|
3781
|
-
* The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
|
|
3782
|
-
*/
|
|
3783
|
-
"transaction-type"?: string;
|
|
3784
|
-
/**
|
|
3785
|
-
* The status provided by the gateway for this transaction, such as `complete` or `failed`.
|
|
3786
|
-
*/
|
|
3787
|
-
status?: string;
|
|
3788
|
-
relationships?: {
|
|
3789
|
-
order?: {
|
|
3790
|
-
data?: {
|
|
3791
|
-
/**
|
|
3792
|
-
* Represents the type of the object being returned. It is always `order`.
|
|
3793
|
-
*/
|
|
3794
|
-
type?: string;
|
|
3795
|
-
/**
|
|
3796
|
-
* The ID of the order.
|
|
3797
|
-
*/
|
|
3798
|
-
id?: string;
|
|
3799
|
-
};
|
|
3800
|
-
};
|
|
3801
|
-
};
|
|
3802
|
-
meta?: {
|
|
3803
|
-
display_price?: FormattedPriceData;
|
|
3804
|
-
display_refunded_amount?: FormattedPriceData;
|
|
3805
|
-
timestamps?: CartCheckoutTimestamps;
|
|
3806
|
-
};
|
|
3807
|
-
/**
|
|
3808
|
-
* Client parameters required for payment processing. Present when gateway is paypal_express_checkout.
|
|
3809
|
-
*/
|
|
3810
|
-
client_parameters?: {
|
|
3811
|
-
/**
|
|
3812
|
-
* The token for the payment session.
|
|
3813
|
-
*/
|
|
3814
|
-
token?: string;
|
|
3815
|
-
/**
|
|
3816
|
-
* The URL to redirect the customer to complete the payment.
|
|
3817
|
-
*/
|
|
3818
|
-
redirect_url?: string;
|
|
3819
|
-
};
|
|
3820
|
-
/**
|
|
3821
|
-
* Additional payment details specific to the gateway. Present when gateway is paypal_express_checkout.
|
|
3822
|
-
*/
|
|
3823
|
-
payment_details?: {
|
|
3824
|
-
/**
|
|
3825
|
-
* Detailed status information from the payment gateway.
|
|
3826
|
-
*/
|
|
3827
|
-
detailed_status?: string;
|
|
3828
|
-
};
|
|
3829
|
-
/**
|
|
3830
|
-
* Available actions that can be performed on this transaction. Present when gateway is paypal_express_checkout.
|
|
3831
|
-
*/
|
|
3832
|
-
next_actions?: Array<"cancel" | "capture" | "refund">;
|
|
3833
|
-
};
|
|
3834
|
-
type TransactionEntityResponse = {
|
|
3835
|
-
data: TransactionResponse;
|
|
3836
|
-
};
|
|
3837
4771
|
type OrdersTransactionsConfirmRequest = {
|
|
3838
4772
|
data?: {
|
|
3839
4773
|
[key: string]: unknown;
|
|
@@ -3861,35 +4795,120 @@ type OrdersTransactionsRefundRequest = {
|
|
|
3861
4795
|
};
|
|
3862
4796
|
};
|
|
3863
4797
|
};
|
|
3864
|
-
type TransactionListResponse = {
|
|
3865
|
-
data: Array<TransactionResponse>;
|
|
3866
|
-
};
|
|
3867
|
-
type ResponseData = {
|
|
3868
|
-
data?: unknown;
|
|
3869
|
-
};
|
|
3870
|
-
type OrdersTransactionsCancelRequest = {
|
|
3871
|
-
data?: {
|
|
3872
|
-
options?: {
|
|
3873
|
-
[key: string]: unknown;
|
|
3874
|
-
};
|
|
3875
|
-
/**
|
|
3876
|
-
* Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
|
|
3877
|
-
*/
|
|
3878
|
-
reason?: string;
|
|
3879
|
-
};
|
|
4798
|
+
type TransactionListResponse = {
|
|
4799
|
+
data: Array<TransactionResponse>;
|
|
4800
|
+
};
|
|
4801
|
+
type ResponseData = {
|
|
4802
|
+
data?: unknown;
|
|
4803
|
+
};
|
|
4804
|
+
type OrdersTransactionsCancelRequest = {
|
|
4805
|
+
data?: {
|
|
4806
|
+
options?: {
|
|
4807
|
+
[key: string]: unknown;
|
|
4808
|
+
};
|
|
4809
|
+
/**
|
|
4810
|
+
* Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
|
|
4811
|
+
*/
|
|
4812
|
+
reason?: string;
|
|
4813
|
+
};
|
|
4814
|
+
};
|
|
4815
|
+
type UpdateOrderShippingGroupRequest = {
|
|
4816
|
+
data?: {
|
|
4817
|
+
type?: "shipping_group";
|
|
4818
|
+
shipping_type?: string;
|
|
4819
|
+
tracking_reference?: string;
|
|
4820
|
+
/**
|
|
4821
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
4822
|
+
*/
|
|
4823
|
+
external_ref?: string;
|
|
4824
|
+
address?: ShippingAddress;
|
|
4825
|
+
delivery_estimate?: DeliveryEstimate;
|
|
4826
|
+
};
|
|
4827
|
+
};
|
|
4828
|
+
type SettingsCart = {
|
|
4829
|
+
data?: {
|
|
4830
|
+
/**
|
|
4831
|
+
* Describes the type of request payload you're sending. Set this value to `settings`.
|
|
4832
|
+
*/
|
|
4833
|
+
type: string;
|
|
4834
|
+
/**
|
|
4835
|
+
* The unique identifier for the cart settings.
|
|
4836
|
+
*/
|
|
4837
|
+
readonly id?: string;
|
|
4838
|
+
/**
|
|
4839
|
+
* Indicates the number of days before a cart expires.
|
|
4840
|
+
*/
|
|
4841
|
+
cart_expiry_days?: number;
|
|
4842
|
+
discounts?: {
|
|
4843
|
+
/**
|
|
4844
|
+
* When `true`, custom discounts are enabled. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.
|
|
4845
|
+
*/
|
|
4846
|
+
custom_discounts_enabled?: boolean;
|
|
4847
|
+
/**
|
|
4848
|
+
* When set to `true`, this parameter allows the cart to use rule promotions.
|
|
4849
|
+
*/
|
|
4850
|
+
use_rule_promotions?: boolean;
|
|
4851
|
+
};
|
|
4852
|
+
inventories?: {
|
|
4853
|
+
/**
|
|
4854
|
+
* When `true`, inventory checks are not performed when adding products to a cart but still occur on checkout as normal. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.
|
|
4855
|
+
*/
|
|
4856
|
+
defer_inventory_check?: boolean;
|
|
4857
|
+
};
|
|
4858
|
+
items?: {
|
|
4859
|
+
/**
|
|
4860
|
+
* When `true`, cart items with the same SKU but different locations are kept as separate line items instead of being merged. When `false` (default), items with the same SKU are merged and the location is updated to the most recent value.
|
|
4861
|
+
*/
|
|
4862
|
+
separate_items_by_location?: boolean;
|
|
4863
|
+
};
|
|
4864
|
+
/**
|
|
4865
|
+
* When `true`, admins (users with admin scope) can retrieve all carts in the store via `GET /v2/carts`, regardless of customer or account associations. When `false`, admins can only see carts that are registered (associated with customers or accounts).
|
|
4866
|
+
*
|
|
4867
|
+
* For new stores, this defaults to `true`. For existing stores created before this feature was introduced, this defaults to `false` to maintain backward compatibility.
|
|
4868
|
+
*
|
|
4869
|
+
*/
|
|
4870
|
+
show_all_carts?: boolean;
|
|
4871
|
+
};
|
|
4872
|
+
};
|
|
4873
|
+
type CartsResponse = {
|
|
4874
|
+
data?: Array<CartItemObject | CustomItemCartObject | SubscriptionItemCartObject | PromotionItemCartObject>;
|
|
4875
|
+
meta?: {
|
|
4876
|
+
display_price?: {
|
|
4877
|
+
with_tax?: FormattedPriceData;
|
|
4878
|
+
without_tax?: FormattedPriceData;
|
|
4879
|
+
tax?: FormattedPriceData;
|
|
4880
|
+
discount?: FormattedPriceData;
|
|
4881
|
+
without_discount?: FormattedPriceData;
|
|
4882
|
+
discounts?: {
|
|
4883
|
+
[key: string]: {
|
|
4884
|
+
amount?: number;
|
|
4885
|
+
currency?: string;
|
|
4886
|
+
formatted?: string;
|
|
4887
|
+
};
|
|
4888
|
+
};
|
|
4889
|
+
};
|
|
4890
|
+
timestamps?: CartTimestamps;
|
|
4891
|
+
};
|
|
4892
|
+
};
|
|
4893
|
+
type CartItemsResponse = {
|
|
4894
|
+
data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
|
|
3880
4895
|
};
|
|
3881
|
-
type
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
|
|
4896
|
+
type CartItemObject = CartItemObjectData & CartItemResponse;
|
|
4897
|
+
type DataStripeConnectPayment = DataBasePayments & {
|
|
4898
|
+
/**
|
|
4899
|
+
* Specifies the type of payment gateway. You must use `stripe_connect`.
|
|
4900
|
+
*/
|
|
4901
|
+
gateway: "stripe_connect";
|
|
4902
|
+
options?: {
|
|
3886
4903
|
/**
|
|
3887
|
-
*
|
|
4904
|
+
* 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.
|
|
3888
4905
|
*/
|
|
3889
|
-
|
|
3890
|
-
address?: ShippingAddress;
|
|
3891
|
-
delivery_estimate?: DeliveryEstimate;
|
|
4906
|
+
receipt_email?: string;
|
|
3892
4907
|
};
|
|
4908
|
+
/**
|
|
4909
|
+
* Specifies the Stripe token or source.
|
|
4910
|
+
*/
|
|
4911
|
+
payment?: string;
|
|
3893
4912
|
};
|
|
3894
4913
|
type CartCheckoutTimestamps = {
|
|
3895
4914
|
/**
|
|
@@ -3899,7 +4918,7 @@ type CartCheckoutTimestamps = {
|
|
|
3899
4918
|
/**
|
|
3900
4919
|
* The date this was last updated.
|
|
3901
4920
|
*/
|
|
3902
|
-
updated_at?:
|
|
4921
|
+
updated_at?: string;
|
|
3903
4922
|
};
|
|
3904
4923
|
type CartIncludedPromotion = {
|
|
3905
4924
|
/**
|
|
@@ -5966,47 +6985,11 @@ type AccountAddressesError = {
|
|
|
5966
6985
|
type AccountAddressesErrorResponse = {
|
|
5967
6986
|
errors: Array<AccountAddressesError>;
|
|
5968
6987
|
};
|
|
5969
|
-
/**
|
|
5970
|
-
* The unique identifier.
|
|
5971
|
-
*/
|
|
5972
|
-
type Uuid = string;
|
|
5973
|
-
type MetaListPage = {
|
|
5974
|
-
/**
|
|
5975
|
-
* The maximum number of records per page for this response. You can set this value up to 100.
|
|
5976
|
-
*/
|
|
5977
|
-
limit?: number;
|
|
5978
|
-
/**
|
|
5979
|
-
* The current page.
|
|
5980
|
-
*/
|
|
5981
|
-
current?: number;
|
|
5982
|
-
/**
|
|
5983
|
-
* The current offset by number of records, not pages. Offset is zero-based.
|
|
5984
|
-
*/
|
|
5985
|
-
offset?: number;
|
|
5986
|
-
/**
|
|
5987
|
-
* The total page count.
|
|
5988
|
-
*/
|
|
5989
|
-
total?: number;
|
|
5990
|
-
};
|
|
5991
|
-
type MetaListResults = {
|
|
5992
|
-
/**
|
|
5993
|
-
* The total number of results after applying filters, if any, or all results.
|
|
5994
|
-
*/
|
|
5995
|
-
total?: number;
|
|
5996
|
-
};
|
|
5997
|
-
/**
|
|
5998
|
-
* The unique identifier for the Account Member that authenticated. This is useful if `account_member_self_management` is enabled in [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication), so that the user can update details for their account.
|
|
5999
|
-
*/
|
|
6000
|
-
type MetaAccountMemberId = string;
|
|
6001
|
-
type MetaList = {
|
|
6002
|
-
page?: MetaListPage;
|
|
6003
|
-
results?: MetaListResults;
|
|
6004
|
-
};
|
|
6005
6988
|
type Account = {
|
|
6006
6989
|
/**
|
|
6007
|
-
* Specifies the
|
|
6990
|
+
* Specifies the type of object. Set this value to `account`.
|
|
6008
6991
|
*/
|
|
6009
|
-
type:
|
|
6992
|
+
type: "account";
|
|
6010
6993
|
/**
|
|
6011
6994
|
* Specifies the name of the account.
|
|
6012
6995
|
*/
|
|
@@ -6022,7 +7005,7 @@ type Account = {
|
|
|
6022
7005
|
/**
|
|
6023
7006
|
* The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is `null`.
|
|
6024
7007
|
*/
|
|
6025
|
-
external_ref?: string;
|
|
7008
|
+
external_ref?: string | null;
|
|
6026
7009
|
};
|
|
6027
7010
|
type ReadOnlyParentId = {
|
|
6028
7011
|
/**
|
|
@@ -6030,12 +7013,10 @@ type ReadOnlyParentId = {
|
|
|
6030
7013
|
*/
|
|
6031
7014
|
readonly parent_id?: string | null;
|
|
6032
7015
|
};
|
|
6033
|
-
|
|
6034
|
-
|
|
6035
|
-
|
|
6036
|
-
|
|
6037
|
-
parent_id?: string | null;
|
|
6038
|
-
};
|
|
7016
|
+
/**
|
|
7017
|
+
* The unique identifier.
|
|
7018
|
+
*/
|
|
7019
|
+
type Uuid = string;
|
|
6039
7020
|
type AccountResponse = Account & ReadOnlyParentId & {
|
|
6040
7021
|
/**
|
|
6041
7022
|
* The unique identifier for an Account.
|
|
@@ -6045,67 +7026,85 @@ type AccountResponse = Account & ReadOnlyParentId & {
|
|
|
6045
7026
|
* Additional information for this realm. For more information, see [The meta object](https://elasticpath.dev/docs/commerce-cloud/accounts/using-account-management-api/account-management-api-overview#the-meta-object) section.
|
|
6046
7027
|
*/
|
|
6047
7028
|
meta?: AccountManagementMetaTimestamps;
|
|
6048
|
-
|
|
7029
|
+
relationships?: {
|
|
6049
7030
|
/**
|
|
6050
|
-
*
|
|
7031
|
+
* Tags associated with the account.
|
|
6051
7032
|
*/
|
|
6052
|
-
|
|
7033
|
+
account_tags?: {
|
|
7034
|
+
data?: Array<{
|
|
7035
|
+
/**
|
|
7036
|
+
* The unique identifier for an Account Tag.
|
|
7037
|
+
*/
|
|
7038
|
+
id?: Uuid;
|
|
7039
|
+
type?: "account_tag";
|
|
7040
|
+
}>;
|
|
7041
|
+
};
|
|
7042
|
+
ancestors?: Array<{
|
|
7043
|
+
data?: {
|
|
7044
|
+
/**
|
|
7045
|
+
* The unique identifier for an Account.
|
|
7046
|
+
*/
|
|
7047
|
+
id?: Uuid;
|
|
7048
|
+
type?: "account";
|
|
7049
|
+
};
|
|
7050
|
+
}>;
|
|
7051
|
+
parent?: {
|
|
7052
|
+
data?: {
|
|
7053
|
+
type?: "account";
|
|
7054
|
+
/**
|
|
7055
|
+
* The unique identifier for an Account.
|
|
7056
|
+
*/
|
|
7057
|
+
id?: Uuid;
|
|
7058
|
+
};
|
|
7059
|
+
};
|
|
6053
7060
|
};
|
|
6054
7061
|
};
|
|
6055
|
-
|
|
6056
|
-
* Whether a user with an [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is `disabled`. Set to `update_only` if you want the user to be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/update-a-user-authentication-info) using the `account_member_id` retrieved from the `meta` in the response of [Generating an Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) as the `id` and find the authentication credentials to update by calling the [Get All User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/get-all-user-authentication-password-profile-info) endpoint.
|
|
6057
|
-
*/
|
|
6058
|
-
type AccountMemberSelfManagement = "disabled" | "update_only";
|
|
6059
|
-
type AccountAuthenticationSettings = {
|
|
7062
|
+
type MetaListPage = {
|
|
6060
7063
|
/**
|
|
6061
|
-
*
|
|
7064
|
+
* The maximum number of records per page for this response. You can set this value up to 100.
|
|
6062
7065
|
*/
|
|
6063
|
-
|
|
7066
|
+
limit?: number;
|
|
6064
7067
|
/**
|
|
6065
|
-
*
|
|
7068
|
+
* The current page.
|
|
6066
7069
|
*/
|
|
6067
|
-
|
|
7070
|
+
current?: number;
|
|
6068
7071
|
/**
|
|
6069
|
-
*
|
|
7072
|
+
* The current offset by number of records, not pages. Offset is zero-based.
|
|
6070
7073
|
*/
|
|
6071
|
-
|
|
7074
|
+
offset?: number;
|
|
6072
7075
|
/**
|
|
6073
|
-
*
|
|
7076
|
+
* The total page count.
|
|
6074
7077
|
*/
|
|
6075
|
-
|
|
7078
|
+
total?: number;
|
|
7079
|
+
};
|
|
7080
|
+
type MetaListResults = {
|
|
6076
7081
|
/**
|
|
6077
|
-
* The
|
|
7082
|
+
* The total number of results after applying filters, if any, or all results.
|
|
6078
7083
|
*/
|
|
6079
|
-
|
|
7084
|
+
total?: number;
|
|
6080
7085
|
};
|
|
6081
|
-
type
|
|
6082
|
-
|
|
6083
|
-
|
|
6084
|
-
|
|
6085
|
-
|
|
6086
|
-
|
|
6087
|
-
|
|
6088
|
-
|
|
6089
|
-
|
|
6090
|
-
|
|
6091
|
-
|
|
6092
|
-
|
|
6093
|
-
|
|
6094
|
-
|
|
6095
|
-
|
|
6096
|
-
|
|
6097
|
-
|
|
6098
|
-
|
|
6099
|
-
|
|
6100
|
-
|
|
6101
|
-
|
|
6102
|
-
|
|
6103
|
-
meta?: {
|
|
6104
|
-
/**
|
|
6105
|
-
* The client ID to be used in Single Sign On authentication flows for accounts.
|
|
6106
|
-
*/
|
|
6107
|
-
client_id?: string;
|
|
6108
|
-
};
|
|
7086
|
+
type MetaList = {
|
|
7087
|
+
page?: MetaListPage;
|
|
7088
|
+
results?: MetaListResults;
|
|
7089
|
+
};
|
|
7090
|
+
type WritableParentId = {
|
|
7091
|
+
/**
|
|
7092
|
+
* Specifies the ID of the parent account, this field cannot be changed after creation.
|
|
7093
|
+
*/
|
|
7094
|
+
parent_id?: string | null;
|
|
7095
|
+
};
|
|
7096
|
+
type AccountTagsRelationshipIdentifier = {
|
|
7097
|
+
/**
|
|
7098
|
+
* The unique identifier for the related Account Tag.
|
|
7099
|
+
*/
|
|
7100
|
+
id?: string;
|
|
7101
|
+
/**
|
|
7102
|
+
* Specifies the type of the resource object.
|
|
7103
|
+
*/
|
|
7104
|
+
type?: "account_tag";
|
|
7105
|
+
};
|
|
7106
|
+
type AccountTagsRelationshipResponse = {
|
|
7107
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
6109
7108
|
links?: {
|
|
6110
7109
|
/**
|
|
6111
7110
|
* A URL to the specific resource.
|
|
@@ -6113,17 +7112,11 @@ type AccountAuthenticationSettingsResponse = AccountAuthenticationSettings & {
|
|
|
6113
7112
|
self?: string;
|
|
6114
7113
|
};
|
|
6115
7114
|
};
|
|
6116
|
-
type
|
|
6117
|
-
data?:
|
|
6118
|
-
|
|
6119
|
-
|
|
6120
|
-
|
|
6121
|
-
type?: "account_membership_setting";
|
|
6122
|
-
/**
|
|
6123
|
-
* The number of accounts an account member can be associated with. You can set this value to any number up to 10,000.
|
|
6124
|
-
*/
|
|
6125
|
-
membership_limit?: number;
|
|
6126
|
-
};
|
|
7115
|
+
type AddAccountTagsOnAccount = {
|
|
7116
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
7117
|
+
};
|
|
7118
|
+
type RemoveAccountTagsOnAccount = {
|
|
7119
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
6127
7120
|
};
|
|
6128
7121
|
type AccountMember = {
|
|
6129
7122
|
/**
|
|
@@ -6133,11 +7126,23 @@ type AccountMember = {
|
|
|
6133
7126
|
/**
|
|
6134
7127
|
* The type of the object that is returned.
|
|
6135
7128
|
*/
|
|
6136
|
-
type?:
|
|
7129
|
+
type?: "account_member";
|
|
6137
7130
|
/**
|
|
6138
7131
|
* The name of the account member.
|
|
6139
7132
|
*/
|
|
6140
7133
|
name?: string;
|
|
7134
|
+
/**
|
|
7135
|
+
* The given name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7136
|
+
*/
|
|
7137
|
+
given_name?: string | null;
|
|
7138
|
+
/**
|
|
7139
|
+
* The middle name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7140
|
+
*/
|
|
7141
|
+
middle_name?: string | null;
|
|
7142
|
+
/**
|
|
7143
|
+
* The family name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7144
|
+
*/
|
|
7145
|
+
family_name?: string | null;
|
|
6141
7146
|
/**
|
|
6142
7147
|
* The email address of the account member.
|
|
6143
7148
|
*/
|
|
@@ -6152,6 +7157,37 @@ type AccountMemberResponse = AccountMember & {
|
|
|
6152
7157
|
self?: string;
|
|
6153
7158
|
};
|
|
6154
7159
|
};
|
|
7160
|
+
type AccountMembershipResponse = {
|
|
7161
|
+
/**
|
|
7162
|
+
* Represents the unique identifier for the account membership.
|
|
7163
|
+
*/
|
|
7164
|
+
id?: string;
|
|
7165
|
+
/**
|
|
7166
|
+
* Represents the type of the object returned.
|
|
7167
|
+
*/
|
|
7168
|
+
type?: "account_membership";
|
|
7169
|
+
meta?: AccountManagementMetaTimestamps;
|
|
7170
|
+
relationships?: {
|
|
7171
|
+
account_member?: {
|
|
7172
|
+
data?: {
|
|
7173
|
+
/**
|
|
7174
|
+
* Specifies the ID of the account member.
|
|
7175
|
+
*/
|
|
7176
|
+
id?: string;
|
|
7177
|
+
/**
|
|
7178
|
+
* Specifies the type of the account member.
|
|
7179
|
+
*/
|
|
7180
|
+
type?: "account_member";
|
|
7181
|
+
};
|
|
7182
|
+
};
|
|
7183
|
+
};
|
|
7184
|
+
links?: {
|
|
7185
|
+
/**
|
|
7186
|
+
* A URL to the specific resource.
|
|
7187
|
+
*/
|
|
7188
|
+
self?: string;
|
|
7189
|
+
};
|
|
7190
|
+
};
|
|
6155
7191
|
type AccountMembership = {
|
|
6156
7192
|
/**
|
|
6157
7193
|
* Specifies the unique identifier of the account member that the membership is associated with.
|
|
@@ -6160,9 +7196,9 @@ type AccountMembership = {
|
|
|
6160
7196
|
/**
|
|
6161
7197
|
* Specifies the type of the object. Set this value to `account_membership`.
|
|
6162
7198
|
*/
|
|
6163
|
-
type?:
|
|
7199
|
+
type?: "account_membership";
|
|
6164
7200
|
};
|
|
6165
|
-
type
|
|
7201
|
+
type AccountMembershipResponseUsingAccountMemberId = {
|
|
6166
7202
|
/**
|
|
6167
7203
|
* Represents the unique identifier for the account membership.
|
|
6168
7204
|
*/
|
|
@@ -6170,19 +7206,19 @@ type AccountMembershipResponse = {
|
|
|
6170
7206
|
/**
|
|
6171
7207
|
* Represents the type of the object returned.
|
|
6172
7208
|
*/
|
|
6173
|
-
type?:
|
|
7209
|
+
type?: "account_membership";
|
|
6174
7210
|
meta?: AccountManagementMetaTimestamps;
|
|
6175
7211
|
relationships?: {
|
|
6176
|
-
|
|
7212
|
+
account?: {
|
|
6177
7213
|
data?: {
|
|
6178
7214
|
/**
|
|
6179
|
-
* Specifies the ID of the account
|
|
7215
|
+
* Specifies the ID of the account.
|
|
6180
7216
|
*/
|
|
6181
7217
|
id?: string;
|
|
6182
7218
|
/**
|
|
6183
|
-
* Specifies the type of the
|
|
7219
|
+
* Specifies the type of the Account.
|
|
6184
7220
|
*/
|
|
6185
|
-
type?:
|
|
7221
|
+
type?: "account";
|
|
6186
7222
|
};
|
|
6187
7223
|
};
|
|
6188
7224
|
};
|
|
@@ -6193,29 +7229,73 @@ type AccountMembershipResponse = {
|
|
|
6193
7229
|
self?: string;
|
|
6194
7230
|
};
|
|
6195
7231
|
};
|
|
6196
|
-
type
|
|
7232
|
+
type AccountMembershipSettings = {
|
|
7233
|
+
data?: {
|
|
7234
|
+
/**
|
|
7235
|
+
* Specifies the type of object. Set this value to `account_membership_setting`.
|
|
7236
|
+
*/
|
|
7237
|
+
type?: "account_membership_setting";
|
|
7238
|
+
/**
|
|
7239
|
+
* The number of accounts an account member can be associated with. You can set this value to any number up to 10,000.
|
|
7240
|
+
*/
|
|
7241
|
+
membership_limit?: number;
|
|
7242
|
+
};
|
|
7243
|
+
};
|
|
7244
|
+
/**
|
|
7245
|
+
* Whether a user with an [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is `disabled`. Set to `update_only` if you want the user to be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/update-a-user-authentication-info) using the `account_member_id` retrieved from the `meta` in the response of [Generating an Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) as the `id` and find the authentication credentials to update by calling the [Get All User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/get-all-user-authentication-password-profile-info) endpoint.
|
|
7246
|
+
*/
|
|
7247
|
+
type AccountMemberSelfManagement = "disabled" | "update_only";
|
|
7248
|
+
type AccountAuthenticationSettings = {
|
|
7249
|
+
/**
|
|
7250
|
+
* Specifies the type of object. Set this value to `account_authentication_settings`.
|
|
7251
|
+
*/
|
|
7252
|
+
type?: "account_authentication_settings";
|
|
7253
|
+
/**
|
|
7254
|
+
* Set to `true` to enable self signup.
|
|
7255
|
+
*/
|
|
7256
|
+
enable_self_signup?: boolean;
|
|
7257
|
+
/**
|
|
7258
|
+
* This will automatically create an account for each new account member, using the account member’s name as the account name.
|
|
7259
|
+
*/
|
|
7260
|
+
auto_create_account_for_account_members?: boolean;
|
|
6197
7261
|
/**
|
|
6198
|
-
*
|
|
7262
|
+
* Whether a user with an [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is `disabled`. Set to `update_only` if you want the user to be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/update-a-user-authentication-info) using the `account_member_id` retrieved from the `meta` in the response of [Generating an Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) as the `id` and find the authentication credentials to update by calling the [Get All User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/get-all-user-authentication-password-profile-info) endpoint.
|
|
6199
7263
|
*/
|
|
6200
|
-
|
|
7264
|
+
account_member_self_management?: "disabled" | "update_only";
|
|
6201
7265
|
/**
|
|
6202
|
-
*
|
|
7266
|
+
* The expiry time for Account Management Authentication Token in seconds. If you want to implement idle timout for you application, see [Implementing Idle Timeout](/guides/How-To/Accounts/implement-idle-timeout)
|
|
6203
7267
|
*/
|
|
6204
|
-
|
|
6205
|
-
|
|
6206
|
-
|
|
6207
|
-
|
|
6208
|
-
|
|
6209
|
-
|
|
6210
|
-
|
|
6211
|
-
|
|
6212
|
-
|
|
6213
|
-
|
|
6214
|
-
|
|
6215
|
-
|
|
6216
|
-
|
|
7268
|
+
account_management_authentication_token_timeout_secs?: number;
|
|
7269
|
+
};
|
|
7270
|
+
type AccountAuthenticationSettingsResponse = {
|
|
7271
|
+
data?: AccountAuthenticationSettings & {
|
|
7272
|
+
id?: Uuid;
|
|
7273
|
+
relationships?: {
|
|
7274
|
+
authentication_realm?: {
|
|
7275
|
+
data?: {
|
|
7276
|
+
/**
|
|
7277
|
+
* The ID of the authentication realm entity.
|
|
7278
|
+
*/
|
|
7279
|
+
id?: string;
|
|
7280
|
+
/**
|
|
7281
|
+
* The type of the authentication realm entity.
|
|
7282
|
+
*/
|
|
7283
|
+
type?: "authentication_realm";
|
|
7284
|
+
links?: {
|
|
7285
|
+
/**
|
|
7286
|
+
* A URL to the specific resource.
|
|
7287
|
+
*/
|
|
7288
|
+
self?: string;
|
|
7289
|
+
};
|
|
7290
|
+
};
|
|
6217
7291
|
};
|
|
6218
7292
|
};
|
|
7293
|
+
meta?: {
|
|
7294
|
+
/**
|
|
7295
|
+
* The client ID to be used in Single Sign On authentication flows for accounts.
|
|
7296
|
+
*/
|
|
7297
|
+
client_id?: string;
|
|
7298
|
+
};
|
|
6219
7299
|
};
|
|
6220
7300
|
links?: {
|
|
6221
7301
|
/**
|
|
@@ -6228,13 +7308,13 @@ type AccountManagementAuthenticationToken = {
|
|
|
6228
7308
|
/**
|
|
6229
7309
|
* Specifies the type of the object. You must use `account_management_authentication_token`.
|
|
6230
7310
|
*/
|
|
6231
|
-
type?:
|
|
7311
|
+
type?: "account_management_authentication_token";
|
|
6232
7312
|
};
|
|
6233
7313
|
type OpenIdConnectRequest = AccountManagementAuthenticationToken & {
|
|
6234
7314
|
/**
|
|
6235
7315
|
* Species the authentication mechanism. You must use `oidc`.
|
|
6236
7316
|
*/
|
|
6237
|
-
authentication_mechanism:
|
|
7317
|
+
authentication_mechanism: "oidc";
|
|
6238
7318
|
/**
|
|
6239
7319
|
* Specifies the code returned from the OpenID Connect Provider authentication.
|
|
6240
7320
|
*/
|
|
@@ -6252,7 +7332,7 @@ type PasswordRequest = AccountManagementAuthenticationToken & {
|
|
|
6252
7332
|
/**
|
|
6253
7333
|
* Species the authentication mechanism. You must use `password`.
|
|
6254
7334
|
*/
|
|
6255
|
-
authentication_mechanism:
|
|
7335
|
+
authentication_mechanism: "password";
|
|
6256
7336
|
/**
|
|
6257
7337
|
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
6258
7338
|
*/
|
|
@@ -6266,11 +7346,29 @@ type PasswordRequest = AccountManagementAuthenticationToken & {
|
|
|
6266
7346
|
*/
|
|
6267
7347
|
password: string;
|
|
6268
7348
|
};
|
|
7349
|
+
type PasswordlessRequest = AccountManagementAuthenticationToken & {
|
|
7350
|
+
/**
|
|
7351
|
+
* Species the authentication mechanism. You must use `passwordless`.
|
|
7352
|
+
*/
|
|
7353
|
+
authentication_mechanism: "passwordless";
|
|
7354
|
+
/**
|
|
7355
|
+
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
7356
|
+
*/
|
|
7357
|
+
password_profile_id: string;
|
|
7358
|
+
/**
|
|
7359
|
+
* The username.
|
|
7360
|
+
*/
|
|
7361
|
+
username: string;
|
|
7362
|
+
/**
|
|
7363
|
+
* The one-time password token.
|
|
7364
|
+
*/
|
|
7365
|
+
one_time_password_token: string;
|
|
7366
|
+
};
|
|
6269
7367
|
type SelfSignupRequest = AccountManagementAuthenticationToken & {
|
|
6270
7368
|
/**
|
|
6271
7369
|
* Species the authentication mechanism. You must use `self_signup`.
|
|
6272
7370
|
*/
|
|
6273
|
-
authentication_mechanism:
|
|
7371
|
+
authentication_mechanism: "self_signup";
|
|
6274
7372
|
/**
|
|
6275
7373
|
* The password profile ID. For more information, see [password profiles page](https://elasticpath.dev/docs/commerce-cloud/authentication/single-sign-on/password-profiles-api/overview).
|
|
6276
7374
|
*/
|
|
@@ -6288,39 +7386,33 @@ type SelfSignupRequest = AccountManagementAuthenticationToken & {
|
|
|
6288
7386
|
*/
|
|
6289
7387
|
name: string;
|
|
6290
7388
|
/**
|
|
6291
|
-
* The
|
|
6292
|
-
*/
|
|
6293
|
-
email: string;
|
|
6294
|
-
};
|
|
6295
|
-
type PasswordlessRequest = AccountManagementAuthenticationToken & {
|
|
6296
|
-
/**
|
|
6297
|
-
* Species the authentication mechanism. You must use `passwordless`.
|
|
7389
|
+
* The given name for the user.
|
|
6298
7390
|
*/
|
|
6299
|
-
|
|
7391
|
+
given_name?: string | null;
|
|
6300
7392
|
/**
|
|
6301
|
-
* The
|
|
7393
|
+
* The middle name for the user.
|
|
6302
7394
|
*/
|
|
6303
|
-
|
|
7395
|
+
middle_name?: string | null;
|
|
6304
7396
|
/**
|
|
6305
|
-
* The
|
|
7397
|
+
* The family name for the user.
|
|
6306
7398
|
*/
|
|
6307
|
-
|
|
7399
|
+
family_name?: string | null;
|
|
6308
7400
|
/**
|
|
6309
|
-
* The
|
|
7401
|
+
* The email.
|
|
6310
7402
|
*/
|
|
6311
|
-
|
|
7403
|
+
email: string;
|
|
6312
7404
|
};
|
|
6313
7405
|
type SwitchingAccountRequest = AccountManagementAuthenticationToken & {
|
|
6314
7406
|
/**
|
|
6315
7407
|
* Species the authentication mechanism. You must use `account_management_authentication_token`.
|
|
6316
7408
|
*/
|
|
6317
|
-
authentication_mechanism:
|
|
7409
|
+
authentication_mechanism: "account_management_authentication_token";
|
|
6318
7410
|
};
|
|
6319
7411
|
type AccountManagementAuthenticationTokenResponse = {
|
|
6320
7412
|
/**
|
|
6321
7413
|
* Specifies the type of the object.
|
|
6322
7414
|
*/
|
|
6323
|
-
type?:
|
|
7415
|
+
type?: "account_management_authentication_token";
|
|
6324
7416
|
/**
|
|
6325
7417
|
* The name of the account that this token grants access to.
|
|
6326
7418
|
*/
|
|
@@ -6338,14 +7430,50 @@ type AccountManagementAuthenticationTokenResponse = {
|
|
|
6338
7430
|
*/
|
|
6339
7431
|
expires?: Date;
|
|
6340
7432
|
};
|
|
7433
|
+
type MetaAccountMemberId = {
|
|
7434
|
+
/**
|
|
7435
|
+
* The unique identifier for the Account Member that authenticated. This is useful if `account_member_self_management` is enabled in [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication), so that the user can update details for their account.
|
|
7436
|
+
*/
|
|
7437
|
+
account_member_id?: string;
|
|
7438
|
+
};
|
|
7439
|
+
type AccountTag = {
|
|
7440
|
+
/**
|
|
7441
|
+
* Specifies the type of the resource object, use `account_tag` for Account Tags.
|
|
7442
|
+
*/
|
|
7443
|
+
type?: "account_tag";
|
|
7444
|
+
/**
|
|
7445
|
+
* Specifies the name of the account tag.
|
|
7446
|
+
*/
|
|
7447
|
+
name?: string;
|
|
7448
|
+
/**
|
|
7449
|
+
* Describes the account tag.
|
|
7450
|
+
*/
|
|
7451
|
+
description?: string;
|
|
7452
|
+
};
|
|
7453
|
+
type AccountTagResponse = AccountTag & {
|
|
7454
|
+
/**
|
|
7455
|
+
* The unique identifier for the account tag.
|
|
7456
|
+
*/
|
|
7457
|
+
id?: Uuid;
|
|
7458
|
+
/**
|
|
7459
|
+
* Additional information for this resource.
|
|
7460
|
+
*/
|
|
7461
|
+
meta?: AccountManagementMetaTimestamps;
|
|
7462
|
+
links?: {
|
|
7463
|
+
/**
|
|
7464
|
+
* A URL to the specific resource.
|
|
7465
|
+
*/
|
|
7466
|
+
self?: string;
|
|
7467
|
+
};
|
|
7468
|
+
};
|
|
6341
7469
|
type AccountManagementMetaTimestamps = {
|
|
6342
7470
|
timestamps?: {
|
|
6343
7471
|
/**
|
|
6344
|
-
* The date the
|
|
7472
|
+
* The date the resource is created.
|
|
6345
7473
|
*/
|
|
6346
7474
|
created_at?: string;
|
|
6347
7475
|
/**
|
|
6348
|
-
* The date the
|
|
7476
|
+
* The date the resource is updated.
|
|
6349
7477
|
*/
|
|
6350
7478
|
updated_at?: string;
|
|
6351
7479
|
};
|
|
@@ -7124,9 +8252,9 @@ type IncludeAccountMember = string;
|
|
|
7124
8252
|
*/
|
|
7125
8253
|
type IncludeAccount = string;
|
|
7126
8254
|
/**
|
|
7127
|
-
*
|
|
8255
|
+
* The ID of the Account Tag.
|
|
7128
8256
|
*/
|
|
7129
|
-
type
|
|
8257
|
+
type AccountTagId = string;
|
|
7130
8258
|
/**
|
|
7131
8259
|
*
|
|
7132
8260
|
* Filtering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).
|
|
@@ -9214,22 +10342,57 @@ type GetCartsData = {
|
|
|
9214
10342
|
/**
|
|
9215
10343
|
* A customer token to access a specific customer's carts.
|
|
9216
10344
|
*/
|
|
9217
|
-
"
|
|
10345
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9218
10346
|
};
|
|
9219
10347
|
path?: never;
|
|
9220
|
-
query?:
|
|
10348
|
+
query?: {
|
|
10349
|
+
/**
|
|
10350
|
+
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
10351
|
+
*/
|
|
10352
|
+
include?: Array<"custom_discounts">;
|
|
10353
|
+
/**
|
|
10354
|
+
* The maximum number of records per page.
|
|
10355
|
+
*/
|
|
10356
|
+
"page[limit]"?: number;
|
|
10357
|
+
/**
|
|
10358
|
+
* The number of records to offset the results by.
|
|
10359
|
+
*/
|
|
10360
|
+
"page[offset]"?: number;
|
|
10361
|
+
/**
|
|
10362
|
+
* Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).
|
|
10363
|
+
*
|
|
10364
|
+
* :::note
|
|
10365
|
+
* Filtering is only supported when using **client credentials** (admin) authentication. When using a **customer token** (`X-Moltin-Customer-Token`) or **account token** (`EP-Account-Management-Authentication-Token`), the `filter` parameter is ignored and all carts associated with the customer or account are returned.
|
|
10366
|
+
* :::
|
|
10367
|
+
*
|
|
10368
|
+
* **Supported Fields:**
|
|
10369
|
+
* - `account_ids`: Filter carts by associated account ID (UUID format)
|
|
10370
|
+
* - `name`: Filter carts by cart name (case-insensitive)
|
|
10371
|
+
*
|
|
10372
|
+
* **Supported Operators:**
|
|
10373
|
+
* - `contains(field,value)`: Contains value in array field
|
|
10374
|
+
* - `ilike(field,value)`: Case-insensitive string matching
|
|
10375
|
+
*
|
|
10376
|
+
* **Examples:**
|
|
10377
|
+
* - `contains(account_ids,"c24e5698-3b54-491b-9225-559c7a9cf2b2")` - Find carts associated with a specific account
|
|
10378
|
+
* - `ilike(name,"Shopping Cart")` - Find carts with name matching "Shopping Cart" (case-insensitive)
|
|
10379
|
+
* - `ilike(name,"*cart*")` - Find carts with names containing "cart" (wildcard search)
|
|
10380
|
+
*
|
|
10381
|
+
* **Combining Filters:**
|
|
10382
|
+
* You can combine multiple filters using the `:`, and `|` operator for and and or respectively:
|
|
10383
|
+
* - `contains(account_ids,"abc123"):ilike(name,"Holiday Cart")` - Find carts matching both conditions
|
|
10384
|
+
* - `contains(account_ids,"abc123")|ilike(name,"Holiday Cart")` - Find carts matching either condition.
|
|
10385
|
+
*
|
|
10386
|
+
*/
|
|
10387
|
+
filter?: string;
|
|
10388
|
+
};
|
|
9221
10389
|
url: "/v2/carts";
|
|
9222
10390
|
};
|
|
9223
10391
|
type GetCartsErrors = {
|
|
9224
10392
|
/**
|
|
9225
10393
|
* Bad Request
|
|
9226
10394
|
*/
|
|
9227
|
-
400:
|
|
9228
|
-
errors?: Array<{
|
|
9229
|
-
detail?: string;
|
|
9230
|
-
title?: string;
|
|
9231
|
-
}>;
|
|
9232
|
-
};
|
|
10395
|
+
400: ResponseErrorResponse;
|
|
9233
10396
|
/**
|
|
9234
10397
|
* Unauthorized call
|
|
9235
10398
|
*/
|
|
@@ -9244,9 +10407,13 @@ type CreateACartData = {
|
|
|
9244
10407
|
body?: CartsRequest;
|
|
9245
10408
|
headers?: {
|
|
9246
10409
|
/**
|
|
9247
|
-
*
|
|
10410
|
+
* An Account Management Authentication token for the account to be associated with the cart.
|
|
9248
10411
|
*/
|
|
9249
|
-
"
|
|
10412
|
+
"EP-Account-Management-Authentication-Token"?: string;
|
|
10413
|
+
/**
|
|
10414
|
+
* A customer token for the customer to be associated with the cart.
|
|
10415
|
+
*/
|
|
10416
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9250
10417
|
};
|
|
9251
10418
|
path?: never;
|
|
9252
10419
|
query?: never;
|
|
@@ -9256,13 +10423,7 @@ type CreateACartErrors = {
|
|
|
9256
10423
|
/**
|
|
9257
10424
|
* Bad Request
|
|
9258
10425
|
*/
|
|
9259
|
-
400:
|
|
9260
|
-
errors?: Array<{
|
|
9261
|
-
detail?: string;
|
|
9262
|
-
status?: number;
|
|
9263
|
-
title?: string;
|
|
9264
|
-
}>;
|
|
9265
|
-
};
|
|
10426
|
+
400: ResponseErrorResponse;
|
|
9266
10427
|
/**
|
|
9267
10428
|
* Unauthorized call
|
|
9268
10429
|
*/
|
|
@@ -9315,13 +10476,7 @@ type GetACartErrors = {
|
|
|
9315
10476
|
/**
|
|
9316
10477
|
* Bad Request
|
|
9317
10478
|
*/
|
|
9318
|
-
400:
|
|
9319
|
-
errors?: Array<{
|
|
9320
|
-
detail?: string;
|
|
9321
|
-
status?: number;
|
|
9322
|
-
title?: string;
|
|
9323
|
-
}>;
|
|
9324
|
-
};
|
|
10479
|
+
400: ResponseErrorResponse;
|
|
9325
10480
|
};
|
|
9326
10481
|
type GetACartError = GetACartErrors[keyof GetACartErrors];
|
|
9327
10482
|
type GetACartResponses = {
|
|
@@ -9350,13 +10505,7 @@ type UpdateACartErrors = {
|
|
|
9350
10505
|
/**
|
|
9351
10506
|
* Unprocessable Content
|
|
9352
10507
|
*/
|
|
9353
|
-
422:
|
|
9354
|
-
errors?: Array<{
|
|
9355
|
-
detail?: string;
|
|
9356
|
-
status?: number;
|
|
9357
|
-
title?: string;
|
|
9358
|
-
}>;
|
|
9359
|
-
};
|
|
10508
|
+
422: ResponseErrorItem;
|
|
9360
10509
|
};
|
|
9361
10510
|
type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors];
|
|
9362
10511
|
type UpdateACartResponses = {
|
|
@@ -9396,7 +10545,12 @@ type GetCartItemsData = {
|
|
|
9396
10545
|
*/
|
|
9397
10546
|
cartID: string;
|
|
9398
10547
|
};
|
|
9399
|
-
query?:
|
|
10548
|
+
query?: {
|
|
10549
|
+
/**
|
|
10550
|
+
* A comma-separated list of related resources to include in the response.
|
|
10551
|
+
*/
|
|
10552
|
+
include?: Array<"tax_items" | "custom_discounts" | "promotions">;
|
|
10553
|
+
};
|
|
9400
10554
|
url: "/v2/carts/{cartID}/items";
|
|
9401
10555
|
};
|
|
9402
10556
|
type GetCartItemsResponses = {
|
|
@@ -9420,7 +10574,11 @@ type ManageCartsErrors = {
|
|
|
9420
10574
|
*/
|
|
9421
10575
|
400: ResponseErrorResponse;
|
|
9422
10576
|
/**
|
|
9423
|
-
*
|
|
10577
|
+
* Unauthorized call
|
|
10578
|
+
*/
|
|
10579
|
+
403: ResponseErrorResponse;
|
|
10580
|
+
/**
|
|
10581
|
+
* Not Found - occurs when a referenced product or promotion cannot be found. For bulk operations with add_all_or_nothing=true, the entire operation fails if any item is invalid.
|
|
9424
10582
|
*/
|
|
9425
10583
|
404: ResponseErrorResponse;
|
|
9426
10584
|
/**
|
|
@@ -9434,6 +10592,9 @@ type ManageCartsErrors = {
|
|
|
9434
10592
|
};
|
|
9435
10593
|
type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors];
|
|
9436
10594
|
type ManageCartsResponses = {
|
|
10595
|
+
/**
|
|
10596
|
+
* Successfully added item(s) to cart. When promotions are added, the response includes informational messages in the `meta.messages` field describing the promotion and discount effects.
|
|
10597
|
+
*/
|
|
9437
10598
|
201: CartsResponse;
|
|
9438
10599
|
};
|
|
9439
10600
|
type ManageCartsResponse = ManageCartsResponses[keyof ManageCartsResponses];
|
|
@@ -9453,6 +10614,10 @@ type BulkUpdateItemsInCartErrors = {
|
|
|
9453
10614
|
* Insufficient Stock
|
|
9454
10615
|
*/
|
|
9455
10616
|
400: ResponseErrorResponse;
|
|
10617
|
+
/**
|
|
10618
|
+
* Unauthorized call
|
|
10619
|
+
*/
|
|
10620
|
+
403: ResponseErrorResponse;
|
|
9456
10621
|
/**
|
|
9457
10622
|
* Not Found
|
|
9458
10623
|
*/
|
|
@@ -9464,8 +10629,12 @@ type BulkUpdateItemsInCartErrors = {
|
|
|
9464
10629
|
};
|
|
9465
10630
|
type BulkUpdateItemsInCartError = BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors];
|
|
9466
10631
|
type BulkUpdateItemsInCartResponses = {
|
|
9467
|
-
|
|
10632
|
+
/**
|
|
10633
|
+
* Successfully updated cart items
|
|
10634
|
+
*/
|
|
10635
|
+
200: CartItemCollectionResponse;
|
|
9468
10636
|
};
|
|
10637
|
+
type BulkUpdateItemsInCartResponse = BulkUpdateItemsInCartResponses[keyof BulkUpdateItemsInCartResponses];
|
|
9469
10638
|
type DeleteACartItemData = {
|
|
9470
10639
|
body?: never;
|
|
9471
10640
|
path: {
|
|
@@ -9505,6 +10674,10 @@ type UpdateACartItemErrors = {
|
|
|
9505
10674
|
* Bad Request
|
|
9506
10675
|
*/
|
|
9507
10676
|
400: ResponseErrorResponse;
|
|
10677
|
+
/**
|
|
10678
|
+
* Unauthorized call
|
|
10679
|
+
*/
|
|
10680
|
+
403: ResponseErrorResponse;
|
|
9508
10681
|
/**
|
|
9509
10682
|
* Not Found
|
|
9510
10683
|
*/
|
|
@@ -9599,7 +10772,7 @@ type DeleteCustomerCartAssociationData = {
|
|
|
9599
10772
|
/**
|
|
9600
10773
|
* A customer token to access a specific customer's carts.
|
|
9601
10774
|
*/
|
|
9602
|
-
"
|
|
10775
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9603
10776
|
};
|
|
9604
10777
|
path: {
|
|
9605
10778
|
/**
|
|
@@ -9634,7 +10807,7 @@ type CreateCustomerCartAssociationData = {
|
|
|
9634
10807
|
/**
|
|
9635
10808
|
* A customer token to access a specific customer's carts.
|
|
9636
10809
|
*/
|
|
9637
|
-
"
|
|
10810
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9638
10811
|
};
|
|
9639
10812
|
path: {
|
|
9640
10813
|
/**
|
|
@@ -9664,36 +10837,152 @@ type CreateCustomerCartAssociationResponses = {
|
|
|
9664
10837
|
/**
|
|
9665
10838
|
* OK
|
|
9666
10839
|
*/
|
|
9667
|
-
200: CartsRelationshipsCustomersData;
|
|
10840
|
+
200: CartsRelationshipsCustomersData;
|
|
10841
|
+
/**
|
|
10842
|
+
* No Content
|
|
10843
|
+
*/
|
|
10844
|
+
204: void;
|
|
10845
|
+
};
|
|
10846
|
+
type CreateCustomerCartAssociationResponse = CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses];
|
|
10847
|
+
type DeleteAPromotionViaPromotionCodeData = {
|
|
10848
|
+
body?: never;
|
|
10849
|
+
path: {
|
|
10850
|
+
/**
|
|
10851
|
+
* Specifies the unique identifier of a cart created by you.
|
|
10852
|
+
*/
|
|
10853
|
+
cartID: string;
|
|
10854
|
+
/**
|
|
10855
|
+
* Specifies the promotion code to be deleted.
|
|
10856
|
+
*/
|
|
10857
|
+
promoCode: string;
|
|
10858
|
+
};
|
|
10859
|
+
query?: never;
|
|
10860
|
+
url: "/v2/carts/{cartID}/discounts/{promoCode}";
|
|
10861
|
+
};
|
|
10862
|
+
type DeleteAPromotionViaPromotionCodeResponses = {
|
|
10863
|
+
/**
|
|
10864
|
+
* No Content
|
|
10865
|
+
*/
|
|
10866
|
+
204: void;
|
|
10867
|
+
};
|
|
10868
|
+
type DeleteAPromotionViaPromotionCodeResponse = DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses];
|
|
10869
|
+
type AddTaxItemToCartData = {
|
|
10870
|
+
body: CartItemTaxesEntityResponse;
|
|
10871
|
+
path: {
|
|
10872
|
+
/**
|
|
10873
|
+
* The unique identifier of the cart.
|
|
10874
|
+
*/
|
|
10875
|
+
cartID: string;
|
|
10876
|
+
/**
|
|
10877
|
+
* The unique identifier of the cart item.
|
|
10878
|
+
*/
|
|
10879
|
+
cartitemID: string;
|
|
10880
|
+
};
|
|
10881
|
+
query?: never;
|
|
10882
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/taxes";
|
|
10883
|
+
};
|
|
10884
|
+
type AddTaxItemToCartErrors = {
|
|
10885
|
+
/**
|
|
10886
|
+
* Unauthorized
|
|
10887
|
+
*/
|
|
10888
|
+
422: ResponseErrorResponse;
|
|
10889
|
+
};
|
|
10890
|
+
type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
|
|
10891
|
+
type AddTaxItemToCartResponses = {
|
|
10892
|
+
200: CartItemTaxesEntityResponse;
|
|
10893
|
+
/**
|
|
10894
|
+
* Created
|
|
10895
|
+
*/
|
|
10896
|
+
201: CartItemTaxesEntityResponse;
|
|
10897
|
+
};
|
|
10898
|
+
type AddTaxItemToCartResponse = AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses];
|
|
10899
|
+
type AddTaxItemToCartItemComponentData = {
|
|
10900
|
+
body: CartItemTaxesEntityResponse;
|
|
10901
|
+
path: {
|
|
10902
|
+
/**
|
|
10903
|
+
* The unique identifier of the cart.
|
|
10904
|
+
*/
|
|
10905
|
+
cartID: string;
|
|
10906
|
+
/**
|
|
10907
|
+
* The unique identifier of the cart item.
|
|
10908
|
+
*/
|
|
10909
|
+
cartitemID: string;
|
|
10910
|
+
/**
|
|
10911
|
+
* The unique identifier of the component product within the bundle.
|
|
10912
|
+
*/
|
|
10913
|
+
productID: string;
|
|
10914
|
+
};
|
|
10915
|
+
query?: never;
|
|
10916
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes";
|
|
10917
|
+
};
|
|
10918
|
+
type AddTaxItemToCartItemComponentErrors = {
|
|
10919
|
+
/**
|
|
10920
|
+
* Bad Request
|
|
10921
|
+
*/
|
|
10922
|
+
400: ResponseErrorResponse;
|
|
10923
|
+
/**
|
|
10924
|
+
* Not Found
|
|
10925
|
+
*/
|
|
10926
|
+
404: ResponseErrorResponse;
|
|
10927
|
+
/**
|
|
10928
|
+
* Unprocessable Entity
|
|
10929
|
+
*/
|
|
10930
|
+
422: ResponseErrorResponse;
|
|
10931
|
+
/**
|
|
10932
|
+
* Internal Server Error
|
|
10933
|
+
*/
|
|
10934
|
+
500: ResponseErrorResponse;
|
|
10935
|
+
};
|
|
10936
|
+
type AddTaxItemToCartItemComponentError = AddTaxItemToCartItemComponentErrors[keyof AddTaxItemToCartItemComponentErrors];
|
|
10937
|
+
type AddTaxItemToCartItemComponentResponses = {
|
|
9668
10938
|
/**
|
|
9669
|
-
*
|
|
10939
|
+
* Created
|
|
9670
10940
|
*/
|
|
9671
|
-
|
|
10941
|
+
201: CartItemTaxesEntityResponse;
|
|
9672
10942
|
};
|
|
9673
|
-
type
|
|
9674
|
-
type
|
|
10943
|
+
type AddTaxItemToCartItemComponentResponse = AddTaxItemToCartItemComponentResponses[keyof AddTaxItemToCartItemComponentResponses];
|
|
10944
|
+
type DeleteTaxItemFromCartItemComponentData = {
|
|
9675
10945
|
body?: never;
|
|
9676
10946
|
path: {
|
|
9677
10947
|
/**
|
|
9678
|
-
*
|
|
10948
|
+
* The unique identifier of the cart.
|
|
9679
10949
|
*/
|
|
9680
10950
|
cartID: string;
|
|
9681
10951
|
/**
|
|
9682
|
-
*
|
|
10952
|
+
* The unique identifier of the cart item.
|
|
9683
10953
|
*/
|
|
9684
|
-
|
|
10954
|
+
cartitemID: string;
|
|
10955
|
+
/**
|
|
10956
|
+
* The unique identifier of the component product within the bundle.
|
|
10957
|
+
*/
|
|
10958
|
+
productID: string;
|
|
10959
|
+
/**
|
|
10960
|
+
* The unique identifier of the tax item on the component product.
|
|
10961
|
+
*/
|
|
10962
|
+
taxitemID: string;
|
|
9685
10963
|
};
|
|
9686
10964
|
query?: never;
|
|
9687
|
-
url: "/v2/carts/{cartID}/
|
|
10965
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}";
|
|
9688
10966
|
};
|
|
9689
|
-
type
|
|
10967
|
+
type DeleteTaxItemFromCartItemComponentErrors = {
|
|
10968
|
+
/**
|
|
10969
|
+
* Not Found
|
|
10970
|
+
*/
|
|
10971
|
+
404: ResponseErrorResponse;
|
|
10972
|
+
/**
|
|
10973
|
+
* Internal Server Error
|
|
10974
|
+
*/
|
|
10975
|
+
500: ResponseErrorResponse;
|
|
10976
|
+
};
|
|
10977
|
+
type DeleteTaxItemFromCartItemComponentError = DeleteTaxItemFromCartItemComponentErrors[keyof DeleteTaxItemFromCartItemComponentErrors];
|
|
10978
|
+
type DeleteTaxItemFromCartItemComponentResponses = {
|
|
9690
10979
|
/**
|
|
9691
10980
|
* No Content
|
|
9692
10981
|
*/
|
|
9693
10982
|
204: void;
|
|
9694
10983
|
};
|
|
9695
|
-
type
|
|
9696
|
-
type
|
|
10984
|
+
type DeleteTaxItemFromCartItemComponentResponse = DeleteTaxItemFromCartItemComponentResponses[keyof DeleteTaxItemFromCartItemComponentResponses];
|
|
10985
|
+
type UpdateTaxItemFromCartItemComponentData = {
|
|
9697
10986
|
body?: CartItemTaxesEntityResponse;
|
|
9698
10987
|
path: {
|
|
9699
10988
|
/**
|
|
@@ -9704,25 +10993,22 @@ type AddTaxItemToCartData = {
|
|
|
9704
10993
|
* The unique identifier of the cart item.
|
|
9705
10994
|
*/
|
|
9706
10995
|
cartitemID: string;
|
|
10996
|
+
/**
|
|
10997
|
+
* The unique identifier of the component product within the bundle.
|
|
10998
|
+
*/
|
|
10999
|
+
productID: string;
|
|
11000
|
+
/**
|
|
11001
|
+
* The unique identifier of the tax item on the component product.
|
|
11002
|
+
*/
|
|
11003
|
+
taxitemID: string;
|
|
9707
11004
|
};
|
|
9708
11005
|
query?: never;
|
|
9709
|
-
url: "/v2/carts/{cartID}/items/{cartitemID}/taxes";
|
|
11006
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}";
|
|
9710
11007
|
};
|
|
9711
|
-
type
|
|
9712
|
-
/**
|
|
9713
|
-
* Unauthorized
|
|
9714
|
-
*/
|
|
9715
|
-
422: ResponseErrorResponse;
|
|
9716
|
-
};
|
|
9717
|
-
type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
|
|
9718
|
-
type AddTaxItemToCartResponses = {
|
|
11008
|
+
type UpdateTaxItemFromCartItemComponentResponses = {
|
|
9719
11009
|
200: CartItemTaxesEntityResponse;
|
|
9720
|
-
/**
|
|
9721
|
-
* Created
|
|
9722
|
-
*/
|
|
9723
|
-
201: CartItemTaxesEntityResponse;
|
|
9724
11010
|
};
|
|
9725
|
-
type
|
|
11011
|
+
type UpdateTaxItemFromCartItemComponentResponse = UpdateTaxItemFromCartItemComponentResponses[keyof UpdateTaxItemFromCartItemComponentResponses];
|
|
9726
11012
|
type BulkDeleteTaxItemsFromCartData = {
|
|
9727
11013
|
body?: never;
|
|
9728
11014
|
path: {
|
|
@@ -9734,6 +11020,13 @@ type BulkDeleteTaxItemsFromCartData = {
|
|
|
9734
11020
|
query?: never;
|
|
9735
11021
|
url: "/v2/carts/{cartID}/taxes";
|
|
9736
11022
|
};
|
|
11023
|
+
type BulkDeleteTaxItemsFromCartErrors = {
|
|
11024
|
+
/**
|
|
11025
|
+
* Not Found - No tax items exist in the cart
|
|
11026
|
+
*/
|
|
11027
|
+
404: ResponseErrorResponse;
|
|
11028
|
+
};
|
|
11029
|
+
type BulkDeleteTaxItemsFromCartError = BulkDeleteTaxItemsFromCartErrors[keyof BulkDeleteTaxItemsFromCartErrors];
|
|
9737
11030
|
type BulkDeleteTaxItemsFromCartResponses = {
|
|
9738
11031
|
/**
|
|
9739
11032
|
* No Content
|
|
@@ -10036,7 +11329,7 @@ type CreateShippingGroupResponses = {
|
|
|
10036
11329
|
/**
|
|
10037
11330
|
* Shipping group created successfully
|
|
10038
11331
|
*/
|
|
10039
|
-
201:
|
|
11332
|
+
201: ShippingGroupEntityResponse;
|
|
10040
11333
|
};
|
|
10041
11334
|
type CreateShippingGroupResponse = CreateShippingGroupResponses[keyof CreateShippingGroupResponses];
|
|
10042
11335
|
type DeleteCartShippingGroupData = {
|
|
@@ -10133,7 +11426,7 @@ type UpdateShippingGroupResponses = {
|
|
|
10133
11426
|
/**
|
|
10134
11427
|
* Shipping group updated successfully
|
|
10135
11428
|
*/
|
|
10136
|
-
200:
|
|
11429
|
+
200: ShippingGroupEntityResponse;
|
|
10137
11430
|
};
|
|
10138
11431
|
type UpdateShippingGroupResponse = UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses];
|
|
10139
11432
|
type CreateCartPaymentIntentData = {
|
|
@@ -10151,7 +11444,7 @@ type CreateCartPaymentIntentResponses = {
|
|
|
10151
11444
|
/**
|
|
10152
11445
|
* Payment Intent created successfully.
|
|
10153
11446
|
*/
|
|
10154
|
-
201:
|
|
11447
|
+
201: CartEntityResponse;
|
|
10155
11448
|
};
|
|
10156
11449
|
type CreateCartPaymentIntentResponse = CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses];
|
|
10157
11450
|
type UpdateCartPaymentIntentData = {
|
|
@@ -10173,7 +11466,7 @@ type UpdateCartPaymentIntentResponses = {
|
|
|
10173
11466
|
/**
|
|
10174
11467
|
* Payment updated successfully
|
|
10175
11468
|
*/
|
|
10176
|
-
200:
|
|
11469
|
+
200: CartEntityResponse;
|
|
10177
11470
|
};
|
|
10178
11471
|
type UpdateCartPaymentIntentResponse = UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses];
|
|
10179
11472
|
type CheckoutApiData = {
|
|
@@ -10221,11 +11514,6 @@ type GetCustomerOrdersData = {
|
|
|
10221
11514
|
};
|
|
10222
11515
|
path?: never;
|
|
10223
11516
|
query?: {
|
|
10224
|
-
/**
|
|
10225
|
-
* For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint documentation to understand the attributes and operators an endpoint supports.
|
|
10226
|
-
*
|
|
10227
|
-
*/
|
|
10228
|
-
filter?: string;
|
|
10229
11517
|
include?: Array<"items">;
|
|
10230
11518
|
/**
|
|
10231
11519
|
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
@@ -10235,6 +11523,11 @@ type GetCustomerOrdersData = {
|
|
|
10235
11523
|
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.
|
|
10236
11524
|
*/
|
|
10237
11525
|
"page[offset]"?: number;
|
|
11526
|
+
/**
|
|
11527
|
+
* For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint documentation to understand the attributes and operators an endpoint supports.
|
|
11528
|
+
*
|
|
11529
|
+
*/
|
|
11530
|
+
filter?: string;
|
|
10238
11531
|
};
|
|
10239
11532
|
url: "/v2/orders";
|
|
10240
11533
|
};
|
|
@@ -10306,7 +11599,12 @@ type GetOrderItemsData = {
|
|
|
10306
11599
|
*/
|
|
10307
11600
|
orderID: string;
|
|
10308
11601
|
};
|
|
10309
|
-
query?:
|
|
11602
|
+
query?: {
|
|
11603
|
+
/**
|
|
11604
|
+
* Comma-delimited string of entities to include (tax_items, custom_discounts, promotions).
|
|
11605
|
+
*/
|
|
11606
|
+
include?: string;
|
|
11607
|
+
};
|
|
10310
11608
|
url: "/v2/orders/{orderID}/items";
|
|
10311
11609
|
};
|
|
10312
11610
|
type GetOrderItemsResponses = {
|
|
@@ -10363,7 +11661,7 @@ type ConfirmOrderResponses = {
|
|
|
10363
11661
|
/**
|
|
10364
11662
|
* Order confirmed successfully
|
|
10365
11663
|
*/
|
|
10366
|
-
200:
|
|
11664
|
+
200: TransactionEntityResponse;
|
|
10367
11665
|
};
|
|
10368
11666
|
type ConfirmOrderResponse = ConfirmOrderResponses[keyof ConfirmOrderResponses];
|
|
10369
11667
|
type PaymentSetupData = {
|
|
@@ -10657,7 +11955,12 @@ type GetShippingGroupsByIdData = {
|
|
|
10657
11955
|
*/
|
|
10658
11956
|
shippingGroupID: string;
|
|
10659
11957
|
};
|
|
10660
|
-
query?:
|
|
11958
|
+
query?: {
|
|
11959
|
+
/**
|
|
11960
|
+
* A comma-separated list of related resources to include in the response.
|
|
11961
|
+
*/
|
|
11962
|
+
include?: "items";
|
|
11963
|
+
};
|
|
10661
11964
|
url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
|
|
10662
11965
|
};
|
|
10663
11966
|
type GetShippingGroupsByIdErrors = {
|
|
@@ -10671,9 +11974,7 @@ type GetShippingGroupsByIdResponses = {
|
|
|
10671
11974
|
/**
|
|
10672
11975
|
* Shipping group details
|
|
10673
11976
|
*/
|
|
10674
|
-
200:
|
|
10675
|
-
data?: ShippingGroupResponse;
|
|
10676
|
-
};
|
|
11977
|
+
200: ShippingGroupEntityResponse;
|
|
10677
11978
|
};
|
|
10678
11979
|
type GetShippingGroupsByIdResponse = GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses];
|
|
10679
11980
|
type PutShippingGroupByIdData = {
|
|
@@ -10706,9 +12007,115 @@ type PutShippingGroupByIdResponses = {
|
|
|
10706
12007
|
/**
|
|
10707
12008
|
* Shipping group updated successfully
|
|
10708
12009
|
*/
|
|
10709
|
-
200:
|
|
12010
|
+
200: ShippingGroupEntityResponse;
|
|
10710
12011
|
};
|
|
10711
12012
|
type PutShippingGroupByIdResponse = PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses];
|
|
12013
|
+
type GetV2SettingsCartData = {
|
|
12014
|
+
body?: never;
|
|
12015
|
+
path?: never;
|
|
12016
|
+
query?: never;
|
|
12017
|
+
url: "/v2/settings/cart";
|
|
12018
|
+
};
|
|
12019
|
+
type GetV2SettingsCartErrors = {
|
|
12020
|
+
/**
|
|
12021
|
+
* Unauthorized
|
|
12022
|
+
*/
|
|
12023
|
+
401: ResponseErrorResponse;
|
|
12024
|
+
};
|
|
12025
|
+
type GetV2SettingsCartError = GetV2SettingsCartErrors[keyof GetV2SettingsCartErrors];
|
|
12026
|
+
type GetV2SettingsCartResponses = {
|
|
12027
|
+
/**
|
|
12028
|
+
* OK
|
|
12029
|
+
*/
|
|
12030
|
+
200: SettingsCart;
|
|
12031
|
+
};
|
|
12032
|
+
type GetV2SettingsCartResponse = GetV2SettingsCartResponses[keyof GetV2SettingsCartResponses];
|
|
12033
|
+
type PutV2SettingsCartData = {
|
|
12034
|
+
body?: SettingsCart;
|
|
12035
|
+
path?: never;
|
|
12036
|
+
query?: never;
|
|
12037
|
+
url: "/v2/settings/cart";
|
|
12038
|
+
};
|
|
12039
|
+
type PutV2SettingsCartErrors = {
|
|
12040
|
+
/**
|
|
12041
|
+
* Bad Request
|
|
12042
|
+
*/
|
|
12043
|
+
400: ResponseErrorResponse;
|
|
12044
|
+
/**
|
|
12045
|
+
* Unauthorized
|
|
12046
|
+
*/
|
|
12047
|
+
401: ResponseErrorResponse;
|
|
12048
|
+
/**
|
|
12049
|
+
* Forbidden
|
|
12050
|
+
*/
|
|
12051
|
+
403: ResponseErrorResponse;
|
|
12052
|
+
};
|
|
12053
|
+
type PutV2SettingsCartError = PutV2SettingsCartErrors[keyof PutV2SettingsCartErrors];
|
|
12054
|
+
type PutV2SettingsCartResponses = {
|
|
12055
|
+
/**
|
|
12056
|
+
* OK
|
|
12057
|
+
*/
|
|
12058
|
+
200: SettingsCart;
|
|
12059
|
+
};
|
|
12060
|
+
type PutV2SettingsCartResponse = PutV2SettingsCartResponses[keyof PutV2SettingsCartResponses];
|
|
12061
|
+
type GetV2SettingsCartStoreIdData = {
|
|
12062
|
+
body?: never;
|
|
12063
|
+
path: {
|
|
12064
|
+
/**
|
|
12065
|
+
* The store ID.
|
|
12066
|
+
*/
|
|
12067
|
+
storeID: string;
|
|
12068
|
+
};
|
|
12069
|
+
query?: never;
|
|
12070
|
+
url: "/v2/settings/cart/{storeID}";
|
|
12071
|
+
};
|
|
12072
|
+
type GetV2SettingsCartStoreIdErrors = {
|
|
12073
|
+
/**
|
|
12074
|
+
* Unauthorized
|
|
12075
|
+
*/
|
|
12076
|
+
401: ResponseErrorResponse;
|
|
12077
|
+
};
|
|
12078
|
+
type GetV2SettingsCartStoreIdError = GetV2SettingsCartStoreIdErrors[keyof GetV2SettingsCartStoreIdErrors];
|
|
12079
|
+
type GetV2SettingsCartStoreIdResponses = {
|
|
12080
|
+
/**
|
|
12081
|
+
* OK
|
|
12082
|
+
*/
|
|
12083
|
+
200: SettingsCart;
|
|
12084
|
+
};
|
|
12085
|
+
type GetV2SettingsCartStoreIdResponse = GetV2SettingsCartStoreIdResponses[keyof GetV2SettingsCartStoreIdResponses];
|
|
12086
|
+
type PutV2SettingsCartStoreIdData = {
|
|
12087
|
+
body?: SettingsCart;
|
|
12088
|
+
path: {
|
|
12089
|
+
/**
|
|
12090
|
+
* The store ID.
|
|
12091
|
+
*/
|
|
12092
|
+
storeID: string;
|
|
12093
|
+
};
|
|
12094
|
+
query?: never;
|
|
12095
|
+
url: "/v2/settings/cart/{storeID}";
|
|
12096
|
+
};
|
|
12097
|
+
type PutV2SettingsCartStoreIdErrors = {
|
|
12098
|
+
/**
|
|
12099
|
+
* Bad Request
|
|
12100
|
+
*/
|
|
12101
|
+
400: ResponseErrorResponse;
|
|
12102
|
+
/**
|
|
12103
|
+
* Unauthorized
|
|
12104
|
+
*/
|
|
12105
|
+
401: ResponseErrorResponse;
|
|
12106
|
+
/**
|
|
12107
|
+
* Forbidden
|
|
12108
|
+
*/
|
|
12109
|
+
403: ResponseErrorResponse;
|
|
12110
|
+
};
|
|
12111
|
+
type PutV2SettingsCartStoreIdError = PutV2SettingsCartStoreIdErrors[keyof PutV2SettingsCartStoreIdErrors];
|
|
12112
|
+
type PutV2SettingsCartStoreIdResponses = {
|
|
12113
|
+
/**
|
|
12114
|
+
* OK
|
|
12115
|
+
*/
|
|
12116
|
+
200: SettingsCart;
|
|
12117
|
+
};
|
|
12118
|
+
type PutV2SettingsCartStoreIdResponse = PutV2SettingsCartStoreIdResponses[keyof PutV2SettingsCartStoreIdResponses];
|
|
10712
12119
|
type ListOfferingsData = {
|
|
10713
12120
|
body?: never;
|
|
10714
12121
|
path?: never;
|
|
@@ -11725,6 +13132,10 @@ type PutV2AccountAddressResponses = {
|
|
|
11725
13132
|
};
|
|
11726
13133
|
};
|
|
11727
13134
|
type PutV2AccountAddressResponse = PutV2AccountAddressResponses[keyof PutV2AccountAddressResponses];
|
|
13135
|
+
/**
|
|
13136
|
+
* Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13137
|
+
*/
|
|
13138
|
+
type Sort = "created_at" | "-created_at" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11728
13139
|
type GetV2AccountsData = {
|
|
11729
13140
|
body?: never;
|
|
11730
13141
|
path?: never;
|
|
@@ -11742,13 +13153,17 @@ type GetV2AccountsData = {
|
|
|
11742
13153
|
*/
|
|
11743
13154
|
"page[offset]"?: BigInt;
|
|
11744
13155
|
/**
|
|
11745
|
-
*
|
|
13156
|
+
* Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
11746
13157
|
*/
|
|
11747
|
-
sort?:
|
|
13158
|
+
sort?: "created_at" | "-created_at" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11748
13159
|
};
|
|
11749
13160
|
url: "/v2/accounts";
|
|
11750
13161
|
};
|
|
11751
13162
|
type GetV2AccountsErrors = {
|
|
13163
|
+
/**
|
|
13164
|
+
* Bad Request
|
|
13165
|
+
*/
|
|
13166
|
+
400: AccountManagementErrorResponse;
|
|
11752
13167
|
/**
|
|
11753
13168
|
* Unauthorized
|
|
11754
13169
|
*/
|
|
@@ -11756,7 +13171,7 @@ type GetV2AccountsErrors = {
|
|
|
11756
13171
|
/**
|
|
11757
13172
|
* Internal server error.
|
|
11758
13173
|
*/
|
|
11759
|
-
|
|
13174
|
+
500: AccountManagementErrorResponse;
|
|
11760
13175
|
};
|
|
11761
13176
|
type GetV2AccountsError = GetV2AccountsErrors[keyof GetV2AccountsErrors];
|
|
11762
13177
|
type GetV2AccountsResponses = {
|
|
@@ -11764,7 +13179,14 @@ type GetV2AccountsResponses = {
|
|
|
11764
13179
|
* OK
|
|
11765
13180
|
*/
|
|
11766
13181
|
200: {
|
|
11767
|
-
data?: Array<AccountResponse
|
|
13182
|
+
data?: Array<AccountResponse & {
|
|
13183
|
+
links?: {
|
|
13184
|
+
/**
|
|
13185
|
+
* A URL to the specific resource.
|
|
13186
|
+
*/
|
|
13187
|
+
self?: string;
|
|
13188
|
+
};
|
|
13189
|
+
}>;
|
|
11768
13190
|
meta?: MetaList;
|
|
11769
13191
|
links?: {
|
|
11770
13192
|
/**
|
|
@@ -11804,10 +13226,22 @@ type PostV2AccountsErrors = {
|
|
|
11804
13226
|
* Bad Request
|
|
11805
13227
|
*/
|
|
11806
13228
|
400: AccountManagementErrorResponse;
|
|
13229
|
+
/**
|
|
13230
|
+
* Not Found
|
|
13231
|
+
*/
|
|
13232
|
+
404: AccountManagementErrorResponse;
|
|
13233
|
+
/**
|
|
13234
|
+
* Conflict
|
|
13235
|
+
*/
|
|
13236
|
+
409: AccountManagementErrorResponse;
|
|
13237
|
+
/**
|
|
13238
|
+
* Unprocessable Entity
|
|
13239
|
+
*/
|
|
13240
|
+
422: AccountManagementErrorResponse;
|
|
11807
13241
|
/**
|
|
11808
13242
|
* Internal server error.
|
|
11809
13243
|
*/
|
|
11810
|
-
|
|
13244
|
+
500: AccountManagementErrorResponse;
|
|
11811
13245
|
};
|
|
11812
13246
|
type PostV2AccountsError = PostV2AccountsErrors[keyof PostV2AccountsErrors];
|
|
11813
13247
|
type PostV2AccountsResponses = {
|
|
@@ -11816,6 +13250,12 @@ type PostV2AccountsResponses = {
|
|
|
11816
13250
|
*/
|
|
11817
13251
|
201: {
|
|
11818
13252
|
data?: AccountResponse;
|
|
13253
|
+
links?: {
|
|
13254
|
+
/**
|
|
13255
|
+
* A URL to the specific resource.
|
|
13256
|
+
*/
|
|
13257
|
+
self?: string;
|
|
13258
|
+
};
|
|
11819
13259
|
};
|
|
11820
13260
|
};
|
|
11821
13261
|
type PostV2AccountsResponse = PostV2AccountsResponses[keyof PostV2AccountsResponses];
|
|
@@ -11838,7 +13278,7 @@ type GetV2AccountsAccountIdErrors = {
|
|
|
11838
13278
|
/**
|
|
11839
13279
|
* Internal server error.
|
|
11840
13280
|
*/
|
|
11841
|
-
|
|
13281
|
+
500: AccountManagementErrorResponse;
|
|
11842
13282
|
};
|
|
11843
13283
|
type GetV2AccountsAccountIdError = GetV2AccountsAccountIdErrors[keyof GetV2AccountsAccountIdErrors];
|
|
11844
13284
|
type GetV2AccountsAccountIdResponses = {
|
|
@@ -11847,6 +13287,12 @@ type GetV2AccountsAccountIdResponses = {
|
|
|
11847
13287
|
*/
|
|
11848
13288
|
200: {
|
|
11849
13289
|
data?: AccountResponse;
|
|
13290
|
+
links?: {
|
|
13291
|
+
/**
|
|
13292
|
+
* A URL to the specific resource.
|
|
13293
|
+
*/
|
|
13294
|
+
self?: string;
|
|
13295
|
+
};
|
|
11850
13296
|
};
|
|
11851
13297
|
};
|
|
11852
13298
|
type GetV2AccountsAccountIdResponse = GetV2AccountsAccountIdResponses[keyof GetV2AccountsAccountIdResponses];
|
|
@@ -11884,10 +13330,14 @@ type PutV2AccountsAccountIdErrors = {
|
|
|
11884
13330
|
title?: string;
|
|
11885
13331
|
}>;
|
|
11886
13332
|
};
|
|
13333
|
+
/**
|
|
13334
|
+
* Conflict
|
|
13335
|
+
*/
|
|
13336
|
+
409: AccountManagementErrorResponse;
|
|
11887
13337
|
/**
|
|
11888
13338
|
* Internal server error.
|
|
11889
13339
|
*/
|
|
11890
|
-
|
|
13340
|
+
500: AccountManagementErrorResponse;
|
|
11891
13341
|
};
|
|
11892
13342
|
type PutV2AccountsAccountIdError = PutV2AccountsAccountIdErrors[keyof PutV2AccountsAccountIdErrors];
|
|
11893
13343
|
type PutV2AccountsAccountIdResponses = {
|
|
@@ -11895,49 +13345,12 @@ type PutV2AccountsAccountIdResponses = {
|
|
|
11895
13345
|
* OK
|
|
11896
13346
|
*/
|
|
11897
13347
|
200: {
|
|
11898
|
-
data?:
|
|
11899
|
-
|
|
11900
|
-
* The unique identifier for an Account.
|
|
11901
|
-
*/
|
|
11902
|
-
id?: string;
|
|
11903
|
-
/**
|
|
11904
|
-
* The type of the object returned. Always use account.
|
|
11905
|
-
*/
|
|
11906
|
-
type?: string;
|
|
11907
|
-
/**
|
|
11908
|
-
* The name of the account.
|
|
11909
|
-
*/
|
|
11910
|
-
name?: string;
|
|
11911
|
-
/**
|
|
11912
|
-
* The legal name of the account.
|
|
11913
|
-
*/
|
|
11914
|
-
legal_name?: string;
|
|
11915
|
-
/**
|
|
11916
|
-
* The registration ID of the account. The maximum character limit for this field is 63.
|
|
11917
|
-
*/
|
|
11918
|
-
registration_id?: string;
|
|
13348
|
+
data?: AccountResponse;
|
|
13349
|
+
links?: {
|
|
11919
13350
|
/**
|
|
11920
|
-
*
|
|
13351
|
+
* A URL to the specific resource.
|
|
11921
13352
|
*/
|
|
11922
|
-
|
|
11923
|
-
meta?: {
|
|
11924
|
-
timestamps?: {
|
|
11925
|
-
/**
|
|
11926
|
-
* The date the account is created.
|
|
11927
|
-
*/
|
|
11928
|
-
created_at?: Date;
|
|
11929
|
-
/**
|
|
11930
|
-
* The date the account is last updated.
|
|
11931
|
-
*/
|
|
11932
|
-
updated_at?: Date;
|
|
11933
|
-
};
|
|
11934
|
-
};
|
|
11935
|
-
links?: {
|
|
11936
|
-
/**
|
|
11937
|
-
* A URL to the specific resource.
|
|
11938
|
-
*/
|
|
11939
|
-
self?: string;
|
|
11940
|
-
};
|
|
13353
|
+
self?: string;
|
|
11941
13354
|
};
|
|
11942
13355
|
};
|
|
11943
13356
|
};
|
|
@@ -11954,18 +13367,22 @@ type GetV2AccountMembersData = {
|
|
|
11954
13367
|
* The number of records to offset the results by.
|
|
11955
13368
|
*/
|
|
11956
13369
|
"page[offset]"?: BigInt;
|
|
11957
|
-
/**
|
|
11958
|
-
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
11959
|
-
*/
|
|
11960
|
-
sort?: string;
|
|
11961
13370
|
/**
|
|
11962
13371
|
* Specifies the filter attributes.
|
|
11963
13372
|
*/
|
|
11964
13373
|
filter?: string;
|
|
13374
|
+
/**
|
|
13375
|
+
* Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13376
|
+
*/
|
|
13377
|
+
sort?: "created_at" | "-created_at" | "email" | "-email" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11965
13378
|
};
|
|
11966
13379
|
url: "/v2/account-members";
|
|
11967
13380
|
};
|
|
11968
13381
|
type GetV2AccountMembersErrors = {
|
|
13382
|
+
/**
|
|
13383
|
+
* Bad Request
|
|
13384
|
+
*/
|
|
13385
|
+
400: AccountManagementErrorResponse;
|
|
11969
13386
|
/**
|
|
11970
13387
|
* Unauthorized
|
|
11971
13388
|
*/
|
|
@@ -11973,7 +13390,7 @@ type GetV2AccountMembersErrors = {
|
|
|
11973
13390
|
/**
|
|
11974
13391
|
* Internal server error.
|
|
11975
13392
|
*/
|
|
11976
|
-
|
|
13393
|
+
500: AccountManagementErrorResponse;
|
|
11977
13394
|
};
|
|
11978
13395
|
type GetV2AccountMembersError = GetV2AccountMembersErrors[keyof GetV2AccountMembersErrors];
|
|
11979
13396
|
type GetV2AccountMembersResponses = {
|
|
@@ -12020,6 +13437,10 @@ type GetV2AccountMembersAccountMemberIdData = {
|
|
|
12020
13437
|
url: "/v2/account-members/{accountMemberID}";
|
|
12021
13438
|
};
|
|
12022
13439
|
type GetV2AccountMembersAccountMemberIdErrors = {
|
|
13440
|
+
/**
|
|
13441
|
+
* Bad Request
|
|
13442
|
+
*/
|
|
13443
|
+
400: AccountManagementErrorResponse;
|
|
12023
13444
|
/**
|
|
12024
13445
|
* Not Found
|
|
12025
13446
|
*/
|
|
@@ -12027,7 +13448,7 @@ type GetV2AccountMembersAccountMemberIdErrors = {
|
|
|
12027
13448
|
/**
|
|
12028
13449
|
* Internal server error.
|
|
12029
13450
|
*/
|
|
12030
|
-
|
|
13451
|
+
500: AccountManagementErrorResponse;
|
|
12031
13452
|
};
|
|
12032
13453
|
type GetV2AccountMembersAccountMemberIdError = GetV2AccountMembersAccountMemberIdErrors[keyof GetV2AccountMembersAccountMemberIdErrors];
|
|
12033
13454
|
type GetV2AccountMembersAccountMemberIdResponses = {
|
|
@@ -12036,6 +13457,12 @@ type GetV2AccountMembersAccountMemberIdResponses = {
|
|
|
12036
13457
|
*/
|
|
12037
13458
|
200: {
|
|
12038
13459
|
data?: AccountMemberResponse;
|
|
13460
|
+
links?: {
|
|
13461
|
+
/**
|
|
13462
|
+
* A URL to the specific resource.
|
|
13463
|
+
*/
|
|
13464
|
+
self?: string;
|
|
13465
|
+
};
|
|
12039
13466
|
};
|
|
12040
13467
|
};
|
|
12041
13468
|
type GetV2AccountMembersAccountMemberIdResponse = GetV2AccountMembersAccountMemberIdResponses[keyof GetV2AccountMembersAccountMemberIdResponses];
|
|
@@ -12052,10 +13479,6 @@ type GetV2AccountsAccountIdAccountMembershipsData = {
|
|
|
12052
13479
|
* Specifies the filter attributes.
|
|
12053
13480
|
*/
|
|
12054
13481
|
filter?: string;
|
|
12055
|
-
/**
|
|
12056
|
-
* Supported attributes are `created_at`, `email`, `id`, `name`, or `updated_at`. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with `-`, for example, `-updated_at`. The default sort order is `created_at` in descending order. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
12057
|
-
*/
|
|
12058
|
-
sort?: string;
|
|
12059
13482
|
/**
|
|
12060
13483
|
* The number of records per page.
|
|
12061
13484
|
*/
|
|
@@ -12068,10 +13491,18 @@ type GetV2AccountsAccountIdAccountMembershipsData = {
|
|
|
12068
13491
|
* Parameter to retrieve more information about any related resources like account members.
|
|
12069
13492
|
*/
|
|
12070
13493
|
include?: string;
|
|
13494
|
+
/**
|
|
13495
|
+
* Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13496
|
+
*/
|
|
13497
|
+
sort?: "created_at" | "-created_at" | "updated_at" | "-updated_at" | "id" | "-id";
|
|
12071
13498
|
};
|
|
12072
13499
|
url: "/v2/accounts/{accountID}/account-memberships";
|
|
12073
13500
|
};
|
|
12074
13501
|
type GetV2AccountsAccountIdAccountMembershipsErrors = {
|
|
13502
|
+
/**
|
|
13503
|
+
* Bad Request
|
|
13504
|
+
*/
|
|
13505
|
+
400: AccountManagementErrorResponse;
|
|
12075
13506
|
/**
|
|
12076
13507
|
* Not Found
|
|
12077
13508
|
*/
|
|
@@ -12079,7 +13510,7 @@ type GetV2AccountsAccountIdAccountMembershipsErrors = {
|
|
|
12079
13510
|
/**
|
|
12080
13511
|
* Internal server error.
|
|
12081
13512
|
*/
|
|
12082
|
-
|
|
13513
|
+
500: AccountManagementErrorResponse;
|
|
12083
13514
|
};
|
|
12084
13515
|
type GetV2AccountsAccountIdAccountMembershipsError = GetV2AccountsAccountIdAccountMembershipsErrors[keyof GetV2AccountsAccountIdAccountMembershipsErrors];
|
|
12085
13516
|
type GetV2AccountsAccountIdAccountMembershipsResponses = {
|
|
@@ -12087,7 +13518,12 @@ type GetV2AccountsAccountIdAccountMembershipsResponses = {
|
|
|
12087
13518
|
* OK
|
|
12088
13519
|
*/
|
|
12089
13520
|
200: {
|
|
12090
|
-
data?: Array<AccountMembershipResponse
|
|
13521
|
+
data?: Array<AccountMembershipResponse & {
|
|
13522
|
+
/**
|
|
13523
|
+
* The unique identifier for an Account Member.
|
|
13524
|
+
*/
|
|
13525
|
+
account_member_id?: Uuid;
|
|
13526
|
+
}>;
|
|
12091
13527
|
meta?: MetaList;
|
|
12092
13528
|
links?: {
|
|
12093
13529
|
/**
|
|
@@ -12133,14 +13569,30 @@ type PostV2AccountMembersTokensData = {
|
|
|
12133
13569
|
url: "/v2/account-members/tokens";
|
|
12134
13570
|
};
|
|
12135
13571
|
type PostV2AccountMembersTokensErrors = {
|
|
13572
|
+
/**
|
|
13573
|
+
* Bad Request
|
|
13574
|
+
*/
|
|
13575
|
+
400: AccountManagementErrorResponse;
|
|
12136
13576
|
/**
|
|
12137
13577
|
* Unauthorized
|
|
12138
13578
|
*/
|
|
12139
13579
|
401: AccountManagementErrorResponse;
|
|
13580
|
+
/**
|
|
13581
|
+
* Forbidden Error
|
|
13582
|
+
*/
|
|
13583
|
+
403: AccountManagementErrorResponse;
|
|
13584
|
+
/**
|
|
13585
|
+
* Not Found
|
|
13586
|
+
*/
|
|
13587
|
+
404: AccountManagementErrorResponse;
|
|
13588
|
+
/**
|
|
13589
|
+
* Unprocessable Entity
|
|
13590
|
+
*/
|
|
13591
|
+
422: AccountManagementErrorResponse;
|
|
12140
13592
|
/**
|
|
12141
13593
|
* Internal server error.
|
|
12142
13594
|
*/
|
|
12143
|
-
|
|
13595
|
+
500: AccountManagementErrorResponse;
|
|
12144
13596
|
};
|
|
12145
13597
|
type PostV2AccountMembersTokensError = PostV2AccountMembersTokensErrors[keyof PostV2AccountMembersTokensErrors];
|
|
12146
13598
|
type PostV2AccountMembersTokensResponses = {
|
|
@@ -12149,9 +13601,7 @@ type PostV2AccountMembersTokensResponses = {
|
|
|
12149
13601
|
*/
|
|
12150
13602
|
201: {
|
|
12151
13603
|
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
12152
|
-
meta?: MetaList &
|
|
12153
|
-
account_member_id?: MetaAccountMemberId;
|
|
12154
|
-
};
|
|
13604
|
+
meta?: MetaList & MetaAccountMemberId;
|
|
12155
13605
|
links?: {
|
|
12156
13606
|
/**
|
|
12157
13607
|
* Always the current page.
|
|
@@ -12403,4 +13853,4 @@ type PostMultiSearchResponses = {
|
|
|
12403
13853
|
};
|
|
12404
13854
|
type PostMultiSearchResponse = PostMultiSearchResponses[keyof PostMultiSearchResponses];
|
|
12405
13855
|
|
|
12406
|
-
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, AlternativePrices, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, AutocompleteResponse, AvailablePrices, 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, CartCheckoutFilter, CartCheckoutLimit, CartCheckoutOffset, 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, CatalogRuleValidatorRequest, CatalogSearchError, CatalogSearchErrorResponse, CatalogSearchProduct, 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, CreateSubscriptionStateData, CreateSubscriptionStateError, CreateSubscriptionStateErrors, CreateSubscriptionStateResponse, CreateSubscriptionStateResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemCartObject, 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, FacetCount, FacetValue, 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, Hit, 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, MatchType, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MultiSearchRequest, MultiSearchResponse, 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, OrderInclude, OrderIncluded, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersInclude, OrdersIncluded, 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, PostMultiSearchData, PostMultiSearchError, PostMultiSearchErrors, PostMultiSearchResponse, PostMultiSearchResponses, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookIdsOfAvailablePricesToShow, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemCartObject, 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, ReleaseIndexingCompleteData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleMeta, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SearchQuery, SearchResult, 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, SubscriptionItemCartObject, 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, ValidateCatalogRulesData, ValidateCatalogRulesError, ValidateCatalogRulesErrors, ValidateCatalogRulesResponse, ValidateCatalogRulesResponses, Variation, VariationOption, WritableParentId, _Error };
|
|
13856
|
+
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, AccountTag, AccountTagId, AccountTagResponse, AccountTagsRelationshipIdentifier, AccountTagsRelationshipResponse, Action, ActivePlan, ActivePricingOption, AddAccountTagsOnAccount, AddAllOrNothingOptionsObject, AddCustomDiscountToCartItemData, AddCustomDiscountToCartItemError, AddCustomDiscountToCartItemErrors, AddCustomDiscountToCartItemResponse, AddCustomDiscountToCartItemResponses, AddTaxItemToCartData, AddTaxItemToCartError, AddTaxItemToCartErrors, AddTaxItemToCartItemComponentData, AddTaxItemToCartItemComponentError, AddTaxItemToCartItemComponentErrors, AddTaxItemToCartItemComponentResponse, AddTaxItemToCartItemComponentResponses, AddTaxItemToCartResponse, AddTaxItemToCartResponses, Address, AddressCommon, AddressResponse, AddressWithCounty, AddressWithRegion, AlternativePrices, Amount, AnonymizeOrdersData, AnonymizeOrdersError, AnonymizeOrdersErrors, AnonymizeOrdersResponse, AnonymizeOrdersResponses, AuthenticationRealm, AuthenticationRealmListResponse, AuthenticationRealmResponse, AuthenticationRealmUpdateRequest, AutocompleteResponse, AvailablePrices, BaseCartResponse, BaseItemObjectData, BillingAddress, BillingIntervalType, BillingRunReport, BuildOffering, BuildSubscription, BuildSubscriptionOrder, BulkAddCustomDiscountsToCartData, BulkAddCustomDiscountsToCartError, BulkAddCustomDiscountsToCartErrors, BulkAddCustomDiscountsToCartResponse, BulkAddCustomDiscountsToCartResponses, BulkAddItemsRequest, BulkAddTaxItemsToCartData, BulkAddTaxItemsToCartError, BulkAddTaxItemsToCartErrors, BulkAddTaxItemsToCartResponse, BulkAddTaxItemsToCartResponses, BulkDeleteCustomDiscountsFromCartData, BulkDeleteCustomDiscountsFromCartResponse, BulkDeleteCustomDiscountsFromCartResponses, BulkDeleteTaxItemsFromCartData, BulkDeleteTaxItemsFromCartError, BulkDeleteTaxItemsFromCartErrors, BulkDeleteTaxItemsFromCartResponse, BulkDeleteTaxItemsFromCartResponses, BulkUpdateCartsItems, BulkUpdateCartsItemsCommon, BulkUpdateCartsItemsWithCustomInputs, BulkUpdateCartsItemsWithQuantity, BulkUpdateCartsItemsWithShippingGroup, BulkUpdateItemsInCartData, BulkUpdateItemsInCartError, BulkUpdateItemsInCartErrors, BulkUpdateItemsInCartResponse, BulkUpdateItemsInCartResponses, BundleConfiguration, BundleConfigurationData, BundleConfigurationData2, CancelATransactionData, CancelATransactionError, CancelATransactionErrors, CancelATransactionResponse, CancelATransactionResponses, CaptureATransactionData, CaptureATransactionError, CaptureATransactionErrors, CaptureATransactionResponse, CaptureATransactionResponses, CaptureMechanism, CartCheckoutFilter, CartCheckoutLimit, CartCheckoutOffset, CartCheckoutTimestamps, CartCollectionResponse, CartContact, CartEntityResponse, CartInclude, CartIncluded, CartIncludedPromotion, CartItemBulkCustomDiscountObject, CartItemCollectionResponse, CartItemFormattedPriceData, CartItemObject, CartItemObjectData, CartItemObjectRequest, CartItemRelationship, CartItemResponse, CartItemTaxesEntityResponse, CartItemsResponse, CartMergeObject, CartMergeObjectRequest, CartPaymentUpdate, CartResponse, CartTimestamps, CartsBulkCustomDiscounts, CartsBulkCustomDiscountsCollectionResponse, CartsBulkCustomDiscountsResponse, CartsBulkTaxes, CartsCustomDiscountsCollectionResponse, CartsCustomDiscountsEntityRequest, CartsCustomDiscountsEntityResponse, CartsCustomDiscountsObject, CartsCustomDiscountsResponseObject, CartsItemsTaxesCommon, CartsItemsTaxesObject, CartsItemsTaxesWithAmount, CartsItemsTaxesWithRate, CartsRelationshipsAccountsData, CartsRelationshipsCustomersData, CartsRequest, CartsResponse, Catalog, CatalogCreateData, CatalogData, CatalogListData, CatalogReleaseCreateData, CatalogRuleValidatorRequest, CatalogSearchError, CatalogSearchErrorResponse, CatalogSearchProduct, CatalogUpdateData, ChangeState, Channel, CheckoutApiData, CheckoutApiError, CheckoutApiErrors, CheckoutApiResponse, CheckoutApiResponses, ComponentProduct, ComponentProductOption, ComponentProductsRelationship, Components, CondensedPromotionResponse, 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, CreateSubscriptionStateData, CreateSubscriptionStateError, CreateSubscriptionStateErrors, CreateSubscriptionStateResponse, CreateSubscriptionStateResponses, Currencies, CurrencyIdentifier, CustomAttributes, CustomDiscountRelationshipsCartItemRequest, CustomDiscountResponse, CustomInput, CustomInputValidationRule, CustomInputValidationRuleOptions, CustomInputs, CustomItemCartObject, CustomItemObject, CustomItemObjectData, CustomRelationship, CustomRelationshipLinks, Customer, 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, DeleteTaxItemFromCartItemComponentData, DeleteTaxItemFromCartItemComponentError, DeleteTaxItemFromCartItemComponentErrors, DeleteTaxItemFromCartItemComponentResponse, DeleteTaxItemFromCartItemComponentResponses, DeleteV2AccountAddressData, DeleteV2AccountAddressError, DeleteV2AccountAddressErrors, DeleteV2AccountAddressResponse, DeleteV2AccountAddressResponses, DeliveryEstimate, DiffListData, Discount, DiscountData, DiscountFormattedPriceData, DiscountSettings, Discounts, DisplayPrice, DisplayPrice2, DunningRule, DunningRuleAttributes, DunningRuleCreate, DunningRuleMeta, DunningRuleUpdate, DunningRuleUpdateAttributes, ElasticPathFile, ElasticPathPaymentsPoweredByStripePayment, EndBehavior, Error2, ErrorBadRequest, ErrorNotFound, ErrorResponse, ErrorResponse2, Extension, Extensions, ExternalRef, ExternalRefUpdate, FacetCount, FacetValue, FailureDetails, 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, GetV2SettingsCartData, GetV2SettingsCartError, GetV2SettingsCartErrors, GetV2SettingsCartResponse, GetV2SettingsCartResponses, GetV2SettingsCartStoreIdData, GetV2SettingsCartStoreIdError, GetV2SettingsCartStoreIdErrors, GetV2SettingsCartStoreIdResponse, GetV2SettingsCartStoreIdResponses, Hierarchy, HierarchyAttributes, HierarchyData, HierarchyListData, HierarchyMeta, HierarchyRelationships, Hit, Import, ImportAttributes, ImportMeta, ImportRecords, Include, IncludeAccount, IncludeAccountMember, IncludedResponse, InventoriesError, InventoriesErrorResponse, InventoriesFilter, InventoriesPageLimit, InventoriesPageOffset, InventoriesTimestamps, InventoriesTransactionResponse, InventoriesUuid, InventoryLocationType, InventorySettings, InvoicePaymentTimestamps, InvoiceTaxItems, InvoiceTimestamps, ItemPriceData, ItemSettings, 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, MatchType, Meta, MetaAccountMemberId, MetaList, MetaListPage, MetaListResults, Method, Money, MultiSearchRequest, MultiSearchResponse, MultipleProducts, Node, NodeAttributes, NodeCreateData, NodeData, NodeListData, NodeMeta, NodeReference, NodeRelationships, NodeRelationshipsData, NonNegativeFormattedPriceData, 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, OrderInclude, OrderIncluded, OrderItemCollectionResponse, OrderItemFormattedUnitPriceData, OrderItemResponse, OrderMeta, OrderPriceData, OrderPriceWrapperMeta, OrderResponse, OrderTimestamps, OrdersAddressData, OrdersAnonymizeData, OrdersAnonymizeRequest, OrdersCancelData, OrdersFulfilledData, OrdersInclude, OrdersIncluded, 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, PostMultiSearchData, PostMultiSearchError, PostMultiSearchErrors, PostMultiSearchResponse, PostMultiSearchResponses, PostV2AccountAddressData, PostV2AccountAddressError, PostV2AccountAddressErrors, PostV2AccountAddressResponse, PostV2AccountAddressResponses, PostV2AccountMembersTokensData, PostV2AccountMembersTokensError, PostV2AccountMembersTokensErrors, PostV2AccountMembersTokensResponse, PostV2AccountMembersTokensResponses, PostV2AccountsData, PostV2AccountsError, PostV2AccountsErrors, PostV2AccountsResponse, PostV2AccountsResponses, Price, PriceFormatting, PriceUnits, Pricebook, PricebookCreateData, PricebookData, PricebookIdsForPriceSegmentationPreview, PricebookIdsOfAvailablePricesToShow, PricebookPrice, PricebookPriceCreateData, PricebookPriceData, PricingOptionAttributes, PricingOptionAttributesAndSelectedMeta, PricingOptionResponseAttributes, PricingOptionUpdateAttributes, PrioritizedPricebooks, Product, ProductAttributes, ProductCreateData, ProductData, ProductDiff, ProductListData, ProductMeta, ProductReference, ProductReferenceListData, ProductReferences, ProductRelationships, ProductRelationshipsData, ProductsForCart, ProductsForCartConfiguration, ProductsForCartConfiguration2, PromotionItemCartObject, PromotionItemObject, PromotionItemObjectData, PromotionSource, 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, PutV2SettingsCartData, PutV2SettingsCartError, PutV2SettingsCartErrors, PutV2SettingsCartResponse, PutV2SettingsCartResponses, PutV2SettingsCartStoreIdData, PutV2SettingsCartStoreIdError, PutV2SettingsCartStoreIdErrors, PutV2SettingsCartStoreIdResponse, PutV2SettingsCartStoreIdResponses, ReOrderObject, ReOrderObjectRequest, ReadOnlyParentId, RefundATransactionData, RefundATransactionError, RefundATransactionErrors, RefundATransactionResponse, RefundATransactionResponses, RefundMechanism, RelatedLink, Relationship, RelationshipArray, RelationshipData, RelationshipItem, RelationshipLinks, Relationships, RelationshipsRequest, Release, ReleaseData, ReleaseIndexingCompleteData, ReleaseListData, ReleaseMeta, ReleaseRelationships, ReleaseStatus, RemoveAccountTagsOnAccount, RequestCreateCurrencies, RequestUpdateCurrencies, ResponseCurrency, ResponseData, ResponseError, ResponseErrorItem, ResponseErrorResponse, ResponseMetaCarts, ResponseMetaCurrency, ResponseMetaOrders, ResponsePageLinks, ResponsePaginationPage, ResponsePaginationResults, ResultsLinks, ResultsMeta, Rounding, Rule, RuleCreateData, RuleData, RuleListData, RuleMeta, RuleSchedule, RuleUpdateData, Sale, Sales, Schedule, Schedule2, ScheduleAttributes, ScheduleCreate, ScheduleJob, ScheduleMeta, ScheduleResponseAttributes, ScheduleUpdate, ScheduleUpdateAttributes, SearchQuery, SearchResult, SelectedMeta, SelectedMetaAttributes, SelfLink, SelfLink2, SelfSignupRequest, SettingsCart, Shipping, ShippingAddress, ShippingGroupEntityResponse, 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, SubscriptionItemCartObject, 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, TaxItemResponse, TaxRunReport, Tier, TieredAmount, TieredCurrencies, Tiers, TimePeriod, Timestamps, TransactionCreate, TransactionCreateAttributes, TransactionEntityResponse, TransactionListResponse, TransactionResponse, TransactionResponseAttributes, TransactionType, 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, UpdateTaxItemFromCartItemComponentData, UpdateTaxItemFromCartItemComponentResponse, UpdateTaxItemFromCartItemComponentResponses, UserAuthenticationInfo, UserAuthenticationInfoCreateRequestWrapper, UserAuthenticationInfoListResponse, UserAuthenticationInfoResponse, UserAuthenticationInfoUpdateRequestWrapper, UserAuthenticationOidcProfileInfo, UserAuthenticationOidcProfileInfoCreateRequestWrapper, UserAuthenticationOidcProfileInfoListResponse, UserAuthenticationOidcProfileInfoResponse, UserAuthenticationOidcProfileInfoUpdateRequestWrapper, Uuid, ValidateCatalogRulesData, ValidateCatalogRulesError, ValidateCatalogRulesErrors, ValidateCatalogRulesResponse, ValidateCatalogRulesResponses, Variation, VariationOption, WritableParentId, _Error };
|