Skip to content
Docs
Select language:English

/api/v1/imports/csv

POST
/api/v1/imports/csv
curl --request POST \
  --url https://example.com/api/v1/imports/csv \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "columns": [ "example" ], "rows": [ [ "example" ] ], "mapping": { "additionalProperty": "example" }, "choices": { "placeSeparator": ">", "createPlaces": true, "dateFormat": "YYYY-MM-DD", "currency": "example", "defaultTarget": { "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "typeByName": true } }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
columns
required
Array<string>
>= 1 items <= 200 items
rows
required
Array<Array<string>>
mapping
required
object
key
additional properties
string
choices
required
object
placeSeparator
required
string
Allowed values: > / \
createPlaces
required
boolean
dateFormat
required
string
Allowed values: YYYY-MM-DD DD/MM/YYYY MM/DD/YYYY DD.MM.YYYY DD-MM-YYYY YYYY/MM/DD
currency
string
/^[A-Za-z]{3}$/
defaultTarget
required
Any of:
object
placeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
typeByName
required
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
source
required
string
Allowed values: csv
status
required
string
Allowed values: draft checked running done failed cancelled
mapping
required
object
key
additional properties
string
choices
required
object
placeSeparator
required
string
Allowed values: > / \
createPlaces
required
boolean
dateFormat
required
string
Allowed values: YYYY-MM-DD DD/MM/YYYY MM/DD/YYYY DD.MM.YYYY DD-MM-YYYY YYYY/MM/DD
currency
string
defaultTarget
required
Any of:
object
placeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
typeByName
required
boolean
progress
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
createdAt
required
string
startedAt
required
string | null
finishedAt
required
string | null
error
required
string | null
updatedAt
required
string
report
object
summary
required
object
things
required
integer
>= -9007199254740991 <= 9007199254740991
places
required
integer
>= -9007199254740991 <= 9007199254740991
purchases
required
integer
>= -9007199254740991 <= 9007199254740991
legacyCodes
required
integer
>= -9007199254740991 <= 9007199254740991
skipped
required
integer
>= -9007199254740991 <= 9007199254740991
asText
required
integer
>= -9007199254740991 <= 9007199254740991
rows
required
Array<object>
object
row
required
integer
>= -9007199254740991 <= 9007199254740991
status
required
string
Allowed values: ok text skipped
issues
required
Array<object>
object
column
required
string
code
required
string
Allowed values: no_name name_too_long already_imported same_as_row too_long type_not_found types_not_matched not_quantity counted_one_by_one zero_needs_consumable brand_too_long vendor_too_long not_condition not_link tag_not_added alias_not_added money_off not_price not_date future_date needs_price needs_date purchase_incomplete not_currency not_type_field no_type not_field_value place_name_too_long no_such_place secret_skipped code_taken code_format notes_cut file_type_refused file_missing file_too_large entry_ignored hb_archived_skipped hb_quantity_rounded hb_quantity_zero hb_number_integer hb_icon_dropped hb_template_partial hb_currency_unsupported hb_needs_module hb_location_in_item hb_notifier_skipped hb_seeded_skipped hb_time_default
params
object
max
integer
>= -9007199254740991 <= 9007199254740991
row
integer
>= -9007199254740991 <= 9007199254740991
format
string
Allowed values: YYYY-MM-DD DD/MM/YYYY MM/DD/YYYY DD.MM.YYYY DD-MM-YYYY YYYY/MM/DD
kind
string
rule
string
message
required
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "source": "csv",
  "status": "draft",
  "choices": {
    "placeSeparator": ">",
    "dateFormat": "YYYY-MM-DD",
    "defaultTarget": {
      "unplaced": true
    }
  },
  "report": {
    "rows": [
      {
        "status": "ok",
        "issues": [
          {
            "code": "no_name",
            "params": {
              "format": "YYYY-MM-DD"
            }
          }
        ]
      }
    ]
  }
}