CustomerCreditHistory_Delete

Deletes a record from a customer’s credit history. This function only deletes the customer credit record. It does not remove the credit from the customer’s balance.

Before you begin#

• The API token needs CustomerCreditHistory_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 CustomerCreditHistory_ID of the record. CustomerCreditHistoryList_Load_Query returns it as id.

Example requests#

Delete a credit history record#

Deletes the credit history record with this ID.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "CustomerCreditHistory_Delete",
    "CustomerCreditHistory_ID": "{{CustomerCreditHistory_ID}}"
}

Request parameters#

Example response#

{
    "success": 1
}

Response parameters#

Related functions#

Try in Postman#

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