younifyd
Menu

Salesforce Commerce Cloud actions

Pick an action to see its parameters, request body and response fields.

414 actions

Assignments (Data API) · 1

Auth (SLAS) · 27

POSTAuthenticate Customer/organizations/{organizationId}/oauth2/loginAuthenticate CustomerGETAuthorize Customer/organizations/{organizationId}/oauth2/authorizeAuthorize CustomerPOSTAuthorize Passwordless Customer/organizations/{organizationId}/oauth2/passwordless/loginAuthorize Passwordless CustomerPOSTAuthorize Webauthn Registration/organizations/{organizationId}/oauth2/webauthn/register/authorizeAuthorize user for WebAuthn registrationDELETEDelete Passkey Credential/organizations/{organizationId}/oauth2/webauthn/passkey/user/{loginId}/credentials/{credentialId}Delete a specific passkey credentialDELETEDelete Passkey User/organizations/{organizationId}/oauth2/webauthn/passkey/user/{loginId}Delete passkey user and all associated credentialsPOSTFinish Webauthn Authentication/organizations/{organizationId}/oauth2/webauthn/authenticate/finishFinish WebAuthn authenticationPOSTFinish Webauthn User Registration/organizations/{organizationId}/oauth2/webauthn/register/finishFinish WebAuthn registrationPOSTGet Access Token/organizations/{organizationId}/oauth2/tokenGet Access TokenGETGet Jwks Uri/organizations/{organizationId}/oauth2/jwksRetrieve JWKS keys.GETGet Passkey User By Login Id/organizations/{organizationId}/oauth2/webauthn/passkey/user/{loginId}Get Passkey User By Login IDPOSTGet Password Less Access Token/organizations/{organizationId}/oauth2/passwordless/tokenIssue a shopper token (JWT).POSTGet Password Reset Token/organizations/{organizationId}/oauth2/password/resetRequest a reset password token.POSTGet Session Bridge Access Token/organizations/{organizationId}/oauth2/session-bridge/tokenGet Session Bridge Access TokenPOSTGet Trusted Agent Access Token/organizations/{organizationId}/oauth2/trusted-agent/tokenGet Trusted Agent Access TokenGETGet Trusted Agent Authorization Token/organizations/{organizationId}/oauth2/trusted-agent/authorizeGet Trusted Agent Authorization TokenPOSTGet Trusted System Access Token/organizations/{organizationId}/oauth2/trusted-system/tokenGet Trusted System Access TokenGETGet User Info/organizations/{organizationId}/oauth2/userinfoGet User InfoGETGet Wellknown Openid Configuration/organizations/{organizationId}/oauth2/.well-known/openid-configurationGet OpenID ConfigurationPOSTIntrospect Token/organizations/{organizationId}/oauth2/introspectReturn token properties.GETLogout Customer/organizations/{organizationId}/oauth2/logoutLog out a shopper.POSTRequest Otp/organizations/{organizationId}/oauth2/otp/requestRequest a one-time password (OTP) for a shopper.POSTReset Password/organizations/{organizationId}/oauth2/password/actionCreate a new password.POSTRevoke Token/organizations/{organizationId}/oauth2/revokeInvalidate a refresh token.POSTStart Webauthn Authentication/organizations/{organizationId}/oauth2/webauthn/authenticate/startStart WebAuthn authenticationPOSTStart Webauthn User Registration/organizations/{organizationId}/oauth2/webauthn/register/startStart WebAuthn registrationPOSTVerify Otp/organizations/{organizationId}/oauth2/otp/verifyVerify a one-time password (OTP) for a shopper.

Auth Admin · 14

DELETEDelete Client/tenants/{tenantId}/clients/{clientId}Delete a client.DELETEDelete Identity Provider/tenants/{tenantId}/idps/{name}Delete an identity provider.DELETEDelete Pwd Action Template/tenants/{tenantId}/clients/{clientId}/password-action-templatesDelete a password action template.DELETEDelete Shopper/tenants/{tenantId}/customers/{customerId}Delete ShopperPUTRegister Client/tenants/{tenantId}/clients/{clientId}Create or update a client.PUTRegister Identity Provider/tenants/{tenantId}/idps/{name}Create or update an identity provider.PUTRegister Pwd Action Template/tenants/{tenantId}/clients/{clientId}/password-action-templatesCreate or update a password action template.PUTRegister Tenant/tenants/{tenantId}Register TenantGETRetrieve Client/tenants/{tenantId}/clients/{clientId}Retrieve a client.GETRetrieve Clients/tenants/{tenantId}/clientsRetrieve/Get all tenant clients.GETRetrieve Identity Provider/tenants/{tenantId}/idps/{name}Retrieve/Get a specific identity provider.GETRetrieve Identity Providers/tenants/{tenantId}/idpsRetrieve/Get all tenant identity providers.GETRetrieve Pwd Action Template/tenants/{tenantId}/clients/{clientId}/password-action-templatesRetrieve/get a password action template.GETRetrieve Tenant/tenants/{tenantId}Retrieve a tenant by tenant ID.

Campaigns (Data API) · 5

Catalogs (Data API) · 32

