Send Warranty with Invoice
You can send warranties with invoice information using this service.
It is recommended that the externalOrderId be a unique value for the integrating company. This value will be used later to delete the warranty.
The email and phone values are not mandatory, but it's recommended to provide at least one of them. The system will search for customer information in the database using the provided field. If no customer information is found or if both fields are missing, unique email and phone values will be generated to create the customer record, which will then be saved in the database.
The serialNumber value is not mandatory, but if provided, the merchantCode, productCode, and serialNumber are treated as a unique group. This ensures that the serialNumber is unique at the dealer level and consolidates warranty notifications for products with the same productCode and serialNumber.
If a request is made with existing productCode and serialNumber values, it will result in an error. In this case, you should verify the productCode or serialNumber values.
When sending product information, three main fields are considered: name, productCode, and brand. Here are the important considerations regarding these fields:
- If the productCode is present:
- The system searches the database for the productCode:
- If found, the warranty transfer will occur.
- If not found, a new product will be created using the name from the name field and the product code from the productCode field with default attributes, followed by the warranty transfer.
- If the productCode is not present but both the brand and name fields are available:
- A new product will be created using the name from the name field and the brand from the brand field with default attributes, followed by the warranty transfer.
- If all fields (productCode, name, and brand) are provided:
- The process will follow the first flow based on the productCode.
- If neither the productCode nor the name and brand fields are provided:
- The warranty transfer will result in an error.
Request
curl --location --request POST '<BASE_URL>/individual-customers/warranty/invoice/with-product-code?merchantCode=<string>'
--header 'Content-Type: application/json'
--header 'Authorization: Basic ZGVtbzpwQDU1dzByZA=='
--data '{
"externalOrderId": "<string>",
"sellerCode": "<string>",
"customer": {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"countryCode": "<enum>"
},
"products": [
{
"name": "<string>",
"brand": "<string>",
"productCode": "<string>",
"serialNumber": "<string>",
"externalLineId": "<string>",
"purchaseDate": "<string>",
"warrantyExpireDate": "<string>"
}
]
}'
Here are examples of acceptable phone number formats:
- 544 333 22 11
- 5443332211
- +905443332211
- 905443332211
- 05443332211
The formats for the purchaseDate and warrantyExpireDate parameters must be in the following format: DD-MM-YYYY HH:MM (e.g., 01-01-2023 00:00).
- If the purchaseDate parameter is not provided, today's date will be used as the purchase date.
- If the warrantyExpireDate parameter is not provided, the warranty expiration date will be set based on the warranty period specified in the product information.
Request Body
Parameter | Type | Required | Description |
---|---|---|---|
name | String | No | The name of the product for which the warranty will be sent. |
brand | String | No | The brand of the product for which the warranty will be sent. |
productCode | String | No | The code of the product for which the warranty will be sent. |
serialNumber | String | No | The serial number of the product for which the warranty will be sent. |
sellerCode | String | Yes | Seller Code |
firstName | String | Yes | The first name of the warranty holder. |
lastName | String | Yes | The last name of the warranty holder. |
String | No | The email address of the warranty holder. | |
phone | String | No | The phone number of the warranty holder. |
countryCode | Enum | No | The country code for the phone number. |
externalOrderId | String | Yes | The invoice code or order number. |
externalLineId | String | No | The information or code of the product in the invoice. |
purchaseDate | String | No | The date of purchase of the product. |
warrantyExpireDate | String | No | The warranty expiration date of the product. |
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
merchantCode | String | Yes | The merchant code to which the product belongs. |
TR
US
DE
GB
AE
NL
FR
UZ
Response
{
"individualCustomerProductResponseList": [
{
"id": 1,
"lineId": "123456"
},
{
"id": 2,
"lineId": "1122334455"
},
{
"id": 3,
"lineId": "987654321"
}
]
}