Loyalty Import Object

An Import object is a batch import of loyalty points for existing customers. You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances. This object tracks the entire import process from file upload to data processing.

Properties
idstringRead-onlyformat GUID

The ID of the import.

asyncImportJobIdstringRead-onlyformat GUID

ID of the asynchronous import job associated with this import.

revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the Loyalty Import is updated. To prevent conflicting changes, the current revision must be passed when updating the Loyalty Import.

Ignored when creating a Loyalty Import.

createdDatestringRead-onlyformat date-time

Date and time the Loyalty Import was created.

updatedDatestringRead-onlyformat date-time

Date and time the Loyalty Import was last updated.

statusstringRead-only

Current status of the import process.

  • UNKNOWN: Status is unknown or not specified.
  • INITIATED: The import has been initiated but processing has not yet begun.
  • PARSING: The system is currently parsing the import file.
  • PARSED: The import file has been successfully parsed and is ready for importing.
  • IMPORTING: The system is currently importing the parsed data.
  • IMPORTED: The import process is complete. This status indicates the process finished, but doesn't guarantee all data imported successfully.
  • FAILED: The import process has failed.
fileMetadataobject

Metadata of the uploaded file containing loyalty points data.

parseResultobject

Results of parsing the uploaded file, including the number of rows parsed and any parse errors.

importResultobject

Results of the import process, including success and failure counts.

Was this helpful?
Yes
No