Our API
Learn about external client integration, store and list overview, and discover v3 injection and status changes
1. External client integration
How to obtain an OAuth client?
NOTE: Before requesting an OAuth client, it is necessary to have established a commercial agreement with Trade.
Once this step is completed and the required information detailed below is gathered, you can start the account configuration process using the designated channels provided by X-Mart.
Information needed to create an OAuth client:
| Data | Required Information | Description | Utility |
|---|---|---|---|
| Country (required) | Name | Name of the country where the application or website will operate. | Necessary for creating delivery addresses, billing information, etc. |
| Allow invoices as final consumer (required) | YES, NO | Show forms for entering billing information | Request billing information before making a purchase. |
| City(ies) (required) | Name - Latitude - Longitude | List of cities. | In Pickup allows obtaining the city’s stores, locates the delivery address. |
| Sector(s) (required) | Name - Latitude - Longitude - City | List of sectors. | Along with the city, allows locating the delivery address, necessary for creating delivery addresses. |
| Brand(s) (required) | Brand name (Vendor) - Brief brand description - Unique brand identifier | List of brands. | Necessary for creating stores, sales channels, and lists. |
| Brand logo(s) (optional) | Compressed file with brand logos (jpg/png), each image file must have the brand name. | Compressed file of brand images. | In future versions, the brand logo may be displayed. |
| Zones (required) | kml, kmz, csv files | Files reflecting the polygons of the coverage areas. | Necessary to get the nearest store. |
| List of zones and stores (required) | Name, identifier or store code - Coverage zone - City | List reflecting the relationship between coverage zone and store. | List used by Trade for configuring zones by store. |
2. Overview of Stores and Lists
X-Mart provides a series of API endpoints that facilitate the management and synchronization of stores, sales channels, and lists within the platform. Below is a summary of the main endpoints available:
Stores and Sales Channels
Lists
This set of endpoints ensures comprehensive and efficient management of store, sales, and list operations within X-Mart, offering robust tools for real-time control and monitoring.
3. Explanation of v3 injection
X-Mart’s Service Catalog includes a series of methods that facilitate the management and synchronization of data on the platform. Below is a summary of the main endpoints available:
4. Fulfillment (status changes)
X-Mart provides a series of API endpoints that facilitate the management and processing of orders, ensuring an efficient flow from order placement to fulfillment. Below is a summary of the main endpoints available: