GET /inventory-exports/{id}/export.json

GET /inventory-exports/{id}/export.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

  • adminNotes string | null

    Admin notes

  • completedAt string(date-time) | null

    Completed at

  • createdAt string(date-time)

    Created at

  • dropshipProviderId integer(int32) | null

    Dropship provider

  • exportType string | null

    Export type

    Values are adjustments, audit_sale_returns, connected_items, cost_prices, dropship_provider_users, dropship_providers, inventory_feed, inventory_levels, invoices_to_pay, missing_items, payment_report, purchase_invoice_items, purchase_invoice_payments, purchases, replenishments, sale_returns, shipping_labels, stock_take, transactions, transfers, variants, vendor_mappings, or warehouse_levels.

  • fileUri string | null

    File uri

  • id integer(int32)

    Id

  • intercomMessageId string | null

    Intercom message

  • inventoryExportId integer(int32) | null

    Inventory export

  • inventoryFeedId integer(int32) | null

    Inventory feed

  • muteError boolean | null Required

    Mute error

    Default value is false.

  • queueName string | null

    Queue name

  • queuedAt string(date-time) | null

    Queued at

  • read boolean | null Required

    Read

    Default value is false.

  • retries integer(int32) | null

    Retries

  • startedAt string(date-time) | null

    Started at

  • status string | null

    Status

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

  • stockTakeId integer(int32) | null

    Stock take

  • templateId integer(int32) | null

    Template

  • updatedAt string(date-time)

    Updated at

  • userId integer(int32) | null

    User

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • adminNotes string | null

      Admin notes

    • completedAt string(date-time) | null

      Completed at

    • createdAt string(date-time)

      Created at

    • dropshipProviderId integer(int32) | null

      Dropship provider

    • exportType string | null

      Export type

      Values are adjustments, audit_sale_returns, connected_items, cost_prices, dropship_provider_users, dropship_providers, inventory_feed, inventory_levels, invoices_to_pay, missing_items, payment_report, purchase_invoice_items, purchase_invoice_payments, purchases, replenishments, sale_returns, shipping_labels, stock_take, transactions, transfers, variants, vendor_mappings, or warehouse_levels.

    • fileUri string | null

      File uri

    • id integer(int32)

      Id

    • intercomMessageId string | null

      Intercom message

    • inventoryExportId integer(int32) | null

      Inventory export

    • inventoryFeedId integer(int32) | null

      Inventory feed

    • muteError boolean | null Required

      Mute error

      Default value is false.

    • queueName string | null

      Queue name

    • queuedAt string(date-time) | null

      Queued at

    • read boolean | null Required

      Read

      Default value is false.

    • retries integer(int32) | null

      Retries

    • startedAt string(date-time) | null

      Started at

    • status string | null

      Status

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

    • stockTakeId integer(int32) | null

      Stock take

    • templateId integer(int32) | null

      Template

    • updatedAt string(date-time)

      Updated at

    • userId integer(int32) | null

      User

GET /inventory-exports/{id}/export.json
curl \
 --request GET 'http://api.example.com/v1/inventory-exports/{id}/export.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"adminNotes":"string","completedAt":"2025-05-04T09:42:00Z","createdAt":"2025-05-04T09:42:00Z","dropshipProviderId":42,"exportType":"adjustments","fileUri":"string","id":42,"intercomMessageId":"string","inventoryExportId":42,"inventoryFeedId":42,"muteError":false,"queueName":"string","queuedAt":"2025-05-04T09:42:00Z","read":false,"retries":42,"startedAt":"2025-05-04T09:42:00Z","status":"pending","statusProblem":{},"stockTakeId":42,"templateId":42,"updatedAt":"2025-05-04T09:42:00Z","userId":42}'
Request examples
{
  "adminNotes": "string",
  "completedAt": "2025-05-04T09:42:00Z",
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "exportType": "adjustments",
  "fileUri": "string",
  "id": 42,
  "intercomMessageId": "string",
  "inventoryExportId": 42,
  "inventoryFeedId": 42,
  "muteError": false,
  "queueName": "string",
  "queuedAt": "2025-05-04T09:42:00Z",
  "read": false,
  "retries": 42,
  "startedAt": "2025-05-04T09:42:00Z",
  "status": "pending",
  "statusProblem": {},
  "stockTakeId": 42,
  "templateId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42
}
Response examples (200)
{
  "adminNotes": "string",
  "completedAt": "2025-05-04T09:42:00Z",
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "exportType": "adjustments",
  "fileUri": "string",
  "id": 42,
  "intercomMessageId": "string",
  "inventoryExportId": 42,
  "inventoryFeedId": 42,
  "muteError": false,
  "queueName": "string",
  "queuedAt": "2025-05-04T09:42:00Z",
  "read": false,
  "retries": 42,
  "startedAt": "2025-05-04T09:42:00Z",
  "status": "pending",
  "statusProblem": {},
  "stockTakeId": 42,
  "templateId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42
}