Skip to content

Create a Customer

Endpoint: https://api.youcan.shop/customers

Method: POST

Required Scopes

  • edit-customers

Parameters

Param NameParam TypeDescriptionRequired
first_namestringCustomer first nameno
last_namestringCustomer last nameno
emailstringCustomer emailno
phonestringCustomer phone numberno
countrystringCustomer countryno
regionstringCustomer regionno
citystringCustomer cityno
notesstringCustomer notesno

Address

Param NameParam TypeDescriptionRequired
first_namestringAddress holder's first nameno
last_namestringAddress holder's last nameno
companystringAddress holder's company nameno
phonestringAddress holder's phone numberno
first_linestringAddress holder's first lineno
second_linestringAddress holder's second lineno
regionstringAddress holder's regionno
statestringAddress holder's stateno
citystringAddress holder's cityno
zip_codestringAddress holder's postal codeno
country_codestringAddress holder's country codeno
is_defaultbooleanAddress holder's country codeno

Response

[201] Created

json
{
    "id": "da4d2666-33d2-47de-881b-3dad8c4abf62",
    "first_name": "customer_first_name",
    "last_name": "customer_last_name",
    "full_name": "customer_full_name",
    "email": "customer_email",
    "avatar": "https://www.gravatar.com/avatar/f287649f7dd2d340b5e22704b3622ecd?s=100&d=http://api.youcan.shop/store-admin/images/generic_avatar.png",
    "phone": "+212706650843",
    "country": "Morocco",
    "region": "my_region",
    "city": "my_city",
    "notes": "my_",
    "location": "Fes, Morocco",
    "created_at": "2021-04-15T13:55:10+00:00",
    "updated_at": "2021-04-15T13:55:10+00:00",
    "deleted_at": null,
    "links": {
        "edit": "http://seller-area.youcan.shop/admin/customers/da4d2666-33d2-47de-881b-3dad8c4abf62/edit"
    },
    "address": [
        {
            "id": "43cc4816-57dc-4eb1-a828-d2850fe1b42b",
            "first_name": "customer_address_first_name",
            "last_name": "customer_address_last_name",
            "full_name": "customer_address_full_name",
            "first_line": "customer_address_first_line",
            "second_line": "customer_address_second_line",
            "company": "customer_address_company",
            "phone": "+212600000000",
            "country_code": "MA",
            "country_name": "Morocco",
            "state": "customer_state",
            "region": "my_region",
            "city": "my_city",
            "zip_code": "50000",
            "default": true,
            "created_at": 1618494926,
            "updated_at": 1618494926
        }
    ]
}