GET /inventory-exports/{id}.json

GET /inventory-exports/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • • 200 object

    Successful response

    • 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

GET /inventory-exports/{id}.json 
curl \
 -X GET http://api.example.com/v1/inventory-exports/{id}.json
Response example (200) 
{
  "createdAt": "2023-05-04T09:42:00+00:00",
  "delivery": "s3",
  "emails": [
    "string"
  ],
  "enabled": true,
  "id": 42,
  "inventoryType": "all",
  "lastExportedAt": "2023-05-04T09:42:00+00:00",
  "name": "string",
  "overwrite": true,
  "s3Bucket": "string",
  "s3Key": "string",
  "s3Path": "string",
  "s3Secret": "string",
  "scheduledType": "shared",
  "sendingSchedule": "manual",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}