/api/v1/imports/{id}/dry-run

POST

const url = 'https://example.com/api/v1/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dry-run';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dry-run

Parameters

Path Parameters

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)$/

Responses

200

Default Response

application/json

object

report

required

Any of:

object
object

object

source

required

string

Allowed values: homebox_zip kept_zip

summary

required

object

key

additional properties

rows

required

Array<object>

object

status

required

string

Allowed values: ok text skipped

ref

required

object

kind

required

string

required

string

name

string

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

key

additional properties

message

required

string

ref

object

kind

required

string

required

string

name

string

Example

{
  "report": {
    "source": "homebox_zip",
    "rows": [
      {
        "status": "ok",
        "issues": [
          {
            "code": "no_name"
          }
        ]
      }
    ]
  }
}