input InventoryGenerateSnapshotInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers.

warehouse_idString

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

notification_emailString

Email address for the notification contact.

post_urlString

URL for the post URL resource.

post_url_pre_checkBoolean

If false, a pre-check on the POST URL will not be performed. This eliminates immediate validation and feedback in the mutation response, before sending the request to the worker. Nonetheless, disabling this check can be useful if a one-time token is used to authenticate the endpoint.

new_formatBoolean

If True, the snapshot structure will be organized by customer account id, rather than by SKU alone, adding support for different customer accounts having repeated SKUs.

updated_fromISODateTime

Only include products updated at or after this ISO-8601 datetime.

has_inventoryBoolean

When true, include only products that currently have inventory.

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "notification_email": "customer@example.com",
  "post_url": "https://example.com/resource",
  "post_url_pre_check": https://example.com/resource,
  "new_format": BLUE-TEE-M,
  "updated_from": "2026-07-09T15:30:00Z",
  "has_inventory": true
}