@epcc-sdk/sdks-shopper 0.0.42 → 0.0.43

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/README.md CHANGED
@@ -339,7 +339,7 @@ const result: GetByContextReleaseResponse = await getByContextRelease(params);
339
339
 
340
340
  **Summary:** Get all Hierarchies
341
341
 
342
- **Description:** Retrieves all hierarchies from a catalog based on the best matching rule for the shopper's context. Supports filtering by attributes like name and ID using operators like `Eq` and `In`.
342
+ **Description:** GET operation
343
343
 
344
344
  **TypeScript Example:**
345
345
 
@@ -369,7 +369,7 @@ const result: GetByContextAllHierarchiesResponse = await getByContextAllHierarch
369
369
 
370
370
  **Summary:** Get a Hierarchy
371
371
 
372
- **Description:** Retrieves a specific hierarchy from the catalog based on the provided hierarchy ID. The API uses catalog rules to determine the best match for the shopper's context.
372
+ **Description:** GET operation
373
373
 
374
374
  **TypeScript Example:**
375
375
 
@@ -397,7 +397,7 @@ const result: GetByContextHierarchyResponse = await getByContextHierarchy(params
397
397
 
398
398
  **Summary:** Get a Hierarchy's Nodes
399
399
 
400
- **Description:** Retrieves all nodes associated with a specified hierarchy, allowing for filtering by attributes like name and ID. Useful for improving store search functionality.
400
+ **Description:** GET operation
401
401
 
402
402
  **TypeScript Example:**
403
403
 
@@ -430,7 +430,7 @@ const result: GetByContextHierarchyNodesResponse = await getByContextHierarchyNo
430
430
 
431
431
  **Summary:** Get a Hierarchy's Children
432
432
 
433
- **Description:** Retrieves the parent nodes for a specified hierarchy, allowing users to identify the hierarchy associated with a node.
433
+ **Description:** GET operation
434
434
 
435
435
  **TypeScript Example:**
436
436
 
@@ -463,7 +463,7 @@ const result: GetByContextHierarchyChildNodesResponse = await getByContextHierar
463
463
 
464
464
  **Summary:** Get all Nodes
465
465
 
466
- **Description:** Retrieves all nodes in the catalog based on the shopper's context, allowing for filtering by attributes like name or ID. Products associated with nodes are listed, including curated products for promoting specific items.
466
+ **Description:** GET operation
467
467
 
468
468
  **TypeScript Example:**
469
469
 
@@ -493,7 +493,7 @@ const result: GetByContextAllNodesResponse = await getByContextAllNodes(params);
493
493
 
494
494
  **Summary:** Get a Node
495
495
 
496
- **Description:** Retrieves a node from the catalog, displaying associated products. Curated products are prioritized and can be managed for unique product collections.
496
+ **Description:** GET operation
497
497
 
498
498
  **TypeScript Example:**
499
499
 
@@ -521,7 +521,7 @@ const result: GetByContextNodeResponse = await getByContextNode(params);
521
521
 
522
522
  **Summary:** Get a Node's Children
523
523
 
524
- **Description:** Retrieves child nodes and associated products for a specific node in the catalog, allowing for filtering by name, slug, or ID. Supports product curation and displays curated products first if configured.
524
+ **Description:** GET operation
525
525
 
526
526
  **TypeScript Example:**
527
527
 
@@ -554,7 +554,7 @@ const result: GetByContextChildNodesResponse = await getByContextChildNodes(para
554
554
 
555
555
  **Summary:** Get all Products
556
556
 
557
- **Description:** This operation retrieves a list of products from the catalog, including only products in a live status. It allows filtering by attributes like name, SKU, and product type.
557
+ **Description:** GET operation
558
558
 
559
559
  **TypeScript Example:**
560
560
 
@@ -584,7 +584,7 @@ const result: GetByContextAllProductsResponse = await getByContextAllProducts(pa
584
584
 
585
585
  **Summary:** Get a Product
586
586
 
587
- **Description:** Retrieves a specified product from the catalog in 'live' status, using the best matching catalog rule for the shopper's context. Includes options to retrieve associated component products, main images, and files.
587
+ **Description:** GET operation
588
588
 
589
589
  **TypeScript Example:**
590
590
 
@@ -650,7 +650,7 @@ const result: GetByContextAllRelatedProductsResponse = await getByContextAllRela
650
650
 
651
651
  **Summary:** Get a Bundle's Component Products
652
652
 
653
- **Description:** Retrieve a list of component product IDs for a specified bundle in Product Experience Manager, allowing you to manage bundles and their associated products efficiently.
653
+ **Description:** GET operation
654
654
 
655
655
  **TypeScript Example:**
656
656
 
@@ -682,7 +682,7 @@ const result: GetByContextComponentProductIdsResponse = await getByContextCompon
682
682
 
683
683
  **Summary:** Get a Parent Product's Child Products
684
684
 
685
- **Description:** This operation retrieves a list of child products associated with a specified parent product in a catalog release, only returning products in a `live` status.
685
+ **Description:** GET operation
686
686
 
687
687
  **TypeScript Example:**
688
688
 
@@ -715,7 +715,7 @@ const result: GetByContextChildProductsResponse = await getByContextChildProduct
715
715
 
716
716
  **Summary:** Get a Hierarchy's Products
717
717
 
718
- **Description:** Retrieve live products associated with a specified hierarchy in the catalog. Filter products by attributes like name, SKU, or product type. Include component products, main images, and files using the `include` parameter.
718
+ **Description:** GET operation
719
719
 
720
720
  **TypeScript Example:**
721
721
 
@@ -748,7 +748,7 @@ const result: GetByContextProductsForHierarchyResponse = await getByContextProdu
748
748
 
749
749
  **Summary:** Get a Node's Products
750
750
 
751
- **Description:** Retrieve products associated with a specified hierarchy node in the catalog, filtered by live status and curated order. Supports filtering by attributes like name, SKU, and product type.
751
+ **Description:** GET operation
752
752
 
753
753
  **TypeScript Example:**
754
754
 
@@ -781,7 +781,7 @@ const result: GetByContextProductsForNodeResponse = await getByContextProductsFo
781
781
 
782
782
  **Summary:** Configure a Shopper Bundle
783
783
 
784
- **Description:** Configure product bundles in your catalog by allowing shoppers to select product options within specified minimum and maximum values, updating the bundle configuration with selected options and displaying them in the storefront.
784
+ **Description:** POST operation
785
785
 
786
786
  **TypeScript Example:**
787
787
 
@@ -817,7 +817,7 @@ const result: ConfigureByContextProductResponse = await configureByContextProduc
817
817
 
818
818
  **Summary:** Gets all authorized catalogs
819
819
 
820
- **Description:** Retrieves a list of authorized catalogs, showing differences between consecutive releases and indicating whether a full refresh is needed before publishing. Supports filtering by name.
820
+ **Description:** GET operation
821
821
 
822
822
  **TypeScript Example:**
823
823
 
@@ -843,7 +843,7 @@ const result: GetCatalogsResponse = await getCatalogs(params);
843
843
 
844
844
  **Summary:** Creates a new catalog
845
845
 
846
- **Description:** Create a catalog by defining hierarchies, products, and price books with priorities for displaying product prices. Up to five price books can be specified for different scenarios.
846
+ **Description:** POST operation
847
847
 
848
848
  **TypeScript Example:**
849
849
 
@@ -873,7 +873,7 @@ const result: CreateCatalogResponse = await createCatalog(params);
873
873
 
874
874
  **Summary:** Deletes a catalog
875
875
 
876
- **Description:** Deletes an unpublished catalog by its unique ID. Use other endpoints to delete releases or update associated catalog rules beforehand.
876
+ **Description:** DELETE operation
877
877
 
878
878
  **TypeScript Example:**
879
879
 
@@ -921,7 +921,7 @@ const result: GetCatalogByIdResponse = await getCatalogById(params);
921
921
 
922
922
  **Summary:** Updates a catalog
923
923
 
924
- **Description:** Update specific attributes of a catalog by providing new values, while keeping existing attributes unchanged. If no attributes are specified, the catalog will not be updated.
924
+ **Description:** PUT operation
925
925
 
926
926
  **TypeScript Example:**
927
927
 
@@ -978,7 +978,7 @@ const result: DeleteReleasesResponse = await deleteReleases(params);
978
978
 
979
979
  **Summary:** Gets all authorized catalog releases
980
980
 
981
- **Description:** This operation retrieves a list of published releases for a specified catalog, allowing users to view differences between consecutive releases using the `delta` link. The `is_full_delta` attribute helps determine if a full refresh of data is needed before publishing a catalog release.
981
+ **Description:** GET operation
982
982
 
983
983
  **TypeScript Example:**
984
984
 
@@ -1005,7 +1005,7 @@ const result: GetReleasesResponse = await getReleases(params);
1005
1005
 
1006
1006
  **Summary:** Publishes a catalog
1007
1007
 
1008
- **Description:** Publish a catalog to make it available for retrieval in an organization or store. Published catalogs are read-only and changes require republishing. Delta links provide differences between catalog releases for updating search integration.
1008
+ **Description:** POST operation
1009
1009
 
1010
1010
  **TypeScript Example:**
1011
1011
 
@@ -1087,7 +1087,7 @@ const result: GetReleaseByIdResponse = await getReleaseById(params);
1087
1087
 
1088
1088
  **Summary:** Gets all authorized catalog rules
1089
1089
 
1090
- **Description:** This operation retrieves all authorized catalog rules and supports filtering by attributes like id, catalog_id, account_ids, customer_ids, channels, and tags using operators like eq and in.
1090
+ **Description:** GET operation
1091
1091
 
1092
1092
  **TypeScript Example:**
1093
1093
 
@@ -1113,7 +1113,7 @@ const result: GetRulesResponse = await getRules(params);
1113
1113
 
1114
1114
  **Summary:** Creates a new catalog rule
1115
1115
 
1116
- **Description:** Create catalog rule resources to display different catalogs to specific shoppers based on custom criteria, such as preferred pricing or device type. Note that there may be a 5-minute delay in displaying catalogs due to caching, and organization catalogs cannot have rules applied.
1116
+ **Description:** POST operation
1117
1117
 
1118
1118
  **TypeScript Example:**
1119
1119
 
@@ -1191,7 +1191,7 @@ const result: GetRuleByIdResponse = await getRuleById(params);
1191
1191
 
1192
1192
  **Summary:** Updates a catalog rule
1193
1193
 
1194
- **Description:** Update specific attributes of a catalog rule by providing new values. If the attributes section is empty, the catalog rule will not be updated.
1194
+ **Description:** PUT operation
1195
1195
 
1196
1196
  **TypeScript Example:**
1197
1197
 
@@ -1224,7 +1224,7 @@ const result: UpdateRuleResponse = await updateRule(params);
1224
1224
 
1225
1225
  **Summary:** Get all Hierarchies
1226
1226
 
1227
- **Description:** Retrieves hierarchies from a published catalog, limited to the current release and two prior releases. Supports filtering by attributes like name and ID.
1227
+ **Description:** GET operation
1228
1228
 
1229
1229
  **TypeScript Example:**
1230
1230
 
@@ -1257,7 +1257,7 @@ const result: GetAllHierarchiesResponse = await getAllHierarchies(params);
1257
1257
 
1258
1258
  **Summary:** Get a Hierarchy
1259
1259
 
1260
- **Description:** Retrieve a specific hierarchy from a published catalog, limited to the current release and two prior releases.
1260
+ **Description:** GET operation
1261
1261
 
1262
1262
  **TypeScript Example:**
1263
1263
 
@@ -1286,7 +1286,7 @@ const result: GetHierarchyResponse = await getHierarchy(params);
1286
1286
 
1287
1287
  **Summary:** Get a Hierarchy's Nodes
1288
1288
 
1289
- **Description:** Retrieves all nodes for a specified hierarchy from a published catalog, allowing identification of parent nodes for improved store search functionality.
1289
+ **Description:** GET operation
1290
1290
 
1291
1291
  **TypeScript Example:**
1292
1292
 
@@ -1320,7 +1320,7 @@ const result: GetHierarchyNodesResponse = await getHierarchyNodes(params);
1320
1320
 
1321
1321
  **Summary:** Get a Hierarchy's Children
1322
1322
 
1323
- **Description:** Retrieves parent nodes for a specified hierarchy in a published catalog, allowing identification of associated parent nodes for improved store search functionality.
1323
+ **Description:** GET operation
1324
1324
 
1325
1325
  **TypeScript Example:**
1326
1326
 
@@ -1354,7 +1354,7 @@ const result: GetHierarchyChildNodesResponse = await getHierarchyChildNodes(para
1354
1354
 
1355
1355
  **Summary:** Get all Nodes
1356
1356
 
1357
- **Description:** Retrieves child nodes from a published catalog, limited to the current release and two prior releases. Useful for displaying product associations in a hierarchical structure.
1357
+ **Description:** GET operation
1358
1358
 
1359
1359
  **TypeScript Example:**
1360
1360
 
@@ -1387,7 +1387,7 @@ const result: GetAllNodesResponse = await getAllNodes(params);
1387
1387
 
1388
1388
  **Summary:** Get a Node
1389
1389
 
1390
- **Description:** Retrieves a node from a published catalog, showing associated products. Curated products can be highlighted for promotion within the hierarchy.
1390
+ **Description:** GET operation
1391
1391
 
1392
1392
  **TypeScript Example:**
1393
1393
 
@@ -1416,7 +1416,7 @@ const result: GetNodeResponse = await getNode(params);
1416
1416
 
1417
1417
  **Summary:** Get a Node's Children
1418
1418
 
1419
- **Description:** Retrieves child nodes associated with a specific node in a published catalog, allowing for the display of products and curated products in a hierarchy structure.
1419
+ **Description:** GET operation
1420
1420
 
1421
1421
  **TypeScript Example:**
1422
1422
 
@@ -1450,7 +1450,7 @@ const result: GetChildNodesResponse = await getChildNodes(params);
1450
1450
 
1451
1451
  **Summary:** Get all Products
1452
1452
 
1453
- **Description:** This operation retrieves products from a published catalog, limited to the current release and two prior releases, with only products in a 'live' status being returned.
1453
+ **Description:** GET operation
1454
1454
 
1455
1455
  **TypeScript Example:**
1456
1456
 
@@ -1484,7 +1484,7 @@ const result: GetAllProductsResponse = await getAllProducts(params);
1484
1484
 
1485
1485
  **Summary:** Get a Product
1486
1486
 
1487
- **Description:** Retrieves a live product from a published catalog within the current release and two prior releases. Includes options to retrieve associated resources like main image and files.
1487
+ **Description:** GET operation
1488
1488
 
1489
1489
  **TypeScript Example:**
1490
1490
 
@@ -1554,7 +1554,7 @@ const result: GetAllRelatedProductsResponse = await getAllRelatedProducts(params
1554
1554
 
1555
1555
  **Summary:** Get a Bundle's Component Products
1556
1556
 
1557
- **Description:** Get a list of component product IDs for a specified bundle in Product Experience Manager, including key attributes like SKU or slug. Use the `include` parameter to retrieve additional resources like main images and files.
1557
+ **Description:** GET operation
1558
1558
 
1559
1559
  **TypeScript Example:**
1560
1560
 
@@ -1588,7 +1588,7 @@ const result: GetComponentProductIdsResponse = await getComponentProductIds(para
1588
1588
 
1589
1589
  **Summary:** Get a Parent Product's Child Products
1590
1590
 
1591
- **Description:** Retrieves a list of child products for a specified parent product in a catalog release, only including products in a `live` status. Non-base products will result in a `422 Unprocessable Entity` response.
1591
+ **Description:** GET operation
1592
1592
 
1593
1593
  **TypeScript Example:**
1594
1594
 
@@ -1623,7 +1623,7 @@ const result: GetChildProductsResponse = await getChildProducts(params);
1623
1623
 
1624
1624
  **Summary:** Get a Hierarchy's Products
1625
1625
 
1626
- **Description:** Retrieve products associated with a specified hierarchy in a catalog, limited to those in 'live' status. Supports filtering by various attributes like name, SKU, and product type.
1626
+ **Description:** GET operation
1627
1627
 
1628
1628
  **TypeScript Example:**
1629
1629
 
@@ -1658,7 +1658,7 @@ const result: GetProductsForHierarchyResponse = await getProductsForHierarchy(pa
1658
1658
 
1659
1659
  **Summary:** Get a Node's Products
1660
1660
 
1661
- **Description:** Retrieves live products associated with a specified node in a catalog, ordered by curation if applicable. Supports filtering by attributes like name, SKU, and product type.
1661
+ **Description:** GET operation
1662
1662
 
1663
1663
  **TypeScript Example:**
1664
1664
 
@@ -1693,7 +1693,7 @@ const result: GetProductsForNodeResponse = await getProductsForNode(params);
1693
1693
 
1694
1694
  **Summary:** Get Shopper Carts
1695
1695
 
1696
- **Description:** Retrieve carts associated with an account or customer, sorted by updated date in descending order. Requires an implicit token for authentication.
1696
+ **Description:** GET operation
1697
1697
 
1698
1698
  **TypeScript Example:**
1699
1699
 
@@ -1717,7 +1717,7 @@ const result: GetCartsResponse = await getCarts(params);
1717
1717
 
1718
1718
  **Summary:** Create a Cart
1719
1719
 
1720
- **Description:** Create a new cart for a customer. Each shopper can have multiple carts with distinct items. Custom discounts and inventory settings can be specified.
1720
+ **Description:** POST operation
1721
1721
 
1722
1722
  **TypeScript Example:**
1723
1723
 
@@ -1748,7 +1748,7 @@ const result: CreateACartResponse = await createACart(params);
1748
1748
 
1749
1749
  **Summary:** Delete a Cart
1750
1750
 
1751
- **Description:** Deletes a cart, including items, name, and description. Ensure cart is disassociated from customer before deletion to avoid error.
1751
+ **Description:** DELETE operation
1752
1752
 
1753
1753
  **TypeScript Example:**
1754
1754
 
@@ -1772,7 +1772,7 @@ const result: DeleteACartResponse = await deleteACart(params);
1772
1772
 
1773
1773
  **Summary:** Get a Cart
1774
1774
 
1775
- **Description:** Retrieve a specific cart by providing the cart ID. If the cart doesn't exist, a new cart will be created. Displays associated shipping group IDs if applicable.
1775
+ **Description:** GET operation
1776
1776
 
1777
1777
  **TypeScript Example:**
1778
1778
 
@@ -1799,7 +1799,7 @@ const result: GetACartResponse = await getACart(params);
1799
1799
 
1800
1800
  **Summary:** Update a Cart
1801
1801
 
1802
- **Description:** Update properties of a specific cart by specifying custom discounts and enabling/disabling inventory checks until checkout.
1802
+ **Description:** PUT operation
1803
1803
 
1804
1804
  **TypeScript Example:**
1805
1805
 
@@ -1830,7 +1830,7 @@ const result: UpdateACartResponse = await updateACart(params);
1830
1830
 
1831
1831
  **Summary:** Delete all Cart Items
1832
1832
 
1833
- **Description:** This operation allows a shopper to delete all custom items and promotions from their cart, while keeping the cart available for further item additions. Cart details and associations persist.
1833
+ **Description:** DELETE operation
1834
1834
 
1835
1835
  **TypeScript Example:**
1836
1836
 
@@ -1854,7 +1854,7 @@ const result: DeleteAllCartItemsResponse = await deleteAllCartItems(params);
1854
1854
 
1855
1855
  **Summary:** Get Cart Items
1856
1856
 
1857
- **Description:** Retrieve cart items with associated shipping group IDs and breakdown by promotion ID, showing discounts applied using the same promotion code in both Promotions Standard and Rule Promotions.
1857
+ **Description:** GET operation
1858
1858
 
1859
1859
  **TypeScript Example:**
1860
1860
 
@@ -1878,7 +1878,7 @@ const result: GetCartItemsResponse = await getCartItems(params);
1878
1878
 
1879
1879
  **Summary:** Add Items to Cart
1880
1880
 
1881
- **Description:** Add products, bundles, personalized items, subscriptions, and promotions to a cart. Customize items with text inputs. Specify stock locations and merge multiple carts.
1881
+ **Description:** POST operation
1882
1882
 
1883
1883
  **TypeScript Example:**
1884
1884
 
@@ -1909,7 +1909,7 @@ const result: ManageCartsResponse = await manageCarts(params);
1909
1909
 
1910
1910
  **Summary:** Bulk Update Items in Cart
1911
1911
 
1912
- **Description:** This operation allows shoppers to update multiple items in their cart at once, including quantity and shipping group details, saving time and enabling bulk updates.
1912
+ **Description:** PUT operation
1913
1913
 
1914
1914
  **TypeScript Example:**
1915
1915
 
@@ -2023,7 +2023,7 @@ const result: DeleteAccountCartAssociationResponse = await deleteAccountCartAsso
2023
2023
 
2024
2024
  **Summary:** Create an Account Cart Association
2025
2025
 
2026
- **Description:** Create associations between an account and carts, allowing the account to access those carts across devices.
2026
+ **Description:** POST operation
2027
2027
 
2028
2028
  **TypeScript Example:**
2029
2029
 
@@ -2081,7 +2081,7 @@ const result: DeleteCustomerCartAssociationResponse = await deleteCustomerCartAs
2081
2081
 
2082
2082
  **Summary:** Create a Customer Cart Association
2083
2083
 
2084
- **Description:** Create associations between a customer and one or more carts, allowing the customer to access those carts across devices.
2084
+ **Description:** POST operation
2085
2085
 
2086
2086
  **TypeScript Example:**
2087
2087
 
@@ -2207,7 +2207,7 @@ const result: BulkDeleteTaxItemsFromCartResponse = await bulkDeleteTaxItemsFromC
2207
2207
 
2208
2208
  **Summary:** Bulk Add Tax Items to Cart
2209
2209
 
2210
- **Description:** This operation allows users to bulk add tax items to a specific cart, with a maximum limit of five tax items per cart item. Errors are returned for exceeding the limit or mismatching item types.
2210
+ **Description:** POST operation
2211
2211
 
2212
2212
  **TypeScript Example:**
2213
2213
 
@@ -2325,7 +2325,7 @@ const result: BulkDeleteCustomDiscountsFromCartResponse = await bulkDeleteCustom
2325
2325
 
2326
2326
  **Summary:** Bulk Add Custom Discounts to Cart
2327
2327
 
2328
- **Description:** This operation allows users to add custom discounts in bulk to a specific cart by setting a default value of 5 if not configured, with the option to increase the value by contacting Elastic Path Support team.
2328
+ **Description:** POST operation
2329
2329
 
2330
2330
  **TypeScript Example:**
2331
2331
 
@@ -2566,7 +2566,7 @@ const result: CreateShippingGroupResponse = await createShippingGroup(params);
2566
2566
 
2567
2567
  **Summary:** Delete Cart Shipping Group
2568
2568
 
2569
- **Description:** Deletes a shipping group from a cart, but only if it is not attached to any cart items. Remove the shipping group from all cart items before deleting it.
2569
+ **Description:** DELETE operation
2570
2570
 
2571
2571
  **TypeScript Example:**
2572
2572
 
@@ -2650,7 +2650,7 @@ const result: UpdateShippingGroupResponse = await updateShippingGroup(params);
2650
2650
 
2651
2651
  **Summary:** Create Stripe Payment Intent for a Cart
2652
2652
 
2653
- **Description:** Create a Stripe Payment Intent tied to a shopping cart for tracking payment details and maintaining consistency throughout the order stage. Allows users to create, update, and synchronize Payment Intents between Stripe and Commerce.
2653
+ **Description:** POST operation
2654
2654
 
2655
2655
  **TypeScript Example:**
2656
2656
 
@@ -2713,7 +2713,7 @@ const result: UpdateCartPaymentIntentResponse = await updateCartPaymentIntent(pa
2713
2713
 
2714
2714
  **Summary:** Checkout API
2715
2715
 
2716
- **Description:** Convert a cart to an order for checkout using customer ID, customer object, or account authentication. Response includes order details and associated shipping group.
2716
+ **Description:** POST operation
2717
2717
 
2718
2718
  **TypeScript Example:**
2719
2719
 
@@ -2742,7 +2742,7 @@ const result: CheckoutApiResponse = await checkoutApi(params);
2742
2742
 
2743
2743
  **Summary:** Get all Orders
2744
2744
 
2745
- **Description:** This operation retrieves orders with custom flow fields, allowing for filtering by various attributes such as status, payment, customer details, and dates. Pagination is available to manage large datasets.
2745
+ **Description:** GET operation
2746
2746
 
2747
2747
  **TypeScript Example:**
2748
2748
 
@@ -2798,7 +2798,7 @@ const result: GetAnOrderResponse = await getAnOrder(params);
2798
2798
 
2799
2799
  **Summary:** Update an Order
2800
2800
 
2801
- **Description:** This operation allows you to update custom data, shipping, shipping address, and status of orders. Order number and external reference can be modified, orders can be canceled or fulfilled, with restrictions on fulfillment and refunds.
2801
+ **Description:** PUT operation
2802
2802
 
2803
2803
  **TypeScript Example:**
2804
2804
 
@@ -2855,7 +2855,7 @@ const result: GetOrderItemsResponse = await getOrderItems(params);
2855
2855
 
2856
2856
  **Summary:** Anonymize Orders
2857
2857
 
2858
- **Description:** Anonymize orders by replacing Personal Identifiable Information with * when fulfilled, canceled, or fully refunded.
2858
+ **Description:** POST operation
2859
2859
 
2860
2860
  **TypeScript Example:**
2861
2861
 
@@ -2911,7 +2911,7 @@ const result: ConfirmOrderResponse = await confirmOrder(params);
2911
2911
 
2912
2912
  **Summary:** Payments
2913
2913
 
2914
- **Description:** This operation allows users to set up payments for an order using different transaction types like immediate charging, authorization for future capture, and verification of payment details without transferring funds until confirmation.
2914
+ **Description:** POST operation
2915
2915
 
2916
2916
  **TypeScript Example:**
2917
2917
 
@@ -2941,7 +2941,7 @@ const result: PaymentSetupResponse = await paymentSetup(params);
2941
2941
 
2942
2942
  **Summary:** Confirm Payment
2943
2943
 
2944
- **Description:** Confirm Payment endpoint synchronizes transaction data from third-party payment provider to ensure accurate reflection in Composable Commerce, including handling 3D Secure validations for Stripe Payments.
2944
+ **Description:** POST operation
2945
2945
 
2946
2946
  **TypeScript Example:**
2947
2947
 
@@ -2972,7 +2972,7 @@ const result: ConfirmPaymentResponse = await confirmPayment(params);
2972
2972
 
2973
2973
  **Summary:** Capture a Transaction
2974
2974
 
2975
- **Description:** Capture a previously authorized payment by using this endpoint, allowing you to pass a custom reference, such as the payment reference from your chosen gateway.
2975
+ **Description:** POST operation
2976
2976
 
2977
2977
  **TypeScript Example:**
2978
2978
 
@@ -3002,7 +3002,7 @@ const result: CaptureATransactionResponse = await captureATransaction(params);
3002
3002
 
3003
3003
  **Summary:** Refund a Transaction
3004
3004
 
3005
- **Description:** This operation allows you to process full or partial refunds for a specific transaction directly through Commerce Manager or API, sending the refund request to the payment gateway for processing.
3005
+ **Description:** POST operation
3006
3006
 
3007
3007
  **TypeScript Example:**
3008
3008
 
@@ -3081,7 +3081,7 @@ const result: GetATransactionResponse = await getATransaction(params);
3081
3081
 
3082
3082
  **Summary:** Cancel a Transaction
3083
3083
 
3084
- **Description:** Cancel or void a pending or authorized transaction for a specific order using this endpoint, applicable only for Stripe and PayPal, not manual gateways.
3084
+ **Description:** POST operation
3085
3085
 
3086
3086
  **TypeScript Example:**
3087
3087
 
@@ -3223,7 +3223,7 @@ const result: PutShippingGroupByIdResponse = await putShippingGroupById(params);
3223
3223
 
3224
3224
  **Summary:** List offerings
3225
3225
 
3226
- **Description:** Retrieves a list of all subscription offerings with support for filtering by attributes like external reference and proration policy ID.
3226
+ **Description:** GET operation
3227
3227
 
3228
3228
  **TypeScript Example:**
3229
3229
 
@@ -3385,7 +3385,7 @@ const result: ListOfferingPlanPricingOptionsResponse = await listOfferingPlanPri
3385
3385
 
3386
3386
  **Summary:** List subscriptions
3387
3387
 
3388
- **Description:** This operation retrieves a list of all subscriptions, supporting filtering by attributes like account ID, name, email, and external reference. It also allows including pricing options and plans associated with a subscription.
3388
+ **Description:** GET operation
3389
3389
 
3390
3390
  **TypeScript Example:**
3391
3391
 
@@ -3438,7 +3438,7 @@ const result: GetSubscriptionResponse = await getSubscription(params);
3438
3438
 
3439
3439
  **Summary:** List subscription plans
3440
3440
 
3441
- **Description:** Retrieve a list of plans associated with a specific subscription. Identify the currently active plan in the subscription based on the 'active_plan' status.
3441
+ **Description:** GET operation
3442
3442
 
3443
3443
  **TypeScript Example:**
3444
3444
 
@@ -3462,7 +3462,7 @@ const result: ListSubscriptionPlansResponse = await listSubscriptionPlans(params
3462
3462
 
3463
3463
  **Summary:** List subscription pricing options
3464
3464
 
3465
- **Description:** Retrieve a list of pricing options for a specified subscription to view currently active pricing options. Active pricing options are indicated by the `active_pricing_option` field.
3465
+ **Description:** GET operation
3466
3466
 
3467
3467
  **TypeScript Example:**
3468
3468
 
@@ -3510,7 +3510,7 @@ const result: ListSubscriptionStatesResponse = await listSubscriptionStates(para
3510
3510
 
3511
3511
  **Summary:** Create a subscription state
3512
3512
 
3513
- **Description:** Create a new state for a specific subscription, such as pending, canceled, paused, or resumed, to manage the subscription lifecycle.
3513
+ **Description:** POST operation
3514
3514
 
3515
3515
  **TypeScript Example:**
3516
3516
 
@@ -3676,7 +3676,7 @@ const result: GetSubscriptionInvoiceResponse = await getSubscriptionInvoice(para
3676
3676
 
3677
3677
  **Summary:** List invoices
3678
3678
 
3679
- **Description:** This operation retrieves a list of all invoices and supports filtering by attributes such as subscriber ID, subscription ID, outstanding status, and tax requirement using the 'eq' operator.
3679
+ **Description:** GET operation
3680
3680
 
3681
3681
  **TypeScript Example:**
3682
3682
 
@@ -3800,7 +3800,7 @@ const result: ListLocationsResponse = await listLocations(params);
3800
3800
 
3801
3801
  **Summary:** Create an Access Token
3802
3802
 
3803
- **Description:** This operation creates an access token for client-side applications to fetch data with live status using the implicit token type. It is suitable for read-only access to resources like products, categories, and brands.
3803
+ **Description:** POST operation
3804
3804
 
3805
3805
  **TypeScript Example:**
3806
3806
 
@@ -3963,7 +3963,7 @@ const result: PutV2AccountAddressResponse = await putV2AccountAddress(params);
3963
3963
 
3964
3964
  **Summary:** Get All Accounts
3965
3965
 
3966
- **Description:** Retrieve all accounts with the option to filter by attributes such as name, legal name, registration ID, external reference, ID, creation date, and update date.
3966
+ **Description:** GET operation
3967
3967
 
3968
3968
  **TypeScript Example:**
3969
3969
 
@@ -4068,7 +4068,7 @@ const result: PutV2AccountsAccountIdResponse = await putV2AccountsAccountId(para
4068
4068
 
4069
4069
  **Summary:** Get all Account Members
4070
4070
 
4071
- **Description:** Retrieve all account members associated with your store, with options to filter by email or name using specific operators like 'eq' or 'like'.
4071
+ **Description:** GET operation
4072
4072
 
4073
4073
  **TypeScript Example:**
4074
4074
 
@@ -4118,7 +4118,7 @@ const result: GetV2AccountMembersAccountMemberIdResponse = await getV2AccountMem
4118
4118
 
4119
4119
  **Summary:** Get all Account Memberships
4120
4120
 
4121
- **Description:** Retrieve account memberships with the option to include details about associated account members, such as name and email, using the `include=account_member` parameter. Filter account memberships by `account_member_id` using operators like `eq` and `like`.
4121
+ **Description:** GET operation
4122
4122
 
4123
4123
  **TypeScript Example:**
4124
4124
 
@@ -4147,7 +4147,7 @@ const result: GetV2AccountsAccountIdAccountMembershipsResponse = await getV2Acco
4147
4147
 
4148
4148
  **Summary:** Generate an Account Management Authentication Token
4149
4149
 
4150
- **Description:** This operation generates authentication tokens for Account Management APIs, allowing shoppers to access resources associated with the account by setting the token as the `EP-Account-Management-Authentication-Token` header when making Commerce API calls.
4150
+ **Description:** POST operation
4151
4151
 
4152
4152
  **TypeScript Example:**
4153
4153
 
@@ -4301,7 +4301,7 @@ const result: GetACurrencyResponse = await getACurrency(params);
4301
4301
 
4302
4302
  **Summary:** Get all Files
4303
4303
 
4304
- **Description:** Retrieves all files with options to filter by file name, width, height, and file size.
4304
+ **Description:** GET operation
4305
4305
 
4306
4306
  **TypeScript Example:**
4307
4307