GET /data-imports/{id}.json

GET /data-imports/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • • 200

    Successful response

    Hide response attributes Show response attributes object
    • added integer(int32) | null Required

      Added

      Default value is 0.

    • adminNotes string | null

      Admin notes

    • completedAt string(date-time) | null

      Completed at

    • createdAt string(date-time)

      Created at

    • dropshipProviderId integer(int32) | null

      Dropship provider

    • errorMessages array[string] | null Required

      Error messages

      Default value is [] (empty).

    • errorUri string | null

      Error uri

    • errors integer(int32) | null Required

      Errors

      Default value is 0.

    • fileSize string | null

      File size

    • fileUri string | null

      File uri

    • id integer(int32)

      Id

    • importType string | null

      Import type

      Values are adjustment_import, cost_prices, dropship_provider_users, dropship_providers, inventory_feed_mapping, inventory_feed_prices, inventory_feed, sales, stock_take, tracking_import, vendor_mappings, or warehouse_location_import.

    • intercomMessageId string | null

      Intercom message

    • inventoryFeedId integer(int32) | null

      Inventory feed

    • muteError boolean | null Required

      Mute error

      Default value is false.

    • priceListId integer(int32) | null

      Price list

    • queuedAt string(date-time) | null

      Queued at

    • read boolean | null Required

      Read

      Default value is false.

    • skipped integer(int32) | null Required

      Skipped

      Default value is 0.

    • skippedUri string | null

      Skipped uri

    • startedAt string(date-time) | null

      Started at

    • status string | null

      Status

      Values are pending, started, complete, error, or skipped.

    • statusMessage string | null

      Status message

    • stockTakeId integer(int32) | null

      Stock take

    • updated integer(int32) | null Required

      Updated

      Default value is 0.

    • updatedAt string(date-time)

      Updated at
GET /data-imports/{id}.json 
curl \
 -X GET http://api.example.com/v1/data-imports/{id}.json
Response examples (200) 
{
  "added": 0,
  "adminNotes": "string",
  "completedAt": "2023-05-04T09:42:00+00:00",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "errorMessages": [],
  "errorUri": "string",
  "errors": 0,
  "fileSize": "string",
  "fileUri": "string",
  "id": 42,
  "importType": "adjustment_import",
  "intercomMessageId": "string",
  "inventoryFeedId": 42,
  "muteError": false,
  "priceListId": 42,
  "queuedAt": "2023-05-04T09:42:00+00:00",
  "read": false,
  "skipped": 0,
  "skippedUri": "string",
  "startedAt": "2023-05-04T09:42:00+00:00",
  "status": "pending",
  "statusMessage": "string",
  "stockTakeId": 42,
  "updated": 0,
  "updatedAt": "2023-05-04T09:42:00+00:00"
}