Endpoints
Discover what is the expected for Merchant API's
Below you will find the exhaustive list of Merchant APIs endpoint to implement on your endpoint.
As explained previously, there are no naming conventions for the required endpoints.
Feel free to name them as you wish. The only thing that matters is the expected response body.
Search Product
id is the item ID in the item catalog. The search will return the product that matches the ID. Generally, the ID is an EAN-13 barcode.
The search is case-insensitive and will return results that contain the query string anywhere in the field.
Request body :
{
"id": "string",
}Response body :
{
"id": "string",
"sku": "string",
"url": "string",
"title": "string",
"subtitle": "string",
"color": "string",
"size": "string",
"image_url": "url",
"price" : "decimal",
"original_price" : "decimal"
}Search Customer
q will be a string of at least 3 characters. The search will return customers that match the query in any of the following fields: customerId, customerName, customerEmail, customerPhone.
The search is case-insensitive and will return results that contain the query string anywhere in the field.
Request body :
{
"q": "string",
}Response body :
{
"data": [
{
"id": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"phone": "string",
"zipcode": "string",
"nbOfOrders": "integer",
"isGuest": "boolean",
"loyaltyStatus": "string",
}
]
}Retrieve Customer
Request body :
{
"email": "string",
}Response body :
{
"data": [
{
"id": "string",
"civility": "string", // accepted values : Mr, Mrs
"firstname": "string",
"lastname": "string",
"email": "string",
"dob": "datetime", // date of birth
"phone": "string", //
"nbOfOrders": "integer",
"isGuest": "boolean",
"loyaltyStatus": "string",
"optin": [
{
"type": "string", // accepted values : email, sms
"status": "boolean"
}
],
"billing_address": {
"id": "string",
"firstname": "string",
"lastname": "string",
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"zipcode": "string",
"phone": "string"
},
"shipping_address": {
"id": "string",
"firstname": "string",
"lastname": "string",
"address": "string",
"city": "string",
"state": "string",
"country": "string",
"zipcode": "string",
"phone": "string"
},
"wishlist": [
{
"id": "string",
"sku": "string",
"title": "string",
"subtitle": "string",
"color": "string",
"size": "string",
"url": "string",
"image_url": "url",
"price" : "decimal",
"original_price" : "decimal"
}
],
"abandoned_cart": [
{
"id": "string",
"sku": "string",
"title": "string",
"subtitle": "string",
"color": "string",
"size": "string",
"url": "string",
"image_url": "url",
"price" : "decimal",
"original_price" : "decimal"
}
],
"orders": [
{
"id": "string",
"amount": "decimal",
"amount_refunded": "decimal",
"order_location": "out_store", // fixed value
"order_type": "string", // accepted values : online, pos
"date": "datetime",
"items": [
{
"id": "string",
"sku": "string",
"title": "string",
"subtitle": "string",
"color": "string",
"size": "string",
"url": "string",
"image_url": "url",
"price" : "decimal",
"original_price" : "decimal",
"quantity": "integer",
"quantity_returned": "integer",
}
],
"currency": "string", // ISO 4217 currency code
}
],
"autologin_url": "string", // URL to login the customer in your app
}
}Create Customer
This endpoint is used to create a customer.
Request body :
{
"id": "string",
"firstname": "string",
"lastname": "string",
"civility": "string", // accepted values : Mr, Mrs
"email": "string",
"dob": "datetime", // date of birth
"phone": "string",
"optin": [
{
"type": "string", // accepted values : email, sms
"status": "boolean"
}
],
}Response body :
{
"status": "success",
"message": "Customer created successfully"
}Update Customer
This endpoint is used to push updated informations about customer information.
Request body :
{
"id": "string",
"firstname": "string",
"lastname": "string",
"civility": "string", // accepted values : Mr, Mrs
"email": "string",
"dob": "datetime", // date of birth
"phone": "string",
"optin": [
{
"type": "string", // accepted values : email, sms
"status": "boolean"
}
],
}Response body :
{
"status": "success",
"message": "Customer updated successfully"
}Retrieve Store Receipt
This endpoint is used to retrieve the store receipts of a customer. The receipts are calculated based on the orders made in the store.
Request body :
{
"email": "string", // customer email or
"id": "string", // order id (optional)
}Response body :
{
"data": [
{
"id": "string",
"amount": "decimal",
"amount_refunded": "decimal",
"order_location": "in_store", // fixed value
"order_type": "store_receipt", // fixed value
"status": "Delivered to customer", // fixed value
"date": "datetime",
"items": [
{
"id": "string",
"sku": "string",
"title": "string",
"url": "string",
"image_url": "url",
"price" : "decimal",
"original_price" : "decimal",
"quantity": "integer",
"quantity_returned": "integer",
}
],
"currency": "string", // ISO 4217 currency code
"store": {
"code": "string",
"name": "string",
}
}
]
}Retrieve Store KPI
This endpoint is used to retrieve the store KPI's, present on dashboard. The KPI's are calculated based on the orders made in the store.
The KPI's are calculated for a period of time defined by the begin and end parameters.
Request body :
{
"code": "string", // store code
"begin" : "datetime", // format ATOM/ISO8601 Extended YYYY-MM-DDTHH:mm:ssZ
"end" : "datetime", // format ATOM/ISO8601 Extended YYYY-MM-DDTHH:mm:ssZ
}Response body :
{
"code": "XXX", // store code
"name": "string", // store name
"revenue": 0, // Total revenue of the store on the period
"count" : 0 // Number of orders of the store on the period
}Updated 9 months ago