Import resource

Methods

  • post - Create import
  • get - Get import detail by Id

Resource

{
    "cancelledAt": "date-time",
    "createdAt": "date-time",
    "errorReportFileUrl": "string",
    "errors": "integer",
    "finishedAt": "date-time",
    "id": "string",
    "options": {
        "couponSetId": "string",
        "delimiter": "string",
        "overrideExisting": "boolean",
        "updateOnlyEmptyFields": "boolean"
    },
    "origin": "string",
    "startedAt": "date-time",
    "status": "string",
    "success": "integer",
    "total": "integer",
    "type": "string"
}

Properties

Name Type Description Additional
cancelledAt date-time

The date of import cancellation in ISO8601 format

 Optional
createdAt date-time

The date of import creation in ISO8601 format
errorReportFileUrl string

The import error report file url. Url to download a file containing all import errors.

 Optional
errors integer

The total number of failed imported elements
finishedAt date-time

The date of import finish in ISO8601 format

 Optional
id string

The identifier of the Import
options object

The import options
options.couponSetId string

Coupon set identifier to import coupons into. It applies only to coupon imports.

 Optional
options.delimiter string

The import delimiter. Values supported are comma and semicolon.

Possible values are:

  • ,
  • ;
options.overrideExisting boolean

Option to override existing elements. Will override if true.
options.updateOnlyEmptyFields boolean

Option to update only empty fields. Will only update fields that are empty for the element if true.
origin string

The import origin. The import was created from the api or from the Connectif app.

Possible values are:

  • api
  • app
startedAt date-time

The date of import start in ISO8601 format

 Optional
status string

The import status

Possible values are:

  • queued
  • inProgress
  • finished
  • error
  • cancelled
success integer

The total number of succeeded imported elements
total integer

The total number of elements to import
type string

The import type

Possible values are:

  • contacts
  • products
  • coupons