PUT /data-exports/{id}.json

PUT /data-exports/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

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, connected_items, cost_prices, dropship_provider_users, dropship_providers, inventory_feed, inventory_levels, missing_items, payment_report, purchase_invoice_items, purchase_invoice_payments, purchases, replenishments, sale_returns, shipping_labels, stock_take, transactions, transfers, or vendor_mappings.

  • 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.

  • queuedAt string(date-time) | null

    Queued at

  • read boolean | null Required

    Read

    Default value is false.

  • 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

PUT /data-exports/{id}.json 
curl \
 -X PUT http://api.example.com/v1/data-exports/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"adminNotes":"string","completedAt":"2023-05-04T09:42:00+00:00","createdAt":"2023-05-04T09:42:00+00:00","dropshipProviderId":42,"exportType":"adjustments","fileUri":"string","id":42,"intercomMessageId":"string","inventoryExportId":42,"inventoryFeedId":42,"muteError":false,"queuedAt":"2023-05-04T09:42:00+00:00","read":false,"startedAt":"2023-05-04T09:42:00+00:00","status":"pending","stockTakeId":42,"templateId":42,"updatedAt":"2023-05-04T09:42:00+00:00","userId":42}'
Request example 
{
  "adminNotes": "string",
  "completedAt": "2023-05-04T09:42:00+00:00",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "exportType": "adjustments",
  "fileUri": "string",
  "id": 42,
  "intercomMessageId": "string",
  "inventoryExportId": 42,
  "inventoryFeedId": 42,
  "muteError": false,
  "queuedAt": "2023-05-04T09:42:00+00:00",
  "read": false,
  "startedAt": "2023-05-04T09:42:00+00:00",
  "status": "pending",
  "stockTakeId": 42,
  "templateId": 42,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "userId": 42
}