Upsert Customer

Create a new customer or update the details of an existing customer. For consumer customers, the email address and merchant identifier constitute the business key. For organisation customers, the customer reference id and the merchant identifier constitute the business key. If a record with the same business key already exists, then it is updated with the provided details, otherwise a new customer is added.

SecurityMarketplace Api Key | Merchant Secret Token
Request
header Parameters
Merchant-Id
string

Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
One of:
required
object (UpsertConsumerCustomer1)

Consumer customers are individuals typically making purchases from the merchant via e-commerce websites. They are uniquely identified by emailAddress for a given merchant.

Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/customers
Request samples
application/json
{
  • "UpsertConsumerCustomer": {
    }
}
Response samples
application/json
{
  • "customerId": "cust_Zk6Lut8_E0a0KOaD",
  • "merchantId": "mcht_Zk6Lut8_E0a0KOaC"
}
Copyright © April Solutions 2023. All right reserved.