POSTAdd Products To Exclusion List/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/excluded-productsAdd products to the exclusion list.PUTAssign Product To Category/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}Create a category product assignment.PUTCreate Category In Catalog/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}Create or update a category within a catalog.POSTCreate Category Rules/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rulesCreate rules and conditions for a catalog and category.PUTCreate Or Update Category Rule Condition/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId}Create or update a condition.PUTCreate Update Rule/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}Create or update a rule.DELETEDelete Category From Catalog/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}Delete a specific category from a catalog.DELETEDelete Category Rule Condition/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId}Delete a condition.DELETEDelete Category Rule Conditions/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditionsDelete all conditions for a rule.DELETEDelete Category Rules/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rulesDelete all rules and conditions for a catalog and category.DELETEDelete Rule/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}Delete a rule.GETGet Assigned Product From Category/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}Retrieve a category product assignment.GETGet Catalog/organizations/{organizationId}/catalogs/{catalogId}Retrieve details of a specific catalog.GETGet Catalogs/organizations/{organizationId}/catalogsRetrieve a list of catalog IDs.GETGet Categories From Catalog/organizations/{organizationId}/catalogs/{catalogId}/categoriesRetrieve all categories within a catalog.GETGet Categorization Status/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules-executionGet the status of the latest categorization job.GETGet Category From Catalog/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}Retrieve details of a specific category within a catalog.GETGet Category Rule Condition/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId}Retrieve a condition by ID.GETGet Category Rule Conditions/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditionsRetrieve conditions for a rule.GETGet Category Rules/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rulesRetrieve all rules for a catalog and category.GETGet Exclusion List/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/excluded-productsGet the list of excluded products.GETGet Rule By Id/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}Retrieve a rule by ID.DELETERemove Products From Exclusion List/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/excluded-productsRemove products from the exclusion list.POSTRun Category Rules/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules-executionSubmit a job to evaluate or execute the rules.POSTSearch Catalogs/organizations/{organizationId}/catalog-searchSearch for catalogs.POSTSearch Categories/organizations/{organizationId}/category-searchSearch for categories within an organization.POSTSearch Categories In Catalog/organizations/{organizationId}/catalogs/{catalogId}/category-searchSearch for catalog categories.POSTSearch Products Assigned To Category/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-searchSearch for category product assignments.DELETEUnassign Product From Category/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}Remove a category product assignment.PATCHUpdate Catalog/organizations/{organizationId}/catalogs/{catalogId}Update details of a specific catalog.PATCHUpdate Category In Catalog/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}Update a specific category within a catalog.PATCHUpdate Product Category Assignment/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/products/{productId}Update a category product assignment.

CORS (Data API) · 3

Coupons (Data API) · 9

POSTCoupon Redemptions Search/organizations/{organizationId}/coupons/redemptionsSearch for coupon redemptions.POSTCoupons Search/organizations/{organizationId}/couponsSearch for coupons.PUTCreate Coupon/organizations/{organizationId}/coupons/{couponId}Create CouponDELETEDelete Coupon/organizations/{organizationId}/coupons/{couponId}Delete a coupon with a specified ID.GETGet Coupon/organizations/{organizationId}/coupons/{couponId}Return coupon information for the specified coupon ID.GETGet Coupon Codes/organizations/{organizationId}/coupons/{couponId}/codesGet Coupon CodesPOSTRedeem Coupon/organizations/{organizationId}/coupons/actions/redeemRedeem CouponPATCHUpdate Coupon/organizations/{organizationId}/coupons/{couponId}Update a coupon with the specified information.POSTUpdate Coupon Codes/organizations/{organizationId}/coupons/{couponId}/codesUpdate Coupon Codes

Customers (Data API) · 15

PUTAssign Customer Group Members/organizations/{organizationId}/customer-groups/{customerGroupId}/membersAssign multiple customers to a customer group.POSTCreate Address For Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addressesAdd a new customer address.PUTCreate Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}Create a new customer in a customer list.POSTCreate Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customersCreate a new customer in a customer list.DELETEDelete Customer From Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}Delete a customer from a customer list.GETGet Address For Customer From Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId}Get a customer address.GETGet Addresses For Customer From Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addressesGet a list of customer addresses.GETGet Customer From Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}Get customer information.GETGet Customer Groups/organizations/{organizationId}/customer-groupsGet a list of customer groups.DELETERemove Address For Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId}Delete a customer address.POSTSearch Customer Group/organizations/{organizationId}/customer-group-searchSearch for customer groups.POSTSearch Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customer-searchSearch for customers in a customer list.DELETEUnassign Customer Group Members/organizations/{organizationId}/customer-groups/{customerGroupId}/membersUnassign multiple customers from a customer group.PATCHUpdate Address For Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId}Update a customer address.PATCHUpdate Customer In Customer List/organizations/{organizationId}/customer-lists/{customerListId}/customers/{customerNo}Update a customer in a customer list.

Generic Request · 5

Gift Certificates (Data API) · 5

Orders (Data API) · 13

