Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

Customer_Delete

Previous Next

Deletes a customer account.

Deletes a customer account. Identify the customer by ID or login.

Before you begin#

  • The API token needs Customer_Delete, either assigned directly under Functions or through a group. See Create an API token.
  • Requests must be signed if the token requires it. See Make a signed request with HMAC.
  • You need the customer’s Customer_ID, Customer_Login or Edit_Customer (the login).

Example requests#

Delete a customer by login#

Deletes the customer whose login is passed in Edit_Customer.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Customer_Delete",
    "Edit_Customer": "{{Customer_Login}}"
}

Request parameters#

Parameter Type Required Description
customer_id
edit_customer
customer_login		 Number
String
String		 The customer id
The customer login
The customer login

Example response#

{
    "success": 1
}

Response parameters#

Parameter Type Description
success boolean Boolean value for if the request was successful

Error responses#

Error Code Error Message Error Description
MER-CUS-JSN-00002 Customer Not Found Customer ID or Login does not exist.
#Error# Unable to load customer: One of Edit_Customer, Customer_ID or Customer_Login must be specified One of the three required parameters to identify a customer is missing.
Function Use it to
Customer_Insert Create a customer
Customer_Update Change a customer
CustomerList_Load_Query Find a customer’s ID or login
CustomerAddressList_Delete Delete a customer’s addresses without deleting the customer

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Customers > Customer_Delete. See Set Up Postman.

CouponPriceGroupList_Load_Query Customer_Insert