POST /inventory-exports.json

application/json

Body Required

delivery string | null Required

Delivery

Values are email, s3, or s3_external. Default value is s3.
emails array[string] | null

Emails
enabled boolean | null Required

Enabled

Default value is true.
inventoryType string | null Required

Inventory type

Values are all, inventory_feeds, or inhouse. Default value is all.
lastExportedAt string(date-time) | null

Last exported at
name string Required

Name
overwrite boolean | null Required

Overwrite

Default value is true.
s3Bucket string | null

S3 bucket
s3Key string | null

S3 key
s3Path string | null

S3 path
s3Secret string | null

S3 secret
scheduledType string | null Required

Scheduled type

Values are shared or dedicated. Default value is shared.
sendingSchedule string | null Required

Sending schedule

Values are daily, hourly, or manual. Default value is manual.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- delivery string | null Required
  
  Delivery
  
  Values are email, s3, or s3_external. Default value is s3.
- emails array[string] | null
  
  Emails
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32) | null
  
  Id
- inventoryType string | null Required
  
  Inventory type
  
  Values are all, inventory_feeds, or inhouse. Default value is all.
- lastExportedAt string(date-time) | null
  
  Last exported at
- name string Required
  
  Name
- overwrite boolean | null Required
  
  Overwrite
  
  Default value is true.
- s3Bucket string | null
  
  S3 bucket
- s3Key string | null
  
  S3 key
- s3Path string | null
  
  S3 path
- s3Secret string | null
  
  S3 secret
- scheduledType string | null Required
  
  Scheduled type
  
  Values are shared or dedicated. Default value is shared.
- sendingSchedule string | null Required
  
  Sending schedule
  
  Values are daily, hourly, or manual. Default value is manual.
- updatedAt string(date-time)
  
  Updated at

POST /inventory-exports.json

curl \
 --request POST 'http://api.example.com/v1/inventory-exports.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"delivery":"s3","emails":["string"],"enabled":true,"inventoryType":"all","lastExportedAt":"2025-05-04T09:42:00Z","name":"string","overwrite":true,"s3Bucket":"string","s3Key":"string","s3Path":"string","s3Secret":"string","scheduledType":"shared","sendingSchedule":"manual"}'

Request examples

{
  "delivery": "s3",
  "emails": [
    "string"
  ],
  "enabled": true,
  "inventoryType": "all",
  "lastExportedAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "overwrite": true,
  "s3Bucket": "string",
  "s3Key": "string",
  "s3Path": "string",
  "s3Secret": "string",
  "scheduledType": "shared",
  "sendingSchedule": "manual"
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "delivery": "s3",
  "emails": [
    "string"
  ],
  "enabled": true,
  "id": 42,
  "inventoryType": "all",
  "lastExportedAt": "2025-05-04T09:42:00Z",
  "name": "string",
  "overwrite": true,
  "s3Bucket": "string",
  "s3Key": "string",
  "s3Path": "string",
  "s3Secret": "string",
  "scheduledType": "shared",
  "sendingSchedule": "manual",
  "updatedAt": "2025-05-04T09:42:00Z"
}