POSTCreate Orders/organizations/{organizationId}/ordersCreate an order.GETGet Order 2/organizations/{organizationId}/orders/{orderNo}Return order details for the specified order number.GETGet Orders/organizations/{organizationId}/ordersGet OrdersPATCHUpdate Order/organizations/{organizationId}/orders/{orderNo}Update an order.PUTUpdate Order Confirmation Status/organizations/{organizationId}/orders/{orderNo}/confirmation-statusUpdate order confirmation status.PUTUpdate Order Export Status/organizations/{organizationId}/orders/{orderNo}/export-statusUpdate Order Export StatusPUTUpdate Order External Status/organizations/{organizationId}/orders/{orderNo}/external-statusUpdate order external status.PATCHUpdate Order Payment Instrument/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}Update the payment instrument of an order.PUTUpdate Order Payment Status/organizations/{organizationId}/orders/{orderNo}/payment-statusUpdate order payment status.PATCHUpdate Order Payment Transaction/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}/transactionUpdate the transaction of an order payment instrument.PUTUpdate Order Shipping Address/organizations/{organizationId}/orders/{orderNo}/shipments/{shipmentId}/shipping-addressCreate or replace a shipping address.PUTUpdate Order Shipping Status/organizations/{organizationId}/orders/{orderNo}/shipping-statusUpdate order shipping status.PUTUpdate Order Status/organizations/{organizationId}/orders/{orderNo}/statusUpdate order status.

Preferences (Data API) · 9

GETGet Global Custom Preference List/organizations/{organizationId}/global-custom-preferencesRetrieves the Global Custom Preferences.GETGet Global Preference Group/organizations/{organizationId}/global-preference-groups/{groupId}/{instanceType}Get Global Preference GroupGETGet Site Custom Preference List/organizations/{organizationId}/site-custom-preferencesRetrieves the Custom Preferences for a specified siteId.GETGet Site Preference/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}/preferences/{preferenceId}Get Site PreferenceGETGet Site Preference Group/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}Get Site Preference GroupPOSTSearch Site Preferences/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}/preference-searchSearch Site PreferencesPATCHUpdate Global Preference Group/organizations/{organizationId}/global-preference-groups/{groupId}/{instanceType}Update Global Preference GroupPATCHUpdate Site Preference/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}/preferences/{preferenceId}Update Site PreferencePATCHUpdate Site Preference Group/organizations/{organizationId}/site-preference-groups/{groupId}/{instanceType}Update Site Preference Group

Products (Data API) · 36

PUTAssign Variation For Master Product/organizations/{organizationId}/products/{masterProductId}/variations/{id}Assign Variation For Master ProductPUTAssign Variation Group To Master Product/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}Assign or create a variation group for a product.PUTCreate Product/organizations/{organizationId}/products/{productId}Create or overwrite a product with provided data.PUTCreate Product Option/organizations/{organizationId}/products/{productId}/product-options/{id}Create or bind a product option.PUTCreate Product Option Value/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}Create a product option value.PUTCreate Variation Attribute/organizations/{organizationId}/products/{productId}/variation-attributes/{id}Create a variation attribute.PUTCreate Variation Attribute Value/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}Create a variation attribute value.DELETEDelete Product/organizations/{organizationId}/products/{productId}Deletes the product by ID.DELETEDelete Product Option/organizations/{organizationId}/products/{productId}/product-options/{id}Delete or unbind a product option.DELETEDelete Product Option Value/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}Delete a product option value.DELETEDelete Variation Attribute/organizations/{organizationId}/products/{productId}/variation-attributes/{id}Remove a variation attribute.DELETEDelete Variation Attribute Value/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}Delete a variation attribute value.GETGet Categorization Attribute Definitions/organizations/{organizationId}/categorization-attribute-definitionsGet Categorization Attribute DefinitionsGETGet Product 2/organizations/{organizationId}/products/{productId}Get product information.GETGet Product Option/organizations/{organizationId}/products/{productId}/product-options/{id}Retrieve a specific product option.GETGet Product Option Value/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}Retrieve a product option value.GETGet Product Options/organizations/{organizationId}/products/{productId}/product-optionsRetrieve product options for a product.GETGet Variation Attribute/organizations/{organizationId}/products/{productId}/variation-attributes/{id}Retrieve a specific variation attribute.GETGet Variation Attribute Value/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}Retrieve a variation attribute value.GETGet Variation Attributes/organizations/{organizationId}/products/{productId}/variation-attributesRetrieve variation attributes of a product.GETGet Variation For Master Product/organizations/{organizationId}/products/{masterProductId}/variations/{id}Get details of a specific variation.GETGet Variation Group For Master Product/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}Get a specific variation group.GETGet Variation Groups For Master Product/organizations/{organizationId}/products/{masterProductId}/variation-groupsList all variation groups of a product.GETGet Variations For Master Product/organizations/{organizationId}/products/{masterProductId}/variationsList all variations of a master product.POSTSearch Product Variations/organizations/{organizationId}/products/{productId}/variant-searchSearch product variations using complex queries and filters.POSTSearch Products/organizations/{organizationId}/product-searchSearch products.POSTSearch Unassigned Products/organizations/{organizationId}/unassigned-product-searchSearch for unassigned products.DELETEUnassign Variation From Master Product/organizations/{organizationId}/products/{masterProductId}/variations/{id}Unassign a variation from a product (does not delete it).DELETEUnassign Variation Group From Master Product/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}Unassign a variation group (product not deleted).PATCHUpdate Product/organizations/{organizationId}/products/{productId}Partially update fields of an existing product.PATCHUpdate Product Option/organizations/{organizationId}/products/{productId}/product-options/{id}Update a product option.PATCHUpdate Product Option Value/organizations/{organizationId}/products/{productId}/product-options/{optionId}/values/{id}Update a product option value.PATCHUpdate Variation Attribute/organizations/{organizationId}/products/{productId}/variation-attributes/{id}Update a variation attribute.PATCHUpdate Variation Attribute Value/organizations/{organizationId}/products/{productId}/variation-attributes/{attributeId}/values/{id}Update a variation attribute value.PATCHUpdate Variation For Master Product/organizations/{organizationId}/products/{masterProductId}/variations/{id}Update a specific product variation.PATCHUpdate Variation Group For Master Product/organizations/{organizationId}/products/{masterProductId}/variation-groups/{id}Update an existing variation group.

Promotions (Data API) · 5

Shopper Availability · 1

Shopper Baskets v1 · 37

POSTAdd Coupon To Basket/organizations/{organizationId}/baskets/{basketId}/couponsAdd a coupon to a basket.POSTAdd Gift Certificate Item To Basket/organizations/{organizationId}/baskets/{basketId}/gift-certificate-itemsAdd a gift certificate to a basket.POSTAdd Item To Basket/organizations/{organizationId}/baskets/{basketId}/itemsAdd an item to a basket.POSTAdd Payment Instrument To Basket/organizations/{organizationId}/baskets/{basketId}/payment-instrumentsAdd a payment instrument to a basket.POSTAdd Price Adjustment To Basket/organizations/{organizationId}/baskets/{basketId}/price-adjustmentsAdd a price adjustment to a basket.PUTAdd Price Books To Basket/organizations/{organizationId}/baskets/{basketId}/price-booksAdd price books to a basket.PUTAdd Taxes For Basket/organizations/{organizationId}/baskets/{basketId}/taxesAdd external taxation information to a basket.PUTAdd Taxes For Basket Item/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxesAdd taxation information for a basket item.POSTCreate Basket/organizations/{organizationId}/basketsCreate a new basket.POSTCreate Shipment For Basket/organizations/{organizationId}/baskets/{basketId}/shipmentsCreate a shipment for a basket.DELETEDelete Basket/organizations/{organizationId}/baskets/{basketId}Delete a basket.GETGet Basket/organizations/{organizationId}/baskets/{basketId}Retrieve an existing basket.GETGet Payment Methods For Basket/organizations/{organizationId}/baskets/{basketId}/payment-methodsRetrieve payment instruments for a basket.GETGet Price Books For Basket/organizations/{organizationId}/baskets/{basketId}/price-booksRetrieve price books for a basket.GETGet Shipping Methods For Shipment/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methodsRetrieve the shipping methods for a shipment.GETGet Taxes From Basket/organizations/{organizationId}/baskets/{basketId}/taxesRetrieve the external taxation information for a basket.POSTMerge Basket/organizations/{organizationId}/baskets/actions/mergeMerge baskets.DELETERemove Coupon From Basket/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId}Remove a coupon from a basket.DELETERemove Gift Certificate Item From Basket/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}Remove a gift certificate from a basket.DELETERemove Item From Basket/organizations/{organizationId}/baskets/{basketId}/items/{itemId}Remove an item from a basket.DELETERemove Payment Instrument From Basket/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}Remove a payment instrument from a basket.DELETERemove Price Adjustment From Basket/organizations/{organizationId}/baskets/{basketId}/price-adjustments/{priceAdjustmentId}Remove a price adjustment from a basket.DELETERemove Shipment From Basket/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}Remove a shipment from a basket.POSTTransfer Basket/organizations/{organizationId}/baskets/actions/transferTransfer an existing basket.PUTUpdate As Agent Basket/organizations/{organizationId}/baskets/{basketId}/agentDesignate a basket as an agent basket.PUTUpdate As Storefront Basket/organizations/{organizationId}/baskets/{basketId}/storefrontDesignate a basket as a storefront basket.PATCHUpdate Basket/organizations/{organizationId}/baskets/{basketId}Update a basket.PUTUpdate Billing Address For Basket/organizations/{organizationId}/baskets/{basketId}/billing-addressAdd a billing address to a basket.PUTUpdate Customer For Basket/organizations/{organizationId}/baskets/{basketId}/customerAdd shopper information to a basket.PATCHUpdate Gift Certificate Item In Basket/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}Update gift certificate information for a basket.PATCHUpdate Item In Basket/organizations/{organizationId}/baskets/{basketId}/items/{itemId}Update an item in a basket.PATCHUpdate Items In Basket/organizations/{organizationId}/baskets/{basketId}/itemsUpdate a basket item.PATCHUpdate Payment Instrument In Basket/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}Update a payment instrument for a basket.PATCHUpdate Price Adjustment In Basket/organizations/{organizationId}/baskets/{basketId}/price-adjustments/{priceAdjustmentId}Update a price adjustment for a basket.PATCHUpdate Shipment For Basket/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}Update a shipment for a basket.PUTUpdate Shipping Address For Shipment/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-addressUpdate the shipping address for a shipment.PUTUpdate Shipping Method For Shipment/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methodUpdate the shipping method for a shipment.

Shopper Baskets v2 · 38

POSTAdd Coupon To Basket 2/organizations/{organizationId}/baskets/{basketId}/couponsAdd a coupon to a basket.POSTAdd Gift Certificate Item To Basket 2/organizations/{organizationId}/baskets/{basketId}/gift-certificate-itemsAdd a gift certificate to a basket.POSTAdd Item To Basket 2/organizations/{organizationId}/baskets/{basketId}/itemsAdd an item to a basket.POSTAdd Payment Instrument To Basket 2/organizations/{organizationId}/baskets/{basketId}/payment-instrumentsAdd a payment instrument to a basket.POSTAdd Price Adjustment To Basket 2/organizations/{organizationId}/baskets/{basketId}/price-adjustmentsAdd a price adjustment to a basket.PUTAdd Price Books To Basket 2/organizations/{organizationId}/baskets/{basketId}/price-booksAdd price books to a basket.PUTAdd Taxes For Basket 2/organizations/{organizationId}/baskets/{basketId}/taxesAdd external taxation information to a basket.PUTAdd Taxes For Basket Item 2/organizations/{organizationId}/baskets/{basketId}/items/{itemId}/taxesAdd taxation information for a basket item.POSTCreate Basket 2/organizations/{organizationId}/basketsCreate a new basket.POSTCreate Shipment For Basket 2/organizations/{organizationId}/baskets/{basketId}/shipmentsCreate a shipment for a basket.DELETEDelete Basket 2/organizations/{organizationId}/baskets/{basketId}Delete a basket.GETGet Basket 2/organizations/{organizationId}/baskets/{basketId}Retrieve an existing basket.GETGet Payment Methods For Basket 2/organizations/{organizationId}/baskets/{basketId}/payment-methodsRetrieve payment instruments for a basket.GETGet Price Books For Basket 2/organizations/{organizationId}/baskets/{basketId}/price-booksRetrieve price books for a basket.GETGet Shipping Methods For Shipment 2/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methodsRetrieve the shipping methods for a shipment.GETGet Taxes From Basket 2/organizations/{organizationId}/baskets/{basketId}/taxesRetrieve the external taxation information for a basket.POSTMerge Basket 2/organizations/{organizationId}/baskets/actions/mergeMerge baskets.POSTPromote Temporary Basket/organizations/{organizationId}/baskets/{basketId}/actions/promotePromote a temporary basket by clearing its isTemporary flag.DELETERemove Coupon From Basket 2/organizations/{organizationId}/baskets/{basketId}/coupons/{couponItemId}Remove a coupon from a basket.DELETERemove Gift Certificate Item From Basket 2/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}Remove a gift certificate from a basket.DELETERemove Item From Basket 2/organizations/{organizationId}/baskets/{basketId}/items/{itemId}Remove an item from a basket.DELETERemove Payment Instrument From Basket 2/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}Remove a payment instrument from a basket.DELETERemove Price Adjustment From Basket 2/organizations/{organizationId}/baskets/{basketId}/price-adjustments/{priceAdjustmentId}Remove a price adjustment from a basket.DELETERemove Shipment From Basket 2/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}Remove a shipment from a basket.POSTTransfer Basket 2/organizations/{organizationId}/baskets/actions/transferTransfer an existing basket.PUTUpdate As Agent Basket 2/organizations/{organizationId}/baskets/{basketId}/agentDesignate a basket as an agent basket.PUTUpdate As Storefront Basket 2/organizations/{organizationId}/baskets/{basketId}/storefrontDesignate a basket as a storefront basket.PATCHUpdate Basket 2/organizations/{organizationId}/baskets/{basketId}Update a basket.PUTUpdate Billing Address For Basket 2/organizations/{organizationId}/baskets/{basketId}/billing-addressAdd a billing address to a basket.PUTUpdate Customer For Basket 2/organizations/{organizationId}/baskets/{basketId}/customerAdd shopper information to a basket.PATCHUpdate Gift Certificate Item In Basket 2/organizations/{organizationId}/baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}Update gift certificate information for a basket.PATCHUpdate Item In Basket 2/organizations/{organizationId}/baskets/{basketId}/items/{itemId}Update an item in a basket.PATCHUpdate Items In Basket 2/organizations/{organizationId}/baskets/{basketId}/itemsUpdate a basket item.PATCHUpdate Payment Instrument In Basket 2/organizations/{organizationId}/baskets/{basketId}/payment-instruments/{paymentInstrumentId}Update a payment instrument for a basket.PATCHUpdate Price Adjustment In Basket 2/organizations/{organizationId}/baskets/{basketId}/price-adjustments/{priceAdjustmentId}Update a price adjustment for a basket.PATCHUpdate Shipment For Basket 2/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}Update a shipment for a basket.PUTUpdate Shipping Address For Shipment 2/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-addressUpdate the shipping address for a shipment.PUTUpdate Shipping Method For Shipment 2/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methodUpdate the shipping method for a shipment.

Shopper Configurations · 1

Shopper Consents · 3

Shopper Context · 4

Shopper Customers · 33

