Signs up a new customer and returns a customer key.
HTTP POST/api/v10/storefront.sign-up
{
"customer" : { // customer to sign up
"cart" : "ebe766e73af1128d13217f1bcea6b9d9", // cart (token) (can be null) - string(32)
"address" : { // billing address (required)
"firstName" : "Sherlock", // first name - string(1…25)
"lastName" : "Holmes", // last name - string(1…25)
"personalCode" : "SH239IBA", // personal code - string(0…20)
"companyName" : "Investigations Inc", // company name - string(0…100)
"companyCode" : "INV8403MC1", // company code number - string(0…20)
"companyCode2" : "7J BA3 006", // second company code number - string(0…20)
"street1" : "221b Baker Street", // street, first row - string(1…60)
"street2" : "", // street, second row - string(0…60)
"city" : "London", // city - string(1…25)
"postalCode" : "NW1 6XE", // postal code - string(1…20)
"stateProv" : "LND", // state, province or county - string(0…3)
"country" : "GB", // country (ISO code) - string(2)
"phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
"mobileNumber" : "", // mobile number - string(0…15)
"faxNumber" : "", // fax number - string(0…15)
"email" : "holmes@inv-london.com" // email address - string(3…120)
},
"privacyConsents" : [ 12, 3, … ], // privacy processings which the customer is giving consent to (required) - int(1…256)
"password" : "I9bV2crS", // password (required) - string(6…16)
"invoiceRecipient" : "AB7TR6K", // electronic invoice recipient code or PEC email address - string(0…256)
"newsletterLists" : [ 5, 7, … ] // newsletter lists (id) to subscribe the customer to - int(1…)
},
"verificationCode" : "AT67N3FG" // verification code - string(6…32)
}
HTTP headersX-Customer-Key: RtRi8JWsxKNB8J3Qhhfsm5b5x9rvwippfnTel3mPy-X5R6GXlPECXTTMwTA1UJtg
{
"status" : "ok"
}
Field | Type | Description |
---|---|---|
cart | NotFound | Cart '<cart> ' does not exist |
AlreadyExists | Email '<email> ' already exists |
|
InvalidValue | '<email> ' is not a well formed email address |
|
newsletterLists | NotFound | Newsletter list <newsletterList> does not exist |
privacyConsents | InvalidValue | Consent to processing <processing> is required |
verificationCode | InvalidValue | Verification code '<verificationCode>' is not valid |
verificationCode | Missing | Verification code is required |