Skip to main content
GET
/
{locale}
/
shop
/
xml-import
/
field-mappings
curl -X GET "https://staging-api.loyalty.lt/lt/shop/xml-import/field-mappings" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "code": 200,
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Field mappings retrieved",
  "data": {
    "product_fields": {
      "name": ["name", "title", "product_name"],
      "description": ["description", "desc"],
      "brand": ["brand", "manufacturer"],
      "model": ["model"],
      "ean": ["ean", "ean13", "barcode"],
      "sku": ["sku", "code", "id"],
      "xml_id": ["id", "xml_id", "external_id"],
      "image_url": ["image", "image_url", "picture"],
      "external_url": ["url", "link", "product_url"],
      "weight": ["weight"],
      "color": ["color"],
      "size": ["size"]
    },
    "offer_fields": {
      "price": ["price", "regular_price"],
      "discounted_price": ["discounted_price", "sale_price", "loyalty_program_item_price"],
      "currency": ["currency"],
      "availability": ["availability", "in_stock"],
      "stock_quantity": ["stock", "quantity"],
      "delivery_info": ["delivery", "shipping"],
      "warranty_info": ["warranty"],
      "external_url": ["url", "link", "product_url"],
      "external_id": ["id", "external_id"],
      "featured": ["featured"]
    },
    "category_fields": {
      "categories": ["categories/category", "category"]
    }
  }
}

​
Get Field Mappings

Retrieve the list of supported XML field mappings. This helps you understand which XML tags the import system recognizes.
This endpoint requires Shop API authentication using X-API-Key and X-API-Secret headers.

​
Path Parameters

​
locale
string
required
Language code (e.g., en, lt)

​
Authentication

​
X-API-Key
string
required
API key from Partners Portal
​
X-API-Secret
string
required
API secret from Partners Portal

​
Response

​
success
boolean
Indicates if request was successful
​
code
integer
HTTP status code
​
request_id
string
Unique request identifier (UUID)
​
message
string
Status message
​
data
object
curl -X GET "https://staging-api.loyalty.lt/lt/shop/xml-import/field-mappings" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "code": 200,
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Field mappings retrieved",
  "data": {
    "product_fields": {
      "name": ["name", "title", "product_name"],
      "description": ["description", "desc"],
      "brand": ["brand", "manufacturer"],
      "model": ["model"],
      "ean": ["ean", "ean13", "barcode"],
      "sku": ["sku", "code", "id"],
      "xml_id": ["id", "xml_id", "external_id"],
      "image_url": ["image", "image_url", "picture"],
      "external_url": ["url", "link", "product_url"],
      "weight": ["weight"],
      "color": ["color"],
      "size": ["size"]
    },
    "offer_fields": {
      "price": ["price", "regular_price"],
      "discounted_price": ["discounted_price", "sale_price", "loyalty_program_item_price"],
      "currency": ["currency"],
      "availability": ["availability", "in_stock"],
      "stock_quantity": ["stock", "quantity"],
      "delivery_info": ["delivery", "shipping"],
      "warranty_info": ["warranty"],
      "external_url": ["url", "link", "product_url"],
      "external_id": ["id", "external_id"],
      "featured": ["featured"]
    },
    "category_fields": {
      "categories": ["categories/category", "category"]
    }
  }
}

​
Understanding Mappings

Each key in the response represents a field in our system. The array values are the XML tag names we look for.

​
Example XML Mapping

Your XML: 
<product>
  <title>iPhone 15 Pro</title>
  <manufacturer>Apple</manufacturer>
  <regular_price>1199.00</regular_price>
  <sale_price>1099.00</sale_price>
  <barcode>0194253401353</barcode>
</product>
Maps to:
Your XML TagOur Field
titlename
manufacturerbrand
regular_priceprice
sale_pricediscounted_price
barcodeean

​
Product Fields Reference

Our FieldDescriptionAccepted Tags
nameProduct namename, title, product_name
descriptionProduct descriptiondescription, desc
brandManufacturer/brandbrand, manufacturer
modelModel numbermodel
eanEAN/barcodeean, ean13, barcode
skuStock keeping unitsku, code, id
xml_idExternal product IDid, xml_id, external_id
image_urlMain product imageimage, image_url, picture
external_urlLink to product pageurl, link, product_url
weightProduct weightweight
colorProduct colorcolor
sizeProduct sizesize

​
Offer/Price Fields Reference

Our FieldDescriptionAccepted Tags
priceRegular priceprice, regular_price
discounted_priceSale/loyalty pricediscounted_price, sale_price, loyalty_program_item_price
currencyPrice currency (default: EUR)currency
availabilityIn stock statusavailability, in_stock
stock_quantityAvailable quantitystock, quantity
delivery_infoDelivery/shipping infodelivery, shipping
warranty_infoWarranty informationwarranty
external_urlLink to product pageurl, link, product_url
external_idExternal offer IDid, external_id
featuredFeatured product flagfeatured

​
Category Fields Reference

Our FieldDescriptionAccepted Tags
categoriesProduct categoriescategories/category, category
Categories should be Loyalty.lt category IDs. When a subcategory is assigned, parent categories are automatically included.

​
Availability Values

The availability field accepts these values:
Input ValueMapped To
true, 1, yes, in_stockin_stock
false, 0, no, out_of_stockout_of_stock
limitedlimited_stock

Validate XML

Test your XML structure

Import from URL

Import products from URL