POSTCreate Customer Address/organizations/{organizationId}/customers/{customerId}/addressesCreate Customer AddressPOSTCreate Customer Payment Instrument/organizations/{organizationId}/customers/{customerId}/payment-instrumentsCreate Customer Payment InstrumentPOSTCreate Customer Product List/organizations/{organizationId}/customers/{customerId}/product-listsCreate Customer Product ListPOSTCreate Customer Product List Item/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/itemsAdd an item to the customer's product list.DELETEDelete Customer Payment Instrument/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}Delete Customer Payment InstrumentDELETEDelete Customer Payment Method Reference/organizations/{organizationId}/customers/{customerId}/payment-method-references/{paymentMethodReferenceId}Delete Customer Payment Method ReferenceDELETEDelete Customer Product List/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}Delete a customer product list. This endpoint accepts a registered customer ShopperToken (JWT) or a guest customer ShopperToken.DELETEDelete Customer Product List Item/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}Delete Customer Product List ItemGETGet Customer/organizations/{organizationId}/customers/{customerId}Get CustomerGETGet Customer Address/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}Get Customer AddressGETGet Customer Baskets/organizations/{organizationId}/customers/{customerId}/basketsGet Customer BasketsGETGet Customer Orders/organizations/{organizationId}/customers/{customerId}/ordersGet Customer OrdersGETGet Customer Payment Instrument/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}Get Customer Payment InstrumentGETGet Customer Product List/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}Get Customer Product ListGETGet Customer Product List Item/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}Get Customer Product List ItemGETGet Customer Product Lists/organizations/{organizationId}/customers/{customerId}/product-listsGet Customer Product ListsGETGet External Profile/organizations/{organizationId}/customers/external-profileGet External ProfileGETGet Product List Item/organizations/{organizationId}/product-lists/{listId}/items/{itemId}Get Product List ItemGETGet Public Product List/organizations/{organizationId}/product-lists/{listId}Get Public Product ListGETGet Public Product List Items/organizations/{organizationId}/product-lists/{listId}/itemsRetrieve all items of a public product list.GETGet Public Product Lists By Search Term/organizations/{organizationId}/product-listsGet Public Product Lists By Search TermPOSTGet Reset Password Token/organizations/{organizationId}/customers/password/actions/create-reset-tokenGet reset password token.POSTRegister Customer/organizations/{organizationId}/customersRegister a new customer.POSTRegister External Profile/organizations/{organizationId}/customers/external-profileRegister External ProfileDELETERemove Customer Address/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}Remove Customer AddressPOSTReset Password 2/organizations/{organizationId}/customers/password/actions/resetReset customer password after obtaining a reset token.POSTSetup Customer Payment Method Reference/organizations/{organizationId}/customers/{customerId}/payment-method-references/actions/setupSetup Customer Payment Method ReferencePATCHUpdate Customer/organizations/{organizationId}/customers/{customerId}Update CustomerPATCHUpdate Customer Address/organizations/{organizationId}/customers/{customerId}/addresses/{addressName}Update Customer AddressPUTUpdate Customer Password/organizations/{organizationId}/customers/{customerId}/passwordUpdate Customer PasswordPATCHUpdate Customer Payment Instrument/organizations/{organizationId}/customers/{customerId}/payment-instruments/{paymentInstrumentId}Update Customer Payment InstrumentPATCHUpdate Customer Product List/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}Update Customer Product ListPATCHUpdate Customer Product List Item/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items/{itemId}Update an item in a customer's product list.

Shopper Experience · 9

GETGet Component/organizations/{organizationId}/components/{componentId}Get a component by ID.GETGet Content/organizations/{organizationId}/contents/{id}Get a content asset by ID.GETGet Content Folder/organizations/{organizationId}/folders/{id}Get content folderGETGet Content Folders/organizations/{organizationId}/foldersGet multiple content foldersGETGet Multiple Content/organizations/{organizationId}/contentsGet multiple content assets.GETGet Page/organizations/{organizationId}/pages/{pageId}Get a Page Designer page based on a single page ID.GETGet Pages/organizations/{organizationId}/pagesGet Page Designer pages.POSTResolve Qualifiers/organizations/{organizationId}/qualifiers/resolveResolve QualifiersGETSearch Content/organizations/{organizationId}/content-searchSearch for content assets.

Shopper Gift Certificates · 1

Shopper Orders · 12

POSTCancel Oms Order/organizations/{organizationId}/orders/{orderNo}/actions/oms-cancel-orderCancel OMS OrderPOSTCreate Order/organizations/{organizationId}/ordersSubmits an order for a basket.POSTCreate Payment Instrument For Order/organizations/{organizationId}/orders/{orderNo}/payment-instrumentsAdd a payment instrument to an order.POSTFail Order/organizations/{organizationId}/orders/{orderNo}/actions/failFail an Order.GETGet Oms Meta Data/organizations/{organizationId}/orders/oms-meta-dataGet OMS Meta DataGETGet Order/organizations/{organizationId}/orders/{orderNo}Retrieve order information.GETGet Payment Methods For Order/organizations/{organizationId}/orders/{orderNo}/payment-methodsRetrieve payment instrument details for an order.GETGet Taxes From Order/organizations/{organizationId}/orders/{orderNo}/taxesRetrieve external taxation data for an order.POSTGuest Order Lookup/organizations/{organizationId}/orders/{orderNo}/lookupGuest Order LookupDELETERemove Payment Instrument From Order/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}Remove a payment instrument from an order.POSTReturn Oms Order/organizations/{organizationId}/orders/{orderNo}/actions/oms-return-orderReturn OMS OrderPATCHUpdate Payment Instrument For Order/organizations/{organizationId}/orders/{orderNo}/payment-instruments/{paymentInstrumentId}Update payment instrument details for an order.

Shopper Products · 7

Shopper Promotions · 2

Shopper Search · 2

Shopper SEO · 1

Shopper Stores · 2

Source Code Groups (Data API) · 5

Zones (Data API) · 77

