Create merchant users
Bulk-creates merchant users. Successful entities are returned in data; per-item failures in errors keyed by email.
POST
/api/v2/{team_slug}/{app_slug}/merchant-usersAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonmerchant_usersCreateMerchantUserItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
CreateMerchantUserItemnamestringsurnamestringemailstringrequiredlanguagestringmarketstringstore_groupstringphone_numberstringadditionsobjectemail_verifiedbooleancommunication_preferencesMerchantUserCommunicationPreferencesShow propertiesHide properties
allow_emailbooleanallow_smsbooleanallow_postalbooleanaddressMerchantUserAddressShow propertiesHide properties
streetstringzip_codestringcitystringcountrystringcountry_codestringstatusstringcommentstringis_super_adminbooleanthird_party_sign_upbooleancustomer_group_idsUUID[]Responses
201
Created (partial success possible)
dataMerchantUser[]requiredShow propertiesHide properties
Array of
MerchantUseridUUIDrequiredapp_idUUIDrequirednamestring | nullsurnamestring | nullemailstringrequiredlanguagestring | nullmarketstringrequiredstore_groupstringrequiredphone_numberstring | nulladditionsobject | nullemail_verifiedbooleanemail_verification_sent_atstring<date-time> | nullcommunication_preferencesMerchantUserCommunicationPreferencesShow propertiesHide properties
allow_emailbooleanallow_smsbooleanallow_postalbooleanaddressMerchantUserAddressShow propertiesHide properties
streetstringzip_codestringcitystringcountrystringcountry_codestringstatusstringrequiredcommentstring | nullis_super_adminbooleanthird_party_sign_upbooleantagsMerchantUserTag[] | nullShow propertiesHide properties
Array of
MerchantUserTagidUUIDrequiredkeystringnamestringstatusstringfilterablebooleancreated_atstring<date-time>updated_atstring<date-time> | nullattributesMerchantUserAttribute[] | nullShow propertiesHide properties
Array of
MerchantUserAttributeidUUIDrequiredkeystringnamestringdescriptionstringfilterablebooleantranslatablebooleanvaluesobjectorganisationsMerchantUserOrganisation[] | nullShow propertiesHide properties
Array of
MerchantUserOrganisationidUUIDrequirednamestringrequiredorganisation_numberstring | nullcustom_role_idUUIDcustom_role_slugstringcustom_role_namestringlevelstringaddress_restrictionsMerchantUserAddressRestriction[] | nullShow propertiesHide properties
Array of
MerchantUserAddressRestrictionorganisation_idUUIDrequiredorganisation_numberstring | nullorganisation_namestringrequiredaddress_idUUIDrequiredformatted_addressstringrequiredcustomer_groupsMerchantUserCustomerGroup[] | nullShow propertiesHide properties
Array of
MerchantUserCustomerGroupidUUIDrequiredslugstringnamestringcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullerrorsMerchantUserError[]requiredShow propertiesHide properties
Array of
MerchantUserErroremailstring | nullidUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullmessagestringrequired400
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required401
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required403
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required500
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required