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

{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

Show data

product_fields

object

Mapping of product fields to accepted XML tags

offer_fields

object

Mapping of offer/price fields to accepted XML tags

category_fields

object

Mapping of category fields to accepted XML tags

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 Tag	Our Field
`title`	`name`
`manufacturer`	`brand`
`regular_price`	`price`
`sale_price`	`discounted_price`
`barcode`	`ean`

Product Fields Reference

Our Field	Description	Accepted Tags
`name`	Product name	`name`, `title`, `product_name`
`description`	Product description	`description`, `desc`
`brand`	Manufacturer/brand	`brand`, `manufacturer`
`model`	Model number	`model`
`ean`	EAN/barcode	`ean`, `ean13`, `barcode`
`sku`	Stock keeping unit	`sku`, `code`, `id`
`xml_id`	External product ID	`id`, `xml_id`, `external_id`
`image_url`	Main product image	`image`, `image_url`, `picture`
`external_url`	Link to product page	`url`, `link`, `product_url`
`weight`	Product weight	`weight`
`color`	Product color	`color`
`size`	Product size	`size`

Offer/Price Fields Reference

Our Field	Description	Accepted Tags
`price`	Regular price	`price`, `regular_price`
`discounted_price`	Sale/loyalty price	`discounted_price`, `sale_price`, `loyalty_program_item_price`
`currency`	Price currency (default: EUR)	`currency`
`availability`	In stock status	`availability`, `in_stock`
`stock_quantity`	Available quantity	`stock`, `quantity`
`delivery_info`	Delivery/shipping info	`delivery`, `shipping`
`warranty_info`	Warranty information	`warranty`
`external_url`	Link to product page	`url`, `link`, `product_url`
`external_id`	External offer ID	`id`, `external_id`
`featured`	Featured product flag	`featured`

Category Fields Reference

Our Field	Description	Accepted Tags
`categories`	Product categories	`categories/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 Value	Mapped To
`true`, `1`, `yes`, `in_stock`	`in_stock`
`false`, `0`, `no`, `out_of_stock`	`out_of_stock`
`limited`	`limited_stock`

Validate XML

Test your XML structure

Import from URL

Import products from URL

Validate XML Import Statistics

​Get Field Mappings

​Path Parameters

​Authentication

​Response

​Understanding Mappings

​Example XML Mapping

​Product Fields Reference

​Offer/Price Fields Reference

​Category Fields Reference

​Availability Values

​Related Endpoints

Validate XML

Import from URL

Get Field Mappings

Path Parameters

Authentication

Response

Understanding Mappings

Example XML Mapping

Product Fields Reference

Offer/Price Fields Reference

Category Fields Reference

Availability Values

Related Endpoints