commerce-sdk - npm Package Versions

v4.0.0

:warning: Planned API Changes :warning:

Shopper Context

Starting July 31st 2024, all endpoints in the Shopper context API will require the siteId parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025. You can read more about the planned change here in the notes section.

Shopper Login (SLAS)

SLAS will soon require new tenants to pass channel_id as an argument for retrieving guest access tokens. You can read more about the planned change here.

Please be aware that existing tenants are on a temporary allow list and will see no immediate disruption to service. We do ask that all users seek to adhere to the channel_id requirement before the end of August to enhance your security posture before the holiday peak season.

In practice, we recommend that customers using the SLAS helper functions upgrade to v4.0.0 of the commerce-sdk.

Enchancements

• Update SLAS helper function loginGuestUserPrivate to require channel_id and loginGuestUser to pass in channel_id to SLAS through clientConfig.parameters.siteId #406

API Changes

CDN Zones API

• Endpoints added | Endpoint Name | Description | | ------------- |-----------------------------------| | getOwaspWafPackage | Get a OWASP ModSecurity Core Rule Set. | | patchOwaspWafPackage | Patch a OWASP ModSecurity Core Rule Set. | | getWafManagedRulesInRuleset | Retrieves all rules in the specified WAFv2 managed ruleset. | | updateWafManagedRuleInRuleset | Updates a WAF managed rule in the specified WAFv2 managed ruleset. | | migrateZoneToWafV2 | Migrates a zone to WAFv2. Only applicable for existing zones using WAFv1. | | upsertOriginHeaderModification | Upsert origin header modification. | | getOriginHeaderModification | Get origin header modification associated with a zone. | | deleteOriginHeaderModification | Delete the origin header modification associated with a zone. |

• BREAKING: Removed deprecated endpoints

  • getFirewallRules
  • createFirewallRule
  • getFirewallRule
  • updateFirewallRule
  • deleteFirewallRule

  NOTE: As of February 6th, 2024, firewall rules are deprecated and customers can use eCDN custom rules moving forward.

v3.1.0

API Changes

Shopper Baskets

| Endpoint Name | Description | | ------------- |-----------------------------------| | updateItemsInBasket | Updates multiple items in a basket. |

v3.0.0

API Changes

Shopper Customers

• Removal of deprecated endpoints:
  • invalidateCustomerAuth
  • authorizeCustomer
  • authorizeTrustedSystem

Shopper Orders

| Endpoint Name | Description | | ------------- |-------------| | guestOrderLookup | Lookup a guest order |

Customers

| Endpoint Name | Description | | ------------- |-------------| | searchCustomerGroup | Search for customer groups in a given Site Id |

Coupons

| Endpoint Name | Description | | ------------- |-------------| | redeemCoupon | Redeems a coupon code for an existing coupon within the selected site. The coupon code must be redeemable. |

Enchancements

• Add helper function customApiHelper.callCustomEndpoint to call Custom APIs - #402

Other Changes

• Removal of deprecated helper function getShopperToken

v2.15.0

API Changes

• Update APIs for Shopper Search

• New Endpoints

  | Endpoint Name | Description | | ------------- |-----------------------------------| | getWafManagedRulesets | Retrieves WAFv2 managed rulesets. | | updateWafManagedRuleset | Updates WAFv2 managed ruleset. |

v2.14.0

• Shopper SEO API*

• New Endpoints

  | Endpoint Name | Description | | ------------- |-------------| | getUrlMapping | Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see URL Resolution. You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the Hook List.|

v2.13.0

Enchancements

• Add support for custom query parameters #396

v2.12.0

New APIs

• Shopper Experience has been added to the SDK.

v2.11.2

Bug fixes

• Mark expand query parameter for getProduct endpoint as optional instead of required

v2.11.1

Bug fixes

• Fix expand query parameter for shopper-products
• Remove retrieveCredQualityUserInfo endpoint from shopper-login as this functionality was removed from SLAS

v2.11.0

API Changes

CDN Zones API

• New Endpoints

  | Endpoint Name | Description | | ------------- |-------------| | getSecuritySettings | Retrieve security settings for a zone | | updateSecuritySettings | Update security settings for a zone | | deleteCertificate | This action deletes a custom hostname and the certificate associated with it. Note that a valid certificate is necessary for a site to remain operational. DELETING AN IN-USE CERTIFICATE MAY RESULT IN DOWNTIME | | createMrtRules | Create MRT rules | | updateMrtRuleset | Update the MRT hostname or add MRT rules to the ruleset | | getMrtRules | Get MRT rules associated with a zone | | deleteMrtRuleset | Delete the MRT ruleset specified for that particular zone | | deleteMrtRule | elete an MRT rule in the specified ruleset | | updateMrtRule | Update the expression and enable or disable an MRT rule | | createLogpushOwnership | Create Logpush ownership token file | | createLogpushJob | Create Logpush job | | listLogpushJob | List Logpush job | | getLogpushJob | Get Logpush job details | | updateLogpushJob | Update Logpush job | | deleteLogpushJob | Delete Logpush job by job ID | | createCustomRule | Creates a custom rule | | getCustomRules | Retrieves existing custom rules | | updateOrderOfCustomRules | Updates the order of all existing custom rules | | getCustomRule | Retrieves a specific custom rule | | updateCustomRule | Updates a specific custom rule | | deleteCustomRule | Deletes a specific custom rule | | createRateLimitingRule | Creates a rate limiting rule | | getRateLimitingRules | Retrieves existing rate limiting rules | | getRateLimitingRule | Retrieves a specific rate limiting rule | | updateRateLimitingRule | Updates a specific rate limiting rule | | deleteRateLimitingRule | Deletes a specific rate limiting rule |

Shopper Baskets API

• New Endpoints

  | Endpoint Name | Description | | ------------- |-------------| | updateAsAgentBasket | Marks a basket as an agent basket | | addPriceAdjustmentToBasket | Adds a custom manual price adjustment to the basket | | removePriceAdjustmentFromBasket | Removes a custom manual price adjustment from the basket | | updatePriceAdjustmentInBasket | Updates a custom manual price adjustment on the basket. Only the following path values are considered for the update (discount, itemText, reasonCode, custom properties); all other attributes are ignored. The discount type of a price adjustment cannot be updated and therefore, the value of the existing type must be passed. For an adjustment of type percentage, the percentage attribute is mandatory. For adjustments of type amount and fixed_price, the amount attribute is mandatory.| | updateAsStorefrontBasket | Marks a basket as a storefront basket |

SLAS Admin API

• New Endpoints

  | Endpoint Name | Description | | ------------- |-------------| | retrievePwdlessTemplate | Retrieve/get a password action template | | registerPwdlessTemplate | Create or update a password action template | | deletePwdlessTemplate | Delete a password action template |

• Removed Endpoints

  • retrieveCredQuailtyStats and retrieveCredQuailtyUserStats endpoints have been removed as that functionality has been eliminated from SLAS and no customers were using these operations.

Documentation

• Admin API examples have been updated in the generated documentation site