---
title: "Import customers from the ERP systems into Litium."
method: POST
path: "/Litium/api/connect/erp/imports"
tags: ["Imports"]
---

# Import customers from the ERP systems into Litium.

`POST /Litium/api/connect/erp/imports`

## Query parameters

- `api-version` string, nullable

## Headers

- `api-version` string, nullable

## Request body

- LitiumConnectErpImportImportBatch, nullable — Represent import batch.
  - `inventories` LitiumConnectErpImportInventory[], nullable — Gets or sets the inventories.
    - `inventoryId` string, nullable — Gets or sets the inventory identifier.
    - `items` LitiumConnectErpImportInventoryItem[], nullable — Gets or sets the inventory items.
      - `articleNumber` string, nullable — Gets or sets the article number.
      - `quantity` number, double, nullable — Gets or sets the quantity.
  - `inventoryItems` LitiumConnectErpImportVariantInventoryItem[], nullable — Gets or sets the inventory items.
    - `inventoryId` string, nullable — Gets or sets the inventory identifier.
    - `articleNumber` string, nullable — Gets or sets the article number.
    - `quantity` number, double, nullable — Gets or sets the quantity.
  - `organizations` LitiumConnectErpImportOrganization[], nullable — Gets or sets the organizations.
    - `id` string, nullable — Gets or sets the identifier.
    - `name` string, nullable — Gets or sets the organization name.
    - `fieldTemplateId` string, nullable — Gets or sets the field template identifier.
    - `vatRegistrationNumber` string, nullable — Gets or sets the vat registration number.
    - `legalRegistrationNumber` string, nullable — Gets or sets the legal registration number.
    - `addresses` LitiumConnectErpImportAddress[], nullable — Gets or sets the addresses.
      - `id` string, nullable — Gets or sets the identifier.
      - `firstName` string, nullable — Gets or sets the first name.
      - `lastName` string, nullable — Gets or sets the last name.
      - `title` string, nullable — Gets or sets the title.
      - `careOf` string, nullable — Gets or sets the care of.
      - `address1` string, nullable — Gets or sets the address 1.
      - `address2` string, nullable — Gets or sets the address 2.
      - `city` string, nullable — Gets or sets the city.
      - `country` string, nullable — Gets or sets the country. This is the ISO two letter country code like: SE(Sweden), AU(Australia)...
      - `email` string, nullable — Gets or sets the email.
      - `fax` string, nullable — Gets or sets the fax.
      - `mobilePhone` string, nullable — Gets or sets the mobile phone.
      - `phone` string, nullable — Gets or sets the phone.
      - `state` string, nullable — Gets or sets the state.
      - `zip` string, nullable — Gets or sets the zip.
      - `houseExtension` string, nullable — Gets or sets the house extension.
      - `houseNumber` string, nullable — Gets or sets the house number.
      - `type` 'billing' | 'shipping' | 'billingAndShipping' — Gets or sets the type.
    - `fields` LitiumConnectErpImportField[], nullable — Gets or sets the fields.
      - `fieldDefinitionId` string, nullable — Gets or sets the field definition identifier.
      - `culture` string, nullable — Gets or sets the culture.
      - `value` object — Gets or sets the field value.
    - `priceListIds` string[], nullable — Gets or sets the price list identifiers.
  - `organizationSettings` LitiumConnectErpImportOrganizationImportSettings, nullable — Organization import settings.
    - `fieldTemplateId` string, nullable — Gets or sets the default field template identifier.
    - `vatRegistrationNumberFieldDefinitionId` string, nullable — Gets or sets the vat registration number field definition identifier.
    - `legalRegistrationNumberFieldDefinitionId` string, nullable — Gets or sets the legal registration number field definition identifier.
    - `addressTypeMapping` object, nullable — Gets or sets the address type mapping.
      - `Billing` string, nullable
      - `Shipping` string, nullable
      - `BillingAndShipping` string, nullable
  - `persons` LitiumConnectErpImportPerson[], nullable — Gets or sets the persons.
    - `id` string, nullable — Gets or sets the identifier.
    - `fieldTemplateId` string, nullable — Gets or sets the field template identifier.
    - `organizationIds` string[], nullable — Gets or sets the vat organization identifiers.
    - `addresses` LitiumConnectErpImportAddress[], nullable — Gets or sets the addresses.
      - `id` string, nullable — Gets or sets the identifier.
      - `firstName` string, nullable — Gets or sets the first name.
      - `lastName` string, nullable — Gets or sets the last name.
      - `title` string, nullable — Gets or sets the title.
      - `careOf` string, nullable — Gets or sets the care of.
      - `address1` string, nullable — Gets or sets the address 1.
      - `address2` string, nullable — Gets or sets the address 2.
      - `city` string, nullable — Gets or sets the city.
      - `country` string, nullable — Gets or sets the country. This is the ISO two letter country code like: SE(Sweden), AU(Australia)...
      - `email` string, nullable — Gets or sets the email.
      - `fax` string, nullable — Gets or sets the fax.
      - `mobilePhone` string, nullable — Gets or sets the mobile phone.
      - `phone` string, nullable — Gets or sets the phone.
      - `state` string, nullable — Gets or sets the state.
      - `zip` string, nullable — Gets or sets the zip.
      - `houseExtension` string, nullable — Gets or sets the house extension.
      - `houseNumber` string, nullable — Gets or sets the house number.
      - `type` 'billing' | 'shipping' | 'billingAndShipping' — Gets or sets the type.
    - `fields` LitiumConnectErpImportField[], nullable — Gets or sets the fields.
      - `fieldDefinitionId` string, nullable — Gets or sets the field definition identifier.
      - `culture` string, nullable — Gets or sets the culture.
      - `value` object — Gets or sets the field value.
    - `priceGroupIds` string[], nullable — Gets or sets the price group identifiers.
  - `personSettings` LitiumConnectErpImportPersonImportSettings, nullable — Person import settings.
    - `fieldTemplateId` string, nullable — Gets or sets the default field template identifier.
    - `addressTypeMapping` object, nullable — Gets or sets the address type mapping.
      - `Billing` string, nullable
      - `Shipping` string, nullable
      - `BillingAndShipping` string, nullable
  - `priceGroups` LitiumConnectErpImportPriceGroup[], nullable — Gets or sets the price groups.
    - `id` string, nullable — Gets or sets the identifier.
    - `name` string, nullable — Gets or sets the name of group.
    - `priceListIds` string[], nullable — Gets or sets the price list identifiers.
  - `priceList` LitiumConnectErpImportPriceList[], nullable — Gets or sets the price list.
    - `id` string, nullable — Gets or sets the identifier.
    - `active` boolean, nullable — Gets or sets a value indicating whether the Litium.Connect.Erp.Import.PriceList is active.
    - `name` string, nullable — Gets or sets the name.
    - `startDate` string, date-time, nullable — Gets or sets the start date.
    - `endDate` string, date-time, nullable — Gets or sets the end date.
    - `currency` string, nullable — Gets or sets the currency.
    - `priority` integer — Gets or sets the priority.
    - `items` LitiumConnectErpImportPriceListItem[], nullable — Gets or sets the price list items.
      - `articleNumber` string, nullable — Gets or sets the article number.
      - `price` number, double, nullable — Gets or sets the price.
      - `minimumQuantity` number, double, nullable — Gets or sets the minimum quantity.
    - `includeVat` boolean — Gets or sets whether the prices in the Litium.Connect.Erp.Import.PriceList is including VAT.
    - `campaignPriceList` boolean — Gets or sets whether the price list is campaign price list.
  - `products` LitiumConnectErpImportProduct[], nullable — Gets or sets the products.
    - `articleNumber` string, nullable — Gets or sets the article number.
    - `fieldTemplateId` string, nullable — Gets or sets the field template identifier.
    - `taxClassId` string, nullable — Gets or sets the tax class identifier.
    - `fields` LitiumConnectErpImportField[], nullable — Gets or sets the fields.
      - `fieldDefinitionId` string, nullable — Gets or sets the field definition identifier.
      - `culture` string, nullable — Gets or sets the culture.
      - `value` object — Gets or sets the field value.
  - `productSettings` LitiumConnectErpImportProductImportSettings, nullable — Setting product import settings.
    - `createUrls` boolean — Gets or sets the auto create urls.
    - `urlFieldDefinitionIds` string[], nullable — Gets or sets the url field definition idendifiers.
    - `taxClassId` string, nullable — Gets or sets the default tax class identifier.
    - `fieldTemplateId` string, nullable — Gets or sets the default field template identifier.
  - `variantPriceItems` LitiumConnectErpImportVariantPriceItem[], nullable — Gets or sets the variant price items.
    - `articleNumber` string, nullable — Gets or sets the article number.
    - `priceListId` string, nullable — Gets or sets the price list identifier.
    - `price` number, double, nullable — Gets or sets the price.
    - `minimumQuantity` number, double, nullable — Gets or sets the minimum quantity.
  - `variants` LitiumConnectErpImportVariant[], nullable — Gets or sets the Variants.
    - `articleNumber` string, nullable — Gets or sets the article number.
    - `productArticleNumber` string, nullable — Gets or sets the product article number.
    - `unitOfMeasurementId` string, nullable — Gets or sets the unit of measurement identifier.
    - `sortIndex` integer — Gets or sets the sort index.
    - `fields` LitiumConnectErpImportField[], nullable — Gets or sets the fields.
      - `fieldDefinitionId` string, nullable — Gets or sets the field definition identifier.
      - `culture` string, nullable — Gets or sets the culture.
      - `value` object — Gets or sets the field value.
  - `variantSettings` LitiumConnectErpImportVariantImportSettings, nullable — Setting variant import.
    - `createBaseProducts` boolean — Gets or sets the create base products.
    - `createUrls` boolean — Gets or sets the create urls.
    - `urlFieldDefinitionIds` string[], nullable — Gets or sets the url field definition identifiers.
    - `unitOfMeasurementId` string, nullable — Gets or sets the default init of measurement identifiers.
  - `importBehavior` 'stopOnAnyError' | 'proceedWithErrors' — Gets or sets the import behavior.
  - `persistNullCollections` boolean, nullable — When {null}, compatible with previous versions. Preserv all collections except organization.addresses and person.addresses. When false, collections that are null in the JSON payload are cleared on the target. When true, null collections are not applied; existing collection values are preserved.

## Response `202`

Accepted

- LitiumConnectErpImportImportBatchResponse, nullable — Import batch response.
  - `importReportId` string, uuid — Gets or sets the import report identifier.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden
- `404` — NotFound

---

[API](https://skmtc.dev/litium/apis/litium-admin-web-api.md) · [All operations](https://skmtc.dev/litium/apis/litium-admin-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/litium/litium-admin-web-api/revisions/a65881b0d0c6/schema)
