customers - Magento B2B API

Create customer account. Perform necessary business operations like sending email.

curl --location -g --request POST 'http:///V1/customers' \ --header 'Content-Type: application/json' \ --data-raw '{ "customer": { "addresses": [ { "city": "string", "company": "string", "country_id": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_id": 0, "default_billing": true, "default_shipping": true, "extension_attributes": {}, "fax": "string", "firstname": "string", "id": 0, "lastname": "string", "middlename": "string", "postcode": "string", "prefix": "string", "region": { "extension_attributes": {}, "region": "string", "region_code": "string", "region_id": 0 }, "region_id": 0, "street": [ "string" ], "suffix": "string", "telephone": "string", "vat_id": "string" } ], "confirmation": "string", "created_at": "string", "created_in": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "default_billing": "string", "default_shipping": "string", "disable_auto_group_change": 0, "dob": "string", "email": "string", "extension_attributes": { "amazon_id": "string", "company_attributes": { "company_id": 0, "customer_id": 0, "extension_attributes": {}, "job_title": "string", "status": 0, "telephone": "string" }, "is_subscribed": true, "vertex_customer_code": "string" }, "firstname": "string", "gender": 0, "group_id": 0, "id": 0, "lastname": "string", "middlename": "string", "prefix": "string", "store_id": 0, "suffix": "string", "taxvat": "string", "updated_at": "string", "website_id": 0 }, "password": "string", "redirectUrl": "string" }'

{ "addresses": [ { "city": "string", "company": "string", "country_id": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_id": 0, "default_billing": true, "default_shipping": true, "extension_attributes": {}, "fax": "string", "firstname": "string", "id": 0, "lastname": "string", "middlename": "string", "postcode": "string", "prefix": "string", "region": { "extension_attributes": {}, "region": "string", "region_code": "string", "region_id": 0 }, "region_id": 0, "street": [ "string" ], "suffix": "string", "telephone": "string", "vat_id": "string" } ], "confirmation": "string", "created_at": "string", "created_in": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "default_billing": "string", "default_shipping": "string", "disable_auto_group_change": 0, "dob": "string", "email": "string", "extension_attributes": { "amazon_id": "string", "company_attributes": { "company_id": 0, "customer_id": 0, "extension_attributes": {}, "job_title": "string", "status": 0, "telephone": "string" }, "is_subscribed": true, "vertex_customer_code": "string" }, "firstname": "string", "gender": 0, "group_id": 0, "id": 0, "lastname": "string", "middlename": "string", "prefix": "string", "store_id": 0, "suffix": "string", "taxvat": "string", "updated_at": "string", "website_id": 0 }

请求参数

Body 参数application/json

customer

object (customer-data-customer-interface)

必需

Customer interface.

addresses

array[object (customer-data-address-interface) {21}]

可选

Customer addresses.

confirmation

string

可选

Confirmation

created_at

string

可选

Created at time

created_in

string

可选

Created in area

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

default_billing

string

可选

Default billing address id

default_shipping

string

可选

Default shipping address id

disable_auto_group_change

integer

可选

Disable auto group change flag.

dob

string

可选

Date of birth

string

必需

Email address

extension_attributes

object (customer-data-customer-extension-interface)

可选

ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface

firstname

string

必需

First name

gender

integer

Gender

可选

group_id

integer

Group id

可选

integer

可选

Customer id

lastname

string

Last name

必需

middlename

string

可选

Middle name

prefix

string

Prefix

可选

store_id

integer

Store id

可选

suffix

string

Suffix

可选

taxvat

string

Tax Vat

可选

updated_at

string

可选

Updated at time

website_id

integer

可选

Website id

password

string

可选

redirectUrl

string

可选

示例

返回响应

🟢200成功

application/json

200 Success.

Body

Customer interface.

addresses

array[object (customer-data-address-interface) {21}]

可选

Customer addresses.

city

string

City name

可选

company

string

Company

可选

country_id

string

可选

Country code in ISO_3166-2 format

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

customer_id

integer

可选

Customer ID

default_billing

boolean

可选

If this address is default billing address

default_shipping

boolean

可选

If this address is default shipping address.

extension_attributes

object (customer-data-address-extension-interface)

可选

ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface

fax

string

可选

Fax number

firstname

string

可选

First name

integer

可选

lastname

string

Last name

可选

middlename

string

可选

Middle name

postcode

string

Postcode

可选

prefix

string

Prefix

可选

region

object (customer-data-region-interface)

可选

Customer address region interface.

region_id

integer

Region ID

可选

street

array[string]

Street

可选

suffix

string

Suffix

可选

telephone

string

可选

Telephone number

vat_id

string

Vat id

可选

confirmation

string

可选

Confirmation

created_at

string

可选

Created at time

created_in

string

可选

Created in area

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

attribute_code

string

必需

Attribute code

value

string

必需

Attribute value

default_billing

string

可选

Default billing address id

default_shipping

string

可选

Default shipping address id

disable_auto_group_change

integer

可选

Disable auto group change flag.

dob

string

可选

Date of birth

string

必需

Email address

extension_attributes

object (customer-data-customer-extension-interface)

可选

ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface

amazon_id

string

可选

company_attributes

object (company-data-company-customer-interface)

可选

Extended customer custom attributes interface.

is_subscribed

boolean

可选

vertex_customer_code

string

可选

firstname

string

必需

First name

gender

integer

Gender

可选

group_id

integer

Group id

可选

integer

可选

Customer id

lastname

string

Last name

必需

middlename

string

可选

Middle name

prefix

string

Prefix

可选

store_id

integer

Store id

可选

suffix

string

Suffix

可选

taxvat

string

Tax Vat

可选

updated_at

string

可选

Updated at time

website_id

integer

可选

Website id

🔴500服务器错误