@epcc-sdk/sdks-shopper 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/@tanstack/react-query.gen.cjs +132 -0
- package/dist/client/@tanstack/react-query.gen.cjs.map +1 -1
- package/dist/client/@tanstack/react-query.gen.d.cts +170 -70
- package/dist/client/@tanstack/react-query.gen.d.ts +170 -70
- package/dist/client/@tanstack/react-query.gen.mjs +128 -0
- package/dist/client/@tanstack/react-query.gen.mjs.map +1 -1
- package/dist/client/index.d.cts +2 -2
- package/dist/client/index.d.ts +2 -2
- package/dist/client/sdk.gen.cjs +126 -0
- package/dist/client/sdk.gen.cjs.map +1 -1
- package/dist/client/sdk.gen.d.cts +248 -77
- package/dist/client/sdk.gen.d.ts +248 -77
- package/dist/client/sdk.gen.mjs +119 -0
- package/dist/client/sdk.gen.mjs.map +1 -1
- package/dist/client/transformers.gen.cjs +98 -34
- package/dist/client/transformers.gen.cjs.map +1 -1
- package/dist/client/transformers.gen.d.cts +7 -3
- package/dist/client/transformers.gen.d.ts +7 -3
- package/dist/client/transformers.gen.mjs +93 -33
- package/dist/client/transformers.gen.mjs.map +1 -1
- package/dist/client/types.gen.cjs.map +1 -1
- package/dist/client/types.gen.d.cts +2272 -822
- package/dist/client/types.gen.d.ts +2272 -822
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/react-query.d.cts +1 -1
- package/dist/react-query.d.ts +1 -1
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GetByContextReleaseData, ReleaseData, ErrorResponse, GetByContextAllHierarchiesData, HierarchyListData, GetByContextHierarchyData, HierarchyData, GetByContextHierarchyNodesData, NodeListData, GetByContextHierarchyChildNodesData, GetByContextAllNodesData, GetByContextNodeData, NodeData, GetByContextChildNodesData, GetByContextAllProductsData, ProductListData, GetByContextProductData, ProductData, GetByContextAllRelatedProductsData, GetByContextComponentProductIdsData, ProductReferenceListData, GetByContextChildProductsData, GetByContextProductsForHierarchyData, GetByContextProductsForNodeData, ConfigureByContextProductData, GetCatalogsData, CatalogListData, CreateCatalogData, CatalogData, DeleteCatalogByIdData, GetCatalogByIdData, UpdateCatalogData, DeleteReleasesData, GetReleasesData, ReleaseListData, PublishReleaseData, DeleteReleaseByIdData, GetReleaseByIdData, GetRulesData, RuleListData, CreateRuleData, RuleData, DeleteRuleByIdData, GetRuleByIdData, UpdateRuleData, ValidateCatalogRulesData, GetAllHierarchiesData, GetHierarchyData, GetHierarchyNodesData, GetHierarchyChildNodesData, GetAllNodesData, GetNodeData, GetChildNodesData, GetAllProductsData, GetProductData, GetAllRelatedProductsData, GetComponentProductIdsData, GetChildProductsData, GetProductsForHierarchyData, GetProductsForNodeData, GetCartsData, CartCollectionResponse,
|
|
1
|
+
import { GetByContextReleaseData, ReleaseData, ErrorResponse, GetByContextAllHierarchiesData, HierarchyListData, GetByContextHierarchyData, HierarchyData, GetByContextHierarchyNodesData, NodeListData, GetByContextHierarchyChildNodesData, GetByContextAllNodesData, GetByContextNodeData, NodeData, GetByContextChildNodesData, GetByContextAllProductsData, ProductListData, GetByContextProductData, ProductData, GetByContextAllRelatedProductsData, GetByContextComponentProductIdsData, ProductReferenceListData, GetByContextChildProductsData, GetByContextProductsForHierarchyData, GetByContextProductsForNodeData, ConfigureByContextProductData, GetCatalogsData, CatalogListData, CreateCatalogData, CatalogData, DeleteCatalogByIdData, GetCatalogByIdData, UpdateCatalogData, DeleteReleasesData, GetReleasesData, ReleaseListData, PublishReleaseData, DeleteReleaseByIdData, GetReleaseByIdData, GetRulesData, RuleListData, CreateRuleData, RuleData, DeleteRuleByIdData, GetRuleByIdData, UpdateRuleData, ValidateCatalogRulesData, GetAllHierarchiesData, GetHierarchyData, GetHierarchyNodesData, GetHierarchyChildNodesData, GetAllNodesData, GetNodeData, GetChildNodesData, GetAllProductsData, GetProductData, GetAllRelatedProductsData, GetComponentProductIdsData, GetChildProductsData, GetProductsForHierarchyData, GetProductsForNodeData, GetCartsData, CartCollectionResponse, ResponseErrorResponse, CreateACartData, CartEntityResponse, DeleteACartData, GetACartData, UpdateACartData, UpdateACartError, DeleteAllCartItemsData, GetCartItemsData, CartItemsResponse, ManageCartsData, CartsResponse, BulkUpdateItemsInCartData, CartItemCollectionResponse, DeleteACartItemData, UpdateACartItemData, DeleteAccountCartAssociationData, CreateAccountCartAssociationData, CreateAccountCartAssociationResponse, DeleteCustomerCartAssociationData, CreateCustomerCartAssociationData, CreateCustomerCartAssociationResponse, DeleteAPromotionViaPromotionCodeData, AddTaxItemToCartData, CartItemTaxesEntityResponse, AddTaxItemToCartItemComponentData, DeleteTaxItemFromCartItemComponentData, UpdateTaxItemFromCartItemComponentData, BulkDeleteTaxItemsFromCartData, BulkAddTaxItemsToCartData, CartsBulkTaxes, DeleteATaxItemData, UpdateATaxItemData, BulkDeleteCustomDiscountsFromCartData, BulkAddCustomDiscountsToCartData, CartsBulkCustomDiscountsResponse, CartsBulkCustomDiscountsCollectionResponse, DeleteCustomDiscountFromCartData, UpdateCustomDiscountForCartData, CartsCustomDiscountsEntityResponse, AddCustomDiscountToCartItemData, CartsCustomDiscountsCollectionResponse, DeleteCustomDiscountFromCartItemData, UpdateCustomDiscountForCartItemData, GetShippingGroupsData, ShippingGroupResponse, CreateShippingGroupData, ShippingGroupEntityResponse, DeleteCartShippingGroupData, GetShippingGroupByIdData, UpdateShippingGroupData, CreateCartPaymentIntentData, UpdateCartPaymentIntentData, CheckoutApiData, OrderEntityResponse, GetCustomerOrdersData, OrderCollectionResponse, GetAnOrderData, UpdateAnOrderData, GetOrderItemsData, OrderItemCollectionResponse, AnonymizeOrdersData, OrdersListResponse, ConfirmOrderData, TransactionEntityResponse, PaymentSetupData, ConfirmPaymentData, CaptureATransactionData, RefundATransactionData, GetOrderTransactionsData, TransactionListResponse, GetATransactionData, ResponseData, TransactionResponse, CancelATransactionData, GetOrderShippingGroupsData, CreateOrderShippingGroupData, GetShippingGroupsByIdData, PutShippingGroupByIdData, GetV2SettingsCartData, SettingsCart, PutV2SettingsCartData, GetV2SettingsCartStoreIdData, PutV2SettingsCartStoreIdData, ListOfferingsData, Offering, OfferingIncludes, Links2, SubscriptionsErrorResponse, GetOfferingData, ListOfferingPricingOptionsData, OfferingPricingOption, ListOfferingFeaturesData, OfferingFeature, ListOfferingPlansData, OfferingPlan, ListOfferingPlanPricingOptionsData, RelationshipData, ListSubscriptionsData, Subscription, SubscriptionIncludes, GetSubscriptionData, ListSubscriptionPlansData, ListSubscriptionPricingOptionsData, ListSubscriptionStatesData, SubscriptionState, CreateSubscriptionStateData, GetSubscriptionStateData, ListSubscriptionInvoicesData, SubscriptionInvoice, ListSubscriptionInvoicePaymentsData, SubscriptionInvoicePayment, GetSubscriptionInvoicePaymentData, GetSubscriptionInvoiceData, ListInvoicesData, GetInvoiceData, GetFeatureData, Feature, GetStockData, StockResponse, InventoriesErrorResponse, ListLocationsData, Location, CreateAnAccessTokenData, AccessTokenResponse, ErrorResponse2, GetV2AccountAddressesData, AccountAddressResponse, AccountAddressesErrorResponse, PostV2AccountAddressData, DeleteV2AccountAddressData, GetV2AccountAddressData, PutV2AccountAddressData, GetV2AccountsData, AccountResponse, MetaList, AccountManagementErrorResponse, PostV2AccountsData, GetV2AccountsAccountIdData, PutV2AccountsAccountIdData, PutV2AccountsAccountIdError, GetV2AccountMembersData, AccountMemberResponse, GetV2AccountMembersAccountMemberIdData, GetV2AccountsAccountIdAccountMembershipsData, AccountMembershipResponse, Uuid, PostV2AccountMembersTokensData, AccountManagementAuthenticationTokenResponse, MetaAccountMemberId, CreateOneTimePasswordTokenRequestData, UpdatePasswordProfileInfoData, PasswordProfileInfoResponse, GetAllCurrenciesData, ResponseCurrency, ResponseError, GetACurrencyData, GetAllFilesData, File, ResultsMeta, ResultsLinks, FilesErrorResponse, GetAFileData, PostMultiSearchData, MultiSearchResponse, CatalogSearchErrorResponse } from './types.gen.cjs';
|
|
2
2
|
import * as _hey_api_client_fetch from '@hey-api/client-fetch';
|
|
3
3
|
import { Options } from '@hey-api/client-fetch';
|
|
4
4
|
|
|
@@ -1083,19 +1083,25 @@ declare const getProductsForHierarchy: <ThrowOnError extends boolean = false>(op
|
|
|
1083
1083
|
*/
|
|
1084
1084
|
declare const getProductsForNode: <ThrowOnError extends boolean = false>(options: Options<GetProductsForNodeData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProductListData, ErrorResponse, ThrowOnError>;
|
|
1085
1085
|
/**
|
|
1086
|
-
* Get
|
|
1087
|
-
*
|
|
1086
|
+
* Get Carts
|
|
1087
|
+
* Retrieves a list of carts. The carts returned depend on the authentication method used:
|
|
1088
1088
|
*
|
|
1089
|
-
*
|
|
1089
|
+
* | Authentication Method | Header | Returns |
|
|
1090
|
+
* | :--- | :--- | :--- |
|
|
1091
|
+
* | **Customer Token** | `X-Moltin-Customer-Token` | Carts for the specified customer. See [Customer Tokens](/docs/customer-management/customer-management-api/customer-tokens). |
|
|
1092
|
+
* | **Account Token** | `EP-Account-Management-Authentication-Token` | Carts for the specified account. See [Account Management Token](/docs/api/accounts/post-v-2-account-members-tokens). |
|
|
1093
|
+
* | **Client Credentials** | `Authorization: Bearer <token>` | All carts or only registered carts, controlled by the `show_all_carts` setting. See [Cart Settings](/docs/api/carts/put-v-2-settings-cart). |
|
|
1090
1094
|
*
|
|
1091
|
-
*
|
|
1095
|
+
* **Client Credentials Behavior:**
|
|
1096
|
+
* - When `show_all_carts` is `true`: Returns all carts in the store.
|
|
1097
|
+
* - When `show_all_carts` is `false`: Returns only registered carts (associated with customers or accounts).
|
|
1092
1098
|
*
|
|
1093
|
-
*
|
|
1099
|
+
* **Sorting**
|
|
1094
1100
|
*
|
|
1095
|
-
*
|
|
1101
|
+
* Carts are sorted in descending order by `updated_date`. For more information, see [Pagination](/guides/Getting-Started/pagination).
|
|
1096
1102
|
*
|
|
1097
1103
|
*/
|
|
1098
|
-
declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options<GetCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartCollectionResponse,
|
|
1104
|
+
declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options<GetCartsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartCollectionResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1099
1105
|
/**
|
|
1100
1106
|
* Create a Cart
|
|
1101
1107
|
*
|
|
@@ -1105,9 +1111,9 @@ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options
|
|
|
1105
1111
|
*
|
|
1106
1112
|
* After the shopper checks out the cart, the cart remains available to the shopper. The cart is persistent and stays with the shopper after it is used.
|
|
1107
1113
|
*
|
|
1108
|
-
* You can create a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/
|
|
1114
|
+
* You can create a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).
|
|
1109
1115
|
*
|
|
1110
|
-
* You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.
|
|
1116
|
+
* You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_check` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).
|
|
1111
1117
|
*
|
|
1112
1118
|
* ### Preview Cart
|
|
1113
1119
|
*
|
|
@@ -1118,7 +1124,7 @@ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options
|
|
|
1118
1124
|
* - Carts with `snapshot_date` are same as preview carts.
|
|
1119
1125
|
* - You cannot checkout a cart that includes a `snapshot_date`.
|
|
1120
1126
|
* - To delete a promotion preview cart, use [Delete a cart](/docs/api/carts/delete-a-cart) endpoint.
|
|
1121
|
-
* - The promotion preview cart has the same expiration time as a regular cart based on the store's [cart settings](/docs/api/
|
|
1127
|
+
* - The promotion preview cart has the same expiration time as a regular cart based on the store's [cart settings](/docs/api/carts/put-v-2-settings-cart).
|
|
1122
1128
|
* - Preview cart interactions skip inventory checks and events, allowing users to preview future carts without impacting related external systems.
|
|
1123
1129
|
* :::
|
|
1124
1130
|
*
|
|
@@ -1159,7 +1165,7 @@ declare const getCarts: <ThrowOnError extends boolean = false>(options?: Options
|
|
|
1159
1165
|
* - In the case of preview carts (those with `snapshot_date`), an error is returned for invalid actions, such as removing the preview date, setting a preview date in the past, or attempting to checkout a cart with a `snapshot_date`.
|
|
1160
1166
|
*
|
|
1161
1167
|
*/
|
|
1162
|
-
declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse,
|
|
1168
|
+
declare const createACart: <ThrowOnError extends boolean = false>(options?: Options<CreateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1163
1169
|
/**
|
|
1164
1170
|
* Delete a Cart
|
|
1165
1171
|
* You can delete a cart, including the items, name, description, and remove all associations.
|
|
@@ -1209,20 +1215,14 @@ declare const deleteACart: <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1209
1215
|
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`,`tax_items`, `custom_discounts`, or `promotions`. |
|
|
1210
1216
|
*
|
|
1211
1217
|
*/
|
|
1212
|
-
declare const getACart: <ThrowOnError extends boolean = false>(options: Options<GetACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse,
|
|
1213
|
-
errors?: Array<{
|
|
1214
|
-
detail?: string;
|
|
1215
|
-
status?: number;
|
|
1216
|
-
title?: string;
|
|
1217
|
-
}>;
|
|
1218
|
-
}, ThrowOnError>;
|
|
1218
|
+
declare const getACart: <ThrowOnError extends boolean = false>(options: Options<GetACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1219
1219
|
/**
|
|
1220
1220
|
* Update a Cart
|
|
1221
1221
|
* Updates cart properties for the specified cartID.
|
|
1222
1222
|
*
|
|
1223
|
-
* You can update a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/
|
|
1223
|
+
* You can update a cart to specify custom discounts. You can enable custom discounts when the `discount_settings.custom_discounts_enabled` field is set to `true`. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/carts/put-v-2-settings-cart).
|
|
1224
1224
|
*
|
|
1225
|
-
* You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.
|
|
1225
|
+
* You can also create a cart when inventory checks are not performed until checkout by setting the `inventory_settings.defer_inventory_check` field to `true`. Again the default is set from cart discount settings for the store. See [Update Cart Settings](/docs/api/carts/put-v-2-settings-cart).
|
|
1226
1226
|
*
|
|
1227
1227
|
*/
|
|
1228
1228
|
declare const updateACart: <ThrowOnError extends boolean = false>(options: Options<UpdateACartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, UpdateACartError, ThrowOnError>;
|
|
@@ -1800,7 +1800,7 @@ declare const manageCarts: <ThrowOnError extends boolean = false>(options: Optio
|
|
|
1800
1800
|
* When you update multiple items that qualify for free gifts in the cart, the corresponding free gifts for all eligible products are also automatically updated in the cart.
|
|
1801
1801
|
*
|
|
1802
1802
|
*/
|
|
1803
|
-
declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
1803
|
+
declare const bulkUpdateItemsInCart: <ThrowOnError extends boolean = false>(options: Options<BulkUpdateItemsInCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemCollectionResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1804
1804
|
/**
|
|
1805
1805
|
* Delete a Cart Item
|
|
1806
1806
|
* Use this endpoint to delete a cart item.
|
|
@@ -1849,26 +1849,117 @@ declare const deleteAPromotionViaPromotionCode: <ThrowOnError extends boolean =
|
|
|
1849
1849
|
*
|
|
1850
1850
|
*/
|
|
1851
1851
|
declare const addTaxItemToCart: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemTaxesEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1852
|
+
/**
|
|
1853
|
+
* Add Tax Item to Bundle Component
|
|
1854
|
+
*
|
|
1855
|
+
* Use this endpoint to add a tax item to a specific bundle component (component product) within a cart item.
|
|
1856
|
+
*
|
|
1857
|
+
* :::note
|
|
1858
|
+
*
|
|
1859
|
+
* There is a soft limit of 5 unique tax items per component product at any one time.
|
|
1860
|
+
*
|
|
1861
|
+
* :::
|
|
1862
|
+
*
|
|
1863
|
+
*/
|
|
1864
|
+
declare const addTaxItemToCartItemComponent: <ThrowOnError extends boolean = false>(options: Options<AddTaxItemToCartItemComponentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemTaxesEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1865
|
+
/**
|
|
1866
|
+
* Delete Tax Item from Bundle Component
|
|
1867
|
+
*
|
|
1868
|
+
* Use this endpoint to delete a tax item from a specific bundle component (component product) within a cart item.
|
|
1869
|
+
*
|
|
1870
|
+
*/
|
|
1871
|
+
declare const deleteTaxItemFromCartItemComponent: <ThrowOnError extends boolean = false>(options: Options<DeleteTaxItemFromCartItemComponentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
|
|
1872
|
+
/**
|
|
1873
|
+
* Update Tax Item on Bundle Component
|
|
1874
|
+
* Use this endpoint to update a tax item on a specific bundle component (component product) within a cart item. To change tax value from `rate` to `amount`, set `rate` to `null`, then set `amount` value and vice versa.
|
|
1875
|
+
*/
|
|
1876
|
+
declare const updateTaxItemFromCartItemComponent: <ThrowOnError extends boolean = false>(options: Options<UpdateTaxItemFromCartItemComponentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartItemTaxesEntityResponse, unknown, ThrowOnError>;
|
|
1852
1877
|
/**
|
|
1853
1878
|
* Bulk Delete Tax Items from Cart
|
|
1854
|
-
* Use this endpoint to bulk delete tax items from cart.
|
|
1879
|
+
* Use this endpoint to bulk delete all tax items from all cart items and bundle component products in the cart.
|
|
1880
|
+
*
|
|
1881
|
+
* :::warning
|
|
1882
|
+
*
|
|
1883
|
+
* This operation will remove ALL tax items from:
|
|
1884
|
+
* - All cart items in the cart
|
|
1885
|
+
* - All bundle component products within bundle cart items
|
|
1886
|
+
*
|
|
1887
|
+
* :::
|
|
1888
|
+
*
|
|
1889
|
+
* ### Behavior
|
|
1890
|
+
*
|
|
1891
|
+
* - Removes all tax items from every cart item
|
|
1892
|
+
* - Removes all tax items from every component product in bundle cart items
|
|
1893
|
+
* - If no tax items exist anywhere in the cart, returns a 404 error
|
|
1894
|
+
*
|
|
1895
|
+
* ### Errors
|
|
1896
|
+
*
|
|
1897
|
+
* `404 Not Found`
|
|
1898
|
+
*
|
|
1899
|
+
* If no tax items exist in the cart (on cart items or component products):
|
|
1900
|
+
*
|
|
1901
|
+
* ```json
|
|
1902
|
+
* {
|
|
1903
|
+
* "status": 404,
|
|
1904
|
+
* "title": "Resource Not Found",
|
|
1905
|
+
* "detail": "No tax items exist in the cart"
|
|
1906
|
+
* }
|
|
1907
|
+
* ```
|
|
1908
|
+
*
|
|
1855
1909
|
*/
|
|
1856
|
-
declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void,
|
|
1910
|
+
declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>(options: Options<BulkDeleteTaxItemsFromCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, ResponseErrorResponse, ThrowOnError>;
|
|
1857
1911
|
/**
|
|
1858
1912
|
* Bulk Add Tax Items to Cart
|
|
1913
|
+
* Use this endpoint to bulk add tax items to cart items and bundle component products.
|
|
1914
|
+
*
|
|
1859
1915
|
* :::note
|
|
1860
1916
|
*
|
|
1861
1917
|
* A cart item can only have a maximum of five tax items.
|
|
1918
|
+
* A bundle component product can only have a maximum of five tax items.
|
|
1862
1919
|
*
|
|
1863
1920
|
* :::
|
|
1864
1921
|
*
|
|
1922
|
+
* ### Bundle Component Taxes
|
|
1923
|
+
*
|
|
1924
|
+
* To add tax items to bundle component products, include a `meta` object with `component_product_id` in each tax item:
|
|
1925
|
+
*
|
|
1926
|
+
* ```json
|
|
1927
|
+
* {
|
|
1928
|
+
* "data": [
|
|
1929
|
+
* {
|
|
1930
|
+
* "type": "tax_item",
|
|
1931
|
+
* "code": "GST",
|
|
1932
|
+
* "name": "Goods and Services Tax",
|
|
1933
|
+
* "rate": 0.1,
|
|
1934
|
+
* "meta": {
|
|
1935
|
+
* "component_product_id": "12345678-1234-5678-9012-123456789012"
|
|
1936
|
+
* },
|
|
1937
|
+
* "relationships": {
|
|
1938
|
+
* "item": {
|
|
1939
|
+
* "data": {
|
|
1940
|
+
* "type": "cart_item",
|
|
1941
|
+
* "id": "cart-item-id"
|
|
1942
|
+
* }
|
|
1943
|
+
* }
|
|
1944
|
+
* }
|
|
1945
|
+
* }
|
|
1946
|
+
* ]
|
|
1947
|
+
* }
|
|
1948
|
+
* ```
|
|
1949
|
+
*
|
|
1865
1950
|
* ### Errors
|
|
1866
1951
|
*
|
|
1952
|
+
*
|
|
1867
1953
|
* `422 Unprocessable Entity`
|
|
1868
1954
|
*
|
|
1869
|
-
*
|
|
1955
|
+
*
|
|
1956
|
+
* In this example, when `options.add_all_or_nothing` is set to `true` and if
|
|
1957
|
+
* one of cart items is not found or has reached its maximum tax item limit,
|
|
1958
|
+
* the following error response is returned:
|
|
1959
|
+
*
|
|
1870
1960
|
*
|
|
1871
1961
|
* ```json
|
|
1962
|
+
*
|
|
1872
1963
|
* {
|
|
1873
1964
|
* "status": 422,
|
|
1874
1965
|
* "title": "Add all or nothing.",
|
|
@@ -1877,9 +1968,13 @@ declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>
|
|
|
1877
1968
|
*
|
|
1878
1969
|
* ```
|
|
1879
1970
|
*
|
|
1880
|
-
*
|
|
1971
|
+
*
|
|
1972
|
+
* In this example, if you add more than five tax items to the same cart item,
|
|
1973
|
+
* the following error response is returned:
|
|
1974
|
+
*
|
|
1881
1975
|
*
|
|
1882
1976
|
* ```json
|
|
1977
|
+
*
|
|
1883
1978
|
* {
|
|
1884
1979
|
* "status": 422,
|
|
1885
1980
|
* "title": "Tax item not added to cart item.",
|
|
@@ -1890,11 +1985,17 @@ declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>
|
|
|
1890
1985
|
* }
|
|
1891
1986
|
* ```
|
|
1892
1987
|
*
|
|
1988
|
+
*
|
|
1893
1989
|
* `404`
|
|
1894
1990
|
*
|
|
1895
|
-
*
|
|
1991
|
+
*
|
|
1992
|
+
* In this example, if there is a mismatch between `cart_item`/`custom_item`
|
|
1993
|
+
* and the `relationships.item.data.type` specified in the bulk add tax item,
|
|
1994
|
+
* the following error response is returned:
|
|
1995
|
+
*
|
|
1896
1996
|
*
|
|
1897
1997
|
* ```json
|
|
1998
|
+
*
|
|
1898
1999
|
* {
|
|
1899
2000
|
* "data": [],
|
|
1900
2001
|
* "errors": [
|
|
@@ -1916,6 +2017,7 @@ declare const bulkDeleteTaxItemsFromCart: <ThrowOnError extends boolean = false>
|
|
|
1916
2017
|
* }
|
|
1917
2018
|
* ]
|
|
1918
2019
|
* }
|
|
2020
|
+
*
|
|
1919
2021
|
* ```
|
|
1920
2022
|
*
|
|
1921
2023
|
*/
|
|
@@ -1941,6 +2043,8 @@ declare const bulkDeleteCustomDiscountsFromCart: <ThrowOnError extends boolean =
|
|
|
1941
2043
|
*
|
|
1942
2044
|
* To increase the custom discount value, contact [Elastic Path Support team](https://support.elasticpath.com/hc/en-us).
|
|
1943
2045
|
*
|
|
2046
|
+
* Custom discounts cannot be combined with Elastic Path promotions. If the cart already contains Elastic Path promotions, remove them before adding custom discounts.
|
|
2047
|
+
*
|
|
1944
2048
|
*/
|
|
1945
2049
|
declare const bulkAddCustomDiscountsToCart: <ThrowOnError extends boolean = false>(options: Options<BulkAddCustomDiscountsToCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsBulkCustomDiscountsResponse | CartsBulkCustomDiscountsCollectionResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1946
2050
|
/**
|
|
@@ -1955,7 +2059,7 @@ declare const deleteCustomDiscountFromCart: <ThrowOnError extends boolean = fals
|
|
|
1955
2059
|
declare const updateCustomDiscountForCart: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomDiscountForCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsCustomDiscountsEntityResponse, unknown, ThrowOnError>;
|
|
1956
2060
|
/**
|
|
1957
2061
|
* Add Custom Discount To Cart Item
|
|
1958
|
-
* Use this endpoint to add a custom discount to cart item.
|
|
2062
|
+
* Use this endpoint to add a custom discount to cart item. Custom discounts cannot be combined with Elastic Path promotions. If the cart already contains Elastic Path promotions, remove them before adding custom discounts.
|
|
1959
2063
|
*/
|
|
1960
2064
|
declare const addCustomDiscountToCartItem: <ThrowOnError extends boolean = false>(options: Options<AddCustomDiscountToCartItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartsCustomDiscountsEntityResponse | CartsCustomDiscountsCollectionResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1961
2065
|
/**
|
|
@@ -1979,7 +2083,7 @@ declare const getShippingGroups: <ThrowOnError extends boolean = false>(options:
|
|
|
1979
2083
|
* Create a new shipping group for a cart
|
|
1980
2084
|
* Create a new shipping group for a cart
|
|
1981
2085
|
*/
|
|
1982
|
-
declare const createShippingGroup: <ThrowOnError extends boolean = false>(options: Options<CreateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2086
|
+
declare const createShippingGroup: <ThrowOnError extends boolean = false>(options: Options<CreateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
1983
2087
|
/**
|
|
1984
2088
|
* Delete Cart Shipping Group
|
|
1985
2089
|
* Deletes a shipping group from a cart. You cannot delete a shipping group that is attached to cart items.
|
|
@@ -1998,7 +2102,7 @@ declare const getShippingGroupById: <ThrowOnError extends boolean = false>(optio
|
|
|
1998
2102
|
* Update a shipping group for a cart
|
|
1999
2103
|
* Update a specific shipping group for a cart
|
|
2000
2104
|
*/
|
|
2001
|
-
declare const updateShippingGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2105
|
+
declare const updateShippingGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateShippingGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2002
2106
|
/**
|
|
2003
2107
|
* Create Stripe Payment Intent for a Cart
|
|
2004
2108
|
* The Cart Payment Intent feature enables the creation of a Stripe Payment Intent specifically tied to a shopping cart and its subsequent order. This allows Payment Intent users to track payment details from the cart stage and seamlessly maintain consistency in payment information throughout the order stage. Using these features, you can create Payment Intents for their carts, update Payment Intents with final cart details, and synchronize Payment Intents from Stripe to Commerce.
|
|
@@ -2027,12 +2131,12 @@ declare const updateShippingGroup: <ThrowOnError extends boolean = false>(option
|
|
|
2027
2131
|
* - To pay the entire amount at once, use the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) endpoint to update the Stripe Payment Intent with the final cart details when preparing to take the payment. Doing so, ensures that the Payment Intent accurately reflects the current cart details when processing payments on the front end. We do not recommend calling the [Update Cart Payment Intent](/docs/carts-orders/update-cart-payment-intent) for each individual change in the cart, as this can lead to more requests and may slow down the front-end performance.
|
|
2028
2132
|
*
|
|
2029
2133
|
*/
|
|
2030
|
-
declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2134
|
+
declare const createCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<CreateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, unknown, ThrowOnError>;
|
|
2031
2135
|
/**
|
|
2032
2136
|
* Update a Payment Intent on a Cart
|
|
2033
2137
|
* Updates the payment information for a specific payment intent on a cart.
|
|
2034
2138
|
*/
|
|
2035
|
-
declare const updateCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<UpdateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2139
|
+
declare const updateCartPaymentIntent: <ThrowOnError extends boolean = false>(options: Options<UpdateCartPaymentIntentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CartEntityResponse, unknown, ThrowOnError>;
|
|
2036
2140
|
/**
|
|
2037
2141
|
* Checkout API
|
|
2038
2142
|
* When a Cart is ready for checkout, you can convert the cart to an order. The cart remains and can be modified and checked out again if required.
|
|
@@ -2057,7 +2161,7 @@ declare const updateCartPaymentIntent: <ThrowOnError extends boolean = false>(op
|
|
|
2057
2161
|
*
|
|
2058
2162
|
* :::caution
|
|
2059
2163
|
*
|
|
2060
|
-
* - By default, carts are automatically deleted 7 days after the last update. You can change this setting by [updating cart settings](/docs/api/
|
|
2164
|
+
* - By default, carts are automatically deleted 7 days after the last update. You can change this setting by [updating cart settings](/docs/api/carts/put-v-2-settings-cart).
|
|
2061
2165
|
* - Your inventory is modified during checkout and payment of an order. For more information about the changes in the inventory, see the [Inventory](/docs/api/pxm/inventory/inventories-introduction) section.
|
|
2062
2166
|
*
|
|
2063
2167
|
* :::
|
|
@@ -2092,7 +2196,7 @@ declare const updateCartPaymentIntent: <ThrowOnError extends boolean = false>(op
|
|
|
2092
2196
|
declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Options<CheckoutApiData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2093
2197
|
/**
|
|
2094
2198
|
* Get all Orders
|
|
2095
|
-
* This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.
|
|
2199
|
+
* This endpoint returns all orders with custom flow fields. The pagination offset is set to fetch a maximum of 10,000 orders. If the store has 10,000 orders, and you fetch the orders without using filters, an error is returned. Use a filter to view orders when the order is beyond the 10,000 mark.
|
|
2096
2200
|
*
|
|
2097
2201
|
* :::note
|
|
2098
2202
|
*
|
|
@@ -2129,12 +2233,25 @@ declare const checkoutApi: <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2129
2233
|
* | `updated_at` | `date` | `eq` / `gt` / `ge`/ `le`/ `lt` | `lt(updated_at,YYYY-MM-DD)` |
|
|
2130
2234
|
* | `external_ref` | `string` | `eq` / `like` | `like(external_ref, 16be*)` |
|
|
2131
2235
|
* | `order_number` | `string` | `eq` / `like` | `like(order_number, 123*)` |
|
|
2236
|
+
* ### Includes
|
|
2237
|
+
* You can include related resources with the order response by using the `include` query parameter.
|
|
2238
|
+
* | Name | Optional | Type | Description |
|
|
2239
|
+
* |:-----|:---------|:-----|:------------|
|
|
2240
|
+
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The information included are `items`, `tax_items`, `custom_discounts`, or `promotions`. |
|
|
2132
2241
|
*
|
|
2133
2242
|
*/
|
|
2134
2243
|
declare const getCustomerOrders: <ThrowOnError extends boolean = false>(options?: Options<GetCustomerOrdersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderCollectionResponse, unknown, ThrowOnError>;
|
|
2135
2244
|
/**
|
|
2136
2245
|
* Get an Order
|
|
2137
2246
|
* Use this endpoint to retrieve a specific order.
|
|
2247
|
+
*
|
|
2248
|
+
* ### Includes
|
|
2249
|
+
*
|
|
2250
|
+
* You can include related resources with the order response by using the `include` query parameter.
|
|
2251
|
+
*
|
|
2252
|
+
* | Name | Required | Type | Description |
|
|
2253
|
+
* |:----------|:---------|:---------|:------------|
|
|
2254
|
+
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `items`, `tax_items`, `custom_discounts`, or `promotions`. |
|
|
2138
2255
|
*/
|
|
2139
2256
|
declare const getAnOrder: <ThrowOnError extends boolean = false>(options: Options<GetAnOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2140
2257
|
/**
|
|
@@ -2166,6 +2283,14 @@ declare const updateAnOrder: <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2166
2283
|
/**
|
|
2167
2284
|
* Get Order Items
|
|
2168
2285
|
* Use this endpoint to retrieve order items.
|
|
2286
|
+
*
|
|
2287
|
+
* ### Includes
|
|
2288
|
+
*
|
|
2289
|
+
* You can include related resources with the order items response by using the `include` query parameter.
|
|
2290
|
+
*
|
|
2291
|
+
* | Name | Required | Type | Description |
|
|
2292
|
+
* |:----------|:---------|:---------|:------------|
|
|
2293
|
+
* | `include` | Optional | `string` | Comma-delimited string of entities that can be included. The included options are `tax_items`, `custom_discounts`, or `promotions`. |
|
|
2169
2294
|
*/
|
|
2170
2295
|
declare const getOrderItems: <ThrowOnError extends boolean = false>(options: Options<GetOrderItemsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<OrderItemCollectionResponse, unknown, ThrowOnError>;
|
|
2171
2296
|
/**
|
|
@@ -2181,7 +2306,7 @@ declare const anonymizeOrders: <ThrowOnError extends boolean = false>(options?:
|
|
|
2181
2306
|
* Use this endpoint to confirm an order. Confirming an order finalizes it and makes it ready for processing.
|
|
2182
2307
|
*
|
|
2183
2308
|
*/
|
|
2184
|
-
declare const confirmOrder: <ThrowOnError extends boolean = false>(options: Options<ConfirmOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2309
|
+
declare const confirmOrder: <ThrowOnError extends boolean = false>(options: Options<ConfirmOrderData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransactionEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2185
2310
|
/**
|
|
2186
2311
|
* Payments
|
|
2187
2312
|
* Depending on the payment gateway, you may have access to different transaction types such as capturing funds immediately or authorizing them for later. For more information, see [Payments](/docs/api/carts/payments).
|
|
@@ -2279,14 +2404,60 @@ declare const createOrderShippingGroup: <ThrowOnError extends boolean = false>(o
|
|
|
2279
2404
|
* Retrieve a specific shipping group for an order
|
|
2280
2405
|
* Retrieve a specific shipping group for an order
|
|
2281
2406
|
*/
|
|
2282
|
-
declare const getShippingGroupsById: <ThrowOnError extends boolean = false>(options: Options<GetShippingGroupsByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2283
|
-
data?: ShippingGroupResponse;
|
|
2284
|
-
}, ResponseErrorResponse, ThrowOnError>;
|
|
2407
|
+
declare const getShippingGroupsById: <ThrowOnError extends boolean = false>(options: Options<GetShippingGroupsByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2285
2408
|
/**
|
|
2286
2409
|
* Update a shipping group for an order
|
|
2287
2410
|
* Update a shipping group for an order
|
|
2288
2411
|
*/
|
|
2289
|
-
declare const putShippingGroupById: <ThrowOnError extends boolean = false>(options: Options<PutShippingGroupByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
2412
|
+
declare const putShippingGroupById: <ThrowOnError extends boolean = false>(options: Options<PutShippingGroupByIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShippingGroupEntityResponse, ResponseErrorResponse, ThrowOnError>;
|
|
2413
|
+
/**
|
|
2414
|
+
* Get Cart Settings
|
|
2415
|
+
* Retrieves cart settings.
|
|
2416
|
+
*/
|
|
2417
|
+
declare const getV2SettingsCart: <ThrowOnError extends boolean = false>(options?: Options<GetV2SettingsCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SettingsCart, ResponseErrorResponse, ThrowOnError>;
|
|
2418
|
+
/**
|
|
2419
|
+
* Update Cart Settings
|
|
2420
|
+
* You can modify the cart expiry settings to set it to any number of days up to 365. Any existing carts default to the expiry of 7 days. To update cart settings in Commerce Manager, see [Updating Cart setting](/docs/commerce-manager/settings/general-settings#updating-cart-settings).
|
|
2421
|
+
*
|
|
2422
|
+
* With update cart settings endpoint, you can:
|
|
2423
|
+
*
|
|
2424
|
+
* - Enable or disable custom discounts by setting the `custom_discounts_enabled` field to `true`. This allows you to activate your custom discounts from external services. By default, this setting is determined by the cart settings configured for the store.
|
|
2425
|
+
* - Enable or disable the use of rule promotions within the cart. You can apply this setting either at the store level using the update cart setting endpoint or individually to a specific cart using the [update a cart](/docs/api/carts/update-a-cart) endpoint.
|
|
2426
|
+
* - Enable or disable deferred inventory checks by setting `defer_inventory_check` to `true`. When set, stock levels are not verified for products in a cart until checkout.
|
|
2427
|
+
* - Control whether admins can see all carts or only shopper-associated carts by setting `show_all_carts` to `true` or `false`.
|
|
2428
|
+
* - Enable or disable location-based item separation by setting `separate_items_by_location` to `true`. When enabled, cart items with the same SKU but different locations are kept as separate line items instead of being merged.
|
|
2429
|
+
*
|
|
2430
|
+
* :::note
|
|
2431
|
+
*
|
|
2432
|
+
* Custom discounts and rule promotions can both be enabled for a store at the same time, for example, while transitioning from one promotion system to the other. However, an individual cart can only contain one type of discount at a time. A cart that contains custom discounts rejects Elastic Path promotions, and a cart that contains Elastic Path promotions rejects custom discounts, until the existing discounts are removed.
|
|
2433
|
+
*
|
|
2434
|
+
* :::
|
|
2435
|
+
*/
|
|
2436
|
+
declare const putV2SettingsCart: <ThrowOnError extends boolean = false>(options?: Options<PutV2SettingsCartData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SettingsCart, ResponseErrorResponse, ThrowOnError>;
|
|
2437
|
+
/**
|
|
2438
|
+
* Get Cart Settings by Store ID
|
|
2439
|
+
* Retrieves cart settings for the specified store.
|
|
2440
|
+
*/
|
|
2441
|
+
declare const getV2SettingsCartStoreId: <ThrowOnError extends boolean = false>(options: Options<GetV2SettingsCartStoreIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SettingsCart, ResponseErrorResponse, ThrowOnError>;
|
|
2442
|
+
/**
|
|
2443
|
+
* Update Cart Settings by Store ID
|
|
2444
|
+
* You can modify the cart expiry settings to set it to any number of days up to 365. Any existing carts default to the expiry of 7 days. To update cart settings in Commerce Manager, see [Updating Cart setting](/docs/commerce-manager/settings/general-settings#updating-cart-settings).
|
|
2445
|
+
*
|
|
2446
|
+
* With update cart settings endpoint, you can:
|
|
2447
|
+
*
|
|
2448
|
+
* - Enable or disable custom discounts by setting the `custom_discounts_enabled` field to `true`. This allows you to activate your custom discounts from external services. By default, this setting is determined by the cart settings configured for the store.
|
|
2449
|
+
* - Enable or disable the use of rule promotions within the cart. You can apply this setting either at the store level using the update cart setting endpoint or individually to a specific cart using the [update a cart](/docs/api/carts/update-a-cart) endpoint.
|
|
2450
|
+
* - Enable or disable deferred inventory checks by setting `defer_inventory_check` to `true`. When set, stock levels are not verified for products in a cart until checkout.
|
|
2451
|
+
* - Control whether admins can see all carts or only shopper-associated carts by setting `show_all_carts` to `true` or `false`.
|
|
2452
|
+
* - Enable or disable location-based item separation by setting `separate_items_by_location` to `true`. When enabled, cart items with the same SKU but different locations are kept as separate line items instead of being merged.
|
|
2453
|
+
*
|
|
2454
|
+
* :::note
|
|
2455
|
+
*
|
|
2456
|
+
* Custom discounts and rule promotions can both be enabled for a store at the same time, for example, while transitioning from one promotion system to the other. However, an individual cart can only contain one type of discount at a time. A cart that contains custom discounts rejects Elastic Path promotions, and a cart that contains Elastic Path promotions rejects custom discounts, until the existing discounts are removed.
|
|
2457
|
+
*
|
|
2458
|
+
* :::
|
|
2459
|
+
*/
|
|
2460
|
+
declare const putV2SettingsCartStoreId: <ThrowOnError extends boolean = false>(options: Options<PutV2SettingsCartStoreIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SettingsCart, ResponseErrorResponse, ThrowOnError>;
|
|
2290
2461
|
/**
|
|
2291
2462
|
* List offerings
|
|
2292
2463
|
* Retrieves a list of all subscription offerings.
|
|
@@ -2561,21 +2732,26 @@ declare const putV2AccountAddress: <ThrowOnError extends boolean = false>(option
|
|
|
2561
2732
|
* You can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).
|
|
2562
2733
|
*
|
|
2563
2734
|
* ### Filtering
|
|
2564
|
-
*
|
|
2565
2735
|
* The following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) accounts:
|
|
2566
2736
|
*
|
|
2567
|
-
* | Attribute
|
|
2568
|
-
*
|
|
2569
|
-
* | `
|
|
2570
|
-
* | `
|
|
2571
|
-
* | `
|
|
2572
|
-
* | `
|
|
2573
|
-
* | `
|
|
2574
|
-
* | `
|
|
2575
|
-
* | `
|
|
2737
|
+
* | Attribute | Operators | Example |
|
|
2738
|
+
* |-------------------|-------------------------------|---------------------------------------------------------------|
|
|
2739
|
+
* | `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,3fa85f64-5717-4562-b3fc-2c963f66afa6)` |
|
|
2740
|
+
* | `created_at` | `lt`,`le`,`eq`,`gt`,`ge` | `ge(created_at,2024-04-29T00:00:00.000Z)` |
|
|
2741
|
+
* | `updated_at` | `lt`,`le`,`eq`,`gt`,`ge` | `le(updated_at,2024-04-29T00:00:00.000Z)` |
|
|
2742
|
+
* | `name` | `eq`,`like` | `like(name,*swan*)` |
|
|
2743
|
+
* | `legal_name` | `eq`,`like` | `like(legal_name,*swan*)` |
|
|
2744
|
+
* | `registration_id` | `eq`,`like` | `like(registration_id,00000000-0000-1000-8000-*)` |
|
|
2745
|
+
* | `external_ref` | `eq`,`like`,`in` | `like(external_ref,16be*)` |
|
|
2746
|
+
* | `account_tags` | `contains` | `contains(account_tags,26beb787-be6e-40c3-bbae-9c645820b075)` |
|
|
2747
|
+
*
|
|
2576
2748
|
*/
|
|
2577
2749
|
declare const getV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2578
|
-
data?: Array<AccountResponse
|
|
2750
|
+
data?: Array<AccountResponse & {
|
|
2751
|
+
links?: {
|
|
2752
|
+
self?: string;
|
|
2753
|
+
};
|
|
2754
|
+
}>;
|
|
2579
2755
|
meta?: MetaList;
|
|
2580
2756
|
links?: {
|
|
2581
2757
|
current?: string;
|
|
@@ -2591,6 +2767,9 @@ declare const getV2Accounts: <ThrowOnError extends boolean = false>(options?: Op
|
|
|
2591
2767
|
*/
|
|
2592
2768
|
declare const postV2Accounts: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2593
2769
|
data?: AccountResponse;
|
|
2770
|
+
links?: {
|
|
2771
|
+
self?: string;
|
|
2772
|
+
};
|
|
2594
2773
|
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2595
2774
|
/**
|
|
2596
2775
|
* Get an Account
|
|
@@ -2598,28 +2777,18 @@ declare const postV2Accounts: <ThrowOnError extends boolean = false>(options?: O
|
|
|
2598
2777
|
*/
|
|
2599
2778
|
declare const getV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2600
2779
|
data?: AccountResponse;
|
|
2780
|
+
links?: {
|
|
2781
|
+
self?: string;
|
|
2782
|
+
};
|
|
2601
2783
|
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2602
2784
|
/**
|
|
2603
2785
|
* Update an Account
|
|
2604
2786
|
* Update the information contained on an account.
|
|
2605
2787
|
*/
|
|
2606
2788
|
declare const putV2AccountsAccountId: <ThrowOnError extends boolean = false>(options: Options<PutV2AccountsAccountIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2607
|
-
data?:
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
name?: string;
|
|
2611
|
-
legal_name?: string;
|
|
2612
|
-
registration_id?: string;
|
|
2613
|
-
external_ref?: string;
|
|
2614
|
-
meta?: {
|
|
2615
|
-
timestamps?: {
|
|
2616
|
-
created_at?: Date;
|
|
2617
|
-
updated_at?: Date;
|
|
2618
|
-
};
|
|
2619
|
-
};
|
|
2620
|
-
links?: {
|
|
2621
|
-
self?: string;
|
|
2622
|
-
};
|
|
2789
|
+
data?: AccountResponse;
|
|
2790
|
+
links?: {
|
|
2791
|
+
self?: string;
|
|
2623
2792
|
};
|
|
2624
2793
|
}, PutV2AccountsAccountIdError, ThrowOnError>;
|
|
2625
2794
|
/**
|
|
@@ -2628,12 +2797,11 @@ declare const putV2AccountsAccountId: <ThrowOnError extends boolean = false>(opt
|
|
|
2628
2797
|
*
|
|
2629
2798
|
* ### Filtering
|
|
2630
2799
|
*
|
|
2631
|
-
* The following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) account members.
|
|
2632
2800
|
*
|
|
2633
|
-
*
|
|
2634
|
-
*
|
|
2635
|
-
*
|
|
2636
|
-
* | `
|
|
2801
|
+
* The following operators and attributes are available for
|
|
2802
|
+
* [filtering](/guides/Getting-Started/filtering) account members.
|
|
2803
|
+
*
|
|
2804
|
+
* | Attribute | Type | Operator | Example | | :--- | :--- | :--- | :--- | | `email` | `string` | `ilike` | `ilike(email,'ronswanson@example.com')` | | `name` | `string` | `ilike` | `ilike(name,'*swan*')` | | `given_name` | `string` | `ilike`/`is_null` | `ilike(given_name,'ron*')` | | `middle_name` | `string` | `ilike`/`is_null` | `is_null(middle_name)` | | `family_name` | `string` | `ilike`/`is_null` | `is_null(family_name)` |
|
|
2637
2805
|
*
|
|
2638
2806
|
*/
|
|
2639
2807
|
declare const getV2AccountMembers: <ThrowOnError extends boolean = false>(options?: Options<GetV2AccountMembersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
@@ -2653,6 +2821,9 @@ declare const getV2AccountMembers: <ThrowOnError extends boolean = false>(option
|
|
|
2653
2821
|
*/
|
|
2654
2822
|
declare const getV2AccountMembersAccountMemberId: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountMembersAccountMemberIdData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2655
2823
|
data?: AccountMemberResponse;
|
|
2824
|
+
links?: {
|
|
2825
|
+
self?: string;
|
|
2826
|
+
};
|
|
2656
2827
|
}, AccountManagementErrorResponse, ThrowOnError>;
|
|
2657
2828
|
/**
|
|
2658
2829
|
* Get all Account Memberships
|
|
@@ -2672,7 +2843,9 @@ declare const getV2AccountMembersAccountMemberId: <ThrowOnError extends boolean
|
|
|
2672
2843
|
* | `account_member_id` | `string` | `eq` / `like` | `eq(account_member_id,00000000-0000-1000-8000-0000000)` |
|
|
2673
2844
|
*/
|
|
2674
2845
|
declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError extends boolean = false>(options: Options<GetV2AccountsAccountIdAccountMembershipsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2675
|
-
data?: Array<AccountMembershipResponse
|
|
2846
|
+
data?: Array<AccountMembershipResponse & {
|
|
2847
|
+
account_member_id?: Uuid;
|
|
2848
|
+
}>;
|
|
2676
2849
|
meta?: MetaList;
|
|
2677
2850
|
links?: {
|
|
2678
2851
|
current?: string;
|
|
@@ -2688,7 +2861,7 @@ declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError extends bo
|
|
|
2688
2861
|
*
|
|
2689
2862
|
* For each element in the list returned by the account member authentication API, a token value is returned. In order for a shopper to authenticate as the account, this value should be set as the `EP-Account-Management-Authentication-Token` header when calling Commerce. This header grants access to additional resources associated with the account, such as [carts](/docs/api/carts/account-cart-associations), [orders](/docs/api/carts/orders), [catalogs with associated rules](/docs/api/pxm/catalog/rules), and [addresses](/docs/api/addresses/addresses-introduction).
|
|
2690
2863
|
*
|
|
2691
|
-
* The set of permissions available to a shopper using an Account Management Authentication token is documented in [Permissions](/docs/authentication/
|
|
2864
|
+
* The set of permissions available to a shopper using an Account Management Authentication token is documented in [Permissions](/docs/authentication/tokens/permissions)
|
|
2692
2865
|
*
|
|
2693
2866
|
* Commerce provides authentication tokens for an account and an account member using:
|
|
2694
2867
|
*
|
|
@@ -2701,9 +2874,7 @@ declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError extends bo
|
|
|
2701
2874
|
*/
|
|
2702
2875
|
declare const postV2AccountMembersTokens: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountMembersTokensData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
|
|
2703
2876
|
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
2704
|
-
meta?: MetaList &
|
|
2705
|
-
account_member_id?: MetaAccountMemberId;
|
|
2706
|
-
};
|
|
2877
|
+
meta?: MetaList & MetaAccountMemberId;
|
|
2707
2878
|
links?: {
|
|
2708
2879
|
current?: string;
|
|
2709
2880
|
first?: string;
|
|
@@ -2780,4 +2951,4 @@ declare const getAFile: <ThrowOnError extends boolean = false>(options: Options<
|
|
|
2780
2951
|
*/
|
|
2781
2952
|
declare const postMultiSearch: <ThrowOnError extends boolean = false>(options: Options<PostMultiSearchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<MultiSearchResponse, CatalogSearchErrorResponse, ThrowOnError>;
|
|
2782
2953
|
|
|
2783
|
-
export { addCustomDiscountToCartItem, addTaxItemToCart, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmOrder, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, createOneTimePasswordTokenRequest, createOrderShippingGroup, createRule, createShippingGroup, createSubscriptionState, deleteACart, deleteACartItem, deleteAPromotionViaPromotionCode, deleteATaxItem, deleteAccountCartAssociation, deleteAllCartItems, deleteCartShippingGroup, deleteCatalogById, deleteCustomDiscountFromCart, deleteCustomDiscountFromCartItem, deleteCustomerCartAssociation, deleteReleaseById, deleteReleases, deleteRuleById, deleteV2AccountAddress, getACart, getACurrency, getAFile, getATransaction, getAllCurrencies, getAllFiles, getAllHierarchies, getAllNodes, getAllProducts, getAllRelatedProducts, getAnOrder, getByContextAllHierarchies, getByContextAllNodes, getByContextAllProducts, getByContextAllRelatedProducts, getByContextChildNodes, getByContextChildProducts, getByContextComponentProductIds, getByContextHierarchy, getByContextHierarchyChildNodes, getByContextHierarchyNodes, getByContextNode, getByContextProduct, getByContextProductsForHierarchy, getByContextProductsForNode, getByContextRelease, getCartItems, getCarts, getCatalogById, getCatalogs, getChildNodes, getChildProducts, getComponentProductIds, getCustomerOrders, getFeature, getHierarchy, getHierarchyChildNodes, getHierarchyNodes, getInvoice, getNode, getOffering, getOrderItems, getOrderShippingGroups, getOrderTransactions, getProduct, getProductsForHierarchy, getProductsForNode, getReleaseById, getReleases, getRuleById, getRules, getShippingGroupById, getShippingGroups, getShippingGroupsById, getStock, getSubscription, getSubscriptionInvoice, getSubscriptionInvoicePayment, getSubscriptionState, getV2AccountAddress, getV2AccountAddresses, getV2AccountMembers, getV2AccountMembersAccountMemberId, getV2Accounts, getV2AccountsAccountId, getV2AccountsAccountIdAccountMemberships, listInvoices, listLocations, listOfferingFeatures, listOfferingPlanPricingOptions, listOfferingPlans, listOfferingPricingOptions, listOfferings, listSubscriptionInvoicePayments, listSubscriptionInvoices, listSubscriptionPlans, listSubscriptionPricingOptions, listSubscriptionStates, listSubscriptions, manageCarts, paymentSetup, postMultiSearch, postV2AccountAddress, postV2AccountMembersTokens, postV2Accounts, publishRelease, putShippingGroupById, putV2AccountAddress, putV2AccountsAccountId, refundATransaction, updateACart, updateACartItem, updateATaxItem, updateAnOrder, updateCartPaymentIntent, updateCatalog, updateCustomDiscountForCart, updateCustomDiscountForCartItem, updatePasswordProfileInfo, updateRule, updateShippingGroup, validateCatalogRules };
|
|
2954
|
+
export { addCustomDiscountToCartItem, addTaxItemToCart, addTaxItemToCartItemComponent, anonymizeOrders, bulkAddCustomDiscountsToCart, bulkAddTaxItemsToCart, bulkDeleteCustomDiscountsFromCart, bulkDeleteTaxItemsFromCart, bulkUpdateItemsInCart, cancelATransaction, captureATransaction, checkoutApi, client, configureByContextProduct, confirmOrder, confirmPayment, createACart, createAccountCartAssociation, createAnAccessToken, createCartPaymentIntent, createCatalog, createCustomerCartAssociation, createOneTimePasswordTokenRequest, createOrderShippingGroup, createRule, createShippingGroup, createSubscriptionState, deleteACart, deleteACartItem, deleteAPromotionViaPromotionCode, deleteATaxItem, deleteAccountCartAssociation, deleteAllCartItems, deleteCartShippingGroup, deleteCatalogById, deleteCustomDiscountFromCart, deleteCustomDiscountFromCartItem, deleteCustomerCartAssociation, deleteReleaseById, deleteReleases, deleteRuleById, deleteTaxItemFromCartItemComponent, deleteV2AccountAddress, getACart, getACurrency, getAFile, getATransaction, getAllCurrencies, getAllFiles, getAllHierarchies, getAllNodes, getAllProducts, getAllRelatedProducts, getAnOrder, getByContextAllHierarchies, getByContextAllNodes, getByContextAllProducts, getByContextAllRelatedProducts, getByContextChildNodes, getByContextChildProducts, getByContextComponentProductIds, getByContextHierarchy, getByContextHierarchyChildNodes, getByContextHierarchyNodes, getByContextNode, getByContextProduct, getByContextProductsForHierarchy, getByContextProductsForNode, getByContextRelease, getCartItems, getCarts, getCatalogById, getCatalogs, getChildNodes, getChildProducts, getComponentProductIds, getCustomerOrders, getFeature, getHierarchy, getHierarchyChildNodes, getHierarchyNodes, getInvoice, getNode, getOffering, getOrderItems, getOrderShippingGroups, getOrderTransactions, getProduct, getProductsForHierarchy, getProductsForNode, getReleaseById, getReleases, getRuleById, getRules, getShippingGroupById, getShippingGroups, getShippingGroupsById, getStock, getSubscription, getSubscriptionInvoice, getSubscriptionInvoicePayment, getSubscriptionState, getV2AccountAddress, getV2AccountAddresses, getV2AccountMembers, getV2AccountMembersAccountMemberId, getV2Accounts, getV2AccountsAccountId, getV2AccountsAccountIdAccountMemberships, getV2SettingsCart, getV2SettingsCartStoreId, listInvoices, listLocations, listOfferingFeatures, listOfferingPlanPricingOptions, listOfferingPlans, listOfferingPricingOptions, listOfferings, listSubscriptionInvoicePayments, listSubscriptionInvoices, listSubscriptionPlans, listSubscriptionPricingOptions, listSubscriptionStates, listSubscriptions, manageCarts, paymentSetup, postMultiSearch, postV2AccountAddress, postV2AccountMembersTokens, postV2Accounts, publishRelease, putShippingGroupById, putV2AccountAddress, putV2AccountsAccountId, putV2SettingsCart, putV2SettingsCartStoreId, refundATransaction, updateACart, updateACartItem, updateATaxItem, updateAnOrder, updateCartPaymentIntent, updateCatalog, updateCustomDiscountForCart, updateCustomDiscountForCartItem, updatePasswordProfileInfo, updateRule, updateShippingGroup, updateTaxItemFromCartItemComponent, validateCatalogRules };
|