Importing Custom Field Values

Method Description

Invoked with a POST request. Request address is set up via Maestra framework. This API methods is used in order to bulk import custom field values (attributes) to different entities: customer, product, area, etc.

POST 
https://api.maestra.io/v3/operations/bulk?endpointId={API endpoint ID}&operation=DirectCrm.CustomFieldEnumValues.Import&customFieldKindSystemName={Custom field system name}&customFieldKindEntityType={Custom field entity type}&csvCodePage=65001 

HTTP/1.1

Authorization: SecretKey {Secret Key}
Accept: application/xml
Content-Type: text/csv

URL Parameter	Description	Value examples
customFieldKindSystemName	Custom field system name
customFieldKindEntityType	Custom field entity type	— HC - Customer; — ProductInfo - Product; — AR - Area; — DC - Discount Card; — CA - Customer Action; — RO - Order; — RP - Order Line; — RLP - Product List Item; — POC - Touchpoint
csvCodePage	Windows codepage ID for CSV file. 65001 (UTF-8) is preferred	65001
csvColumnDelimiter	Column delimiter symbol in CSV file	%3B
csvTextQualifier	Optional start/end character in column value, masking otherwise invalid characters	%22
Authorization	The value is obtained via Maestra endpoint settings

The service allows up to 60 imports an hour. When this limit is exceeded, you’ll receive 429 Too Many Requests until the ratio of tasks queued/hour drops below 60.

Field Descriptions

Title	Description
ExternalId	Value transfer option ID
Value	Value transfer option

Sample Request

POST 
https://api.maestra.io/v3/operations/bulk?endpointId=Maestra&operation=DirectCrm.CustomFieldEnumValues.Import&customFieldKindSystemName=CustomStatus&suppressAllWarnings=true&csvCodePage=65001&csvColumnDelimiter=%3B&csvTextQualifier=%22

Authorization: SecretKey mDdO
Accept: application/xml
Content-Type: text/csv


ExternalId;Value
SilverStatus;Silver Status
GoldStatus;Gold Status

Updated about 1 year ago