@epcc-sdk/sdks-shopper 0.1.0 → 0.2.1
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/auth/access-token.cjs +17 -0
- package/dist/auth/access-token.cjs.map +1 -0
- package/dist/auth/access-token.d.cts +7 -0
- package/dist/auth/access-token.d.ts +7 -0
- package/dist/auth/access-token.mjs +1 -0
- package/dist/auth/access-token.mjs.map +1 -0
- package/dist/auth/configure-client.d.cts +1 -0
- package/dist/auth/configure-client.d.ts +1 -0
- package/dist/auth/kit.cjs.map +1 -1
- package/dist/auth/kit.d.cts +2 -1
- package/dist/auth/kit.d.ts +2 -1
- package/dist/auth/kit.mjs.map +1 -1
- package/dist/auth/make-auth-fetch.d.cts +1 -0
- package/dist/auth/make-auth-fetch.d.ts +1 -0
- package/dist/auth/token-providers.d.cts +1 -0
- package/dist/auth/token-providers.d.ts +1 -0
- 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 +250 -79
- package/dist/client/sdk.gen.d.ts +250 -79
- package/dist/client/sdk.gen.mjs +119 -0
- package/dist/client/sdk.gen.mjs.map +1 -1
- package/dist/client/transformers.gen.cjs +101 -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 +96 -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 +2348 -847
- package/dist/client/types.gen.d.ts +2348 -847
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -2
- package/dist/index.d.ts +3 -2
- package/dist/index.mjs.map +1 -1
- package/dist/interceptors/auth-local-storage-interceptor.cjs.map +1 -1
- package/dist/interceptors/auth-local-storage-interceptor.mjs.map +1 -1
- package/dist/react-query.d.cts +1 -1
- package/dist/react-query.d.ts +1 -1
- package/package.json +1 -1
|
@@ -133,6 +133,10 @@ type Catalog = {
|
|
|
133
133
|
* This indicates whether the catalog will support price segmentation using catalog rules to define which pricebook(s) to use for pricing
|
|
134
134
|
*/
|
|
135
135
|
enable_price_segmentation?: boolean;
|
|
136
|
+
/**
|
|
137
|
+
* When `true`, publishing this catalog includes products in `draft` status in the catalog release. When `false` or omitted, only `live` products are included in the release (default).
|
|
138
|
+
*/
|
|
139
|
+
include_draft_products?: boolean;
|
|
136
140
|
};
|
|
137
141
|
/**
|
|
138
142
|
* Relationships are established between different catalog entities. For example, a catalog rule and a price book are related to a catalog, as both are associated with it.
|
|
@@ -195,6 +199,10 @@ type CatalogCreateData = {
|
|
|
195
199
|
* This indicates whether the catalog will support price segmentation using catalog rules to define which pricebook(s) to use for pricing
|
|
196
200
|
*/
|
|
197
201
|
enable_price_segmentation?: boolean;
|
|
202
|
+
/**
|
|
203
|
+
* When `true`, publishing this catalog includes products in `draft` status in the catalog release. When `false` or omitted, only `live` products are included in the release (default).
|
|
204
|
+
*/
|
|
205
|
+
include_draft_products?: boolean;
|
|
198
206
|
};
|
|
199
207
|
/**
|
|
200
208
|
* Represents the type of object being returned. Always `Catalog`.
|
|
@@ -252,6 +260,10 @@ type CatalogUpdateData = {
|
|
|
252
260
|
* This indicates whether the catalog will support price segmentation using catalog rules to define which pricebook(s) to use for pricing
|
|
253
261
|
*/
|
|
254
262
|
enable_price_segmentation?: boolean;
|
|
263
|
+
/**
|
|
264
|
+
* When `true`, publishing this catalog includes products in `draft` status in the catalog release. When `false` or omitted, only `live` products are included in the release (default).
|
|
265
|
+
*/
|
|
266
|
+
include_draft_products?: boolean;
|
|
255
267
|
};
|
|
256
268
|
/**
|
|
257
269
|
* The unique identifier of the catalog to be updated.
|
|
@@ -812,6 +824,10 @@ type ReleaseIndexingCompleteData = {
|
|
|
812
824
|
* The final status of the search indexing process.
|
|
813
825
|
*/
|
|
814
826
|
status: "succeeded" | "failed";
|
|
827
|
+
/**
|
|
828
|
+
* The elapsed time in milliseconds spent indexing the release.
|
|
829
|
+
*/
|
|
830
|
+
duration_ms?: BigInt | null;
|
|
815
831
|
};
|
|
816
832
|
};
|
|
817
833
|
/**
|
|
@@ -1642,6 +1658,14 @@ type ReleaseMeta = {
|
|
|
1642
1658
|
* This indicates whether the catalog release will support price segmentation using catalog rules to define which pricebook(s) to use for pricing
|
|
1643
1659
|
*/
|
|
1644
1660
|
price_segmentation_enabled?: boolean;
|
|
1661
|
+
/**
|
|
1662
|
+
* The elapsed time in milliseconds Catalog Search spent indexing this release.
|
|
1663
|
+
*/
|
|
1664
|
+
indexing_duration_ms?: BigInt | null;
|
|
1665
|
+
/**
|
|
1666
|
+
* When `true`, this catalog release includes `draft` products in its published data. This reflects the catalog `include_draft_products` attribute at the time of publish.
|
|
1667
|
+
*/
|
|
1668
|
+
includes_draft_products?: boolean;
|
|
1645
1669
|
};
|
|
1646
1670
|
/**
|
|
1647
1671
|
* Relationships are established between different catalog entities. For example, products, hierarchies, price books, and catalog rules are related to a catalog, as they are associated with it.
|
|
@@ -1730,6 +1754,13 @@ type Rule = {
|
|
|
1730
1754
|
*/
|
|
1731
1755
|
updated_at: Date;
|
|
1732
1756
|
pricebook_ids?: PrioritizedPricebooks;
|
|
1757
|
+
/**
|
|
1758
|
+
* Optional slug of a Catalog Search profile to apply when this rule is selected for a shopper.
|
|
1759
|
+
* This is configuration on the rule (same role as `pricebook_ids`), not a shopper-context matching dimension.
|
|
1760
|
+
* Omitted from responses when unset.
|
|
1761
|
+
*
|
|
1762
|
+
*/
|
|
1763
|
+
search_profile_slug?: string | null;
|
|
1733
1764
|
};
|
|
1734
1765
|
/**
|
|
1735
1766
|
* This represents the type of object being returned. Always `catalog_rule`.
|
|
@@ -1823,6 +1854,12 @@ type RuleCreateData = {
|
|
|
1823
1854
|
*/
|
|
1824
1855
|
catalog_id: string;
|
|
1825
1856
|
pricebook_ids?: PrioritizedPricebooks;
|
|
1857
|
+
/**
|
|
1858
|
+
* Optional slug of a Catalog Search profile to apply when this rule is selected for a shopper.
|
|
1859
|
+
* This is configuration on the rule (same role as `pricebook_ids`), not a shopper-context matching dimension.
|
|
1860
|
+
*
|
|
1861
|
+
*/
|
|
1862
|
+
search_profile_slug?: string | null;
|
|
1826
1863
|
};
|
|
1827
1864
|
/**
|
|
1828
1865
|
* This represents the type of object being returned. Always `catalog_rule`.
|
|
@@ -1915,6 +1952,13 @@ type RuleUpdateData = {
|
|
|
1915
1952
|
*/
|
|
1916
1953
|
catalog_id?: string | null;
|
|
1917
1954
|
pricebook_ids?: PrioritizedPricebooks;
|
|
1955
|
+
/**
|
|
1956
|
+
* Optional slug of a Catalog Search profile to apply when this rule is selected for a shopper.
|
|
1957
|
+
* This is configuration on the rule (same role as `pricebook_ids`), not a shopper-context matching dimension.
|
|
1958
|
+
* Omit the field to leave unchanged. Send an empty string to clear. Invalid format or SYSTEMS_DEFAULT_PROFILE is rejected with 400.
|
|
1959
|
+
*
|
|
1960
|
+
*/
|
|
1961
|
+
search_profile_slug?: string | null;
|
|
1918
1962
|
};
|
|
1919
1963
|
/**
|
|
1920
1964
|
* This represents the type of object being returned. Always `catalog_rule`.
|
|
@@ -1992,6 +2036,13 @@ type CatalogRuleValidatorRequest = {
|
|
|
1992
2036
|
* The id of the catalog to match against.
|
|
1993
2037
|
*/
|
|
1994
2038
|
catalog_id?: string | null;
|
|
2039
|
+
/**
|
|
2040
|
+
* Optional. When `match_type` is `filter`, ANDs an exact match on the rule's
|
|
2041
|
+
* `search_profile_slug`. Not used as a shopper-context matching dimension for
|
|
2042
|
+
* `resolve_for_shopper`.
|
|
2043
|
+
*
|
|
2044
|
+
*/
|
|
2045
|
+
search_profile_slug?: string | null;
|
|
1995
2046
|
/**
|
|
1996
2047
|
* The date to match against the schedules.
|
|
1997
2048
|
*/
|
|
@@ -2092,11 +2143,11 @@ type CartContact = {
|
|
|
2092
2143
|
};
|
|
2093
2144
|
type DiscountSettings = {
|
|
2094
2145
|
/**
|
|
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/
|
|
2146
|
+
* 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
2147
|
*/
|
|
2097
2148
|
custom_discounts_enabled?: boolean;
|
|
2098
2149
|
/**
|
|
2099
|
-
* When set to true, this parameter allows the cart to use rule promotions.
|
|
2150
|
+
* 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
2151
|
*/
|
|
2101
2152
|
use_rule_promotions?: boolean;
|
|
2102
2153
|
};
|
|
@@ -2106,6 +2157,16 @@ type InventorySettings = {
|
|
|
2106
2157
|
*/
|
|
2107
2158
|
defer_inventory_check?: boolean;
|
|
2108
2159
|
};
|
|
2160
|
+
type ItemSettings = {
|
|
2161
|
+
/**
|
|
2162
|
+
* 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.
|
|
2163
|
+
*/
|
|
2164
|
+
separate_items_by_location?: boolean;
|
|
2165
|
+
};
|
|
2166
|
+
/**
|
|
2167
|
+
* The type of the custom attribute value.
|
|
2168
|
+
*/
|
|
2169
|
+
type Type = "string" | "integer" | "boolean" | "float";
|
|
2109
2170
|
/**
|
|
2110
2171
|
* 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
2172
|
*
|
|
@@ -2125,7 +2186,16 @@ type InventorySettings = {
|
|
|
2125
2186
|
*
|
|
2126
2187
|
*/
|
|
2127
2188
|
type CustomAttributes = {
|
|
2128
|
-
[key: string]:
|
|
2189
|
+
[key: string]: {
|
|
2190
|
+
/**
|
|
2191
|
+
* The type of the custom attribute value.
|
|
2192
|
+
*/
|
|
2193
|
+
type: "string" | "integer" | "boolean" | "float";
|
|
2194
|
+
/**
|
|
2195
|
+
* The value of the custom attribute.
|
|
2196
|
+
*/
|
|
2197
|
+
value: number;
|
|
2198
|
+
};
|
|
2129
2199
|
};
|
|
2130
2200
|
type FormattedPriceData = {
|
|
2131
2201
|
/**
|
|
@@ -2141,6 +2211,20 @@ type FormattedPriceData = {
|
|
|
2141
2211
|
*/
|
|
2142
2212
|
formatted?: string;
|
|
2143
2213
|
};
|
|
2214
|
+
type CartTimestamps = {
|
|
2215
|
+
/**
|
|
2216
|
+
* The date this was created.
|
|
2217
|
+
*/
|
|
2218
|
+
created_at?: string;
|
|
2219
|
+
/**
|
|
2220
|
+
* The date this was last updated.
|
|
2221
|
+
*/
|
|
2222
|
+
updated_at?: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* The date this expires.
|
|
2225
|
+
*/
|
|
2226
|
+
expires_at?: string;
|
|
2227
|
+
};
|
|
2144
2228
|
/**
|
|
2145
2229
|
* Relationship data entry
|
|
2146
2230
|
*/
|
|
@@ -2148,11 +2232,11 @@ type RelationshipItem = {
|
|
|
2148
2232
|
/**
|
|
2149
2233
|
* The type of related resource.
|
|
2150
2234
|
*/
|
|
2151
|
-
type
|
|
2235
|
+
type: string;
|
|
2152
2236
|
/**
|
|
2153
2237
|
* The ID of the related resource.
|
|
2154
2238
|
*/
|
|
2155
|
-
id
|
|
2239
|
+
id: string;
|
|
2156
2240
|
};
|
|
2157
2241
|
/**
|
|
2158
2242
|
* Array of relationships
|
|
@@ -2163,15 +2247,11 @@ type RelationshipArray = {
|
|
|
2163
2247
|
*/
|
|
2164
2248
|
data?: Array<RelationshipItem>;
|
|
2165
2249
|
};
|
|
2166
|
-
type
|
|
2250
|
+
type BaseCartResponse = {
|
|
2167
2251
|
/**
|
|
2168
2252
|
* The unique identifier for the cart. Use SDK or create it yourself.
|
|
2169
2253
|
*/
|
|
2170
2254
|
id?: string;
|
|
2171
|
-
/**
|
|
2172
|
-
* The type of object being returned.
|
|
2173
|
-
*/
|
|
2174
|
-
type?: string;
|
|
2175
2255
|
/**
|
|
2176
2256
|
* The name of this cart.
|
|
2177
2257
|
*/
|
|
@@ -2183,11 +2263,16 @@ type CartResponse = {
|
|
|
2183
2263
|
contact?: CartContact;
|
|
2184
2264
|
discount_settings?: DiscountSettings;
|
|
2185
2265
|
inventory_settings?: InventorySettings;
|
|
2266
|
+
item_settings?: ItemSettings;
|
|
2186
2267
|
/**
|
|
2187
2268
|
* Stripe-assigned unique identifier for the linked Payment Intent
|
|
2188
2269
|
*/
|
|
2189
2270
|
payment_intent_id?: string;
|
|
2190
2271
|
custom_attributes?: CustomAttributes;
|
|
2272
|
+
/**
|
|
2273
|
+
* The snapshot date for the cart.
|
|
2274
|
+
*/
|
|
2275
|
+
snapshot_date?: Date;
|
|
2191
2276
|
links?: {
|
|
2192
2277
|
/**
|
|
2193
2278
|
* A link to that specific resource.
|
|
@@ -2202,19 +2287,64 @@ type CartResponse = {
|
|
|
2202
2287
|
discount?: FormattedPriceData;
|
|
2203
2288
|
without_discount?: FormattedPriceData;
|
|
2204
2289
|
shipping?: FormattedPriceData;
|
|
2290
|
+
shipping_discount?: FormattedPriceData;
|
|
2205
2291
|
};
|
|
2206
|
-
timestamps?:
|
|
2292
|
+
timestamps?: CartTimestamps;
|
|
2293
|
+
/**
|
|
2294
|
+
* Array of promotion suggestions
|
|
2295
|
+
*/
|
|
2296
|
+
promotion_suggestions?: Array<{
|
|
2297
|
+
/**
|
|
2298
|
+
* Bundle configuration with promotion targets
|
|
2299
|
+
*/
|
|
2300
|
+
bundle?: Array<{
|
|
2301
|
+
/**
|
|
2302
|
+
* Whether to automatically add free gift
|
|
2303
|
+
*/
|
|
2304
|
+
auto_add_free_gift?: boolean;
|
|
2305
|
+
/**
|
|
2306
|
+
* Cart item ID for the target
|
|
2307
|
+
*/
|
|
2308
|
+
cart_item_id?: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* Quantity for the promotion
|
|
2311
|
+
*/
|
|
2312
|
+
quantity?: number;
|
|
2313
|
+
/**
|
|
2314
|
+
* Array of target SKUs
|
|
2315
|
+
*/
|
|
2316
|
+
targets?: Array<string>;
|
|
2317
|
+
[key: string]: unknown | boolean | string | number | Array<string> | undefined;
|
|
2318
|
+
}>;
|
|
2319
|
+
code?: string;
|
|
2320
|
+
info?: string;
|
|
2321
|
+
message?: string;
|
|
2322
|
+
promotion_id?: string;
|
|
2323
|
+
}>;
|
|
2207
2324
|
};
|
|
2208
2325
|
relationships?: {
|
|
2209
|
-
customers?: RelationshipArray
|
|
2326
|
+
customers?: RelationshipArray | {
|
|
2327
|
+
[key: string]: unknown;
|
|
2328
|
+
};
|
|
2210
2329
|
items?: RelationshipArray | {
|
|
2211
|
-
data
|
|
2330
|
+
data: null | Array<{
|
|
2331
|
+
id?: string;
|
|
2332
|
+
type?: string;
|
|
2333
|
+
}>;
|
|
2334
|
+
};
|
|
2335
|
+
accounts?: RelationshipArray | {
|
|
2336
|
+
[key: string]: unknown;
|
|
2212
2337
|
};
|
|
2213
|
-
accounts?: RelationshipArray;
|
|
2214
2338
|
custom_discounts?: RelationshipArray;
|
|
2215
2339
|
promotions?: RelationshipArray;
|
|
2216
2340
|
};
|
|
2217
2341
|
};
|
|
2342
|
+
type CartResponse = BaseCartResponse & {
|
|
2343
|
+
/**
|
|
2344
|
+
* The type of object being returned.
|
|
2345
|
+
*/
|
|
2346
|
+
type?: "cart";
|
|
2347
|
+
};
|
|
2218
2348
|
type ResponsePageLinks = {
|
|
2219
2349
|
/**
|
|
2220
2350
|
* Always the current page.
|
|
@@ -2283,6 +2413,13 @@ type ResponseErrorItem = {
|
|
|
2283
2413
|
* Optional additional detail about the error.
|
|
2284
2414
|
*/
|
|
2285
2415
|
detail?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* 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').
|
|
2418
|
+
*/
|
|
2419
|
+
source?: string;
|
|
2420
|
+
/**
|
|
2421
|
+
* Additional metadata associated with the error. May include arbitrary keys.
|
|
2422
|
+
*/
|
|
2286
2423
|
meta?: {
|
|
2287
2424
|
/**
|
|
2288
2425
|
* The resource id associated with the error
|
|
@@ -2307,10 +2444,28 @@ type ResponseErrorItem = {
|
|
|
2307
2444
|
* The order id associated with the error.
|
|
2308
2445
|
*/
|
|
2309
2446
|
order_id?: string;
|
|
2447
|
+
/**
|
|
2448
|
+
* The SKU associated with the error.
|
|
2449
|
+
*/
|
|
2450
|
+
sku?: string;
|
|
2451
|
+
/**
|
|
2452
|
+
* The email address associated with the error.
|
|
2453
|
+
*/
|
|
2454
|
+
email?: string;
|
|
2455
|
+
/**
|
|
2456
|
+
* The component product ID associated with the error.
|
|
2457
|
+
*/
|
|
2458
|
+
component_product_id?: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* Custom error metadata key used for additional error context (e.g., in payment rejections).
|
|
2461
|
+
*/
|
|
2462
|
+
"error-meta-key"?: string;
|
|
2310
2463
|
/**
|
|
2311
2464
|
* The value associated with the error.
|
|
2312
2465
|
*/
|
|
2313
|
-
value?:
|
|
2466
|
+
value?: string | number | boolean | {
|
|
2467
|
+
[key: string]: unknown;
|
|
2468
|
+
} | Array<unknown>;
|
|
2314
2469
|
};
|
|
2315
2470
|
};
|
|
2316
2471
|
type ResponseErrorResponse = {
|
|
@@ -2324,6 +2479,7 @@ type CartsRequest = {
|
|
|
2324
2479
|
description?: string;
|
|
2325
2480
|
discount_settings?: DiscountSettings;
|
|
2326
2481
|
inventory_settings?: InventorySettings;
|
|
2482
|
+
item_settings?: ItemSettings;
|
|
2327
2483
|
/**
|
|
2328
2484
|
* 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
2485
|
*/
|
|
@@ -2368,60 +2524,110 @@ type CartsRequest = {
|
|
|
2368
2524
|
payment_intent_id?: string;
|
|
2369
2525
|
};
|
|
2370
2526
|
};
|
|
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 = {
|
|
2527
|
+
type CustomDiscountResponse = {
|
|
2380
2528
|
/**
|
|
2381
|
-
*
|
|
2529
|
+
* Specifies the type of the resource. Always `custom_discount`.
|
|
2382
2530
|
*/
|
|
2383
|
-
type
|
|
2531
|
+
type?: "custom_discount";
|
|
2384
2532
|
/**
|
|
2385
|
-
*
|
|
2533
|
+
* Specifies the UUID of the custom discount.
|
|
2386
2534
|
*/
|
|
2387
|
-
|
|
2535
|
+
id?: string;
|
|
2536
|
+
/**
|
|
2537
|
+
* Specifies an external id for the custom discount.
|
|
2538
|
+
*/
|
|
2539
|
+
external_id?: string;
|
|
2388
2540
|
/**
|
|
2389
|
-
* Specifies
|
|
2541
|
+
* Specifies from where the custom discount is applied.
|
|
2542
|
+
*
|
|
2390
2543
|
*/
|
|
2391
|
-
|
|
2544
|
+
discount_engine?: string;
|
|
2392
2545
|
/**
|
|
2393
|
-
*
|
|
2546
|
+
* The amount of the custom discount.
|
|
2394
2547
|
*/
|
|
2395
|
-
|
|
2548
|
+
amount?: FormattedPriceData;
|
|
2396
2549
|
/**
|
|
2397
|
-
*
|
|
2550
|
+
* Specifies a description for the custom discount.
|
|
2398
2551
|
*/
|
|
2399
|
-
|
|
2400
|
-
|
|
2552
|
+
description?: string;
|
|
2553
|
+
/**
|
|
2554
|
+
* Specifies the discount code used for the custom discount.
|
|
2555
|
+
*/
|
|
2556
|
+
discount_code?: string;
|
|
2557
|
+
/**
|
|
2558
|
+
* Relationships to other resources like cart items
|
|
2559
|
+
*/
|
|
2560
|
+
relationships?: {
|
|
2561
|
+
item?: {
|
|
2562
|
+
data?: {
|
|
2563
|
+
/**
|
|
2564
|
+
* The cart item ID this discount is related to
|
|
2565
|
+
*/
|
|
2566
|
+
id?: string;
|
|
2567
|
+
type?: "cart_item" | "custom_item";
|
|
2568
|
+
};
|
|
2569
|
+
};
|
|
2401
2570
|
};
|
|
2571
|
+
};
|
|
2572
|
+
type CondensedPromotionResponse = {
|
|
2402
2573
|
/**
|
|
2403
|
-
*
|
|
2574
|
+
* Specifies the type of the resource. Always `promotion`.
|
|
2404
2575
|
*/
|
|
2405
|
-
|
|
2576
|
+
type?: "promotion";
|
|
2577
|
+
/**
|
|
2578
|
+
* Specifies the UUID of the promotion.
|
|
2579
|
+
*/
|
|
2580
|
+
readonly id?: string;
|
|
2581
|
+
/**
|
|
2582
|
+
* The name of the promotion.
|
|
2583
|
+
*/
|
|
2584
|
+
name?: string;
|
|
2585
|
+
/**
|
|
2586
|
+
* The description of the promotion.
|
|
2587
|
+
*/
|
|
2588
|
+
description?: string;
|
|
2589
|
+
/**
|
|
2590
|
+
* Whether the promotion is applied automatically.
|
|
2591
|
+
*/
|
|
2592
|
+
automatic?: boolean;
|
|
2593
|
+
/**
|
|
2594
|
+
* The type of promotion (for v1 promotions).
|
|
2595
|
+
*/
|
|
2596
|
+
promotion_type?: string;
|
|
2597
|
+
/**
|
|
2598
|
+
* The source of the promotion (for rule promotions).
|
|
2599
|
+
*/
|
|
2600
|
+
promotion_source?: string;
|
|
2601
|
+
/**
|
|
2602
|
+
* The start date and time of the promotion.
|
|
2603
|
+
*/
|
|
2604
|
+
start?: Date;
|
|
2605
|
+
/**
|
|
2606
|
+
* The end date and time of the promotion.
|
|
2607
|
+
*/
|
|
2608
|
+
end?: Date;
|
|
2609
|
+
};
|
|
2610
|
+
type CartEntityResponse = {
|
|
2611
|
+
data: CartResponse;
|
|
2612
|
+
/**
|
|
2613
|
+
* Related objects that are included in the response.
|
|
2614
|
+
*/
|
|
2615
|
+
included?: CartIncluded;
|
|
2616
|
+
/**
|
|
2617
|
+
* Additional metadata for the cart response.
|
|
2618
|
+
*/
|
|
2619
|
+
meta?: {
|
|
2406
2620
|
/**
|
|
2407
|
-
*
|
|
2621
|
+
* Payment intent details with nested structure including status and other Stripe payment intent fields
|
|
2408
2622
|
*/
|
|
2409
|
-
|
|
2623
|
+
payment_intent?: {
|
|
2410
2624
|
[key: string]: unknown;
|
|
2411
2625
|
};
|
|
2412
|
-
/**
|
|
2413
|
-
* Array of component products for the selected options.
|
|
2414
|
-
*/
|
|
2415
|
-
component_products?: Array<unknown>;
|
|
2416
2626
|
};
|
|
2417
2627
|
/**
|
|
2418
|
-
*
|
|
2419
|
-
*/
|
|
2420
|
-
shipping_group_id?: string;
|
|
2421
|
-
/**
|
|
2422
|
-
* The slug of a stock location.
|
|
2628
|
+
* Array of error objects, if any errors occurred.
|
|
2423
2629
|
*/
|
|
2424
|
-
|
|
2630
|
+
errors?: Array<ResponseErrorItem>;
|
|
2425
2631
|
};
|
|
2426
2632
|
type ItemPriceData = {
|
|
2427
2633
|
/**
|
|
@@ -2437,6 +2643,47 @@ type ItemPriceData = {
|
|
|
2437
2643
|
*/
|
|
2438
2644
|
readonly includes_tax?: boolean;
|
|
2439
2645
|
};
|
|
2646
|
+
type Money = {
|
|
2647
|
+
/**
|
|
2648
|
+
* Amount in minor currency units (e.g., cents).
|
|
2649
|
+
*/
|
|
2650
|
+
amount: number;
|
|
2651
|
+
/**
|
|
2652
|
+
* ISO 4217 currency code (e.g., "USD").
|
|
2653
|
+
*/
|
|
2654
|
+
currency: string;
|
|
2655
|
+
/**
|
|
2656
|
+
* Whether the amount includes tax.
|
|
2657
|
+
*/
|
|
2658
|
+
includes_tax: boolean;
|
|
2659
|
+
};
|
|
2660
|
+
type Discount = {
|
|
2661
|
+
amount: Money;
|
|
2662
|
+
/**
|
|
2663
|
+
* The discount code used, if applicable.
|
|
2664
|
+
*/
|
|
2665
|
+
code?: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* Unique identifier for the discount.
|
|
2668
|
+
*/
|
|
2669
|
+
id: string;
|
|
2670
|
+
/**
|
|
2671
|
+
* The source or origin of the promotion, if applicable.
|
|
2672
|
+
*/
|
|
2673
|
+
promotion_source?: string;
|
|
2674
|
+
/**
|
|
2675
|
+
* Indicates whether the discount applies to the entire cart.
|
|
2676
|
+
*/
|
|
2677
|
+
is_cart_discount?: boolean;
|
|
2678
|
+
/**
|
|
2679
|
+
* Order in which the discount was applied.
|
|
2680
|
+
*/
|
|
2681
|
+
ordinal?: number;
|
|
2682
|
+
/**
|
|
2683
|
+
* Identifies the specific action within a multi-action rule promotion that produced this discount.
|
|
2684
|
+
*/
|
|
2685
|
+
promotion_action_id?: string;
|
|
2686
|
+
};
|
|
2440
2687
|
type CartItemFormattedPriceData = {
|
|
2441
2688
|
/**
|
|
2442
2689
|
* The amount per each single unit.
|
|
@@ -2447,11 +2694,27 @@ type CartItemFormattedPriceData = {
|
|
|
2447
2694
|
*/
|
|
2448
2695
|
value?: FormattedPriceData;
|
|
2449
2696
|
};
|
|
2697
|
+
/**
|
|
2698
|
+
* The source of the promotion (for promotion items).
|
|
2699
|
+
*/
|
|
2700
|
+
type PromotionSource = "rule-promotion";
|
|
2450
2701
|
type CartItemResponse = {
|
|
2451
2702
|
/**
|
|
2452
|
-
* The unique
|
|
2703
|
+
* The unique identifier for the cart item.
|
|
2704
|
+
*/
|
|
2705
|
+
readonly id?: string;
|
|
2706
|
+
/**
|
|
2707
|
+
* The type of cart item.
|
|
2708
|
+
*/
|
|
2709
|
+
type?: "cart_item" | "custom_item" | "subscription_item" | "promotion_item";
|
|
2710
|
+
/**
|
|
2711
|
+
* The unique ID of the product (for cart_item type).
|
|
2453
2712
|
*/
|
|
2454
2713
|
readonly product_id?: string;
|
|
2714
|
+
/**
|
|
2715
|
+
* The unique ID of the promotion (for promotion_item type).
|
|
2716
|
+
*/
|
|
2717
|
+
readonly promotion_id?: string;
|
|
2455
2718
|
/**
|
|
2456
2719
|
* The unique ID of the subscription offering for subscription items.
|
|
2457
2720
|
*/
|
|
@@ -2464,6 +2727,14 @@ type CartItemResponse = {
|
|
|
2464
2727
|
* A description of the cart item.
|
|
2465
2728
|
*/
|
|
2466
2729
|
readonly description?: string;
|
|
2730
|
+
/**
|
|
2731
|
+
* The SKU of the cart item.
|
|
2732
|
+
*/
|
|
2733
|
+
readonly sku?: string;
|
|
2734
|
+
/**
|
|
2735
|
+
* The slug of the cart item.
|
|
2736
|
+
*/
|
|
2737
|
+
readonly slug?: string;
|
|
2467
2738
|
/**
|
|
2468
2739
|
* The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.
|
|
2469
2740
|
*/
|
|
@@ -2472,24 +2743,92 @@ type CartItemResponse = {
|
|
|
2472
2743
|
* The catalog source. Always `pim` or `legacy`.
|
|
2473
2744
|
*/
|
|
2474
2745
|
readonly catalog_source?: string;
|
|
2475
|
-
readonly image?: {
|
|
2476
|
-
/**
|
|
2477
|
-
* The MIME type for the uploaded file.
|
|
2478
|
-
*/
|
|
2479
|
-
readonly mime_type?: string;
|
|
2480
|
-
/**
|
|
2481
|
-
* The name of the image file that was uploaded.
|
|
2482
|
-
*/
|
|
2483
|
-
readonly file_name?: string;
|
|
2484
|
-
/**
|
|
2485
|
-
* The link to the image.
|
|
2486
|
-
*/
|
|
2487
|
-
readonly href?: string;
|
|
2488
|
-
};
|
|
2489
2746
|
/**
|
|
2490
|
-
*
|
|
2747
|
+
* Configuration for bundle products.
|
|
2491
2748
|
*/
|
|
2492
|
-
readonly
|
|
2749
|
+
readonly bundle_configuration?: {
|
|
2750
|
+
selected_options?: {
|
|
2751
|
+
[key: string]: {
|
|
2752
|
+
[key: string]: number;
|
|
2753
|
+
};
|
|
2754
|
+
};
|
|
2755
|
+
/**
|
|
2756
|
+
* Array of component products for bundle configuration
|
|
2757
|
+
*/
|
|
2758
|
+
component_products?: Array<{
|
|
2759
|
+
/**
|
|
2760
|
+
* Product ID
|
|
2761
|
+
*/
|
|
2762
|
+
id?: string;
|
|
2763
|
+
/**
|
|
2764
|
+
* Product type
|
|
2765
|
+
*/
|
|
2766
|
+
type?: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* Product attributes as a generic object
|
|
2769
|
+
*/
|
|
2770
|
+
attributes?: {
|
|
2771
|
+
[key: string]: unknown;
|
|
2772
|
+
};
|
|
2773
|
+
/**
|
|
2774
|
+
* Product meta information as a generic object
|
|
2775
|
+
*/
|
|
2776
|
+
meta?: {
|
|
2777
|
+
[key: string]: unknown;
|
|
2778
|
+
};
|
|
2779
|
+
/**
|
|
2780
|
+
* Product price
|
|
2781
|
+
*/
|
|
2782
|
+
price?: {
|
|
2783
|
+
[key: string]: unknown;
|
|
2784
|
+
};
|
|
2785
|
+
/**
|
|
2786
|
+
* Product relationships as a generic object
|
|
2787
|
+
*/
|
|
2788
|
+
relationships?: {
|
|
2789
|
+
[key: string]: unknown;
|
|
2790
|
+
};
|
|
2791
|
+
}>;
|
|
2792
|
+
};
|
|
2793
|
+
/**
|
|
2794
|
+
* Components of the cart item for bundle products.
|
|
2795
|
+
*/
|
|
2796
|
+
readonly components?: {
|
|
2797
|
+
[key: string]: {
|
|
2798
|
+
name?: string;
|
|
2799
|
+
options?: Array<{
|
|
2800
|
+
id?: string;
|
|
2801
|
+
quantity?: number;
|
|
2802
|
+
type?: string;
|
|
2803
|
+
}>;
|
|
2804
|
+
};
|
|
2805
|
+
};
|
|
2806
|
+
readonly image?: {
|
|
2807
|
+
/**
|
|
2808
|
+
* The MIME type for the uploaded file.
|
|
2809
|
+
*/
|
|
2810
|
+
readonly mime_type?: string;
|
|
2811
|
+
/**
|
|
2812
|
+
* The name of the image file that was uploaded.
|
|
2813
|
+
*/
|
|
2814
|
+
readonly file_name?: string;
|
|
2815
|
+
/**
|
|
2816
|
+
* The link to the image.
|
|
2817
|
+
*/
|
|
2818
|
+
readonly href?: string;
|
|
2819
|
+
};
|
|
2820
|
+
/**
|
|
2821
|
+
* The quantity of the cart item.
|
|
2822
|
+
*/
|
|
2823
|
+
readonly quantity?: number;
|
|
2824
|
+
/**
|
|
2825
|
+
* The quantity automatically added (for gift items).
|
|
2826
|
+
*/
|
|
2827
|
+
readonly auto_add_quantity?: number;
|
|
2828
|
+
/**
|
|
2829
|
+
* Whether or not the quantity of the item will be checked against inventory.
|
|
2830
|
+
*/
|
|
2831
|
+
readonly manage_stock?: boolean;
|
|
2493
2832
|
/**
|
|
2494
2833
|
* The unit price of the item.
|
|
2495
2834
|
*/
|
|
@@ -2498,11 +2837,38 @@ type CartItemResponse = {
|
|
|
2498
2837
|
* The total price of the item (i.e., unit * quantity).
|
|
2499
2838
|
*/
|
|
2500
2839
|
value?: ItemPriceData;
|
|
2840
|
+
/**
|
|
2841
|
+
* Array of discounts applied to the cart item.
|
|
2842
|
+
*/
|
|
2843
|
+
readonly discounts?: Array<Discount>;
|
|
2844
|
+
/**
|
|
2845
|
+
* Custom inputs for personalized products.
|
|
2846
|
+
*/
|
|
2847
|
+
readonly custom_inputs?: {
|
|
2848
|
+
[key: string]: unknown;
|
|
2849
|
+
};
|
|
2850
|
+
/**
|
|
2851
|
+
* Configuration for subscription items.
|
|
2852
|
+
*/
|
|
2853
|
+
readonly subscription_configuration?: {
|
|
2854
|
+
/**
|
|
2855
|
+
* The subscription plan ID.
|
|
2856
|
+
*/
|
|
2857
|
+
plan?: string;
|
|
2858
|
+
/**
|
|
2859
|
+
* The subscription pricing option ID.
|
|
2860
|
+
*/
|
|
2861
|
+
pricing_option?: string;
|
|
2862
|
+
};
|
|
2501
2863
|
readonly links?: {
|
|
2502
2864
|
/**
|
|
2503
2865
|
* A URL related to the resource.
|
|
2504
2866
|
*/
|
|
2505
2867
|
product?: string;
|
|
2868
|
+
/**
|
|
2869
|
+
* A URL related to the subscription offering resource.
|
|
2870
|
+
*/
|
|
2871
|
+
subscription_offering?: string;
|
|
2506
2872
|
};
|
|
2507
2873
|
readonly meta?: {
|
|
2508
2874
|
display_price?: {
|
|
@@ -2523,101 +2889,283 @@ type CartItemResponse = {
|
|
|
2523
2889
|
*/
|
|
2524
2890
|
discount?: CartItemFormattedPriceData;
|
|
2525
2891
|
without_discount?: CartItemFormattedPriceData;
|
|
2892
|
+
/**
|
|
2893
|
+
* 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).
|
|
2894
|
+
*/
|
|
2895
|
+
original_price?: CartItemFormattedPriceData;
|
|
2896
|
+
/**
|
|
2897
|
+
* Detailed discount information.
|
|
2898
|
+
*/
|
|
2899
|
+
discounts?: {
|
|
2900
|
+
[key: string]: {
|
|
2901
|
+
/**
|
|
2902
|
+
* The discount amount.
|
|
2903
|
+
*/
|
|
2904
|
+
amount: number;
|
|
2905
|
+
/**
|
|
2906
|
+
* The currency code.
|
|
2907
|
+
*/
|
|
2908
|
+
currency: string;
|
|
2909
|
+
/**
|
|
2910
|
+
* The formatted discount amount.
|
|
2911
|
+
*/
|
|
2912
|
+
formatted: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* The discount constituents.
|
|
2915
|
+
*/
|
|
2916
|
+
constituents?: {
|
|
2917
|
+
[key: string]: FormattedPriceData;
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
};
|
|
2526
2921
|
};
|
|
2527
2922
|
timestamps?: CartCheckoutTimestamps;
|
|
2528
2923
|
};
|
|
2529
|
-
};
|
|
2530
|
-
type CartItemObject = CartItemObjectData & CartItemResponse;
|
|
2531
|
-
type CustomItemObjectData = {
|
|
2532
|
-
/**
|
|
2533
|
-
* The type of object being returned. Must be `custom_item`.
|
|
2534
|
-
*/
|
|
2535
|
-
type: "custom_item";
|
|
2536
2924
|
/**
|
|
2537
|
-
*
|
|
2925
|
+
* Relationships to other resources.
|
|
2538
2926
|
*/
|
|
2539
|
-
|
|
2540
|
-
price: {
|
|
2927
|
+
readonly relationships?: {
|
|
2541
2928
|
/**
|
|
2542
|
-
*
|
|
2929
|
+
* Related tax items.
|
|
2543
2930
|
*/
|
|
2544
|
-
|
|
2931
|
+
taxes?: {
|
|
2932
|
+
data?: null | Array<RelationshipItem>;
|
|
2933
|
+
};
|
|
2545
2934
|
/**
|
|
2546
|
-
*
|
|
2935
|
+
* Related custom discounts.
|
|
2547
2936
|
*/
|
|
2548
|
-
|
|
2937
|
+
custom_discounts?: {
|
|
2938
|
+
data?: null | Array<RelationshipItem>;
|
|
2939
|
+
};
|
|
2940
|
+
/**
|
|
2941
|
+
* Related promotions.
|
|
2942
|
+
*/
|
|
2943
|
+
promotions?: {
|
|
2944
|
+
data?: null | Array<RelationshipItem>;
|
|
2945
|
+
};
|
|
2549
2946
|
};
|
|
2550
2947
|
/**
|
|
2551
|
-
*
|
|
2948
|
+
* The shipping group ID for this item.
|
|
2552
2949
|
*/
|
|
2553
|
-
|
|
2950
|
+
readonly shipping_group_id?: string;
|
|
2554
2951
|
/**
|
|
2555
|
-
* The
|
|
2952
|
+
* The source of the promotion (for promotion items).
|
|
2556
2953
|
*/
|
|
2557
|
-
|
|
2954
|
+
promotion_source?: "rule-promotion";
|
|
2558
2955
|
/**
|
|
2559
|
-
* The
|
|
2956
|
+
* The action ID within the rule promotion that produced this promotion item.
|
|
2560
2957
|
*/
|
|
2561
|
-
|
|
2958
|
+
readonly promotion_action_id?: string;
|
|
2562
2959
|
/**
|
|
2563
|
-
* The
|
|
2960
|
+
* The stock location for this item.
|
|
2564
2961
|
*/
|
|
2565
|
-
|
|
2566
|
-
[key: string]: unknown;
|
|
2567
|
-
};
|
|
2962
|
+
readonly location?: string;
|
|
2568
2963
|
/**
|
|
2569
|
-
*
|
|
2964
|
+
* Custom attributes attached to the cart item.
|
|
2570
2965
|
*/
|
|
2571
|
-
|
|
2572
|
-
};
|
|
2573
|
-
type CustomItemObject = {
|
|
2574
|
-
data?: CustomItemObjectData;
|
|
2966
|
+
custom_attributes?: CustomAttributes;
|
|
2575
2967
|
};
|
|
2576
|
-
type
|
|
2968
|
+
type TaxItemResponse = {
|
|
2577
2969
|
/**
|
|
2578
|
-
*
|
|
2970
|
+
* Specifies the type of the resource. Always `tax_item`.
|
|
2579
2971
|
*/
|
|
2580
|
-
type
|
|
2972
|
+
type?: "tax_item";
|
|
2581
2973
|
/**
|
|
2582
|
-
*
|
|
2974
|
+
* Specifies the UUID of the tax item.
|
|
2583
2975
|
*/
|
|
2584
|
-
|
|
2976
|
+
readonly id?: string;
|
|
2585
2977
|
/**
|
|
2586
|
-
*
|
|
2978
|
+
* The jurisdiction for the tax item.
|
|
2587
2979
|
*/
|
|
2588
|
-
|
|
2980
|
+
jurisdiction?: string;
|
|
2589
2981
|
/**
|
|
2590
|
-
*
|
|
2982
|
+
* The tax code for the tax item.
|
|
2591
2983
|
*/
|
|
2592
|
-
|
|
2984
|
+
code?: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* The name of the tax item.
|
|
2987
|
+
*/
|
|
2988
|
+
name?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
* The tax rate as a decimal (e.g., 0.085 for 8.5%).
|
|
2991
|
+
*/
|
|
2992
|
+
rate?: number;
|
|
2993
|
+
/**
|
|
2994
|
+
* The tax amount in the smallest currency unit.
|
|
2995
|
+
*/
|
|
2996
|
+
amount?: number;
|
|
2997
|
+
};
|
|
2998
|
+
type CartItemCollectionResponse = {
|
|
2999
|
+
data: Array<CartItemResponse>;
|
|
3000
|
+
/**
|
|
3001
|
+
* Related objects that are included in the response.
|
|
3002
|
+
*/
|
|
3003
|
+
included?: {
|
|
3004
|
+
custom_discounts?: Array<CustomDiscountResponse>;
|
|
3005
|
+
promotions?: Array<{
|
|
3006
|
+
automatic?: boolean;
|
|
3007
|
+
description?: string;
|
|
3008
|
+
end?: Date;
|
|
3009
|
+
id?: string;
|
|
3010
|
+
name?: string;
|
|
3011
|
+
promotion_type?: string;
|
|
3012
|
+
/**
|
|
3013
|
+
* The source of the promotion
|
|
3014
|
+
*/
|
|
3015
|
+
promotion_source?: string;
|
|
3016
|
+
start?: Date;
|
|
3017
|
+
type?: "promotion";
|
|
3018
|
+
}>;
|
|
2593
3019
|
/**
|
|
2594
|
-
*
|
|
3020
|
+
* Array of tax items included in the response.
|
|
2595
3021
|
*/
|
|
2596
|
-
|
|
3022
|
+
tax_items?: Array<TaxItemResponse>;
|
|
3023
|
+
};
|
|
3024
|
+
/**
|
|
3025
|
+
* Additional meta information about the cart items collection.
|
|
3026
|
+
*/
|
|
3027
|
+
meta?: {
|
|
3028
|
+
display_price?: {
|
|
3029
|
+
with_tax?: FormattedPriceData;
|
|
3030
|
+
without_tax?: FormattedPriceData;
|
|
3031
|
+
tax?: FormattedPriceData;
|
|
3032
|
+
discount?: FormattedPriceData;
|
|
3033
|
+
without_discount?: FormattedPriceData;
|
|
3034
|
+
shipping?: FormattedPriceData;
|
|
3035
|
+
shipping_discount?: FormattedPriceData;
|
|
3036
|
+
authorized?: FormattedPriceData;
|
|
3037
|
+
balance_owing?: FormattedPriceData;
|
|
3038
|
+
paid?: FormattedPriceData;
|
|
3039
|
+
};
|
|
3040
|
+
timestamps?: CartTimestamps;
|
|
2597
3041
|
/**
|
|
2598
|
-
*
|
|
3042
|
+
* 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.
|
|
3043
|
+
*
|
|
2599
3044
|
*/
|
|
2600
|
-
|
|
3045
|
+
messages?: Array<{
|
|
3046
|
+
/**
|
|
3047
|
+
* Identifies the cart item that triggered this message
|
|
3048
|
+
*/
|
|
3049
|
+
source?: {
|
|
3050
|
+
/**
|
|
3051
|
+
* The type of the source item
|
|
3052
|
+
*/
|
|
3053
|
+
type: string;
|
|
3054
|
+
/**
|
|
3055
|
+
* The unique identifier of the source item
|
|
3056
|
+
*/
|
|
3057
|
+
id: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* The promotion code (present when source type is promotion)
|
|
3060
|
+
*/
|
|
3061
|
+
code?: string;
|
|
3062
|
+
};
|
|
3063
|
+
/**
|
|
3064
|
+
* A short descriptive title for the message
|
|
3065
|
+
*/
|
|
3066
|
+
title: string;
|
|
3067
|
+
/**
|
|
3068
|
+
* A detailed description of the message
|
|
3069
|
+
*/
|
|
3070
|
+
description: string;
|
|
3071
|
+
}>;
|
|
3072
|
+
/**
|
|
3073
|
+
* Array of promotion suggestions
|
|
3074
|
+
*/
|
|
3075
|
+
promotion_suggestions?: Array<{
|
|
3076
|
+
/**
|
|
3077
|
+
* Bundle configuration with promotion targets
|
|
3078
|
+
*/
|
|
3079
|
+
bundle?: Array<{
|
|
3080
|
+
/**
|
|
3081
|
+
* Whether to automatically add free gift
|
|
3082
|
+
*/
|
|
3083
|
+
auto_add_free_gift?: boolean;
|
|
3084
|
+
/**
|
|
3085
|
+
* Cart item ID for the target
|
|
3086
|
+
*/
|
|
3087
|
+
cart_item_id?: string;
|
|
3088
|
+
/**
|
|
3089
|
+
* Quantity for the promotion
|
|
3090
|
+
*/
|
|
3091
|
+
quantity?: number;
|
|
3092
|
+
/**
|
|
3093
|
+
* Array of target SKUs
|
|
3094
|
+
*/
|
|
3095
|
+
targets?: Array<string>;
|
|
3096
|
+
[key: string]: unknown | boolean | string | number | Array<string> | undefined;
|
|
3097
|
+
}>;
|
|
3098
|
+
code?: string;
|
|
3099
|
+
info?: string;
|
|
3100
|
+
message?: string;
|
|
3101
|
+
promotion_id?: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* Whether this promotion should be automatically added
|
|
3104
|
+
*/
|
|
3105
|
+
auto_add?: boolean;
|
|
3106
|
+
/**
|
|
3107
|
+
* Array of promotion targets (alternative structure)
|
|
3108
|
+
*/
|
|
3109
|
+
targets?: Array<{
|
|
3110
|
+
/**
|
|
3111
|
+
* The cart item ID for this target
|
|
3112
|
+
*/
|
|
3113
|
+
cart_item_id?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* The quantity for this target
|
|
3116
|
+
*/
|
|
3117
|
+
quantity?: number;
|
|
3118
|
+
/**
|
|
3119
|
+
* Array of SKU codes for this target
|
|
3120
|
+
*/
|
|
3121
|
+
skus?: Array<string>;
|
|
3122
|
+
}>;
|
|
3123
|
+
}>;
|
|
2601
3124
|
};
|
|
3125
|
+
/**
|
|
3126
|
+
* Array of error objects, if any errors occurred.
|
|
3127
|
+
*/
|
|
3128
|
+
errors?: Array<ResponseErrorItem>;
|
|
2602
3129
|
};
|
|
2603
|
-
type
|
|
2604
|
-
data?: SubscriptionItemObjectData & CartItemResponse;
|
|
2605
|
-
};
|
|
2606
|
-
type PromotionItemObjectData = {
|
|
3130
|
+
type BulkUpdateCartsItemsCommon = {
|
|
2607
3131
|
/**
|
|
2608
|
-
* Specifies the
|
|
3132
|
+
* Specifies the ID of the cart item that you want to update in cart.
|
|
2609
3133
|
*/
|
|
2610
|
-
|
|
3134
|
+
id?: string;
|
|
2611
3135
|
/**
|
|
2612
|
-
* Specifies the
|
|
3136
|
+
* Specifies the amount of items to update in the cart.
|
|
2613
3137
|
*/
|
|
2614
|
-
|
|
3138
|
+
quantity?: number;
|
|
3139
|
+
/**
|
|
3140
|
+
* The type of cart item being updated.
|
|
3141
|
+
*/
|
|
3142
|
+
type?: "cart_item" | "custom_item";
|
|
3143
|
+
/**
|
|
3144
|
+
* 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).
|
|
3145
|
+
*/
|
|
3146
|
+
custom_inputs?: {
|
|
3147
|
+
[key: string]: unknown;
|
|
3148
|
+
};
|
|
3149
|
+
/**
|
|
3150
|
+
* Specifies custom attributes to be added to the cart item.
|
|
3151
|
+
*/
|
|
3152
|
+
custom_attributes?: CustomAttributes;
|
|
3153
|
+
/**
|
|
3154
|
+
* Specifies the shipping group ID for the cart item.
|
|
3155
|
+
*/
|
|
3156
|
+
shipping_group_id?: string;
|
|
2615
3157
|
};
|
|
2616
|
-
type
|
|
2617
|
-
|
|
3158
|
+
type BulkUpdateCartsItemsWithQuantity = BulkUpdateCartsItemsCommon & {
|
|
3159
|
+
quantity: unknown;
|
|
3160
|
+
id: unknown;
|
|
2618
3161
|
};
|
|
2619
|
-
type
|
|
2620
|
-
|
|
3162
|
+
type BulkUpdateCartsItemsWithShippingGroup = BulkUpdateCartsItemsCommon & {
|
|
3163
|
+
shipping_group_id: unknown;
|
|
3164
|
+
id: unknown;
|
|
3165
|
+
};
|
|
3166
|
+
type BulkUpdateCartsItemsWithCustomInputs = BulkUpdateCartsItemsCommon & {
|
|
3167
|
+
custom_inputs: unknown;
|
|
3168
|
+
id: unknown;
|
|
2621
3169
|
};
|
|
2622
3170
|
type UpdateAllOrNothingOptionsObject = {
|
|
2623
3171
|
/**
|
|
@@ -2626,28 +3174,98 @@ type UpdateAllOrNothingOptionsObject = {
|
|
|
2626
3174
|
update_all_or_nothing?: boolean;
|
|
2627
3175
|
};
|
|
2628
3176
|
type BulkUpdateCartsItems = {
|
|
2629
|
-
data?: Array<
|
|
2630
|
-
/**
|
|
2631
|
-
* Specifies the ID of the cart item that you want to update in cart.
|
|
2632
|
-
*/
|
|
2633
|
-
id?: string;
|
|
2634
|
-
/**
|
|
2635
|
-
* Specifies the amount of items to update in the cart.
|
|
2636
|
-
*/
|
|
2637
|
-
quantity?: number;
|
|
2638
|
-
/**
|
|
2639
|
-
* 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).
|
|
2640
|
-
*/
|
|
2641
|
-
custom_inputs?: {
|
|
2642
|
-
[key: string]: unknown;
|
|
2643
|
-
};
|
|
2644
|
-
}>;
|
|
3177
|
+
data?: Array<BulkUpdateCartsItemsWithQuantity | BulkUpdateCartsItemsWithShippingGroup | BulkUpdateCartsItemsWithCustomInputs>;
|
|
2645
3178
|
options?: UpdateAllOrNothingOptionsObject;
|
|
2646
3179
|
};
|
|
2647
|
-
type
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
3180
|
+
type BaseItemObjectData = {
|
|
3181
|
+
/**
|
|
3182
|
+
* The number of items to add.
|
|
3183
|
+
*/
|
|
3184
|
+
quantity: number;
|
|
3185
|
+
/**
|
|
3186
|
+
* Specifies the ID of the product you want to add. (use this OR sku)
|
|
3187
|
+
*/
|
|
3188
|
+
id?: string;
|
|
3189
|
+
/**
|
|
3190
|
+
* Specifies the item SKU that you want to add. (use this OR id)
|
|
3191
|
+
*/
|
|
3192
|
+
sku?: string;
|
|
3193
|
+
/**
|
|
3194
|
+
* Optional name for the product item. If not provided, the product name from catalog will be used.
|
|
3195
|
+
*/
|
|
3196
|
+
name?: string;
|
|
3197
|
+
/**
|
|
3198
|
+
* The custom text to be added to a product.
|
|
3199
|
+
*/
|
|
3200
|
+
custom_inputs?: {
|
|
3201
|
+
[key: string]: unknown;
|
|
3202
|
+
};
|
|
3203
|
+
/**
|
|
3204
|
+
* Object used to describe the bundle options selected.
|
|
3205
|
+
*/
|
|
3206
|
+
bundle_configuration?: {
|
|
3207
|
+
/**
|
|
3208
|
+
* Specifies selected options.
|
|
3209
|
+
*/
|
|
3210
|
+
selected_options?: {
|
|
3211
|
+
[key: string]: unknown;
|
|
3212
|
+
};
|
|
3213
|
+
/**
|
|
3214
|
+
* Array of component products for the selected options.
|
|
3215
|
+
*/
|
|
3216
|
+
component_products?: Array<unknown>;
|
|
3217
|
+
};
|
|
3218
|
+
/**
|
|
3219
|
+
* Identifier for a Shipping Group
|
|
3220
|
+
*/
|
|
3221
|
+
shipping_group_id?: string;
|
|
3222
|
+
/**
|
|
3223
|
+
* The slug of a stock location.
|
|
3224
|
+
*/
|
|
3225
|
+
location?: string;
|
|
3226
|
+
custom_attributes?: CustomAttributes;
|
|
3227
|
+
};
|
|
3228
|
+
type CartItemObjectData = {
|
|
3229
|
+
/**
|
|
3230
|
+
* The type of object being returned. Must be `cart_item` for cart items.
|
|
3231
|
+
*/
|
|
3232
|
+
type: "cart_item";
|
|
3233
|
+
} & BaseItemObjectData;
|
|
3234
|
+
type CartItemObjectRequest = {
|
|
3235
|
+
data?: CartItemObjectData;
|
|
3236
|
+
};
|
|
3237
|
+
type SubscriptionItemObjectData = {
|
|
3238
|
+
/**
|
|
3239
|
+
* The type of object being returned.
|
|
3240
|
+
*/
|
|
3241
|
+
type: "subscription_item";
|
|
3242
|
+
/**
|
|
3243
|
+
* The number of items added to the cart.
|
|
3244
|
+
*/
|
|
3245
|
+
quantity: number;
|
|
3246
|
+
/**
|
|
3247
|
+
* Specifies the ID of the subscription offering you want to add to cart.
|
|
3248
|
+
*/
|
|
3249
|
+
id: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* Specifies how the subscription offering should be configured.
|
|
3252
|
+
*/
|
|
3253
|
+
subscription_configuration: {
|
|
3254
|
+
/**
|
|
3255
|
+
* The ID of the pricing option within the offering to use for the subscription.
|
|
3256
|
+
*/
|
|
3257
|
+
pricing_option: string;
|
|
3258
|
+
/**
|
|
3259
|
+
* The ID of the plan within the offering to use for the subscription.
|
|
3260
|
+
* @deprecated
|
|
3261
|
+
*/
|
|
3262
|
+
plan: string;
|
|
3263
|
+
};
|
|
3264
|
+
};
|
|
3265
|
+
type SubscriptionItemObject = {
|
|
3266
|
+
data?: SubscriptionItemObjectData & CartItemResponse;
|
|
3267
|
+
};
|
|
3268
|
+
type CartMergeObject = {
|
|
2651
3269
|
/**
|
|
2652
3270
|
* The type of object being returned. Must be `cart_items`.
|
|
2653
3271
|
*/
|
|
@@ -2667,6 +3285,52 @@ type CartMergeObjectRequest = {
|
|
|
2667
3285
|
data?: CartMergeObject;
|
|
2668
3286
|
options?: AddAllOrNothingOptionsObject;
|
|
2669
3287
|
};
|
|
3288
|
+
type CustomItemObjectData = {
|
|
3289
|
+
/**
|
|
3290
|
+
* The type of object being returned. Must be `custom_item`.
|
|
3291
|
+
*/
|
|
3292
|
+
type: "custom_item";
|
|
3293
|
+
/**
|
|
3294
|
+
* The number of custom items to add to cart.
|
|
3295
|
+
*/
|
|
3296
|
+
quantity: number;
|
|
3297
|
+
price: {
|
|
3298
|
+
/**
|
|
3299
|
+
* The unit price of the custom item.
|
|
3300
|
+
*/
|
|
3301
|
+
amount: number;
|
|
3302
|
+
/**
|
|
3303
|
+
* Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.
|
|
3304
|
+
*/
|
|
3305
|
+
includes_tax?: boolean;
|
|
3306
|
+
};
|
|
3307
|
+
/**
|
|
3308
|
+
* A description of the custom item.
|
|
3309
|
+
*/
|
|
3310
|
+
description?: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* 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.
|
|
3313
|
+
*/
|
|
3314
|
+
sku?: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* The name of the custom item.
|
|
3317
|
+
*/
|
|
3318
|
+
name: string;
|
|
3319
|
+
/**
|
|
3320
|
+
* The custom text to be added to a product.
|
|
3321
|
+
*/
|
|
3322
|
+
custom_inputs?: {
|
|
3323
|
+
[key: string]: unknown;
|
|
3324
|
+
};
|
|
3325
|
+
/**
|
|
3326
|
+
* Identifier for a created Cart Shipping Group
|
|
3327
|
+
*/
|
|
3328
|
+
shipping_group_id?: string;
|
|
3329
|
+
custom_attributes?: CustomAttributes;
|
|
3330
|
+
};
|
|
3331
|
+
type CustomItemObject = {
|
|
3332
|
+
data?: CustomItemObjectData;
|
|
3333
|
+
};
|
|
2670
3334
|
type ReOrderObject = {
|
|
2671
3335
|
/**
|
|
2672
3336
|
* The type of resource being returned. Use `order_items`.
|
|
@@ -2681,35 +3345,23 @@ type ReOrderObjectRequest = {
|
|
|
2681
3345
|
data?: ReOrderObject;
|
|
2682
3346
|
options?: AddAllOrNothingOptionsObject;
|
|
2683
3347
|
};
|
|
3348
|
+
type PromotionItemObjectData = {
|
|
3349
|
+
/**
|
|
3350
|
+
* Specifies the type of resource, which is `promotion_item`.
|
|
3351
|
+
*/
|
|
3352
|
+
type: "promotion_item";
|
|
3353
|
+
/**
|
|
3354
|
+
* Specifies the promotion code. For more information about codes[].user[], see the [Create Promotion codes](/docs/api/promotions/create-promotion-codes) section.
|
|
3355
|
+
*/
|
|
3356
|
+
code: string;
|
|
3357
|
+
};
|
|
3358
|
+
type PromotionItemObject = {
|
|
3359
|
+
data?: PromotionItemObjectData;
|
|
3360
|
+
};
|
|
2684
3361
|
type BulkAddItemsRequest = {
|
|
2685
3362
|
data?: Array<CartItemObjectData | CartMergeObject | CustomItemObjectData | ReOrderObject | PromotionItemObjectData>;
|
|
2686
3363
|
options?: AddAllOrNothingOptionsObject;
|
|
2687
3364
|
};
|
|
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
3365
|
type UpdateCartsItems = {
|
|
2714
3366
|
data?: {
|
|
2715
3367
|
/**
|
|
@@ -2730,6 +3382,10 @@ type UpdateCartsItems = {
|
|
|
2730
3382
|
custom_inputs?: {
|
|
2731
3383
|
[key: string]: unknown;
|
|
2732
3384
|
};
|
|
3385
|
+
/**
|
|
3386
|
+
* Custom attributes to be added to the cart item.
|
|
3387
|
+
*/
|
|
3388
|
+
custom_attributes?: CustomAttributes;
|
|
2733
3389
|
/**
|
|
2734
3390
|
* The unique identifier of the shipping group to be added to the cart.
|
|
2735
3391
|
*/
|
|
@@ -2760,7 +3416,7 @@ type CartsRelationshipsCustomersData = {
|
|
|
2760
3416
|
type?: string;
|
|
2761
3417
|
}>;
|
|
2762
3418
|
};
|
|
2763
|
-
type
|
|
3419
|
+
type CartsItemsTaxesCommon = {
|
|
2764
3420
|
/**
|
|
2765
3421
|
* A unique tax code in this jurisdiction.
|
|
2766
3422
|
*/
|
|
@@ -2774,43 +3430,75 @@ type CartsItemsTaxesObject = {
|
|
|
2774
3430
|
*/
|
|
2775
3431
|
name?: string;
|
|
2776
3432
|
/**
|
|
2777
|
-
* The tax rate
|
|
3433
|
+
* The tax rate as a decimal (12.5% -> 0.125). You must specify either `rate` or `amount`, but not both.
|
|
3434
|
+
*
|
|
2778
3435
|
*/
|
|
2779
3436
|
rate?: number;
|
|
2780
3437
|
/**
|
|
2781
|
-
* The tax
|
|
3438
|
+
* 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.
|
|
3439
|
+
*
|
|
2782
3440
|
*/
|
|
2783
3441
|
amount?: number;
|
|
2784
3442
|
/**
|
|
2785
3443
|
* The type of object being returned. Use `tax_item`.
|
|
2786
3444
|
*/
|
|
2787
|
-
type:
|
|
3445
|
+
type: "tax_item";
|
|
2788
3446
|
/**
|
|
2789
3447
|
* The unique identifier for this tax item.
|
|
2790
3448
|
*/
|
|
2791
3449
|
readonly id?: string;
|
|
2792
3450
|
};
|
|
3451
|
+
type CartsItemsTaxesWithRate = CartsItemsTaxesCommon & {
|
|
3452
|
+
/**
|
|
3453
|
+
* The tax rate as a decimal (12.5% -> 0.125). Required when using rate-based taxation.
|
|
3454
|
+
*
|
|
3455
|
+
*/
|
|
3456
|
+
rate: number;
|
|
3457
|
+
/**
|
|
3458
|
+
* The tax as an absolute amount. Not allowed when rate is specified.
|
|
3459
|
+
*
|
|
3460
|
+
*/
|
|
3461
|
+
amount?: number;
|
|
3462
|
+
};
|
|
3463
|
+
type CartsItemsTaxesWithAmount = CartsItemsTaxesCommon & {
|
|
3464
|
+
/**
|
|
3465
|
+
* The tax as an absolute amount in the smallest currency unit (e.g., $10 -> 1000). Required when using amount-based taxation.
|
|
3466
|
+
*
|
|
3467
|
+
*/
|
|
3468
|
+
amount: number;
|
|
3469
|
+
/**
|
|
3470
|
+
* The tax rate as a decimal. Not allowed when amount is specified.
|
|
3471
|
+
*
|
|
3472
|
+
*/
|
|
3473
|
+
rate?: number;
|
|
3474
|
+
};
|
|
3475
|
+
/**
|
|
3476
|
+
* 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.
|
|
3477
|
+
*
|
|
3478
|
+
*/
|
|
3479
|
+
type CartsItemsTaxesObject = CartsItemsTaxesWithRate | CartsItemsTaxesWithAmount;
|
|
2793
3480
|
type CartItemTaxesEntityResponse = {
|
|
2794
3481
|
data: CartsItemsTaxesObject;
|
|
2795
3482
|
};
|
|
2796
3483
|
type CartItemRelationship = {
|
|
2797
3484
|
relationships?: {
|
|
2798
|
-
|
|
2799
|
-
data
|
|
3485
|
+
item: {
|
|
3486
|
+
data: {
|
|
2800
3487
|
/**
|
|
2801
|
-
*
|
|
3488
|
+
* Specifies the type of item. For example, `custom_item` or `cart_item`.
|
|
2802
3489
|
*/
|
|
2803
|
-
type
|
|
3490
|
+
type: string;
|
|
2804
3491
|
/**
|
|
2805
|
-
*
|
|
3492
|
+
* Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
|
|
2806
3493
|
*/
|
|
2807
|
-
id
|
|
3494
|
+
id: string;
|
|
2808
3495
|
};
|
|
2809
3496
|
};
|
|
2810
3497
|
};
|
|
2811
3498
|
};
|
|
2812
3499
|
type CartsBulkTaxes = {
|
|
2813
3500
|
data?: Array<CartsItemsTaxesObject & CartItemRelationship>;
|
|
3501
|
+
errors?: Array<ResponseErrorItem>;
|
|
2814
3502
|
options?: AddAllOrNothingOptionsObject;
|
|
2815
3503
|
};
|
|
2816
3504
|
type CartsCustomDiscountsObject = {
|
|
@@ -2838,7 +3526,25 @@ type CartsCustomDiscountsObject = {
|
|
|
2838
3526
|
/**
|
|
2839
3527
|
* Specifies the type of the resource. Always `custom_discount`.
|
|
2840
3528
|
*/
|
|
2841
|
-
type:
|
|
3529
|
+
type: "custom_discount";
|
|
3530
|
+
/**
|
|
3531
|
+
* Specifies the UUID of the custom discount.
|
|
3532
|
+
*/
|
|
3533
|
+
id?: string;
|
|
3534
|
+
/**
|
|
3535
|
+
* Relationships to other resources like cart items
|
|
3536
|
+
*/
|
|
3537
|
+
relationships?: {
|
|
3538
|
+
item?: {
|
|
3539
|
+
data?: {
|
|
3540
|
+
/**
|
|
3541
|
+
* The item ID this discount is related to
|
|
3542
|
+
*/
|
|
3543
|
+
id?: string;
|
|
3544
|
+
type?: "cart_item" | "custom_item";
|
|
3545
|
+
};
|
|
3546
|
+
};
|
|
3547
|
+
};
|
|
2842
3548
|
};
|
|
2843
3549
|
type CustomDiscountRelationshipsCartItemRequest = {
|
|
2844
3550
|
relationships?: {
|
|
@@ -2847,11 +3553,11 @@ type CustomDiscountRelationshipsCartItemRequest = {
|
|
|
2847
3553
|
/**
|
|
2848
3554
|
* Specifies the type of item. For example, `custom_item` or `cart_item`.
|
|
2849
3555
|
*/
|
|
2850
|
-
type
|
|
3556
|
+
type: string;
|
|
2851
3557
|
/**
|
|
2852
3558
|
* Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.
|
|
2853
3559
|
*/
|
|
2854
|
-
id
|
|
3560
|
+
id: string;
|
|
2855
3561
|
};
|
|
2856
3562
|
};
|
|
2857
3563
|
};
|
|
@@ -2863,11 +3569,17 @@ type CartsBulkCustomDiscounts = {
|
|
|
2863
3569
|
};
|
|
2864
3570
|
type CartsBulkCustomDiscountsResponse = {
|
|
2865
3571
|
data?: CartsCustomDiscountsObject;
|
|
2866
|
-
|
|
3572
|
+
/**
|
|
3573
|
+
* Array of validation or processing errors
|
|
3574
|
+
*/
|
|
3575
|
+
errors?: Array<ResponseErrorItem>;
|
|
2867
3576
|
};
|
|
2868
3577
|
type CartsBulkCustomDiscountsCollectionResponse = {
|
|
2869
3578
|
data?: Array<CartsCustomDiscountsObject>;
|
|
2870
|
-
|
|
3579
|
+
/**
|
|
3580
|
+
* Array of validation or processing errors
|
|
3581
|
+
*/
|
|
3582
|
+
errors?: Array<ResponseErrorItem>;
|
|
2871
3583
|
};
|
|
2872
3584
|
type CartsCustomDiscountsResponseObject = {
|
|
2873
3585
|
amount?: {
|
|
@@ -2903,11 +3615,25 @@ type CartsCustomDiscountsResponseObject = {
|
|
|
2903
3615
|
/**
|
|
2904
3616
|
* Specifies the type of the resource. Always `custom_discount`.
|
|
2905
3617
|
*/
|
|
2906
|
-
type?:
|
|
3618
|
+
type?: "custom_discount";
|
|
2907
3619
|
/**
|
|
2908
3620
|
* Specifies the UUID of the custom discount.
|
|
2909
3621
|
*/
|
|
2910
3622
|
readonly id?: string;
|
|
3623
|
+
/**
|
|
3624
|
+
* Relationships to other resources like cart items
|
|
3625
|
+
*/
|
|
3626
|
+
relationships?: {
|
|
3627
|
+
item?: {
|
|
3628
|
+
data?: {
|
|
3629
|
+
/**
|
|
3630
|
+
* The item ID this discount is related to
|
|
3631
|
+
*/
|
|
3632
|
+
id?: string;
|
|
3633
|
+
type?: "cart_item" | "custom_item";
|
|
3634
|
+
};
|
|
3635
|
+
};
|
|
3636
|
+
};
|
|
2911
3637
|
};
|
|
2912
3638
|
type CartsCustomDiscountsEntityRequest = {
|
|
2913
3639
|
data?: CartsCustomDiscountsResponseObject;
|
|
@@ -2918,165 +3644,455 @@ type CartsCustomDiscountsEntityResponse = {
|
|
|
2918
3644
|
type CartsCustomDiscountsCollectionResponse = {
|
|
2919
3645
|
data?: Array<CartsCustomDiscountsObject>;
|
|
2920
3646
|
};
|
|
2921
|
-
type
|
|
3647
|
+
type AddressCommon = {
|
|
2922
3648
|
/**
|
|
2923
|
-
* First name of the
|
|
3649
|
+
* First name of the recipient.
|
|
2924
3650
|
*/
|
|
2925
3651
|
first_name: string;
|
|
2926
3652
|
/**
|
|
2927
|
-
* Last name of the
|
|
3653
|
+
* Last name of the recipient.
|
|
2928
3654
|
*/
|
|
2929
3655
|
last_name: string;
|
|
2930
3656
|
/**
|
|
2931
|
-
*
|
|
3657
|
+
* Company of the recipient.
|
|
2932
3658
|
*/
|
|
2933
|
-
|
|
3659
|
+
company_name?: string;
|
|
2934
3660
|
/**
|
|
2935
|
-
*
|
|
3661
|
+
* First line of the address.
|
|
2936
3662
|
*/
|
|
2937
|
-
|
|
3663
|
+
line_1: string;
|
|
2938
3664
|
/**
|
|
2939
|
-
*
|
|
3665
|
+
* Second line of the address.
|
|
2940
3666
|
*/
|
|
2941
|
-
|
|
3667
|
+
line_2?: string;
|
|
2942
3668
|
/**
|
|
2943
|
-
*
|
|
3669
|
+
* Third line of the address.
|
|
2944
3670
|
*/
|
|
2945
|
-
|
|
3671
|
+
line_3?: string;
|
|
2946
3672
|
/**
|
|
2947
|
-
* City of the
|
|
3673
|
+
* City of the address.
|
|
2948
3674
|
*/
|
|
2949
|
-
city
|
|
3675
|
+
city?: string;
|
|
2950
3676
|
/**
|
|
2951
|
-
* Post code of the
|
|
3677
|
+
* Post code of the address.
|
|
2952
3678
|
*/
|
|
2953
3679
|
postcode: string;
|
|
2954
3680
|
/**
|
|
2955
|
-
* County of the
|
|
3681
|
+
* County of the address.
|
|
2956
3682
|
*/
|
|
2957
|
-
county
|
|
3683
|
+
county?: string;
|
|
2958
3684
|
/**
|
|
2959
|
-
* Country of the
|
|
3685
|
+
* Country of the address.
|
|
2960
3686
|
*/
|
|
2961
3687
|
country: string;
|
|
2962
3688
|
/**
|
|
2963
|
-
* State, province, or region of the
|
|
3689
|
+
* State, province, or region of the address.
|
|
2964
3690
|
*/
|
|
2965
3691
|
region?: string;
|
|
3692
|
+
};
|
|
3693
|
+
type AddressWithRegion = AddressCommon & {
|
|
3694
|
+
/**
|
|
3695
|
+
* State, province, or region of the address.
|
|
3696
|
+
*/
|
|
3697
|
+
region: string;
|
|
3698
|
+
};
|
|
3699
|
+
type AddressWithCounty = AddressCommon & {
|
|
3700
|
+
/**
|
|
3701
|
+
* County of the address.
|
|
3702
|
+
*/
|
|
3703
|
+
county: string;
|
|
3704
|
+
};
|
|
3705
|
+
/**
|
|
3706
|
+
* Shipping address information. You must specify at least one of region (state/province) or county.
|
|
3707
|
+
*
|
|
3708
|
+
*/
|
|
3709
|
+
type ShippingAddress = (AddressWithRegion | AddressWithCounty) & {
|
|
3710
|
+
/**
|
|
3711
|
+
* Phone number of the shipping recipient.
|
|
3712
|
+
*/
|
|
3713
|
+
phone_number?: string;
|
|
2966
3714
|
/**
|
|
2967
3715
|
* Delivery instructions.
|
|
2968
3716
|
*/
|
|
2969
|
-
instructions
|
|
3717
|
+
instructions?: string;
|
|
2970
3718
|
};
|
|
2971
3719
|
type DeliveryEstimate = {
|
|
2972
3720
|
start?: Date;
|
|
2973
3721
|
end?: Date;
|
|
2974
3722
|
};
|
|
2975
|
-
|
|
3723
|
+
/**
|
|
3724
|
+
* Single relationship
|
|
3725
|
+
*/
|
|
3726
|
+
type SingleRelationship = {
|
|
3727
|
+
data?: RelationshipItem;
|
|
3728
|
+
};
|
|
3729
|
+
type Discounts = Array<Discount>;
|
|
3730
|
+
type ShippingPriceResponse = {
|
|
3731
|
+
total: FormattedPriceData;
|
|
3732
|
+
base: FormattedPriceData;
|
|
3733
|
+
tax?: FormattedPriceData;
|
|
3734
|
+
fees?: FormattedPriceData;
|
|
3735
|
+
discount?: FormattedPriceData;
|
|
3736
|
+
};
|
|
3737
|
+
type NonNegativeFormattedPriceData = {
|
|
2976
3738
|
/**
|
|
2977
|
-
*
|
|
3739
|
+
* The raw total. Must be non-negative.
|
|
2978
3740
|
*/
|
|
2979
|
-
amount
|
|
3741
|
+
amount?: number;
|
|
2980
3742
|
/**
|
|
2981
|
-
*
|
|
3743
|
+
* The currency set for this amount.
|
|
3744
|
+
*/
|
|
3745
|
+
currency?: string;
|
|
3746
|
+
/**
|
|
3747
|
+
* The formatted total based on the amount and currency.
|
|
3748
|
+
*/
|
|
3749
|
+
formatted?: string;
|
|
3750
|
+
};
|
|
3751
|
+
type DiscountFormattedPriceData = {
|
|
3752
|
+
/**
|
|
3753
|
+
* The discount amount. Must be non-positive (zero or negative).
|
|
3754
|
+
*/
|
|
3755
|
+
amount?: number;
|
|
3756
|
+
/**
|
|
3757
|
+
* The currency set for this amount.
|
|
3758
|
+
*/
|
|
3759
|
+
currency?: string;
|
|
3760
|
+
/**
|
|
3761
|
+
* The formatted total based on the amount and currency.
|
|
3762
|
+
*/
|
|
3763
|
+
formatted?: string;
|
|
3764
|
+
};
|
|
3765
|
+
/**
|
|
3766
|
+
* Order pricing information.
|
|
3767
|
+
*/
|
|
3768
|
+
type OrderPriceWrapperMeta = {
|
|
3769
|
+
with_tax: NonNegativeFormattedPriceData;
|
|
3770
|
+
without_tax: NonNegativeFormattedPriceData;
|
|
3771
|
+
tax: NonNegativeFormattedPriceData;
|
|
3772
|
+
discount: DiscountFormattedPriceData;
|
|
3773
|
+
balance_owing: NonNegativeFormattedPriceData;
|
|
3774
|
+
paid: NonNegativeFormattedPriceData;
|
|
3775
|
+
authorized: NonNegativeFormattedPriceData;
|
|
3776
|
+
without_discount: NonNegativeFormattedPriceData;
|
|
3777
|
+
shipping: NonNegativeFormattedPriceData;
|
|
3778
|
+
shipping_discount: DiscountFormattedPriceData;
|
|
3779
|
+
};
|
|
3780
|
+
type ShippingGroupMeta = {
|
|
3781
|
+
shipping_display_price?: ShippingPriceResponse;
|
|
3782
|
+
total_display_price?: OrderPriceWrapperMeta;
|
|
3783
|
+
};
|
|
3784
|
+
type ShippingGroupResponse = {
|
|
3785
|
+
type?: "shipping_group";
|
|
3786
|
+
id?: string;
|
|
3787
|
+
relation?: string;
|
|
3788
|
+
cart_id?: string;
|
|
3789
|
+
order_id?: string;
|
|
3790
|
+
shipping_type?: string;
|
|
3791
|
+
tracking_reference?: string;
|
|
3792
|
+
/**
|
|
3793
|
+
* 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.
|
|
3794
|
+
*/
|
|
3795
|
+
external_ref?: string;
|
|
3796
|
+
address?: ShippingAddress;
|
|
3797
|
+
delivery_estimate?: DeliveryEstimate;
|
|
3798
|
+
created_at?: Date;
|
|
3799
|
+
updated_at?: Date;
|
|
3800
|
+
relationships?: {
|
|
3801
|
+
cart?: SingleRelationship;
|
|
3802
|
+
order?: SingleRelationship;
|
|
3803
|
+
/**
|
|
3804
|
+
* 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.
|
|
3805
|
+
*/
|
|
3806
|
+
items?: RelationshipArray;
|
|
3807
|
+
};
|
|
3808
|
+
discounts?: Discounts;
|
|
3809
|
+
meta?: ShippingGroupMeta;
|
|
3810
|
+
};
|
|
3811
|
+
type ShippingPriceRequest = {
|
|
3812
|
+
total?: number;
|
|
3813
|
+
base?: number;
|
|
3814
|
+
tax?: number;
|
|
3815
|
+
fees?: number;
|
|
3816
|
+
discount?: number;
|
|
3817
|
+
};
|
|
3818
|
+
type CreateShippingGroupRequest = {
|
|
3819
|
+
data?: {
|
|
3820
|
+
type?: "shipping_group";
|
|
3821
|
+
shipping_type?: string;
|
|
3822
|
+
tracking_reference?: string;
|
|
3823
|
+
/**
|
|
3824
|
+
* 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.
|
|
3825
|
+
*/
|
|
3826
|
+
external_ref?: string;
|
|
3827
|
+
shipping_price?: ShippingPriceRequest;
|
|
3828
|
+
address?: ShippingAddress;
|
|
3829
|
+
includes_tax?: boolean;
|
|
3830
|
+
delivery_estimate?: DeliveryEstimate;
|
|
3831
|
+
};
|
|
3832
|
+
};
|
|
3833
|
+
type OrderPriceData = {
|
|
3834
|
+
/**
|
|
3835
|
+
* The amount for this item.
|
|
3836
|
+
*/
|
|
3837
|
+
amount?: number;
|
|
3838
|
+
/**
|
|
3839
|
+
* The currency this item.
|
|
3840
|
+
*/
|
|
3841
|
+
currency?: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* Whether this price is tax inclusive.
|
|
3844
|
+
*/
|
|
3845
|
+
includes_tax?: boolean;
|
|
3846
|
+
};
|
|
3847
|
+
type DiscountData = {
|
|
3848
|
+
amount?: OrderPriceData;
|
|
3849
|
+
code?: string;
|
|
3850
|
+
readonly id?: string;
|
|
3851
|
+
/**
|
|
3852
|
+
* The source or origin of the promotion, if applicable.
|
|
3853
|
+
*/
|
|
3854
|
+
promotion_source?: string;
|
|
3855
|
+
/**
|
|
3856
|
+
* Indicates whether the discount applies to the entire cart.
|
|
3857
|
+
*/
|
|
3858
|
+
is_cart_discount?: boolean;
|
|
3859
|
+
/**
|
|
3860
|
+
* Order in which the discount was applied.
|
|
3861
|
+
*/
|
|
3862
|
+
ordinal?: number;
|
|
3863
|
+
/**
|
|
3864
|
+
* Identifies the specific action within a multi-action rule promotion that produced this discount.
|
|
3865
|
+
*/
|
|
3866
|
+
promotion_action_id?: string;
|
|
3867
|
+
};
|
|
3868
|
+
type OrderItemFormattedUnitPriceData = {
|
|
3869
|
+
unit?: FormattedPriceData;
|
|
3870
|
+
value?: FormattedPriceData;
|
|
3871
|
+
};
|
|
3872
|
+
type OrderItemResponse = {
|
|
3873
|
+
/**
|
|
3874
|
+
* The type represents the object being returned.
|
|
3875
|
+
*/
|
|
3876
|
+
type?: string;
|
|
3877
|
+
/**
|
|
3878
|
+
* The unique identifier for this order item.
|
|
3879
|
+
*/
|
|
3880
|
+
readonly id?: string;
|
|
3881
|
+
/**
|
|
3882
|
+
* The quantity of this item were ordered.
|
|
3883
|
+
*/
|
|
3884
|
+
quantity?: number;
|
|
3885
|
+
/**
|
|
3886
|
+
* The unique identifier for this order item.
|
|
3887
|
+
*/
|
|
3888
|
+
readonly product_id?: string;
|
|
3889
|
+
/**
|
|
3890
|
+
* The unique identifier for the subscription offering for this order item.
|
|
3891
|
+
*/
|
|
3892
|
+
readonly subscription_offering_id?: string;
|
|
3893
|
+
/**
|
|
3894
|
+
* The name of this order item.
|
|
3895
|
+
*/
|
|
3896
|
+
name?: string;
|
|
3897
|
+
/**
|
|
3898
|
+
* The SKU code for the order item.
|
|
3899
|
+
*/
|
|
3900
|
+
sku?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* The stock location for this order item.
|
|
3903
|
+
*/
|
|
3904
|
+
readonly location?: string;
|
|
3905
|
+
unit_price?: OrderPriceData;
|
|
3906
|
+
value?: OrderPriceData;
|
|
3907
|
+
discounts?: Array<DiscountData>;
|
|
3908
|
+
links?: {
|
|
3909
|
+
[key: string]: unknown;
|
|
3910
|
+
};
|
|
3911
|
+
meta?: {
|
|
3912
|
+
display_price?: {
|
|
3913
|
+
with_tax?: OrderItemFormattedUnitPriceData;
|
|
3914
|
+
without_tax?: OrderItemFormattedUnitPriceData;
|
|
3915
|
+
tax?: OrderItemFormattedUnitPriceData;
|
|
3916
|
+
discount?: OrderItemFormattedUnitPriceData;
|
|
3917
|
+
without_discount?: OrderItemFormattedUnitPriceData;
|
|
3918
|
+
discounts?: {
|
|
3919
|
+
[key: string]: {
|
|
3920
|
+
amount?: number;
|
|
3921
|
+
currency?: string;
|
|
3922
|
+
formatted?: string;
|
|
3923
|
+
/**
|
|
3924
|
+
* Detailed breakdown of discount constituents by ID
|
|
3925
|
+
*/
|
|
3926
|
+
constituents?: {
|
|
3927
|
+
[key: string]: {
|
|
3928
|
+
/**
|
|
3929
|
+
* The discount amount
|
|
3930
|
+
*/
|
|
3931
|
+
amount?: number;
|
|
3932
|
+
/**
|
|
3933
|
+
* The currency code
|
|
3934
|
+
*/
|
|
3935
|
+
currency?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* The formatted discount amount
|
|
3938
|
+
*/
|
|
3939
|
+
formatted?: string;
|
|
3940
|
+
};
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
};
|
|
3944
|
+
/**
|
|
3945
|
+
* 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).
|
|
3946
|
+
*/
|
|
3947
|
+
original_price?: OrderItemFormattedUnitPriceData;
|
|
3948
|
+
};
|
|
3949
|
+
timestamps?: CartCheckoutTimestamps;
|
|
3950
|
+
};
|
|
3951
|
+
relationships?: {
|
|
3952
|
+
cart_item?: {
|
|
3953
|
+
data?: {
|
|
3954
|
+
/**
|
|
3955
|
+
* The type represents the object being returned.
|
|
3956
|
+
*/
|
|
3957
|
+
type?: string;
|
|
3958
|
+
/**
|
|
3959
|
+
* The unique identifier for this item.
|
|
3960
|
+
*/
|
|
3961
|
+
readonly id?: string;
|
|
3962
|
+
};
|
|
3963
|
+
};
|
|
3964
|
+
/**
|
|
3965
|
+
* Related tax items.
|
|
3966
|
+
*/
|
|
3967
|
+
taxes?: {
|
|
3968
|
+
data?: null | Array<RelationshipItem>;
|
|
3969
|
+
};
|
|
3970
|
+
/**
|
|
3971
|
+
* Related promotions.
|
|
3972
|
+
*/
|
|
3973
|
+
promotions?: {
|
|
3974
|
+
data?: null | Array<RelationshipItem>;
|
|
3975
|
+
};
|
|
3976
|
+
};
|
|
3977
|
+
/**
|
|
3978
|
+
* The unique identifier of the catalog associated with the product is shown if `catalog_source=pim` is set.
|
|
3979
|
+
*/
|
|
3980
|
+
catalog_id?: string;
|
|
3981
|
+
/**
|
|
3982
|
+
* The catalog source. Always `pim` or `legacy`.
|
|
3983
|
+
*/
|
|
3984
|
+
catalog_source?: string;
|
|
3985
|
+
/**
|
|
3986
|
+
* Configuration for bundle products.
|
|
3987
|
+
*/
|
|
3988
|
+
bundle_configuration?: {
|
|
3989
|
+
selected_options?: {
|
|
3990
|
+
[key: string]: {
|
|
3991
|
+
[key: string]: number;
|
|
3992
|
+
};
|
|
3993
|
+
};
|
|
3994
|
+
/**
|
|
3995
|
+
* Array of component products for bundle configuration
|
|
3996
|
+
*/
|
|
3997
|
+
component_products?: Array<{
|
|
3998
|
+
/**
|
|
3999
|
+
* Component product ID
|
|
4000
|
+
*/
|
|
4001
|
+
id?: string;
|
|
4002
|
+
/**
|
|
4003
|
+
* Component product type
|
|
4004
|
+
*/
|
|
4005
|
+
type?: string;
|
|
4006
|
+
/**
|
|
4007
|
+
* Product attributes as a generic object
|
|
4008
|
+
*/
|
|
4009
|
+
attributes?: {
|
|
4010
|
+
[key: string]: unknown;
|
|
4011
|
+
};
|
|
4012
|
+
/**
|
|
4013
|
+
* Product metadata as a generic object
|
|
4014
|
+
*/
|
|
4015
|
+
meta?: {
|
|
4016
|
+
[key: string]: unknown;
|
|
4017
|
+
};
|
|
4018
|
+
/**
|
|
4019
|
+
* Product price information as a generic object
|
|
4020
|
+
*/
|
|
4021
|
+
price?: {
|
|
4022
|
+
[key: string]: unknown;
|
|
4023
|
+
};
|
|
4024
|
+
/**
|
|
4025
|
+
* Product relationships as a generic object
|
|
4026
|
+
*/
|
|
4027
|
+
relationships?: {
|
|
4028
|
+
[key: string]: unknown;
|
|
4029
|
+
};
|
|
4030
|
+
}>;
|
|
4031
|
+
};
|
|
4032
|
+
/**
|
|
4033
|
+
* Components of the bundle product.
|
|
2982
4034
|
*/
|
|
2983
|
-
|
|
4035
|
+
components?: {
|
|
4036
|
+
[key: string]: {
|
|
4037
|
+
name?: string;
|
|
4038
|
+
options?: Array<{
|
|
4039
|
+
id?: string;
|
|
4040
|
+
quantity?: number;
|
|
4041
|
+
type?: string;
|
|
4042
|
+
}>;
|
|
4043
|
+
};
|
|
4044
|
+
};
|
|
2984
4045
|
/**
|
|
2985
|
-
*
|
|
4046
|
+
* Custom inputs for the order item as a generic object
|
|
2986
4047
|
*/
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
amount: Money;
|
|
4048
|
+
custom_inputs?: {
|
|
4049
|
+
[key: string]: unknown;
|
|
4050
|
+
};
|
|
2991
4051
|
/**
|
|
2992
|
-
*
|
|
4052
|
+
* Custom attributes attached to the order item.
|
|
2993
4053
|
*/
|
|
2994
|
-
|
|
4054
|
+
custom_attributes?: CustomAttributes;
|
|
2995
4055
|
/**
|
|
2996
|
-
*
|
|
4056
|
+
* The shipping group ID for the order item
|
|
2997
4057
|
*/
|
|
2998
|
-
|
|
4058
|
+
shipping_group_id?: string;
|
|
2999
4059
|
/**
|
|
3000
|
-
* The source
|
|
4060
|
+
* The promotion source for the order item
|
|
3001
4061
|
*/
|
|
3002
4062
|
promotion_source?: string;
|
|
3003
4063
|
/**
|
|
3004
|
-
*
|
|
4064
|
+
* The action ID within the rule promotion that produced this promotion item.
|
|
3005
4065
|
*/
|
|
3006
|
-
|
|
4066
|
+
readonly promotion_action_id?: string;
|
|
3007
4067
|
/**
|
|
3008
|
-
*
|
|
4068
|
+
* Subscription configuration for the order item
|
|
3009
4069
|
*/
|
|
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;
|
|
4070
|
+
subscription_configuration?: {
|
|
4071
|
+
/**
|
|
4072
|
+
* Subscription plan details
|
|
4073
|
+
*/
|
|
4074
|
+
plan?: string;
|
|
4075
|
+
/**
|
|
4076
|
+
* Pricing option for the subscription
|
|
4077
|
+
*/
|
|
4078
|
+
pricing_option?: string;
|
|
4079
|
+
};
|
|
3035
4080
|
};
|
|
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;
|
|
4081
|
+
type ShippingGroupEntityResponse = {
|
|
4082
|
+
data?: ShippingGroupResponse;
|
|
3044
4083
|
/**
|
|
3045
|
-
*
|
|
4084
|
+
* Related objects that are included in the response when using the include query parameter.
|
|
3046
4085
|
*/
|
|
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;
|
|
4086
|
+
included?: {
|
|
3071
4087
|
/**
|
|
3072
|
-
*
|
|
4088
|
+
* Array of order items associated with this shipping group.
|
|
3073
4089
|
*/
|
|
3074
|
-
|
|
3075
|
-
shipping_price?: ShippingPriceRequest;
|
|
3076
|
-
address?: ShippingAddress;
|
|
3077
|
-
includes_tax?: boolean;
|
|
3078
|
-
delivery_estimate?: DeliveryEstimate;
|
|
4090
|
+
items?: Array<OrderItemResponse>;
|
|
3079
4091
|
};
|
|
4092
|
+
/**
|
|
4093
|
+
* Array of validation or processing errors
|
|
4094
|
+
*/
|
|
4095
|
+
errors?: Array<ResponseErrorItem>;
|
|
3080
4096
|
};
|
|
3081
4097
|
type UpdateCartShippingGroupRequest = {
|
|
3082
4098
|
data?: {
|
|
@@ -3093,13 +4109,13 @@ type UpdateCartShippingGroupRequest = {
|
|
|
3093
4109
|
delivery_estimate?: DeliveryEstimate;
|
|
3094
4110
|
};
|
|
3095
4111
|
};
|
|
3096
|
-
type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "
|
|
4112
|
+
type Gateway = "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents";
|
|
3097
4113
|
/**
|
|
3098
4114
|
* Specifies the transaction method, such as `purchase` or `authorize`.
|
|
3099
4115
|
*/
|
|
3100
4116
|
type Method = "authorize" | "purchase" | "purchase_setup" | "authorize_setup";
|
|
3101
4117
|
type DataBasePayments = {
|
|
3102
|
-
gateway: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "
|
|
4118
|
+
gateway: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents";
|
|
3103
4119
|
/**
|
|
3104
4120
|
* Specifies the transaction method, such as `purchase` or `authorize`.
|
|
3105
4121
|
*/
|
|
@@ -3151,48 +4167,11 @@ type CartPaymentUpdate = {
|
|
|
3151
4167
|
};
|
|
3152
4168
|
};
|
|
3153
4169
|
};
|
|
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
|
-
};
|
|
4170
|
+
/**
|
|
4171
|
+
* Billing address information. You must specify at least one of region (state/province) or county.
|
|
4172
|
+
*
|
|
4173
|
+
*/
|
|
4174
|
+
type BillingAddress = AddressWithRegion | AddressWithCounty;
|
|
3196
4175
|
type CustomerCheckout = {
|
|
3197
4176
|
data?: {
|
|
3198
4177
|
/**
|
|
@@ -3255,20 +4234,41 @@ type AccountCheckout = {
|
|
|
3255
4234
|
shipping_address?: ShippingAddress;
|
|
3256
4235
|
};
|
|
3257
4236
|
};
|
|
4237
|
+
type OrderTimestamps = {
|
|
4238
|
+
/**
|
|
4239
|
+
* The date this order was created.
|
|
4240
|
+
*/
|
|
4241
|
+
created_at?: string;
|
|
4242
|
+
/**
|
|
4243
|
+
* The date this order was last updated.
|
|
4244
|
+
*/
|
|
4245
|
+
updated_at?: string;
|
|
4246
|
+
/**
|
|
4247
|
+
* The date this order was fully paid. Only present for orders with payment status 'paid'.
|
|
4248
|
+
*/
|
|
4249
|
+
fully_paid_at?: string;
|
|
4250
|
+
};
|
|
3258
4251
|
type OrderMeta = {
|
|
3259
|
-
timestamps?:
|
|
4252
|
+
timestamps?: OrderTimestamps;
|
|
4253
|
+
/**
|
|
4254
|
+
* Order pricing information including amounts, tax, discounts, and payment details.
|
|
4255
|
+
*/
|
|
3260
4256
|
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?:
|
|
4257
|
+
with_tax?: NonNegativeFormattedPriceData;
|
|
4258
|
+
without_tax?: NonNegativeFormattedPriceData;
|
|
4259
|
+
tax?: NonNegativeFormattedPriceData;
|
|
4260
|
+
discount?: DiscountFormattedPriceData;
|
|
4261
|
+
balance_owing?: NonNegativeFormattedPriceData;
|
|
4262
|
+
paid?: NonNegativeFormattedPriceData;
|
|
4263
|
+
authorized?: NonNegativeFormattedPriceData;
|
|
4264
|
+
without_discount?: NonNegativeFormattedPriceData;
|
|
4265
|
+
shipping?: NonNegativeFormattedPriceData;
|
|
4266
|
+
shipping_discount?: DiscountFormattedPriceData;
|
|
3271
4267
|
};
|
|
4268
|
+
/**
|
|
4269
|
+
* Specifies if the order was created manually.
|
|
4270
|
+
*/
|
|
4271
|
+
is_manual?: boolean;
|
|
3272
4272
|
};
|
|
3273
4273
|
type Contact = {
|
|
3274
4274
|
/**
|
|
@@ -3280,11 +4280,19 @@ type Contact = {
|
|
|
3280
4280
|
*/
|
|
3281
4281
|
name?: string;
|
|
3282
4282
|
};
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
4283
|
+
type Customer = {
|
|
4284
|
+
/**
|
|
4285
|
+
* The name of the customer.
|
|
4286
|
+
*/
|
|
4287
|
+
name?: string;
|
|
4288
|
+
/**
|
|
4289
|
+
* The email address of the customer.
|
|
4290
|
+
*/
|
|
4291
|
+
email?: string;
|
|
4292
|
+
/**
|
|
4293
|
+
* The unique identifier of the customer.
|
|
4294
|
+
*/
|
|
4295
|
+
id?: string;
|
|
3288
4296
|
};
|
|
3289
4297
|
/**
|
|
3290
4298
|
* Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.
|
|
@@ -3332,10 +4340,13 @@ type OrderResponse = {
|
|
|
3332
4340
|
*/
|
|
3333
4341
|
payment_intent_id?: string;
|
|
3334
4342
|
custom_attributes?: CustomAttributes;
|
|
4343
|
+
links?: {
|
|
4344
|
+
[key: string]: unknown;
|
|
4345
|
+
};
|
|
3335
4346
|
meta?: OrderMeta;
|
|
3336
4347
|
billing_address?: BillingAddress;
|
|
3337
4348
|
contact?: Contact;
|
|
3338
|
-
customer?:
|
|
4349
|
+
customer?: Customer;
|
|
3339
4350
|
shipping_address?: ShippingAddress;
|
|
3340
4351
|
relationships?: {
|
|
3341
4352
|
items?: RelationshipArray;
|
|
@@ -3344,11 +4355,20 @@ type OrderResponse = {
|
|
|
3344
4355
|
customer?: SingleRelationship;
|
|
3345
4356
|
account?: SingleRelationship;
|
|
3346
4357
|
account_member?: SingleRelationship;
|
|
4358
|
+
store?: SingleRelationship;
|
|
3347
4359
|
};
|
|
3348
4360
|
};
|
|
3349
4361
|
type OrderEntityResponse = {
|
|
3350
4362
|
data?: OrderResponse;
|
|
4363
|
+
/**
|
|
4364
|
+
* Optional included data such as order items, tax items, custom discounts, and promotions.
|
|
4365
|
+
*
|
|
4366
|
+
*/
|
|
3351
4367
|
included?: OrderIncluded;
|
|
4368
|
+
/**
|
|
4369
|
+
* Array of error objects, if any errors occurred.
|
|
4370
|
+
*/
|
|
4371
|
+
errors?: Array<ResponseErrorItem>;
|
|
3352
4372
|
};
|
|
3353
4373
|
type ResponseMetaOrders = {
|
|
3354
4374
|
page?: ResponsePaginationPage;
|
|
@@ -3361,6 +4381,10 @@ type OrderCollectionResponse = {
|
|
|
3361
4381
|
included?: OrdersIncluded;
|
|
3362
4382
|
};
|
|
3363
4383
|
type OrdersAddressData = {
|
|
4384
|
+
/**
|
|
4385
|
+
* The type of the resource. You must use "order".
|
|
4386
|
+
*/
|
|
4387
|
+
type: string;
|
|
3364
4388
|
/**
|
|
3365
4389
|
* 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
4390
|
*/
|
|
@@ -3394,6 +4418,10 @@ type OrdersAddressData = {
|
|
|
3394
4418
|
* Specifies the second line of the address.
|
|
3395
4419
|
*/
|
|
3396
4420
|
line_2?: string;
|
|
4421
|
+
/**
|
|
4422
|
+
* Specifies the third line of the address.
|
|
4423
|
+
*/
|
|
4424
|
+
line_3?: string;
|
|
3397
4425
|
/**
|
|
3398
4426
|
* Specifies the name of the city in the shipping address.
|
|
3399
4427
|
*/
|
|
@@ -3451,118 +4479,181 @@ type OrdersFulfilledData = {
|
|
|
3451
4479
|
type OrdersUpdateRequest = {
|
|
3452
4480
|
data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
|
|
3453
4481
|
};
|
|
3454
|
-
type
|
|
4482
|
+
type OrderItemCollectionResponse = {
|
|
4483
|
+
data?: Array<OrderItemResponse>;
|
|
3455
4484
|
/**
|
|
3456
|
-
*
|
|
4485
|
+
* Optional included data such as tax items, custom discounts, and promotions.
|
|
4486
|
+
*
|
|
3457
4487
|
*/
|
|
3458
|
-
|
|
4488
|
+
included?: {
|
|
4489
|
+
/**
|
|
4490
|
+
* Array of tax items included in the response.
|
|
4491
|
+
*/
|
|
4492
|
+
tax_items?: Array<TaxItemResponse>;
|
|
4493
|
+
/**
|
|
4494
|
+
* Array of custom discounts included in the response.
|
|
4495
|
+
*/
|
|
4496
|
+
custom_discounts?: Array<CustomDiscountResponse>;
|
|
4497
|
+
/**
|
|
4498
|
+
* Array of promotions included in the response.
|
|
4499
|
+
*/
|
|
4500
|
+
promotions?: Array<CondensedPromotionResponse>;
|
|
4501
|
+
};
|
|
4502
|
+
};
|
|
4503
|
+
type OrdersAnonymizeData = {
|
|
3459
4504
|
/**
|
|
3460
|
-
* The
|
|
4505
|
+
* The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.
|
|
3461
4506
|
*/
|
|
3462
|
-
|
|
4507
|
+
order_ids?: Array<string>;
|
|
4508
|
+
};
|
|
4509
|
+
type OrdersAnonymizeRequest = {
|
|
4510
|
+
data?: OrdersAnonymizeData;
|
|
4511
|
+
};
|
|
4512
|
+
type OrdersListResponse = {
|
|
4513
|
+
data: Array<OrderResponse>;
|
|
4514
|
+
};
|
|
4515
|
+
/**
|
|
4516
|
+
* Non-PII payment failure information from the payment gateway. Only present on failed transactions where the gateway provided structured failure details.
|
|
4517
|
+
*/
|
|
4518
|
+
type FailureDetails = {
|
|
3463
4519
|
/**
|
|
3464
|
-
*
|
|
4520
|
+
* Machine-readable failure or error code from the payment gateway.
|
|
3465
4521
|
*/
|
|
3466
|
-
includes_tax?: boolean;
|
|
3467
|
-
};
|
|
3468
|
-
type DiscountData = {
|
|
3469
|
-
amount?: OrderPriceData;
|
|
3470
4522
|
code?: string;
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
value?: FormattedPriceData;
|
|
4523
|
+
/**
|
|
4524
|
+
* Human-readable failure reason or error message from the payment gateway.
|
|
4525
|
+
*/
|
|
4526
|
+
reason?: string;
|
|
3476
4527
|
};
|
|
3477
|
-
|
|
4528
|
+
/**
|
|
4529
|
+
* The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
|
|
4530
|
+
*/
|
|
4531
|
+
type TransactionType = "purchase" | "authorize" | "capture" | "refund";
|
|
4532
|
+
/**
|
|
4533
|
+
* The mechanism used for capturing the transaction.
|
|
4534
|
+
*/
|
|
4535
|
+
type CaptureMechanism = "automatic" | "manual";
|
|
4536
|
+
/**
|
|
4537
|
+
* The mechanism used for refunding the transaction.
|
|
4538
|
+
*/
|
|
4539
|
+
type RefundMechanism = "automatic" | "manual";
|
|
4540
|
+
type TransactionResponse = {
|
|
3478
4541
|
/**
|
|
3479
|
-
* The
|
|
4542
|
+
* The ID of the transaction.
|
|
4543
|
+
*/
|
|
4544
|
+
readonly id?: string;
|
|
4545
|
+
/**
|
|
4546
|
+
* The payment gateway reference.
|
|
4547
|
+
*/
|
|
4548
|
+
reference?: string;
|
|
4549
|
+
/**
|
|
4550
|
+
* A custom name associated with the payment method.
|
|
4551
|
+
*/
|
|
4552
|
+
name?: string;
|
|
4553
|
+
/**
|
|
4554
|
+
* 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.
|
|
4555
|
+
*/
|
|
4556
|
+
custom_reference?: string;
|
|
4557
|
+
/**
|
|
4558
|
+
* The name of the payment gateway used.
|
|
4559
|
+
*/
|
|
4560
|
+
gateway?: "adyen" | "authorize_net" | "braintree" | "card_connect" | "cyber_source" | "elastic_path_payments_stripe" | "manual" | "paypal_express_checkout" | "stripe" | "stripe_payment_intents" | "stripe_platform_account";
|
|
4561
|
+
/**
|
|
4562
|
+
* The amount for this transaction.
|
|
4563
|
+
*/
|
|
4564
|
+
amount?: number;
|
|
4565
|
+
/**
|
|
4566
|
+
* The refunded amount.
|
|
4567
|
+
*/
|
|
4568
|
+
refunded_amount?: number;
|
|
4569
|
+
/**
|
|
4570
|
+
* The transaction currency.
|
|
4571
|
+
*/
|
|
4572
|
+
currency?: string;
|
|
4573
|
+
/**
|
|
4574
|
+
* The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.
|
|
4575
|
+
*/
|
|
4576
|
+
transaction_type?: "purchase" | "authorize" | "capture" | "refund";
|
|
4577
|
+
/**
|
|
4578
|
+
* The type of object being returned.
|
|
3480
4579
|
*/
|
|
3481
4580
|
type?: string;
|
|
3482
4581
|
/**
|
|
3483
|
-
* The
|
|
4582
|
+
* The status provided by the gateway for this transaction, such as `complete` or `failed`.
|
|
3484
4583
|
*/
|
|
3485
|
-
|
|
4584
|
+
status?: string;
|
|
3486
4585
|
/**
|
|
3487
|
-
*
|
|
4586
|
+
* Additional payment details specific to the gateway. Present when gateway is paypal_express_checkout.
|
|
3488
4587
|
*/
|
|
3489
|
-
|
|
4588
|
+
payment_details?: {
|
|
4589
|
+
/**
|
|
4590
|
+
* Detailed status information from the payment gateway.
|
|
4591
|
+
*/
|
|
4592
|
+
detailed_status?: string;
|
|
4593
|
+
};
|
|
3490
4594
|
/**
|
|
3491
|
-
*
|
|
4595
|
+
* Non-PII payment failure details from the gateway. Only present on failed transactions where the gateway provided structured failure information.
|
|
4596
|
+
*/
|
|
4597
|
+
failure_details?: FailureDetails;
|
|
4598
|
+
/**
|
|
4599
|
+
* Payment intent details.
|
|
3492
4600
|
*/
|
|
3493
|
-
|
|
4601
|
+
payment_intent?: {
|
|
4602
|
+
[key: string]: unknown;
|
|
4603
|
+
};
|
|
3494
4604
|
/**
|
|
3495
|
-
* The
|
|
4605
|
+
* The mechanism used for capturing the transaction.
|
|
3496
4606
|
*/
|
|
3497
|
-
|
|
4607
|
+
capture_mechanism?: "automatic" | "manual";
|
|
3498
4608
|
/**
|
|
3499
|
-
* The
|
|
4609
|
+
* The mechanism used for refunding the transaction.
|
|
3500
4610
|
*/
|
|
3501
|
-
|
|
4611
|
+
refund_mechanism?: "automatic" | "manual";
|
|
3502
4612
|
/**
|
|
3503
|
-
*
|
|
4613
|
+
* Client parameters required for payment processing. Present when gateway is paypal_express_checkout.
|
|
3504
4614
|
*/
|
|
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;
|
|
4615
|
+
client_parameters?: {
|
|
4616
|
+
/**
|
|
4617
|
+
* The URL to redirect the customer to complete the payment.
|
|
4618
|
+
*/
|
|
4619
|
+
redirect_url?: string;
|
|
4620
|
+
/**
|
|
4621
|
+
* Client secret for payment processing.
|
|
4622
|
+
*/
|
|
4623
|
+
secret?: string;
|
|
4624
|
+
/**
|
|
4625
|
+
* The token for the payment session.
|
|
4626
|
+
*/
|
|
4627
|
+
token?: string;
|
|
3528
4628
|
};
|
|
4629
|
+
/**
|
|
4630
|
+
* Available actions that can be performed on this transaction. Present when gateway is paypal_express_checkout.
|
|
4631
|
+
*/
|
|
4632
|
+
next_actions?: Array<"cancel" | "capture" | "refund">;
|
|
3529
4633
|
relationships?: {
|
|
3530
|
-
|
|
4634
|
+
order?: {
|
|
3531
4635
|
data?: {
|
|
3532
4636
|
/**
|
|
3533
|
-
*
|
|
4637
|
+
* Represents the type of the object being returned. It is always `order`.
|
|
3534
4638
|
*/
|
|
3535
4639
|
type?: string;
|
|
3536
4640
|
/**
|
|
3537
|
-
* The
|
|
4641
|
+
* The ID of the order.
|
|
3538
4642
|
*/
|
|
3539
|
-
|
|
4643
|
+
id?: string;
|
|
3540
4644
|
};
|
|
3541
4645
|
};
|
|
3542
4646
|
};
|
|
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;
|
|
4647
|
+
meta?: {
|
|
4648
|
+
display_price?: FormattedPriceData;
|
|
4649
|
+
display_refunded_amount?: {
|
|
4650
|
+
total?: FormattedPriceData;
|
|
4651
|
+
};
|
|
4652
|
+
timestamps?: CartCheckoutTimestamps;
|
|
4653
|
+
};
|
|
3563
4654
|
};
|
|
3564
|
-
type
|
|
3565
|
-
data:
|
|
4655
|
+
type TransactionEntityResponse = {
|
|
4656
|
+
data: TransactionResponse;
|
|
3566
4657
|
};
|
|
3567
4658
|
type DataAdyenPayment = DataBasePayments & {
|
|
3568
4659
|
/**
|
|
@@ -3708,22 +4799,6 @@ type DataStripePayment = DataBasePayments & {
|
|
|
3708
4799
|
*/
|
|
3709
4800
|
payment?: string;
|
|
3710
4801
|
};
|
|
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
4802
|
type DataStripePaymentIntentsPayment = DataBasePayments & {
|
|
3728
4803
|
/**
|
|
3729
4804
|
* Specifies the type of payment gateway. You must use `stripe_payment_intents`.
|
|
@@ -3740,100 +4815,10 @@ type DataStripePaymentIntentsPayment = DataBasePayments & {
|
|
|
3740
4815
|
*/
|
|
3741
4816
|
payment?: string;
|
|
3742
4817
|
};
|
|
3743
|
-
type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment |
|
|
4818
|
+
type DataPaymentObject = DataAdyenPayment | DataAuthorizeNetPayment | DataBraintreePayment | DataCardConnectPayment | DataCyberSourcePayment | ElasticPathPaymentsPoweredByStripePayment | DataManualPayment | DataPayPalExpressCheckoutPayment | DataStripePayment | DataStripePaymentIntentsPayment;
|
|
3744
4819
|
type PaymentsRequest = {
|
|
3745
4820
|
data?: DataPaymentObject;
|
|
3746
4821
|
};
|
|
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
4822
|
type OrdersTransactionsConfirmRequest = {
|
|
3838
4823
|
data?: {
|
|
3839
4824
|
[key: string]: unknown;
|
|
@@ -3861,35 +4846,120 @@ type OrdersTransactionsRefundRequest = {
|
|
|
3861
4846
|
};
|
|
3862
4847
|
};
|
|
3863
4848
|
};
|
|
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
|
-
};
|
|
4849
|
+
type TransactionListResponse = {
|
|
4850
|
+
data: Array<TransactionResponse>;
|
|
4851
|
+
};
|
|
4852
|
+
type ResponseData = {
|
|
4853
|
+
data?: unknown;
|
|
4854
|
+
};
|
|
4855
|
+
type OrdersTransactionsCancelRequest = {
|
|
4856
|
+
data?: {
|
|
4857
|
+
options?: {
|
|
4858
|
+
[key: string]: unknown;
|
|
4859
|
+
};
|
|
4860
|
+
/**
|
|
4861
|
+
* Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.
|
|
4862
|
+
*/
|
|
4863
|
+
reason?: string;
|
|
4864
|
+
};
|
|
4865
|
+
};
|
|
4866
|
+
type UpdateOrderShippingGroupRequest = {
|
|
4867
|
+
data?: {
|
|
4868
|
+
type?: "shipping_group";
|
|
4869
|
+
shipping_type?: string;
|
|
4870
|
+
tracking_reference?: string;
|
|
4871
|
+
/**
|
|
4872
|
+
* 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.
|
|
4873
|
+
*/
|
|
4874
|
+
external_ref?: string;
|
|
4875
|
+
address?: ShippingAddress;
|
|
4876
|
+
delivery_estimate?: DeliveryEstimate;
|
|
4877
|
+
};
|
|
4878
|
+
};
|
|
4879
|
+
type SettingsCart = {
|
|
4880
|
+
data?: {
|
|
4881
|
+
/**
|
|
4882
|
+
* Describes the type of request payload you're sending. Set this value to `settings`.
|
|
4883
|
+
*/
|
|
4884
|
+
type: string;
|
|
4885
|
+
/**
|
|
4886
|
+
* The unique identifier for the cart settings.
|
|
4887
|
+
*/
|
|
4888
|
+
readonly id?: string;
|
|
4889
|
+
/**
|
|
4890
|
+
* Indicates the number of days before a cart expires.
|
|
4891
|
+
*/
|
|
4892
|
+
cart_expiry_days?: number;
|
|
4893
|
+
discounts?: {
|
|
4894
|
+
/**
|
|
4895
|
+
* 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.
|
|
4896
|
+
*/
|
|
4897
|
+
custom_discounts_enabled?: boolean;
|
|
4898
|
+
/**
|
|
4899
|
+
* When set to `true`, this parameter allows the cart to use rule promotions.
|
|
4900
|
+
*/
|
|
4901
|
+
use_rule_promotions?: boolean;
|
|
4902
|
+
};
|
|
4903
|
+
inventories?: {
|
|
4904
|
+
/**
|
|
4905
|
+
* 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.
|
|
4906
|
+
*/
|
|
4907
|
+
defer_inventory_check?: boolean;
|
|
4908
|
+
};
|
|
4909
|
+
items?: {
|
|
4910
|
+
/**
|
|
4911
|
+
* 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.
|
|
4912
|
+
*/
|
|
4913
|
+
separate_items_by_location?: boolean;
|
|
4914
|
+
};
|
|
4915
|
+
/**
|
|
4916
|
+
* 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).
|
|
4917
|
+
*
|
|
4918
|
+
* For new stores, this defaults to `true`. For existing stores created before this feature was introduced, this defaults to `false` to maintain backward compatibility.
|
|
4919
|
+
*
|
|
4920
|
+
*/
|
|
4921
|
+
show_all_carts?: boolean;
|
|
4922
|
+
};
|
|
4923
|
+
};
|
|
4924
|
+
type CartsResponse = {
|
|
4925
|
+
data?: Array<CartItemObject | CustomItemCartObject | SubscriptionItemCartObject | PromotionItemCartObject>;
|
|
4926
|
+
meta?: {
|
|
4927
|
+
display_price?: {
|
|
4928
|
+
with_tax?: FormattedPriceData;
|
|
4929
|
+
without_tax?: FormattedPriceData;
|
|
4930
|
+
tax?: FormattedPriceData;
|
|
4931
|
+
discount?: FormattedPriceData;
|
|
4932
|
+
without_discount?: FormattedPriceData;
|
|
4933
|
+
discounts?: {
|
|
4934
|
+
[key: string]: {
|
|
4935
|
+
amount?: number;
|
|
4936
|
+
currency?: string;
|
|
4937
|
+
formatted?: string;
|
|
4938
|
+
};
|
|
4939
|
+
};
|
|
4940
|
+
};
|
|
4941
|
+
timestamps?: CartTimestamps;
|
|
4942
|
+
};
|
|
4943
|
+
};
|
|
4944
|
+
type CartItemsResponse = {
|
|
4945
|
+
data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
|
|
3880
4946
|
};
|
|
3881
|
-
type
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
|
|
4947
|
+
type CartItemObject = CartItemObjectData & CartItemResponse;
|
|
4948
|
+
type DataStripeConnectPayment = DataBasePayments & {
|
|
4949
|
+
/**
|
|
4950
|
+
* Specifies the type of payment gateway. You must use `stripe_connect`.
|
|
4951
|
+
*/
|
|
4952
|
+
gateway: "stripe_connect";
|
|
4953
|
+
options?: {
|
|
3886
4954
|
/**
|
|
3887
|
-
*
|
|
4955
|
+
* 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
4956
|
*/
|
|
3889
|
-
|
|
3890
|
-
address?: ShippingAddress;
|
|
3891
|
-
delivery_estimate?: DeliveryEstimate;
|
|
4957
|
+
receipt_email?: string;
|
|
3892
4958
|
};
|
|
4959
|
+
/**
|
|
4960
|
+
* Specifies the Stripe token or source.
|
|
4961
|
+
*/
|
|
4962
|
+
payment?: string;
|
|
3893
4963
|
};
|
|
3894
4964
|
type CartCheckoutTimestamps = {
|
|
3895
4965
|
/**
|
|
@@ -3899,7 +4969,7 @@ type CartCheckoutTimestamps = {
|
|
|
3899
4969
|
/**
|
|
3900
4970
|
* The date this was last updated.
|
|
3901
4971
|
*/
|
|
3902
|
-
updated_at?:
|
|
4972
|
+
updated_at?: string;
|
|
3903
4973
|
};
|
|
3904
4974
|
type CartIncludedPromotion = {
|
|
3905
4975
|
/**
|
|
@@ -5966,47 +7036,11 @@ type AccountAddressesError = {
|
|
|
5966
7036
|
type AccountAddressesErrorResponse = {
|
|
5967
7037
|
errors: Array<AccountAddressesError>;
|
|
5968
7038
|
};
|
|
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
7039
|
type Account = {
|
|
6006
7040
|
/**
|
|
6007
|
-
* Specifies the
|
|
7041
|
+
* Specifies the type of object. Set this value to `account`.
|
|
6008
7042
|
*/
|
|
6009
|
-
type:
|
|
7043
|
+
type: "account";
|
|
6010
7044
|
/**
|
|
6011
7045
|
* Specifies the name of the account.
|
|
6012
7046
|
*/
|
|
@@ -6022,7 +7056,7 @@ type Account = {
|
|
|
6022
7056
|
/**
|
|
6023
7057
|
* 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
7058
|
*/
|
|
6025
|
-
external_ref?: string;
|
|
7059
|
+
external_ref?: string | null;
|
|
6026
7060
|
};
|
|
6027
7061
|
type ReadOnlyParentId = {
|
|
6028
7062
|
/**
|
|
@@ -6030,12 +7064,10 @@ type ReadOnlyParentId = {
|
|
|
6030
7064
|
*/
|
|
6031
7065
|
readonly parent_id?: string | null;
|
|
6032
7066
|
};
|
|
6033
|
-
|
|
6034
|
-
|
|
6035
|
-
|
|
6036
|
-
|
|
6037
|
-
parent_id?: string | null;
|
|
6038
|
-
};
|
|
7067
|
+
/**
|
|
7068
|
+
* The unique identifier.
|
|
7069
|
+
*/
|
|
7070
|
+
type Uuid = string;
|
|
6039
7071
|
type AccountResponse = Account & ReadOnlyParentId & {
|
|
6040
7072
|
/**
|
|
6041
7073
|
* The unique identifier for an Account.
|
|
@@ -6045,67 +7077,85 @@ type AccountResponse = Account & ReadOnlyParentId & {
|
|
|
6045
7077
|
* 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
7078
|
*/
|
|
6047
7079
|
meta?: AccountManagementMetaTimestamps;
|
|
6048
|
-
|
|
7080
|
+
relationships?: {
|
|
6049
7081
|
/**
|
|
6050
|
-
*
|
|
7082
|
+
* Tags associated with the account.
|
|
6051
7083
|
*/
|
|
6052
|
-
|
|
7084
|
+
account_tags?: {
|
|
7085
|
+
data?: Array<{
|
|
7086
|
+
/**
|
|
7087
|
+
* The unique identifier for an Account Tag.
|
|
7088
|
+
*/
|
|
7089
|
+
id?: Uuid;
|
|
7090
|
+
type?: "account_tag";
|
|
7091
|
+
}>;
|
|
7092
|
+
};
|
|
7093
|
+
ancestors?: Array<{
|
|
7094
|
+
data?: {
|
|
7095
|
+
/**
|
|
7096
|
+
* The unique identifier for an Account.
|
|
7097
|
+
*/
|
|
7098
|
+
id?: Uuid;
|
|
7099
|
+
type?: "account";
|
|
7100
|
+
};
|
|
7101
|
+
}>;
|
|
7102
|
+
parent?: {
|
|
7103
|
+
data?: {
|
|
7104
|
+
type?: "account";
|
|
7105
|
+
/**
|
|
7106
|
+
* The unique identifier for an Account.
|
|
7107
|
+
*/
|
|
7108
|
+
id?: Uuid;
|
|
7109
|
+
};
|
|
7110
|
+
};
|
|
6053
7111
|
};
|
|
6054
7112
|
};
|
|
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 = {
|
|
7113
|
+
type MetaListPage = {
|
|
6060
7114
|
/**
|
|
6061
|
-
*
|
|
7115
|
+
* The maximum number of records per page for this response. You can set this value up to 100.
|
|
6062
7116
|
*/
|
|
6063
|
-
|
|
7117
|
+
limit?: number;
|
|
6064
7118
|
/**
|
|
6065
|
-
*
|
|
7119
|
+
* The current page.
|
|
6066
7120
|
*/
|
|
6067
|
-
|
|
7121
|
+
current?: number;
|
|
6068
7122
|
/**
|
|
6069
|
-
*
|
|
7123
|
+
* The current offset by number of records, not pages. Offset is zero-based.
|
|
6070
7124
|
*/
|
|
6071
|
-
|
|
7125
|
+
offset?: number;
|
|
6072
7126
|
/**
|
|
6073
|
-
*
|
|
7127
|
+
* The total page count.
|
|
6074
7128
|
*/
|
|
6075
|
-
|
|
7129
|
+
total?: number;
|
|
7130
|
+
};
|
|
7131
|
+
type MetaListResults = {
|
|
6076
7132
|
/**
|
|
6077
|
-
* The
|
|
7133
|
+
* The total number of results after applying filters, if any, or all results.
|
|
6078
7134
|
*/
|
|
6079
|
-
|
|
7135
|
+
total?: number;
|
|
6080
7136
|
};
|
|
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
|
-
};
|
|
7137
|
+
type MetaList = {
|
|
7138
|
+
page?: MetaListPage;
|
|
7139
|
+
results?: MetaListResults;
|
|
7140
|
+
};
|
|
7141
|
+
type WritableParentId = {
|
|
7142
|
+
/**
|
|
7143
|
+
* Specifies the ID of the parent account, this field cannot be changed after creation.
|
|
7144
|
+
*/
|
|
7145
|
+
parent_id?: string | null;
|
|
7146
|
+
};
|
|
7147
|
+
type AccountTagsRelationshipIdentifier = {
|
|
7148
|
+
/**
|
|
7149
|
+
* The unique identifier for the related Account Tag.
|
|
7150
|
+
*/
|
|
7151
|
+
id?: string;
|
|
7152
|
+
/**
|
|
7153
|
+
* Specifies the type of the resource object.
|
|
7154
|
+
*/
|
|
7155
|
+
type?: "account_tag";
|
|
7156
|
+
};
|
|
7157
|
+
type AccountTagsRelationshipResponse = {
|
|
7158
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
6109
7159
|
links?: {
|
|
6110
7160
|
/**
|
|
6111
7161
|
* A URL to the specific resource.
|
|
@@ -6113,17 +7163,11 @@ type AccountAuthenticationSettingsResponse = AccountAuthenticationSettings & {
|
|
|
6113
7163
|
self?: string;
|
|
6114
7164
|
};
|
|
6115
7165
|
};
|
|
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
|
-
};
|
|
7166
|
+
type AddAccountTagsOnAccount = {
|
|
7167
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
7168
|
+
};
|
|
7169
|
+
type RemoveAccountTagsOnAccount = {
|
|
7170
|
+
data?: Array<AccountTagsRelationshipIdentifier>;
|
|
6127
7171
|
};
|
|
6128
7172
|
type AccountMember = {
|
|
6129
7173
|
/**
|
|
@@ -6133,11 +7177,23 @@ type AccountMember = {
|
|
|
6133
7177
|
/**
|
|
6134
7178
|
* The type of the object that is returned.
|
|
6135
7179
|
*/
|
|
6136
|
-
type?:
|
|
7180
|
+
type?: "account_member";
|
|
6137
7181
|
/**
|
|
6138
7182
|
* The name of the account member.
|
|
6139
7183
|
*/
|
|
6140
7184
|
name?: string;
|
|
7185
|
+
/**
|
|
7186
|
+
* The given name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7187
|
+
*/
|
|
7188
|
+
given_name?: string | null;
|
|
7189
|
+
/**
|
|
7190
|
+
* The middle name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7191
|
+
*/
|
|
7192
|
+
middle_name?: string | null;
|
|
7193
|
+
/**
|
|
7194
|
+
* The family name of the account member. This field is optional and not computed or extracted from the name field.
|
|
7195
|
+
*/
|
|
7196
|
+
family_name?: string | null;
|
|
6141
7197
|
/**
|
|
6142
7198
|
* The email address of the account member.
|
|
6143
7199
|
*/
|
|
@@ -6152,6 +7208,37 @@ type AccountMemberResponse = AccountMember & {
|
|
|
6152
7208
|
self?: string;
|
|
6153
7209
|
};
|
|
6154
7210
|
};
|
|
7211
|
+
type AccountMembershipResponse = {
|
|
7212
|
+
/**
|
|
7213
|
+
* Represents the unique identifier for the account membership.
|
|
7214
|
+
*/
|
|
7215
|
+
id?: string;
|
|
7216
|
+
/**
|
|
7217
|
+
* Represents the type of the object returned.
|
|
7218
|
+
*/
|
|
7219
|
+
type?: "account_membership";
|
|
7220
|
+
meta?: AccountManagementMetaTimestamps;
|
|
7221
|
+
relationships?: {
|
|
7222
|
+
account_member?: {
|
|
7223
|
+
data?: {
|
|
7224
|
+
/**
|
|
7225
|
+
* Specifies the ID of the account member.
|
|
7226
|
+
*/
|
|
7227
|
+
id?: string;
|
|
7228
|
+
/**
|
|
7229
|
+
* Specifies the type of the account member.
|
|
7230
|
+
*/
|
|
7231
|
+
type?: "account_member";
|
|
7232
|
+
};
|
|
7233
|
+
};
|
|
7234
|
+
};
|
|
7235
|
+
links?: {
|
|
7236
|
+
/**
|
|
7237
|
+
* A URL to the specific resource.
|
|
7238
|
+
*/
|
|
7239
|
+
self?: string;
|
|
7240
|
+
};
|
|
7241
|
+
};
|
|
6155
7242
|
type AccountMembership = {
|
|
6156
7243
|
/**
|
|
6157
7244
|
* Specifies the unique identifier of the account member that the membership is associated with.
|
|
@@ -6160,9 +7247,9 @@ type AccountMembership = {
|
|
|
6160
7247
|
/**
|
|
6161
7248
|
* Specifies the type of the object. Set this value to `account_membership`.
|
|
6162
7249
|
*/
|
|
6163
|
-
type?:
|
|
7250
|
+
type?: "account_membership";
|
|
6164
7251
|
};
|
|
6165
|
-
type
|
|
7252
|
+
type AccountMembershipResponseUsingAccountMemberId = {
|
|
6166
7253
|
/**
|
|
6167
7254
|
* Represents the unique identifier for the account membership.
|
|
6168
7255
|
*/
|
|
@@ -6170,19 +7257,19 @@ type AccountMembershipResponse = {
|
|
|
6170
7257
|
/**
|
|
6171
7258
|
* Represents the type of the object returned.
|
|
6172
7259
|
*/
|
|
6173
|
-
type?:
|
|
7260
|
+
type?: "account_membership";
|
|
6174
7261
|
meta?: AccountManagementMetaTimestamps;
|
|
6175
7262
|
relationships?: {
|
|
6176
|
-
|
|
7263
|
+
account?: {
|
|
6177
7264
|
data?: {
|
|
6178
7265
|
/**
|
|
6179
|
-
* Specifies the ID of the account
|
|
7266
|
+
* Specifies the ID of the account.
|
|
6180
7267
|
*/
|
|
6181
7268
|
id?: string;
|
|
6182
7269
|
/**
|
|
6183
|
-
* Specifies the type of the
|
|
7270
|
+
* Specifies the type of the Account.
|
|
6184
7271
|
*/
|
|
6185
|
-
type?:
|
|
7272
|
+
type?: "account";
|
|
6186
7273
|
};
|
|
6187
7274
|
};
|
|
6188
7275
|
};
|
|
@@ -6193,29 +7280,73 @@ type AccountMembershipResponse = {
|
|
|
6193
7280
|
self?: string;
|
|
6194
7281
|
};
|
|
6195
7282
|
};
|
|
6196
|
-
type
|
|
7283
|
+
type AccountMembershipSettings = {
|
|
7284
|
+
data?: {
|
|
7285
|
+
/**
|
|
7286
|
+
* Specifies the type of object. Set this value to `account_membership_setting`.
|
|
7287
|
+
*/
|
|
7288
|
+
type?: "account_membership_setting";
|
|
7289
|
+
/**
|
|
7290
|
+
* The number of accounts an account member can be associated with. You can set this value to any number up to 10,000.
|
|
7291
|
+
*/
|
|
7292
|
+
membership_limit?: number;
|
|
7293
|
+
};
|
|
7294
|
+
};
|
|
7295
|
+
/**
|
|
7296
|
+
* 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.
|
|
7297
|
+
*/
|
|
7298
|
+
type AccountMemberSelfManagement = "disabled" | "update_only";
|
|
7299
|
+
type AccountAuthenticationSettings = {
|
|
7300
|
+
/**
|
|
7301
|
+
* Specifies the type of object. Set this value to `account_authentication_settings`.
|
|
7302
|
+
*/
|
|
7303
|
+
type?: "account_authentication_settings";
|
|
7304
|
+
/**
|
|
7305
|
+
* Set to `true` to enable self signup.
|
|
7306
|
+
*/
|
|
7307
|
+
enable_self_signup?: boolean;
|
|
7308
|
+
/**
|
|
7309
|
+
* This will automatically create an account for each new account member, using the account member’s name as the account name.
|
|
7310
|
+
*/
|
|
7311
|
+
auto_create_account_for_account_members?: boolean;
|
|
6197
7312
|
/**
|
|
6198
|
-
*
|
|
7313
|
+
* 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
7314
|
*/
|
|
6200
|
-
|
|
7315
|
+
account_member_self_management?: "disabled" | "update_only";
|
|
6201
7316
|
/**
|
|
6202
|
-
*
|
|
7317
|
+
* 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
7318
|
*/
|
|
6204
|
-
|
|
6205
|
-
|
|
6206
|
-
|
|
6207
|
-
|
|
6208
|
-
|
|
6209
|
-
|
|
6210
|
-
|
|
6211
|
-
|
|
6212
|
-
|
|
6213
|
-
|
|
6214
|
-
|
|
6215
|
-
|
|
6216
|
-
|
|
7319
|
+
account_management_authentication_token_timeout_secs?: number;
|
|
7320
|
+
};
|
|
7321
|
+
type AccountAuthenticationSettingsResponse = {
|
|
7322
|
+
data?: AccountAuthenticationSettings & {
|
|
7323
|
+
id?: Uuid;
|
|
7324
|
+
relationships?: {
|
|
7325
|
+
authentication_realm?: {
|
|
7326
|
+
data?: {
|
|
7327
|
+
/**
|
|
7328
|
+
* The ID of the authentication realm entity.
|
|
7329
|
+
*/
|
|
7330
|
+
id?: string;
|
|
7331
|
+
/**
|
|
7332
|
+
* The type of the authentication realm entity.
|
|
7333
|
+
*/
|
|
7334
|
+
type?: "authentication_realm";
|
|
7335
|
+
links?: {
|
|
7336
|
+
/**
|
|
7337
|
+
* A URL to the specific resource.
|
|
7338
|
+
*/
|
|
7339
|
+
self?: string;
|
|
7340
|
+
};
|
|
7341
|
+
};
|
|
6217
7342
|
};
|
|
6218
7343
|
};
|
|
7344
|
+
meta?: {
|
|
7345
|
+
/**
|
|
7346
|
+
* The client ID to be used in Single Sign On authentication flows for accounts.
|
|
7347
|
+
*/
|
|
7348
|
+
client_id?: string;
|
|
7349
|
+
};
|
|
6219
7350
|
};
|
|
6220
7351
|
links?: {
|
|
6221
7352
|
/**
|
|
@@ -6228,13 +7359,13 @@ type AccountManagementAuthenticationToken = {
|
|
|
6228
7359
|
/**
|
|
6229
7360
|
* Specifies the type of the object. You must use `account_management_authentication_token`.
|
|
6230
7361
|
*/
|
|
6231
|
-
type?:
|
|
7362
|
+
type?: "account_management_authentication_token";
|
|
6232
7363
|
};
|
|
6233
7364
|
type OpenIdConnectRequest = AccountManagementAuthenticationToken & {
|
|
6234
7365
|
/**
|
|
6235
7366
|
* Species the authentication mechanism. You must use `oidc`.
|
|
6236
7367
|
*/
|
|
6237
|
-
authentication_mechanism:
|
|
7368
|
+
authentication_mechanism: "oidc";
|
|
6238
7369
|
/**
|
|
6239
7370
|
* Specifies the code returned from the OpenID Connect Provider authentication.
|
|
6240
7371
|
*/
|
|
@@ -6252,7 +7383,7 @@ type PasswordRequest = AccountManagementAuthenticationToken & {
|
|
|
6252
7383
|
/**
|
|
6253
7384
|
* Species the authentication mechanism. You must use `password`.
|
|
6254
7385
|
*/
|
|
6255
|
-
authentication_mechanism:
|
|
7386
|
+
authentication_mechanism: "password";
|
|
6256
7387
|
/**
|
|
6257
7388
|
* 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
7389
|
*/
|
|
@@ -6266,11 +7397,29 @@ type PasswordRequest = AccountManagementAuthenticationToken & {
|
|
|
6266
7397
|
*/
|
|
6267
7398
|
password: string;
|
|
6268
7399
|
};
|
|
7400
|
+
type PasswordlessRequest = AccountManagementAuthenticationToken & {
|
|
7401
|
+
/**
|
|
7402
|
+
* Species the authentication mechanism. You must use `passwordless`.
|
|
7403
|
+
*/
|
|
7404
|
+
authentication_mechanism: "passwordless";
|
|
7405
|
+
/**
|
|
7406
|
+
* 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).
|
|
7407
|
+
*/
|
|
7408
|
+
password_profile_id: string;
|
|
7409
|
+
/**
|
|
7410
|
+
* The username.
|
|
7411
|
+
*/
|
|
7412
|
+
username: string;
|
|
7413
|
+
/**
|
|
7414
|
+
* The one-time password token.
|
|
7415
|
+
*/
|
|
7416
|
+
one_time_password_token: string;
|
|
7417
|
+
};
|
|
6269
7418
|
type SelfSignupRequest = AccountManagementAuthenticationToken & {
|
|
6270
7419
|
/**
|
|
6271
7420
|
* Species the authentication mechanism. You must use `self_signup`.
|
|
6272
7421
|
*/
|
|
6273
|
-
authentication_mechanism:
|
|
7422
|
+
authentication_mechanism: "self_signup";
|
|
6274
7423
|
/**
|
|
6275
7424
|
* 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
7425
|
*/
|
|
@@ -6288,39 +7437,33 @@ type SelfSignupRequest = AccountManagementAuthenticationToken & {
|
|
|
6288
7437
|
*/
|
|
6289
7438
|
name: string;
|
|
6290
7439
|
/**
|
|
6291
|
-
* The
|
|
6292
|
-
*/
|
|
6293
|
-
email: string;
|
|
6294
|
-
};
|
|
6295
|
-
type PasswordlessRequest = AccountManagementAuthenticationToken & {
|
|
6296
|
-
/**
|
|
6297
|
-
* Species the authentication mechanism. You must use `passwordless`.
|
|
7440
|
+
* The given name for the user.
|
|
6298
7441
|
*/
|
|
6299
|
-
|
|
7442
|
+
given_name?: string | null;
|
|
6300
7443
|
/**
|
|
6301
|
-
* The
|
|
7444
|
+
* The middle name for the user.
|
|
6302
7445
|
*/
|
|
6303
|
-
|
|
7446
|
+
middle_name?: string | null;
|
|
6304
7447
|
/**
|
|
6305
|
-
* The
|
|
7448
|
+
* The family name for the user.
|
|
6306
7449
|
*/
|
|
6307
|
-
|
|
7450
|
+
family_name?: string | null;
|
|
6308
7451
|
/**
|
|
6309
|
-
* The
|
|
7452
|
+
* The email.
|
|
6310
7453
|
*/
|
|
6311
|
-
|
|
7454
|
+
email: string;
|
|
6312
7455
|
};
|
|
6313
7456
|
type SwitchingAccountRequest = AccountManagementAuthenticationToken & {
|
|
6314
7457
|
/**
|
|
6315
7458
|
* Species the authentication mechanism. You must use `account_management_authentication_token`.
|
|
6316
7459
|
*/
|
|
6317
|
-
authentication_mechanism:
|
|
7460
|
+
authentication_mechanism: "account_management_authentication_token";
|
|
6318
7461
|
};
|
|
6319
7462
|
type AccountManagementAuthenticationTokenResponse = {
|
|
6320
7463
|
/**
|
|
6321
7464
|
* Specifies the type of the object.
|
|
6322
7465
|
*/
|
|
6323
|
-
type?:
|
|
7466
|
+
type?: "account_management_authentication_token";
|
|
6324
7467
|
/**
|
|
6325
7468
|
* The name of the account that this token grants access to.
|
|
6326
7469
|
*/
|
|
@@ -6338,14 +7481,50 @@ type AccountManagementAuthenticationTokenResponse = {
|
|
|
6338
7481
|
*/
|
|
6339
7482
|
expires?: Date;
|
|
6340
7483
|
};
|
|
7484
|
+
type MetaAccountMemberId = {
|
|
7485
|
+
/**
|
|
7486
|
+
* 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.
|
|
7487
|
+
*/
|
|
7488
|
+
account_member_id?: string;
|
|
7489
|
+
};
|
|
7490
|
+
type AccountTag = {
|
|
7491
|
+
/**
|
|
7492
|
+
* Specifies the type of the resource object, use `account_tag` for Account Tags.
|
|
7493
|
+
*/
|
|
7494
|
+
type?: "account_tag";
|
|
7495
|
+
/**
|
|
7496
|
+
* Specifies the name of the account tag.
|
|
7497
|
+
*/
|
|
7498
|
+
name?: string;
|
|
7499
|
+
/**
|
|
7500
|
+
* Describes the account tag.
|
|
7501
|
+
*/
|
|
7502
|
+
description?: string;
|
|
7503
|
+
};
|
|
7504
|
+
type AccountTagResponse = AccountTag & {
|
|
7505
|
+
/**
|
|
7506
|
+
* The unique identifier for the account tag.
|
|
7507
|
+
*/
|
|
7508
|
+
id?: Uuid;
|
|
7509
|
+
/**
|
|
7510
|
+
* Additional information for this resource.
|
|
7511
|
+
*/
|
|
7512
|
+
meta?: AccountManagementMetaTimestamps;
|
|
7513
|
+
links?: {
|
|
7514
|
+
/**
|
|
7515
|
+
* A URL to the specific resource.
|
|
7516
|
+
*/
|
|
7517
|
+
self?: string;
|
|
7518
|
+
};
|
|
7519
|
+
};
|
|
6341
7520
|
type AccountManagementMetaTimestamps = {
|
|
6342
7521
|
timestamps?: {
|
|
6343
7522
|
/**
|
|
6344
|
-
* The date the
|
|
7523
|
+
* The date the resource is created.
|
|
6345
7524
|
*/
|
|
6346
7525
|
created_at?: string;
|
|
6347
7526
|
/**
|
|
6348
|
-
* The date the
|
|
7527
|
+
* The date the resource is updated.
|
|
6349
7528
|
*/
|
|
6350
7529
|
updated_at?: string;
|
|
6351
7530
|
};
|
|
@@ -7124,9 +8303,9 @@ type IncludeAccountMember = string;
|
|
|
7124
8303
|
*/
|
|
7125
8304
|
type IncludeAccount = string;
|
|
7126
8305
|
/**
|
|
7127
|
-
*
|
|
8306
|
+
* The ID of the Account Tag.
|
|
7128
8307
|
*/
|
|
7129
|
-
type
|
|
8308
|
+
type AccountTagId = string;
|
|
7130
8309
|
/**
|
|
7131
8310
|
*
|
|
7132
8311
|
* Filtering is available for this endpoint. See [Filtering](/docs/api/pxm/files/get-all-files#filtering).
|
|
@@ -9214,22 +10393,57 @@ type GetCartsData = {
|
|
|
9214
10393
|
/**
|
|
9215
10394
|
* A customer token to access a specific customer's carts.
|
|
9216
10395
|
*/
|
|
9217
|
-
"
|
|
10396
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9218
10397
|
};
|
|
9219
10398
|
path?: never;
|
|
9220
|
-
query?:
|
|
10399
|
+
query?: {
|
|
10400
|
+
/**
|
|
10401
|
+
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
10402
|
+
*/
|
|
10403
|
+
include?: Array<"custom_discounts">;
|
|
10404
|
+
/**
|
|
10405
|
+
* The maximum number of records per page.
|
|
10406
|
+
*/
|
|
10407
|
+
"page[limit]"?: number;
|
|
10408
|
+
/**
|
|
10409
|
+
* The number of records to offset the results by.
|
|
10410
|
+
*/
|
|
10411
|
+
"page[offset]"?: number;
|
|
10412
|
+
/**
|
|
10413
|
+
* Filter expression for searching carts. For more information about filtering, see [Filtering](/guides/Getting-Started/filtering).
|
|
10414
|
+
*
|
|
10415
|
+
* :::note
|
|
10416
|
+
* 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.
|
|
10417
|
+
* :::
|
|
10418
|
+
*
|
|
10419
|
+
* **Supported Fields:**
|
|
10420
|
+
* - `account_ids`: Filter carts by associated account ID (UUID format)
|
|
10421
|
+
* - `name`: Filter carts by cart name (case-insensitive)
|
|
10422
|
+
*
|
|
10423
|
+
* **Supported Operators:**
|
|
10424
|
+
* - `contains(field,value)`: Contains value in array field
|
|
10425
|
+
* - `ilike(field,value)`: Case-insensitive string matching
|
|
10426
|
+
*
|
|
10427
|
+
* **Examples:**
|
|
10428
|
+
* - `contains(account_ids,"c24e5698-3b54-491b-9225-559c7a9cf2b2")` - Find carts associated with a specific account
|
|
10429
|
+
* - `ilike(name,"Shopping Cart")` - Find carts with name matching "Shopping Cart" (case-insensitive)
|
|
10430
|
+
* - `ilike(name,"*cart*")` - Find carts with names containing "cart" (wildcard search)
|
|
10431
|
+
*
|
|
10432
|
+
* **Combining Filters:**
|
|
10433
|
+
* You can combine multiple filters using the `:`, and `|` operator for and and or respectively:
|
|
10434
|
+
* - `contains(account_ids,"abc123"):ilike(name,"Holiday Cart")` - Find carts matching both conditions
|
|
10435
|
+
* - `contains(account_ids,"abc123")|ilike(name,"Holiday Cart")` - Find carts matching either condition.
|
|
10436
|
+
*
|
|
10437
|
+
*/
|
|
10438
|
+
filter?: string;
|
|
10439
|
+
};
|
|
9221
10440
|
url: "/v2/carts";
|
|
9222
10441
|
};
|
|
9223
10442
|
type GetCartsErrors = {
|
|
9224
10443
|
/**
|
|
9225
10444
|
* Bad Request
|
|
9226
10445
|
*/
|
|
9227
|
-
400:
|
|
9228
|
-
errors?: Array<{
|
|
9229
|
-
detail?: string;
|
|
9230
|
-
title?: string;
|
|
9231
|
-
}>;
|
|
9232
|
-
};
|
|
10446
|
+
400: ResponseErrorResponse;
|
|
9233
10447
|
/**
|
|
9234
10448
|
* Unauthorized call
|
|
9235
10449
|
*/
|
|
@@ -9244,9 +10458,13 @@ type CreateACartData = {
|
|
|
9244
10458
|
body?: CartsRequest;
|
|
9245
10459
|
headers?: {
|
|
9246
10460
|
/**
|
|
9247
|
-
*
|
|
10461
|
+
* An Account Management Authentication token for the account to be associated with the cart.
|
|
9248
10462
|
*/
|
|
9249
|
-
"
|
|
10463
|
+
"EP-Account-Management-Authentication-Token"?: string;
|
|
10464
|
+
/**
|
|
10465
|
+
* A customer token for the customer to be associated with the cart.
|
|
10466
|
+
*/
|
|
10467
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9250
10468
|
};
|
|
9251
10469
|
path?: never;
|
|
9252
10470
|
query?: never;
|
|
@@ -9256,13 +10474,7 @@ type CreateACartErrors = {
|
|
|
9256
10474
|
/**
|
|
9257
10475
|
* Bad Request
|
|
9258
10476
|
*/
|
|
9259
|
-
400:
|
|
9260
|
-
errors?: Array<{
|
|
9261
|
-
detail?: string;
|
|
9262
|
-
status?: number;
|
|
9263
|
-
title?: string;
|
|
9264
|
-
}>;
|
|
9265
|
-
};
|
|
10477
|
+
400: ResponseErrorResponse;
|
|
9266
10478
|
/**
|
|
9267
10479
|
* Unauthorized call
|
|
9268
10480
|
*/
|
|
@@ -9315,13 +10527,7 @@ type GetACartErrors = {
|
|
|
9315
10527
|
/**
|
|
9316
10528
|
* Bad Request
|
|
9317
10529
|
*/
|
|
9318
|
-
400:
|
|
9319
|
-
errors?: Array<{
|
|
9320
|
-
detail?: string;
|
|
9321
|
-
status?: number;
|
|
9322
|
-
title?: string;
|
|
9323
|
-
}>;
|
|
9324
|
-
};
|
|
10530
|
+
400: ResponseErrorResponse;
|
|
9325
10531
|
};
|
|
9326
10532
|
type GetACartError = GetACartErrors[keyof GetACartErrors];
|
|
9327
10533
|
type GetACartResponses = {
|
|
@@ -9350,13 +10556,7 @@ type UpdateACartErrors = {
|
|
|
9350
10556
|
/**
|
|
9351
10557
|
* Unprocessable Content
|
|
9352
10558
|
*/
|
|
9353
|
-
422:
|
|
9354
|
-
errors?: Array<{
|
|
9355
|
-
detail?: string;
|
|
9356
|
-
status?: number;
|
|
9357
|
-
title?: string;
|
|
9358
|
-
}>;
|
|
9359
|
-
};
|
|
10559
|
+
422: ResponseErrorItem;
|
|
9360
10560
|
};
|
|
9361
10561
|
type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors];
|
|
9362
10562
|
type UpdateACartResponses = {
|
|
@@ -9396,7 +10596,12 @@ type GetCartItemsData = {
|
|
|
9396
10596
|
*/
|
|
9397
10597
|
cartID: string;
|
|
9398
10598
|
};
|
|
9399
|
-
query?:
|
|
10599
|
+
query?: {
|
|
10600
|
+
/**
|
|
10601
|
+
* A comma-separated list of related resources to include in the response.
|
|
10602
|
+
*/
|
|
10603
|
+
include?: Array<"tax_items" | "custom_discounts" | "promotions">;
|
|
10604
|
+
};
|
|
9400
10605
|
url: "/v2/carts/{cartID}/items";
|
|
9401
10606
|
};
|
|
9402
10607
|
type GetCartItemsResponses = {
|
|
@@ -9420,7 +10625,11 @@ type ManageCartsErrors = {
|
|
|
9420
10625
|
*/
|
|
9421
10626
|
400: ResponseErrorResponse;
|
|
9422
10627
|
/**
|
|
9423
|
-
*
|
|
10628
|
+
* Unauthorized call
|
|
10629
|
+
*/
|
|
10630
|
+
403: ResponseErrorResponse;
|
|
10631
|
+
/**
|
|
10632
|
+
* 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
10633
|
*/
|
|
9425
10634
|
404: ResponseErrorResponse;
|
|
9426
10635
|
/**
|
|
@@ -9434,6 +10643,9 @@ type ManageCartsErrors = {
|
|
|
9434
10643
|
};
|
|
9435
10644
|
type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors];
|
|
9436
10645
|
type ManageCartsResponses = {
|
|
10646
|
+
/**
|
|
10647
|
+
* 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.
|
|
10648
|
+
*/
|
|
9437
10649
|
201: CartsResponse;
|
|
9438
10650
|
};
|
|
9439
10651
|
type ManageCartsResponse = ManageCartsResponses[keyof ManageCartsResponses];
|
|
@@ -9453,6 +10665,10 @@ type BulkUpdateItemsInCartErrors = {
|
|
|
9453
10665
|
* Insufficient Stock
|
|
9454
10666
|
*/
|
|
9455
10667
|
400: ResponseErrorResponse;
|
|
10668
|
+
/**
|
|
10669
|
+
* Unauthorized call
|
|
10670
|
+
*/
|
|
10671
|
+
403: ResponseErrorResponse;
|
|
9456
10672
|
/**
|
|
9457
10673
|
* Not Found
|
|
9458
10674
|
*/
|
|
@@ -9464,8 +10680,12 @@ type BulkUpdateItemsInCartErrors = {
|
|
|
9464
10680
|
};
|
|
9465
10681
|
type BulkUpdateItemsInCartError = BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors];
|
|
9466
10682
|
type BulkUpdateItemsInCartResponses = {
|
|
9467
|
-
|
|
10683
|
+
/**
|
|
10684
|
+
* Successfully updated cart items
|
|
10685
|
+
*/
|
|
10686
|
+
200: CartItemCollectionResponse;
|
|
9468
10687
|
};
|
|
10688
|
+
type BulkUpdateItemsInCartResponse = BulkUpdateItemsInCartResponses[keyof BulkUpdateItemsInCartResponses];
|
|
9469
10689
|
type DeleteACartItemData = {
|
|
9470
10690
|
body?: never;
|
|
9471
10691
|
path: {
|
|
@@ -9505,6 +10725,10 @@ type UpdateACartItemErrors = {
|
|
|
9505
10725
|
* Bad Request
|
|
9506
10726
|
*/
|
|
9507
10727
|
400: ResponseErrorResponse;
|
|
10728
|
+
/**
|
|
10729
|
+
* Unauthorized call
|
|
10730
|
+
*/
|
|
10731
|
+
403: ResponseErrorResponse;
|
|
9508
10732
|
/**
|
|
9509
10733
|
* Not Found
|
|
9510
10734
|
*/
|
|
@@ -9599,7 +10823,7 @@ type DeleteCustomerCartAssociationData = {
|
|
|
9599
10823
|
/**
|
|
9600
10824
|
* A customer token to access a specific customer's carts.
|
|
9601
10825
|
*/
|
|
9602
|
-
"
|
|
10826
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9603
10827
|
};
|
|
9604
10828
|
path: {
|
|
9605
10829
|
/**
|
|
@@ -9634,7 +10858,7 @@ type CreateCustomerCartAssociationData = {
|
|
|
9634
10858
|
/**
|
|
9635
10859
|
* A customer token to access a specific customer's carts.
|
|
9636
10860
|
*/
|
|
9637
|
-
"
|
|
10861
|
+
"X-Moltin-Customer-Token"?: string;
|
|
9638
10862
|
};
|
|
9639
10863
|
path: {
|
|
9640
10864
|
/**
|
|
@@ -9664,36 +10888,152 @@ type CreateCustomerCartAssociationResponses = {
|
|
|
9664
10888
|
/**
|
|
9665
10889
|
* OK
|
|
9666
10890
|
*/
|
|
9667
|
-
200: CartsRelationshipsCustomersData;
|
|
10891
|
+
200: CartsRelationshipsCustomersData;
|
|
10892
|
+
/**
|
|
10893
|
+
* No Content
|
|
10894
|
+
*/
|
|
10895
|
+
204: void;
|
|
10896
|
+
};
|
|
10897
|
+
type CreateCustomerCartAssociationResponse = CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses];
|
|
10898
|
+
type DeleteAPromotionViaPromotionCodeData = {
|
|
10899
|
+
body?: never;
|
|
10900
|
+
path: {
|
|
10901
|
+
/**
|
|
10902
|
+
* Specifies the unique identifier of a cart created by you.
|
|
10903
|
+
*/
|
|
10904
|
+
cartID: string;
|
|
10905
|
+
/**
|
|
10906
|
+
* Specifies the promotion code to be deleted.
|
|
10907
|
+
*/
|
|
10908
|
+
promoCode: string;
|
|
10909
|
+
};
|
|
10910
|
+
query?: never;
|
|
10911
|
+
url: "/v2/carts/{cartID}/discounts/{promoCode}";
|
|
10912
|
+
};
|
|
10913
|
+
type DeleteAPromotionViaPromotionCodeResponses = {
|
|
10914
|
+
/**
|
|
10915
|
+
* No Content
|
|
10916
|
+
*/
|
|
10917
|
+
204: void;
|
|
10918
|
+
};
|
|
10919
|
+
type DeleteAPromotionViaPromotionCodeResponse = DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses];
|
|
10920
|
+
type AddTaxItemToCartData = {
|
|
10921
|
+
body: CartItemTaxesEntityResponse;
|
|
10922
|
+
path: {
|
|
10923
|
+
/**
|
|
10924
|
+
* The unique identifier of the cart.
|
|
10925
|
+
*/
|
|
10926
|
+
cartID: string;
|
|
10927
|
+
/**
|
|
10928
|
+
* The unique identifier of the cart item.
|
|
10929
|
+
*/
|
|
10930
|
+
cartitemID: string;
|
|
10931
|
+
};
|
|
10932
|
+
query?: never;
|
|
10933
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/taxes";
|
|
10934
|
+
};
|
|
10935
|
+
type AddTaxItemToCartErrors = {
|
|
10936
|
+
/**
|
|
10937
|
+
* Unauthorized
|
|
10938
|
+
*/
|
|
10939
|
+
422: ResponseErrorResponse;
|
|
10940
|
+
};
|
|
10941
|
+
type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
|
|
10942
|
+
type AddTaxItemToCartResponses = {
|
|
10943
|
+
200: CartItemTaxesEntityResponse;
|
|
10944
|
+
/**
|
|
10945
|
+
* Created
|
|
10946
|
+
*/
|
|
10947
|
+
201: CartItemTaxesEntityResponse;
|
|
10948
|
+
};
|
|
10949
|
+
type AddTaxItemToCartResponse = AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses];
|
|
10950
|
+
type AddTaxItemToCartItemComponentData = {
|
|
10951
|
+
body: CartItemTaxesEntityResponse;
|
|
10952
|
+
path: {
|
|
10953
|
+
/**
|
|
10954
|
+
* The unique identifier of the cart.
|
|
10955
|
+
*/
|
|
10956
|
+
cartID: string;
|
|
10957
|
+
/**
|
|
10958
|
+
* The unique identifier of the cart item.
|
|
10959
|
+
*/
|
|
10960
|
+
cartitemID: string;
|
|
10961
|
+
/**
|
|
10962
|
+
* The unique identifier of the component product within the bundle.
|
|
10963
|
+
*/
|
|
10964
|
+
productID: string;
|
|
10965
|
+
};
|
|
10966
|
+
query?: never;
|
|
10967
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes";
|
|
10968
|
+
};
|
|
10969
|
+
type AddTaxItemToCartItemComponentErrors = {
|
|
10970
|
+
/**
|
|
10971
|
+
* Bad Request
|
|
10972
|
+
*/
|
|
10973
|
+
400: ResponseErrorResponse;
|
|
10974
|
+
/**
|
|
10975
|
+
* Not Found
|
|
10976
|
+
*/
|
|
10977
|
+
404: ResponseErrorResponse;
|
|
10978
|
+
/**
|
|
10979
|
+
* Unprocessable Entity
|
|
10980
|
+
*/
|
|
10981
|
+
422: ResponseErrorResponse;
|
|
10982
|
+
/**
|
|
10983
|
+
* Internal Server Error
|
|
10984
|
+
*/
|
|
10985
|
+
500: ResponseErrorResponse;
|
|
10986
|
+
};
|
|
10987
|
+
type AddTaxItemToCartItemComponentError = AddTaxItemToCartItemComponentErrors[keyof AddTaxItemToCartItemComponentErrors];
|
|
10988
|
+
type AddTaxItemToCartItemComponentResponses = {
|
|
9668
10989
|
/**
|
|
9669
|
-
*
|
|
10990
|
+
* Created
|
|
9670
10991
|
*/
|
|
9671
|
-
|
|
10992
|
+
201: CartItemTaxesEntityResponse;
|
|
9672
10993
|
};
|
|
9673
|
-
type
|
|
9674
|
-
type
|
|
10994
|
+
type AddTaxItemToCartItemComponentResponse = AddTaxItemToCartItemComponentResponses[keyof AddTaxItemToCartItemComponentResponses];
|
|
10995
|
+
type DeleteTaxItemFromCartItemComponentData = {
|
|
9675
10996
|
body?: never;
|
|
9676
10997
|
path: {
|
|
9677
10998
|
/**
|
|
9678
|
-
*
|
|
10999
|
+
* The unique identifier of the cart.
|
|
9679
11000
|
*/
|
|
9680
11001
|
cartID: string;
|
|
9681
11002
|
/**
|
|
9682
|
-
*
|
|
11003
|
+
* The unique identifier of the cart item.
|
|
9683
11004
|
*/
|
|
9684
|
-
|
|
11005
|
+
cartitemID: string;
|
|
11006
|
+
/**
|
|
11007
|
+
* The unique identifier of the component product within the bundle.
|
|
11008
|
+
*/
|
|
11009
|
+
productID: string;
|
|
11010
|
+
/**
|
|
11011
|
+
* The unique identifier of the tax item on the component product.
|
|
11012
|
+
*/
|
|
11013
|
+
taxitemID: string;
|
|
9685
11014
|
};
|
|
9686
11015
|
query?: never;
|
|
9687
|
-
url: "/v2/carts/{cartID}/
|
|
11016
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}";
|
|
9688
11017
|
};
|
|
9689
|
-
type
|
|
11018
|
+
type DeleteTaxItemFromCartItemComponentErrors = {
|
|
11019
|
+
/**
|
|
11020
|
+
* Not Found
|
|
11021
|
+
*/
|
|
11022
|
+
404: ResponseErrorResponse;
|
|
11023
|
+
/**
|
|
11024
|
+
* Internal Server Error
|
|
11025
|
+
*/
|
|
11026
|
+
500: ResponseErrorResponse;
|
|
11027
|
+
};
|
|
11028
|
+
type DeleteTaxItemFromCartItemComponentError = DeleteTaxItemFromCartItemComponentErrors[keyof DeleteTaxItemFromCartItemComponentErrors];
|
|
11029
|
+
type DeleteTaxItemFromCartItemComponentResponses = {
|
|
9690
11030
|
/**
|
|
9691
11031
|
* No Content
|
|
9692
11032
|
*/
|
|
9693
11033
|
204: void;
|
|
9694
11034
|
};
|
|
9695
|
-
type
|
|
9696
|
-
type
|
|
11035
|
+
type DeleteTaxItemFromCartItemComponentResponse = DeleteTaxItemFromCartItemComponentResponses[keyof DeleteTaxItemFromCartItemComponentResponses];
|
|
11036
|
+
type UpdateTaxItemFromCartItemComponentData = {
|
|
9697
11037
|
body?: CartItemTaxesEntityResponse;
|
|
9698
11038
|
path: {
|
|
9699
11039
|
/**
|
|
@@ -9704,25 +11044,22 @@ type AddTaxItemToCartData = {
|
|
|
9704
11044
|
* The unique identifier of the cart item.
|
|
9705
11045
|
*/
|
|
9706
11046
|
cartitemID: string;
|
|
11047
|
+
/**
|
|
11048
|
+
* The unique identifier of the component product within the bundle.
|
|
11049
|
+
*/
|
|
11050
|
+
productID: string;
|
|
11051
|
+
/**
|
|
11052
|
+
* The unique identifier of the tax item on the component product.
|
|
11053
|
+
*/
|
|
11054
|
+
taxitemID: string;
|
|
9707
11055
|
};
|
|
9708
11056
|
query?: never;
|
|
9709
|
-
url: "/v2/carts/{cartID}/items/{cartitemID}/taxes";
|
|
11057
|
+
url: "/v2/carts/{cartID}/items/{cartitemID}/components/{productID}/taxes/{taxitemID}";
|
|
9710
11058
|
};
|
|
9711
|
-
type
|
|
9712
|
-
/**
|
|
9713
|
-
* Unauthorized
|
|
9714
|
-
*/
|
|
9715
|
-
422: ResponseErrorResponse;
|
|
9716
|
-
};
|
|
9717
|
-
type AddTaxItemToCartError = AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors];
|
|
9718
|
-
type AddTaxItemToCartResponses = {
|
|
11059
|
+
type UpdateTaxItemFromCartItemComponentResponses = {
|
|
9719
11060
|
200: CartItemTaxesEntityResponse;
|
|
9720
|
-
/**
|
|
9721
|
-
* Created
|
|
9722
|
-
*/
|
|
9723
|
-
201: CartItemTaxesEntityResponse;
|
|
9724
11061
|
};
|
|
9725
|
-
type
|
|
11062
|
+
type UpdateTaxItemFromCartItemComponentResponse = UpdateTaxItemFromCartItemComponentResponses[keyof UpdateTaxItemFromCartItemComponentResponses];
|
|
9726
11063
|
type BulkDeleteTaxItemsFromCartData = {
|
|
9727
11064
|
body?: never;
|
|
9728
11065
|
path: {
|
|
@@ -9734,6 +11071,13 @@ type BulkDeleteTaxItemsFromCartData = {
|
|
|
9734
11071
|
query?: never;
|
|
9735
11072
|
url: "/v2/carts/{cartID}/taxes";
|
|
9736
11073
|
};
|
|
11074
|
+
type BulkDeleteTaxItemsFromCartErrors = {
|
|
11075
|
+
/**
|
|
11076
|
+
* Not Found - No tax items exist in the cart
|
|
11077
|
+
*/
|
|
11078
|
+
404: ResponseErrorResponse;
|
|
11079
|
+
};
|
|
11080
|
+
type BulkDeleteTaxItemsFromCartError = BulkDeleteTaxItemsFromCartErrors[keyof BulkDeleteTaxItemsFromCartErrors];
|
|
9737
11081
|
type BulkDeleteTaxItemsFromCartResponses = {
|
|
9738
11082
|
/**
|
|
9739
11083
|
* No Content
|
|
@@ -10036,7 +11380,7 @@ type CreateShippingGroupResponses = {
|
|
|
10036
11380
|
/**
|
|
10037
11381
|
* Shipping group created successfully
|
|
10038
11382
|
*/
|
|
10039
|
-
201:
|
|
11383
|
+
201: ShippingGroupEntityResponse;
|
|
10040
11384
|
};
|
|
10041
11385
|
type CreateShippingGroupResponse = CreateShippingGroupResponses[keyof CreateShippingGroupResponses];
|
|
10042
11386
|
type DeleteCartShippingGroupData = {
|
|
@@ -10133,7 +11477,7 @@ type UpdateShippingGroupResponses = {
|
|
|
10133
11477
|
/**
|
|
10134
11478
|
* Shipping group updated successfully
|
|
10135
11479
|
*/
|
|
10136
|
-
200:
|
|
11480
|
+
200: ShippingGroupEntityResponse;
|
|
10137
11481
|
};
|
|
10138
11482
|
type UpdateShippingGroupResponse = UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses];
|
|
10139
11483
|
type CreateCartPaymentIntentData = {
|
|
@@ -10151,7 +11495,7 @@ type CreateCartPaymentIntentResponses = {
|
|
|
10151
11495
|
/**
|
|
10152
11496
|
* Payment Intent created successfully.
|
|
10153
11497
|
*/
|
|
10154
|
-
201:
|
|
11498
|
+
201: CartEntityResponse;
|
|
10155
11499
|
};
|
|
10156
11500
|
type CreateCartPaymentIntentResponse = CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses];
|
|
10157
11501
|
type UpdateCartPaymentIntentData = {
|
|
@@ -10173,7 +11517,7 @@ type UpdateCartPaymentIntentResponses = {
|
|
|
10173
11517
|
/**
|
|
10174
11518
|
* Payment updated successfully
|
|
10175
11519
|
*/
|
|
10176
|
-
200:
|
|
11520
|
+
200: CartEntityResponse;
|
|
10177
11521
|
};
|
|
10178
11522
|
type UpdateCartPaymentIntentResponse = UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses];
|
|
10179
11523
|
type CheckoutApiData = {
|
|
@@ -10221,11 +11565,6 @@ type GetCustomerOrdersData = {
|
|
|
10221
11565
|
};
|
|
10222
11566
|
path?: never;
|
|
10223
11567
|
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
11568
|
include?: Array<"items">;
|
|
10230
11569
|
/**
|
|
10231
11570
|
* 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 +11574,11 @@ type GetCustomerOrdersData = {
|
|
|
10235
11574
|
* 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
11575
|
*/
|
|
10237
11576
|
"page[offset]"?: number;
|
|
11577
|
+
/**
|
|
11578
|
+
* 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.
|
|
11579
|
+
*
|
|
11580
|
+
*/
|
|
11581
|
+
filter?: string;
|
|
10238
11582
|
};
|
|
10239
11583
|
url: "/v2/orders";
|
|
10240
11584
|
};
|
|
@@ -10306,7 +11650,12 @@ type GetOrderItemsData = {
|
|
|
10306
11650
|
*/
|
|
10307
11651
|
orderID: string;
|
|
10308
11652
|
};
|
|
10309
|
-
query?:
|
|
11653
|
+
query?: {
|
|
11654
|
+
/**
|
|
11655
|
+
* Comma-delimited string of entities to include (tax_items, custom_discounts, promotions).
|
|
11656
|
+
*/
|
|
11657
|
+
include?: string;
|
|
11658
|
+
};
|
|
10310
11659
|
url: "/v2/orders/{orderID}/items";
|
|
10311
11660
|
};
|
|
10312
11661
|
type GetOrderItemsResponses = {
|
|
@@ -10363,7 +11712,7 @@ type ConfirmOrderResponses = {
|
|
|
10363
11712
|
/**
|
|
10364
11713
|
* Order confirmed successfully
|
|
10365
11714
|
*/
|
|
10366
|
-
200:
|
|
11715
|
+
200: TransactionEntityResponse;
|
|
10367
11716
|
};
|
|
10368
11717
|
type ConfirmOrderResponse = ConfirmOrderResponses[keyof ConfirmOrderResponses];
|
|
10369
11718
|
type PaymentSetupData = {
|
|
@@ -10657,7 +12006,12 @@ type GetShippingGroupsByIdData = {
|
|
|
10657
12006
|
*/
|
|
10658
12007
|
shippingGroupID: string;
|
|
10659
12008
|
};
|
|
10660
|
-
query?:
|
|
12009
|
+
query?: {
|
|
12010
|
+
/**
|
|
12011
|
+
* A comma-separated list of related resources to include in the response.
|
|
12012
|
+
*/
|
|
12013
|
+
include?: "items";
|
|
12014
|
+
};
|
|
10661
12015
|
url: "/v2/orders/{orderID}/shipping-groups/{shippingGroupID}";
|
|
10662
12016
|
};
|
|
10663
12017
|
type GetShippingGroupsByIdErrors = {
|
|
@@ -10671,9 +12025,7 @@ type GetShippingGroupsByIdResponses = {
|
|
|
10671
12025
|
/**
|
|
10672
12026
|
* Shipping group details
|
|
10673
12027
|
*/
|
|
10674
|
-
200:
|
|
10675
|
-
data?: ShippingGroupResponse;
|
|
10676
|
-
};
|
|
12028
|
+
200: ShippingGroupEntityResponse;
|
|
10677
12029
|
};
|
|
10678
12030
|
type GetShippingGroupsByIdResponse = GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses];
|
|
10679
12031
|
type PutShippingGroupByIdData = {
|
|
@@ -10706,9 +12058,115 @@ type PutShippingGroupByIdResponses = {
|
|
|
10706
12058
|
/**
|
|
10707
12059
|
* Shipping group updated successfully
|
|
10708
12060
|
*/
|
|
10709
|
-
200:
|
|
12061
|
+
200: ShippingGroupEntityResponse;
|
|
10710
12062
|
};
|
|
10711
12063
|
type PutShippingGroupByIdResponse = PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses];
|
|
12064
|
+
type GetV2SettingsCartData = {
|
|
12065
|
+
body?: never;
|
|
12066
|
+
path?: never;
|
|
12067
|
+
query?: never;
|
|
12068
|
+
url: "/v2/settings/cart";
|
|
12069
|
+
};
|
|
12070
|
+
type GetV2SettingsCartErrors = {
|
|
12071
|
+
/**
|
|
12072
|
+
* Unauthorized
|
|
12073
|
+
*/
|
|
12074
|
+
401: ResponseErrorResponse;
|
|
12075
|
+
};
|
|
12076
|
+
type GetV2SettingsCartError = GetV2SettingsCartErrors[keyof GetV2SettingsCartErrors];
|
|
12077
|
+
type GetV2SettingsCartResponses = {
|
|
12078
|
+
/**
|
|
12079
|
+
* OK
|
|
12080
|
+
*/
|
|
12081
|
+
200: SettingsCart;
|
|
12082
|
+
};
|
|
12083
|
+
type GetV2SettingsCartResponse = GetV2SettingsCartResponses[keyof GetV2SettingsCartResponses];
|
|
12084
|
+
type PutV2SettingsCartData = {
|
|
12085
|
+
body?: SettingsCart;
|
|
12086
|
+
path?: never;
|
|
12087
|
+
query?: never;
|
|
12088
|
+
url: "/v2/settings/cart";
|
|
12089
|
+
};
|
|
12090
|
+
type PutV2SettingsCartErrors = {
|
|
12091
|
+
/**
|
|
12092
|
+
* Bad Request
|
|
12093
|
+
*/
|
|
12094
|
+
400: ResponseErrorResponse;
|
|
12095
|
+
/**
|
|
12096
|
+
* Unauthorized
|
|
12097
|
+
*/
|
|
12098
|
+
401: ResponseErrorResponse;
|
|
12099
|
+
/**
|
|
12100
|
+
* Forbidden
|
|
12101
|
+
*/
|
|
12102
|
+
403: ResponseErrorResponse;
|
|
12103
|
+
};
|
|
12104
|
+
type PutV2SettingsCartError = PutV2SettingsCartErrors[keyof PutV2SettingsCartErrors];
|
|
12105
|
+
type PutV2SettingsCartResponses = {
|
|
12106
|
+
/**
|
|
12107
|
+
* OK
|
|
12108
|
+
*/
|
|
12109
|
+
200: SettingsCart;
|
|
12110
|
+
};
|
|
12111
|
+
type PutV2SettingsCartResponse = PutV2SettingsCartResponses[keyof PutV2SettingsCartResponses];
|
|
12112
|
+
type GetV2SettingsCartStoreIdData = {
|
|
12113
|
+
body?: never;
|
|
12114
|
+
path: {
|
|
12115
|
+
/**
|
|
12116
|
+
* The store ID.
|
|
12117
|
+
*/
|
|
12118
|
+
storeID: string;
|
|
12119
|
+
};
|
|
12120
|
+
query?: never;
|
|
12121
|
+
url: "/v2/settings/cart/{storeID}";
|
|
12122
|
+
};
|
|
12123
|
+
type GetV2SettingsCartStoreIdErrors = {
|
|
12124
|
+
/**
|
|
12125
|
+
* Unauthorized
|
|
12126
|
+
*/
|
|
12127
|
+
401: ResponseErrorResponse;
|
|
12128
|
+
};
|
|
12129
|
+
type GetV2SettingsCartStoreIdError = GetV2SettingsCartStoreIdErrors[keyof GetV2SettingsCartStoreIdErrors];
|
|
12130
|
+
type GetV2SettingsCartStoreIdResponses = {
|
|
12131
|
+
/**
|
|
12132
|
+
* OK
|
|
12133
|
+
*/
|
|
12134
|
+
200: SettingsCart;
|
|
12135
|
+
};
|
|
12136
|
+
type GetV2SettingsCartStoreIdResponse = GetV2SettingsCartStoreIdResponses[keyof GetV2SettingsCartStoreIdResponses];
|
|
12137
|
+
type PutV2SettingsCartStoreIdData = {
|
|
12138
|
+
body?: SettingsCart;
|
|
12139
|
+
path: {
|
|
12140
|
+
/**
|
|
12141
|
+
* The store ID.
|
|
12142
|
+
*/
|
|
12143
|
+
storeID: string;
|
|
12144
|
+
};
|
|
12145
|
+
query?: never;
|
|
12146
|
+
url: "/v2/settings/cart/{storeID}";
|
|
12147
|
+
};
|
|
12148
|
+
type PutV2SettingsCartStoreIdErrors = {
|
|
12149
|
+
/**
|
|
12150
|
+
* Bad Request
|
|
12151
|
+
*/
|
|
12152
|
+
400: ResponseErrorResponse;
|
|
12153
|
+
/**
|
|
12154
|
+
* Unauthorized
|
|
12155
|
+
*/
|
|
12156
|
+
401: ResponseErrorResponse;
|
|
12157
|
+
/**
|
|
12158
|
+
* Forbidden
|
|
12159
|
+
*/
|
|
12160
|
+
403: ResponseErrorResponse;
|
|
12161
|
+
};
|
|
12162
|
+
type PutV2SettingsCartStoreIdError = PutV2SettingsCartStoreIdErrors[keyof PutV2SettingsCartStoreIdErrors];
|
|
12163
|
+
type PutV2SettingsCartStoreIdResponses = {
|
|
12164
|
+
/**
|
|
12165
|
+
* OK
|
|
12166
|
+
*/
|
|
12167
|
+
200: SettingsCart;
|
|
12168
|
+
};
|
|
12169
|
+
type PutV2SettingsCartStoreIdResponse = PutV2SettingsCartStoreIdResponses[keyof PutV2SettingsCartStoreIdResponses];
|
|
10712
12170
|
type ListOfferingsData = {
|
|
10713
12171
|
body?: never;
|
|
10714
12172
|
path?: never;
|
|
@@ -11725,6 +13183,10 @@ type PutV2AccountAddressResponses = {
|
|
|
11725
13183
|
};
|
|
11726
13184
|
};
|
|
11727
13185
|
type PutV2AccountAddressResponse = PutV2AccountAddressResponses[keyof PutV2AccountAddressResponses];
|
|
13186
|
+
/**
|
|
13187
|
+
* Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13188
|
+
*/
|
|
13189
|
+
type Sort = "created_at" | "-created_at" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11728
13190
|
type GetV2AccountsData = {
|
|
11729
13191
|
body?: never;
|
|
11730
13192
|
path?: never;
|
|
@@ -11742,13 +13204,17 @@ type GetV2AccountsData = {
|
|
|
11742
13204
|
*/
|
|
11743
13205
|
"page[offset]"?: BigInt;
|
|
11744
13206
|
/**
|
|
11745
|
-
*
|
|
13207
|
+
* Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
11746
13208
|
*/
|
|
11747
|
-
sort?:
|
|
13209
|
+
sort?: "created_at" | "-created_at" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11748
13210
|
};
|
|
11749
13211
|
url: "/v2/accounts";
|
|
11750
13212
|
};
|
|
11751
13213
|
type GetV2AccountsErrors = {
|
|
13214
|
+
/**
|
|
13215
|
+
* Bad Request
|
|
13216
|
+
*/
|
|
13217
|
+
400: AccountManagementErrorResponse;
|
|
11752
13218
|
/**
|
|
11753
13219
|
* Unauthorized
|
|
11754
13220
|
*/
|
|
@@ -11756,7 +13222,7 @@ type GetV2AccountsErrors = {
|
|
|
11756
13222
|
/**
|
|
11757
13223
|
* Internal server error.
|
|
11758
13224
|
*/
|
|
11759
|
-
|
|
13225
|
+
500: AccountManagementErrorResponse;
|
|
11760
13226
|
};
|
|
11761
13227
|
type GetV2AccountsError = GetV2AccountsErrors[keyof GetV2AccountsErrors];
|
|
11762
13228
|
type GetV2AccountsResponses = {
|
|
@@ -11764,7 +13230,14 @@ type GetV2AccountsResponses = {
|
|
|
11764
13230
|
* OK
|
|
11765
13231
|
*/
|
|
11766
13232
|
200: {
|
|
11767
|
-
data?: Array<AccountResponse
|
|
13233
|
+
data?: Array<AccountResponse & {
|
|
13234
|
+
links?: {
|
|
13235
|
+
/**
|
|
13236
|
+
* A URL to the specific resource.
|
|
13237
|
+
*/
|
|
13238
|
+
self?: string;
|
|
13239
|
+
};
|
|
13240
|
+
}>;
|
|
11768
13241
|
meta?: MetaList;
|
|
11769
13242
|
links?: {
|
|
11770
13243
|
/**
|
|
@@ -11804,10 +13277,22 @@ type PostV2AccountsErrors = {
|
|
|
11804
13277
|
* Bad Request
|
|
11805
13278
|
*/
|
|
11806
13279
|
400: AccountManagementErrorResponse;
|
|
13280
|
+
/**
|
|
13281
|
+
* Not Found
|
|
13282
|
+
*/
|
|
13283
|
+
404: AccountManagementErrorResponse;
|
|
13284
|
+
/**
|
|
13285
|
+
* Conflict
|
|
13286
|
+
*/
|
|
13287
|
+
409: AccountManagementErrorResponse;
|
|
13288
|
+
/**
|
|
13289
|
+
* Unprocessable Entity
|
|
13290
|
+
*/
|
|
13291
|
+
422: AccountManagementErrorResponse;
|
|
11807
13292
|
/**
|
|
11808
13293
|
* Internal server error.
|
|
11809
13294
|
*/
|
|
11810
|
-
|
|
13295
|
+
500: AccountManagementErrorResponse;
|
|
11811
13296
|
};
|
|
11812
13297
|
type PostV2AccountsError = PostV2AccountsErrors[keyof PostV2AccountsErrors];
|
|
11813
13298
|
type PostV2AccountsResponses = {
|
|
@@ -11816,6 +13301,12 @@ type PostV2AccountsResponses = {
|
|
|
11816
13301
|
*/
|
|
11817
13302
|
201: {
|
|
11818
13303
|
data?: AccountResponse;
|
|
13304
|
+
links?: {
|
|
13305
|
+
/**
|
|
13306
|
+
* A URL to the specific resource.
|
|
13307
|
+
*/
|
|
13308
|
+
self?: string;
|
|
13309
|
+
};
|
|
11819
13310
|
};
|
|
11820
13311
|
};
|
|
11821
13312
|
type PostV2AccountsResponse = PostV2AccountsResponses[keyof PostV2AccountsResponses];
|
|
@@ -11838,7 +13329,7 @@ type GetV2AccountsAccountIdErrors = {
|
|
|
11838
13329
|
/**
|
|
11839
13330
|
* Internal server error.
|
|
11840
13331
|
*/
|
|
11841
|
-
|
|
13332
|
+
500: AccountManagementErrorResponse;
|
|
11842
13333
|
};
|
|
11843
13334
|
type GetV2AccountsAccountIdError = GetV2AccountsAccountIdErrors[keyof GetV2AccountsAccountIdErrors];
|
|
11844
13335
|
type GetV2AccountsAccountIdResponses = {
|
|
@@ -11847,6 +13338,12 @@ type GetV2AccountsAccountIdResponses = {
|
|
|
11847
13338
|
*/
|
|
11848
13339
|
200: {
|
|
11849
13340
|
data?: AccountResponse;
|
|
13341
|
+
links?: {
|
|
13342
|
+
/**
|
|
13343
|
+
* A URL to the specific resource.
|
|
13344
|
+
*/
|
|
13345
|
+
self?: string;
|
|
13346
|
+
};
|
|
11850
13347
|
};
|
|
11851
13348
|
};
|
|
11852
13349
|
type GetV2AccountsAccountIdResponse = GetV2AccountsAccountIdResponses[keyof GetV2AccountsAccountIdResponses];
|
|
@@ -11884,10 +13381,14 @@ type PutV2AccountsAccountIdErrors = {
|
|
|
11884
13381
|
title?: string;
|
|
11885
13382
|
}>;
|
|
11886
13383
|
};
|
|
13384
|
+
/**
|
|
13385
|
+
* Conflict
|
|
13386
|
+
*/
|
|
13387
|
+
409: AccountManagementErrorResponse;
|
|
11887
13388
|
/**
|
|
11888
13389
|
* Internal server error.
|
|
11889
13390
|
*/
|
|
11890
|
-
|
|
13391
|
+
500: AccountManagementErrorResponse;
|
|
11891
13392
|
};
|
|
11892
13393
|
type PutV2AccountsAccountIdError = PutV2AccountsAccountIdErrors[keyof PutV2AccountsAccountIdErrors];
|
|
11893
13394
|
type PutV2AccountsAccountIdResponses = {
|
|
@@ -11895,49 +13396,12 @@ type PutV2AccountsAccountIdResponses = {
|
|
|
11895
13396
|
* OK
|
|
11896
13397
|
*/
|
|
11897
13398
|
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;
|
|
13399
|
+
data?: AccountResponse;
|
|
13400
|
+
links?: {
|
|
11919
13401
|
/**
|
|
11920
|
-
*
|
|
13402
|
+
* A URL to the specific resource.
|
|
11921
13403
|
*/
|
|
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
|
-
};
|
|
13404
|
+
self?: string;
|
|
11941
13405
|
};
|
|
11942
13406
|
};
|
|
11943
13407
|
};
|
|
@@ -11954,18 +13418,22 @@ type GetV2AccountMembersData = {
|
|
|
11954
13418
|
* The number of records to offset the results by.
|
|
11955
13419
|
*/
|
|
11956
13420
|
"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
13421
|
/**
|
|
11962
13422
|
* Specifies the filter attributes.
|
|
11963
13423
|
*/
|
|
11964
13424
|
filter?: string;
|
|
13425
|
+
/**
|
|
13426
|
+
* Specifies the order in which account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13427
|
+
*/
|
|
13428
|
+
sort?: "created_at" | "-created_at" | "email" | "-email" | "id" | "-id" | "name" | "-name" | "updated_at" | "-updated_at";
|
|
11965
13429
|
};
|
|
11966
13430
|
url: "/v2/account-members";
|
|
11967
13431
|
};
|
|
11968
13432
|
type GetV2AccountMembersErrors = {
|
|
13433
|
+
/**
|
|
13434
|
+
* Bad Request
|
|
13435
|
+
*/
|
|
13436
|
+
400: AccountManagementErrorResponse;
|
|
11969
13437
|
/**
|
|
11970
13438
|
* Unauthorized
|
|
11971
13439
|
*/
|
|
@@ -11973,7 +13441,7 @@ type GetV2AccountMembersErrors = {
|
|
|
11973
13441
|
/**
|
|
11974
13442
|
* Internal server error.
|
|
11975
13443
|
*/
|
|
11976
|
-
|
|
13444
|
+
500: AccountManagementErrorResponse;
|
|
11977
13445
|
};
|
|
11978
13446
|
type GetV2AccountMembersError = GetV2AccountMembersErrors[keyof GetV2AccountMembersErrors];
|
|
11979
13447
|
type GetV2AccountMembersResponses = {
|
|
@@ -12020,6 +13488,10 @@ type GetV2AccountMembersAccountMemberIdData = {
|
|
|
12020
13488
|
url: "/v2/account-members/{accountMemberID}";
|
|
12021
13489
|
};
|
|
12022
13490
|
type GetV2AccountMembersAccountMemberIdErrors = {
|
|
13491
|
+
/**
|
|
13492
|
+
* Bad Request
|
|
13493
|
+
*/
|
|
13494
|
+
400: AccountManagementErrorResponse;
|
|
12023
13495
|
/**
|
|
12024
13496
|
* Not Found
|
|
12025
13497
|
*/
|
|
@@ -12027,7 +13499,7 @@ type GetV2AccountMembersAccountMemberIdErrors = {
|
|
|
12027
13499
|
/**
|
|
12028
13500
|
* Internal server error.
|
|
12029
13501
|
*/
|
|
12030
|
-
|
|
13502
|
+
500: AccountManagementErrorResponse;
|
|
12031
13503
|
};
|
|
12032
13504
|
type GetV2AccountMembersAccountMemberIdError = GetV2AccountMembersAccountMemberIdErrors[keyof GetV2AccountMembersAccountMemberIdErrors];
|
|
12033
13505
|
type GetV2AccountMembersAccountMemberIdResponses = {
|
|
@@ -12036,6 +13508,12 @@ type GetV2AccountMembersAccountMemberIdResponses = {
|
|
|
12036
13508
|
*/
|
|
12037
13509
|
200: {
|
|
12038
13510
|
data?: AccountMemberResponse;
|
|
13511
|
+
links?: {
|
|
13512
|
+
/**
|
|
13513
|
+
* A URL to the specific resource.
|
|
13514
|
+
*/
|
|
13515
|
+
self?: string;
|
|
13516
|
+
};
|
|
12039
13517
|
};
|
|
12040
13518
|
};
|
|
12041
13519
|
type GetV2AccountMembersAccountMemberIdResponse = GetV2AccountMembersAccountMemberIdResponses[keyof GetV2AccountMembersAccountMemberIdResponses];
|
|
@@ -12052,10 +13530,6 @@ type GetV2AccountsAccountIdAccountMembershipsData = {
|
|
|
12052
13530
|
* Specifies the filter attributes.
|
|
12053
13531
|
*/
|
|
12054
13532
|
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
13533
|
/**
|
|
12060
13534
|
* The number of records per page.
|
|
12061
13535
|
*/
|
|
@@ -12068,10 +13542,18 @@ type GetV2AccountsAccountIdAccountMembershipsData = {
|
|
|
12068
13542
|
* Parameter to retrieve more information about any related resources like account members.
|
|
12069
13543
|
*/
|
|
12070
13544
|
include?: string;
|
|
13545
|
+
/**
|
|
13546
|
+
* Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).
|
|
13547
|
+
*/
|
|
13548
|
+
sort?: "created_at" | "-created_at" | "updated_at" | "-updated_at" | "id" | "-id";
|
|
12071
13549
|
};
|
|
12072
13550
|
url: "/v2/accounts/{accountID}/account-memberships";
|
|
12073
13551
|
};
|
|
12074
13552
|
type GetV2AccountsAccountIdAccountMembershipsErrors = {
|
|
13553
|
+
/**
|
|
13554
|
+
* Bad Request
|
|
13555
|
+
*/
|
|
13556
|
+
400: AccountManagementErrorResponse;
|
|
12075
13557
|
/**
|
|
12076
13558
|
* Not Found
|
|
12077
13559
|
*/
|
|
@@ -12079,7 +13561,7 @@ type GetV2AccountsAccountIdAccountMembershipsErrors = {
|
|
|
12079
13561
|
/**
|
|
12080
13562
|
* Internal server error.
|
|
12081
13563
|
*/
|
|
12082
|
-
|
|
13564
|
+
500: AccountManagementErrorResponse;
|
|
12083
13565
|
};
|
|
12084
13566
|
type GetV2AccountsAccountIdAccountMembershipsError = GetV2AccountsAccountIdAccountMembershipsErrors[keyof GetV2AccountsAccountIdAccountMembershipsErrors];
|
|
12085
13567
|
type GetV2AccountsAccountIdAccountMembershipsResponses = {
|
|
@@ -12087,7 +13569,12 @@ type GetV2AccountsAccountIdAccountMembershipsResponses = {
|
|
|
12087
13569
|
* OK
|
|
12088
13570
|
*/
|
|
12089
13571
|
200: {
|
|
12090
|
-
data?: Array<AccountMembershipResponse
|
|
13572
|
+
data?: Array<AccountMembershipResponse & {
|
|
13573
|
+
/**
|
|
13574
|
+
* The unique identifier for an Account Member.
|
|
13575
|
+
*/
|
|
13576
|
+
account_member_id?: Uuid;
|
|
13577
|
+
}>;
|
|
12091
13578
|
meta?: MetaList;
|
|
12092
13579
|
links?: {
|
|
12093
13580
|
/**
|
|
@@ -12133,14 +13620,30 @@ type PostV2AccountMembersTokensData = {
|
|
|
12133
13620
|
url: "/v2/account-members/tokens";
|
|
12134
13621
|
};
|
|
12135
13622
|
type PostV2AccountMembersTokensErrors = {
|
|
13623
|
+
/**
|
|
13624
|
+
* Bad Request
|
|
13625
|
+
*/
|
|
13626
|
+
400: AccountManagementErrorResponse;
|
|
12136
13627
|
/**
|
|
12137
13628
|
* Unauthorized
|
|
12138
13629
|
*/
|
|
12139
13630
|
401: AccountManagementErrorResponse;
|
|
13631
|
+
/**
|
|
13632
|
+
* Forbidden Error
|
|
13633
|
+
*/
|
|
13634
|
+
403: AccountManagementErrorResponse;
|
|
13635
|
+
/**
|
|
13636
|
+
* Not Found
|
|
13637
|
+
*/
|
|
13638
|
+
404: AccountManagementErrorResponse;
|
|
13639
|
+
/**
|
|
13640
|
+
* Unprocessable Entity
|
|
13641
|
+
*/
|
|
13642
|
+
422: AccountManagementErrorResponse;
|
|
12140
13643
|
/**
|
|
12141
13644
|
* Internal server error.
|
|
12142
13645
|
*/
|
|
12143
|
-
|
|
13646
|
+
500: AccountManagementErrorResponse;
|
|
12144
13647
|
};
|
|
12145
13648
|
type PostV2AccountMembersTokensError = PostV2AccountMembersTokensErrors[keyof PostV2AccountMembersTokensErrors];
|
|
12146
13649
|
type PostV2AccountMembersTokensResponses = {
|
|
@@ -12149,9 +13652,7 @@ type PostV2AccountMembersTokensResponses = {
|
|
|
12149
13652
|
*/
|
|
12150
13653
|
201: {
|
|
12151
13654
|
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
12152
|
-
meta?: MetaList &
|
|
12153
|
-
account_member_id?: MetaAccountMemberId;
|
|
12154
|
-
};
|
|
13655
|
+
meta?: MetaList & MetaAccountMemberId;
|
|
12155
13656
|
links?: {
|
|
12156
13657
|
/**
|
|
12157
13658
|
* Always the current page.
|
|
@@ -12403,4 +13904,4 @@ type PostMultiSearchResponses = {
|
|
|
12403
13904
|
};
|
|
12404
13905
|
type PostMultiSearchResponse = PostMultiSearchResponses[keyof PostMultiSearchResponses];
|
|
12405
13906
|
|
|
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 };
|
|
13907
|
+
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 };
|