Create a customer

Creates a new customer for the authenticated company.

Use customers to store and reuse buyer information (for example name, email, phone, and addresses). The created customer can be referenced later when creating orders and other resources.

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Request body

namestring required

Customer's name.

emailstring email required

Customer email address.

phonestring nullable

Customer phone number.

corporateboolean

Indicates whether the customer email is corporate.

custom_referencestring

Merchant-defined reference used to identify the customer in your system.

metadataobject

Arbitrary metadata associated with the customer.

Example request

{
  "name": "miguel",
  "email": "miguel@gmail.com",
  "phone": "+5215555555555",
  "payment_sources": [
    {
      "type": "cash",
      "expires_at": 1553273553
    }
  ],
  "fiscal_entities": [
    {
      "address": {
        "street1": "Nuevo Leon 254",
        "street2": "Departamento 404",
        "postal_code": "06100",
        "city": "Ciudad de Mexico",
        "state": "Ciudad de Mexico",
        "country": "MX",
        "residential": true,
        "external_number": "string"
      },
      "name": "Femsa"
    }
  ],
  "shipping_contacts": [
    {
      "phone": "+525511223344",
      "receiver": "Marvin Fuller",
      "between_streets": "Ackerman Crescent",
      "address": {
        "street1": "Nuevo Leon 254",
        "street2": "Departamento 404",
        "postal_code": "06100",
        "city": "Ciudad de Mexico",
        "state": "Ciudad de Mexico",
        "country": "MX",
        "residential": true
      }
    }
  ]
}

Response

successful operation

v1

Create a customer

Headers

Request body

Example request

Response