POSTAdd Certificate For Zone/organizations/{organizationId}/zones/{zoneId}/certificatesAdd certificate for a zone.POSTCache Purge/organizations/{organizationId}/zones/{zoneId}/cachepurgePurge the cache for the host specified in the request body.POSTCreate Cache Rule/organizations/{organizationId}/zones/{zoneId}/cache/rulesCreate a cache rule.POSTCreate Code Upload Certificate/organizations/{organizationId}/mtls/code-upload-certificatesCreate Code Upload CertificatePOSTCreate Custom Rule/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rulesCreate a custom rule.POSTCreate Logpush Job/organizations/{organizationId}/zones/{zoneId}/logpush/jobsCreate Logpush job.POSTCreate Logpush Ownership/organizations/{organizationId}/zones/{zoneId}/logpush/ownershipCreate Logpush ownership token file.POSTCreate Mrt Rules/organizations/{organizationId}/zones/{zoneId}/mrtrulesCreate MRT rules to route to a new MRT environment.POSTCreate Page Shield Policy/organizations/{organizationId}/zones/{zoneId}/page-shield/policiesCreate page shield policy.POSTCreate Rate Limiting Rule/organizations/{organizationId}/zones/{zoneId}/rate-limiting/rulesCreate a rate limiting rule.POSTCreate Storefront Zone/organizations/{organizationId}/storefront-zonesCreate a new storefront zone.POSTCreate Webhook/organizations/{organizationId}/webhookCreate webhook.DELETEDelete Cache Rule/organizations/{organizationId}/zones/{zoneId}/cache/rules/{ruleId}Delete a cache rule.DELETEDelete Certificate/organizations/{organizationId}/zones/{zoneId}/certificates/{certificateId}Delete CertificateDELETEDelete Code Upload Certificate/organizations/{organizationId}/mtls/code-upload-certificates/{mtlsCertificateId}Remove an mTLS certificate and associated hostname.DELETEDelete Custom Rule/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rules/{ruleId}Delete a specific custom rule.DELETEDelete Logpush Job/organizations/{organizationId}/zones/{zoneId}/logpush/jobs/{jobId}Delete Logpush job by job ID.DELETEDelete Mrt Rule/organizations/{organizationId}/zones/{zoneId}/mrtrules/{rulesetId}/rules/{ruleId}Delete an MRT rule.DELETEDelete Mrt Ruleset/organizations/{organizationId}/zones/{zoneId}/mrtrules/{rulesetId}Delete the MRT ruleset and all rules within the ruleset.DELETEDelete Origin Header Modification/organizations/{organizationId}/zones/{zoneId}/origin-header-modification/{type}Delete Origin Header ModificationDELETEDelete Page Shield Notification/organizations/{organizationId}/page-shield/notifications/{webhookId}Delete page shield notification webhook.DELETEDelete Page Shield Policy/organizations/{organizationId}/zones/{zoneId}/page-shield/policies/{policyId}Delete page shield policy.DELETEDelete Rate Limiting Rule/organizations/{organizationId}/zones/{zoneId}/rate-limiting/rules/{ruleId}Delete a specific rate limiting rule.DELETEDelete Webhook/organizations/{organizationId}/webhook/{webhookId}Delete webhook.GETGet Cache Rules/organizations/{organizationId}/zones/{zoneId}/cache/rulesRetrieve existing cache rules.GETGet Certificates/organizations/{organizationId}/zones/{zoneId}/certificatesList certificates for a zone.GETGet Cipher Suites/organizations/{organizationId}/zones/{zoneId}/settings/ciphersGet cipher suites settings by zoneId.GETGet Code Upload Certificate/organizations/{organizationId}/mtls/code-upload-certificates/{mtlsCertificateId}Get Code Upload CertificateGETGet Code Upload Certificates/organizations/{organizationId}/mtls/code-upload-certificatesReturn all the mTLS certificates for the account.GETGet Custom Rule/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rules/{ruleId}Retrieve a specific custom rule.GETGet Custom Rules/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rulesRetrieve existing custom rules.GETGet Logpush Job/organizations/{organizationId}/zones/{zoneId}/logpush/jobs/{jobId}Get Logpush job details.GETGet Mrt Rules/organizations/{organizationId}/zones/{zoneId}/mrtrulesGet all MRT rules.GETGet Origin Header Modification/organizations/{organizationId}/zones/{zoneId}/origin-header-modification/{type}Get Origin Header ModificationGETGet Owasp Waf Package/organizations/{organizationId}/zones/{zoneId}/firewall/waf/packages/owaspGet a OWASP ModSecurity Core Rule Set.GETGet Page Shield Notification/organizations/{organizationId}/page-shield/notificationsGet page shield notification webhooks.GETGet Page Shield Policies/organizations/{organizationId}/zones/{zoneId}/page-shield/policiesList page shield policies.GETGet Page Shield Policy/organizations/{organizationId}/zones/{zoneId}/page-shield/policies/{policyId}Get page shield policy by policy ID.GETGet Page Shield Script/organizations/{organizationId}/zones/{zoneId}/page-shield/scripts/{scriptId}Fetch a script detected by Page Shield by script ID.GETGet Page Shield Scripts/organizations/{organizationId}/zones/{zoneId}/page-shield/scriptsGet Page Shield ScriptsGETGet Rate Limiting Rule/organizations/{organizationId}/zones/{zoneId}/rate-limiting/rules/{ruleId}Retrieve a specific rate limiting rule.GETGet Rate Limiting Rules/organizations/{organizationId}/zones/{zoneId}/rate-limiting/rulesRetrieve existing rate limiting rules.GETGet Security Settings/organizations/{organizationId}/zones/{zoneId}/security-settingsRetrieve the security settings for a zone.GETGet Speed Settings/organizations/{organizationId}/zones/{zoneId}/speed-settingsRetrieve the speed settings for a zone.GETGet Waf Groups/organizations/{organizationId}/zones/{zoneId}/waf/groupsRetrieve all WAF groups accessible to the caller.GETGet Waf Managed Rules In Ruleset/organizations/{organizationId}/zones/{zoneId}/firewall-managed/rulesets/{rulesetId}/rulesRetrieve all rules in the specified WAFv2 managed ruleset.GETGet Waf Managed Rulesets/organizations/{organizationId}/zones/{zoneId}/firewall-managed/rulesetsRetrieve WAFv2 managed rulesets.GETGet Waf Rule/organizations/{organizationId}/zones/{zoneId}/waf/rules/{ruleId}Retrieve details of a specific WAF rule.GETGet Waf Rules/organizations/{organizationId}/zones/{zoneId}/waf/rulesGet WAF RulesGETGet Webhook/organizations/{organizationId}/webhook/{webhookId}Get webhook by ID.GETGet Webhooks/organizations/{organizationId}/webhookList webhooks.GETGet Zones Info/organizations/{organizationId}/zones/infoRetrieve zone information.GETList Logpush Job/organizations/{organizationId}/zones/{zoneId}/logpush/jobsList Logpush job.PUTMigrate Zone To Waf V2/organizations/{organizationId}/zones/{zoneId}/firewall-managed/migrationMigrate Zone to WAF V2PATCHPatch Owasp Waf Package/organizations/{organizationId}/zones/{zoneId}/firewall/waf/packages/owaspPatch a OWASP ModSecurity Core Rule Set.POSTPost Page Shield Notification/organizations/{organizationId}/page-shield/notificationsSetup page shield notification webhook.PATCHToggle Ocapi Caching Page Rule/organizations/{organizationId}/zones/{zoneId}/ocapicachingpageruleEnable or disable the OCAPI Caching page rule.PATCHUpdate Cache Rule/organizations/{organizationId}/zones/{zoneId}/cache/rules/{ruleId}Update a cache rule.PATCHUpdate Certificate/organizations/{organizationId}/zones/{zoneId}/certificates/{certificateId}Update CertificatePATCHUpdate Cipher Suites/organizations/{organizationId}/zones/{zoneId}/settings/ciphersUpdate cipher suite settings for the zone.PATCHUpdate Custom Rule/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rules/{ruleId}Update a specific custom rule.PUTUpdate Logpush Job/organizations/{organizationId}/zones/{zoneId}/logpush/jobs/{jobId}Update Logpush job.PATCHUpdate Mrt Rule/organizations/{organizationId}/zones/{zoneId}/mrtrules/{rulesetId}/rules/{ruleId}Update an MRT rule.PATCHUpdate Mrt Ruleset/organizations/{organizationId}/zones/{zoneId}/mrtrulesUpdate MRT RulesetPATCHUpdate Order Of Custom Rules/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rulesUpdate the order of all existing custom rules.PATCHUpdate Page Shield Notification/organizations/{organizationId}/page-shield/notifications/{webhookId}Update page shield notification webhook.PUTUpdate Page Shield Policy/organizations/{organizationId}/zones/{zoneId}/page-shield/policies/{policyId}Update page shield policy by policy ID.PATCHUpdate Rate Limiting Rule/organizations/{organizationId}/zones/{zoneId}/rate-limiting/rules/{ruleId}Update a specific rate limiting rule.PATCHUpdate Security Settings/organizations/{organizationId}/zones/{zoneId}/security-settingsUpdate the security settings for a zone.PATCHUpdate Speed Settings/organizations/{organizationId}/zones/{zoneId}/speed-settingsUpdate the speed settings for a zone.PUTUpdate Waf Group/organizations/{organizationId}/zones/{zoneId}/waf/groups/{groupId}Update the action or mode of a specific WAF group.PATCHUpdate Waf Managed Rule In Ruleset/organizations/{organizationId}/zones/{zoneId}/firewall-managed/rulesets/{rulesetId}/rules/{ruleId}Update WAF Managed Rule in RulesetPATCHUpdate Waf Managed Ruleset/organizations/{organizationId}/zones/{zoneId}/firewall-managed/rulesets/{rulesetId}Update WAFv2 managed ruleset.PUTUpdate Waf Rule/organizations/{organizationId}/zones/{zoneId}/waf/rules/{ruleId}Update the action of a specific WAF rule.PUTUpdate Webhook/organizations/{organizationId}/webhook/{webhookId}Update webhook.PUTUpsert Origin Header Modification/organizations/{organizationId}/zones/{zoneId}/origin-header-modification/{type}Upsert Origin Header ModificationPATCHValidate Custom Hostname/organizations/{organizationId}/zones/{zoneId}/certificates/custom-hostnames/{customHostnameId}Trigger the validation of a custom hostname.
Salesforce Commerce Cloud actions — Documentation