PUT /data-exports/{id}.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.
statusProblem object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Status problem

Status problem

Status problem

Status problem

Status problem

Status problem
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 "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"adminNotes":"string","completedAt":"2024-05-04T09:42:00+00:00","createdAt":"2024-05-04T09:42:00+00:00","dropshipProviderId":42,"exportType":"adjustments","fileUri":"string","id":42,"intercomMessageId":"string","inventoryExportId":42,"inventoryFeedId":42,"muteError":false,"queueName":"string","queuedAt":"2024-05-04T09:42:00+00:00","read":false,"retries":42,"startedAt":"2024-05-04T09:42:00+00:00","status":"pending","statusProblem":{},"stockTakeId":42,"templateId":42,"updatedAt":"2024-05-04T09:42:00+00:00","userId":42}'

Request example

{
  "adminNotes": "string",
  "completedAt": "2024-05-04T09:42:00+00:00",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "exportType": "adjustments",
  "fileUri": "string",
  "id": 42,
  "intercomMessageId": "string",
  "inventoryExportId": 42,
  "inventoryFeedId": 42,
  "muteError": false,
  "queueName": "string",
  "queuedAt": "2024-05-04T09:42:00+00:00",
  "read": false,
  "retries": 42,
  "startedAt": "2024-05-04T09:42:00+00:00",
  "status": "pending",
  "statusProblem": {},
  "stockTakeId": 42,
  "templateId": 42,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "userId": 42
}

PUT /data-exports/{id}.json

Path parameters

Body Required

statusProblem object | null | array | boolean | integer | number | string