33 x-api-type : Shopper
44 x-api-family : Customer
55 title : Shopper Customers
6- version : 1.6.1
6+ version : 1.7.0
77 description : |-
88 [Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-customers/shopper-customers-oas-v1-public.yaml)
99
@@ -620,8 +620,9 @@ paths:
620620 type : integer
621621 format : int32
622622 default : 10
623+ minimum : 1
623624 maximum : 50
624- description : Maximum records to retrieve per request, not to exceed 50 . Defaults to 10.
625+ description : Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum) . Defaults to 10.
625626 - name : offset
626627 in : query
627628 required : false
@@ -895,7 +896,7 @@ paths:
895896 /organizations/{organizationId}/customers/{customerId}/payment-method-references/{paymentMethodReferenceId} :
896897 delete :
897898 summary : Delete a customer's payment method reference. This endpoint only accepts a registered customer ShopperToken (JWT).
898- description : Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
899+ description : Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
899900 operationId : deleteCustomerPaymentMethodReference
900901 parameters :
901902 - $ref : ' #/components/parameters/paymentMethodReferenceId'
@@ -906,6 +907,40 @@ paths:
906907 responses :
907908 ' 204 ' :
908909 description : No content
910+ security :
911+ - ShopperToken :
912+ - sfcc.shopper-myaccount.paymentinstruments.rw
913+ /organizations/{organizationId}/customers/{customerId}/payment-method-references/actions/setup :
914+ post :
915+ summary : Set up a new payment method reference for a customer. This endpoint only accepts a registered customer ShopperToken (JWT).
916+ description : Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
917+ operationId : setupCustomerPaymentMethodReference
918+ parameters :
919+ - $ref : ' #/components/parameters/customerId'
920+ - $ref : ' #/components/parameters/organizationId'
921+ - $ref : ' #/components/parameters/siteId'
922+ - $ref : ' #/components/parameters/zoneId'
923+ requestBody :
924+ content :
925+ application/json :
926+ schema :
927+ $ref : ' #/components/schemas/PaymentMethodReferenceSetupRequest'
928+ examples :
929+ PaymentMethodReferenceSetupBodyStripe :
930+ $ref : ' #/components/examples/PaymentMethodReferenceSetupBodyStripe'
931+ PaymentMethodReferenceSetupBodyAdyen :
932+ $ref : ' #/components/examples/PaymentMethodReferenceSetupBodyAdyen'
933+ required : true
934+ responses :
935+ ' 200 ' :
936+ description : Payment method reference setup initiated successfully.
937+ content :
938+ application/json :
939+ schema :
940+ $ref : ' #/components/schemas/PaymentMethodReferenceSetupResponse'
941+ examples :
942+ setupPaymentMethodReferenceSuccess :
943+ $ref : ' #/components/examples/setupPaymentMethodReferenceSuccess'
909944 ' 400 ' :
910945 description : |
911946 CustomerId URL parameter does not match the verified customer represented by the JWT token.
@@ -914,8 +949,8 @@ paths:
914949 schema :
915950 $ref : ' #/components/schemas/ErrorResponse'
916951 examples :
917- registerCustomer400 :
918- $ref : ' #/components/examples/registerCustomer400 '
952+ getCustomer404 :
953+ $ref : ' #/components/examples/getCustomer404 '
919954 ' 404 ' :
920955 description : |
921956 Requested resource not found.
@@ -926,6 +961,8 @@ paths:
926961 examples :
927962 getCustomer404 :
928963 $ref : ' #/components/examples/getCustomer404'
964+ setupPaymentMethodReferencePaymentZoneNotFound404 :
965+ $ref : ' #/components/examples/setupPaymentMethodReferencePaymentZoneNotFound404'
929966 security :
930967 - ShopperToken :
931968 - sfcc.shopper-myaccount.paymentinstruments.rw
@@ -1864,6 +1901,11 @@ components:
18641901 example : Acme
18651902 maxLength : 256
18661903 type : string
1904+ crmContactId :
1905+ description : The customer's core contact ID.
1906+ example : 003xx000004WhKe
1907+ maxLength : 18
1908+ type : string
18671909 creationDate :
18681910 description : Returns the value of attribute 'creationDate'.
18691911 example : ' 9999-12-31T00:00:00.0Z'
@@ -4177,6 +4219,58 @@ components:
41774219 example : 2028
41784220 description : The payment card expiration information.
41794221 description : Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
4222+ PaymentMethodReferenceSetupRequest :
4223+ type : object
4224+ description : Request to set up a new payment method reference.
4225+ required :
4226+ - gatewayProperties
4227+ properties :
4228+ paymentMethodType :
4229+ type : string
4230+ maxLength : 256
4231+ description : Payment Method Type
4232+ example : card
4233+ gatewayProperties :
4234+ description : Properties specific to the payment gateway
4235+ type : object
4236+ additionalProperties : false
4237+ properties :
4238+ stripe :
4239+ description : |
4240+ # Stripe-specific properties.
4241+ type : object
4242+ additionalProperties : true
4243+ adyen :
4244+ description : |
4245+ # Adyen-specific properties.
4246+ type : object
4247+ additionalProperties : true
4248+ PaymentMethodReferenceSetupResponse :
4249+ type : object
4250+ description : Response from setting up a new payment method reference.
4251+ required :
4252+ - paymentMethodReferenceSetupId
4253+ properties :
4254+ paymentMethodReferenceSetupId :
4255+ type : string
4256+ maxLength : 256
4257+ description : The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
4258+ example : seti_1Mm8s8LkdIwHu7ix0OXBfTRG
4259+ gatewayProperties :
4260+ description : Properties specific to the payment gateway
4261+ type : object
4262+ additionalProperties : false
4263+ properties :
4264+ stripe :
4265+ description : |
4266+ # Stripe-specific properties.
4267+ type : object
4268+ additionalProperties : true
4269+ adyen :
4270+ description : |
4271+ # Adyen-specific properties.
4272+ type : object
4273+ additionalProperties : true
41804274 CustomerProductListRegistrant :
41814275 description : Document representing a customer product list registrant.
41824276 properties :
@@ -5441,6 +5535,20 @@ components:
54415535 maxLength : 256
54425536 type : string
54435537 example : acc_987654321
5538+ zoneId :
5539+ name : zoneId
5540+ in : query
5541+ description : The zone identifier for the payment configuration.
5542+ required : true
5543+ examples :
5544+ ZoneId :
5545+ value : Amer-Zone
5546+ schema :
5547+ type : string
5548+ description : The unique identifier for a Payments zone.
5549+ minLength : 1
5550+ maxLength : 100
5551+ example : Amer-Zone
54445552 listId :
54455553 name : listId
54465554 in : path
@@ -5512,6 +5620,7 @@ components:
55125620 customerRegistrationResponse :
55135621 value :
55145622 authType : registered
5623+ crmContactId : 003xx000004WhKe
55155624 creationDate : ' 2020-02-13T17:44:15.892Z'
55165625 customerId : abkd9LhOWzAiAFubdEDChtkMHW
55175626 customerNo : ' 00006002'
@@ -5594,6 +5703,7 @@ components:
55945703 salutation : Mr.
55955704 stateCode : MA
55965705 authType : registered
5706+ crmContactId : 003xx000004WhKe
55975707 creationDate : ' 2020-02-14T20:39:53.818Z'
55985708 customerId : abfTEMDZOgi3JPrkHjv9IhoziM
55995709 customerNo : ' 00010009'
@@ -5633,6 +5743,7 @@ components:
56335743 salutation : Mr.
56345744 stateCode : MA
56355745 authType : registered
5746+ crmContactId : 003xx000004WhKe
56365747 creationDate : ' 2020-02-14T20:39:53.818Z'
56375748 customerId : abfTEMDZOgi3JPrkHjv9IhoziM
56385749 customerNo : ' 00010009'
@@ -5669,6 +5780,7 @@ components:
56695780 updateCustomerResponse :
56705781 value :
56715782 authType : registered
5783+ crmContactId : 003xx000004WhKe
56725784 creationDate : ' 2020-02-14T20:39:53.818Z'
56735785 customerId : abfTEMDZOgi3JPrkHjv9IhoziM
56745786 customerNo : ' 00010009'
@@ -6414,6 +6526,37 @@ components:
64146526 title : Unsupported Fields
64156527 type : https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unsupported-fields
64166528 detail : Unsupported fields in the request for updates.
6529+ PaymentMethodReferenceSetupBodyStripe :
6530+ summary : Setup Payment Method Reference (Stripe)
6531+ value :
6532+ paymentMethodType : card
6533+ gatewayProperties :
6534+ stripe :
6535+ usage : on_session
6536+ PaymentMethodReferenceSetupBodyAdyen :
6537+ summary : Setup Payment Method Reference (Adyen)
6538+ value :
6539+ gatewayProperties :
6540+ adyen :
6541+ paymentMethod :
6542+ type : scheme
6543+ encryptedCardNumber : test_4111111111111111
6544+ encryptedExpiryMonth : test_03
6545+ encryptedExpiryYear : test_2030
6546+ encryptedSecurityCode : test_737
6547+ setupPaymentMethodReferenceSuccess :
6548+ summary : Successful payment method reference setup (Stripe)
6549+ value :
6550+ paymentMethodReferenceSetupId : seti_1Mm8s8LkdIwHu7ix0OXBfTRG
6551+ gatewayProperties :
6552+ stripe :
6553+ clientSecret : seti_1Mm8s8LkdIwHu7ix0OXBfTRG_secret_NXDICkPqPeiBTAFYUKGBMVdE7
6554+ setupPaymentMethodReferencePaymentZoneNotFound404 :
6555+ value :
6556+ title : Payment Zone Not Found
6557+ type : https://api.commercecloud.salesforce.com/documentation/error/v1/errors/payment-zone-not-found
6558+ detail : No payment zone with ID 'Amer-Zone' could be found.
6559+ zoneId : Amer-Zone
64176560 customerProductListResult :
64186561 value :
64196562 limit : 1
0 commit comments