Back to KlaviyoGet Create Items Jobs
Get all catalog item bulk create jobs.\nReturns a maximum of 100 jobs per request.
Rate limits:
Burst: 350/s
Steady: 3500/m
\n\nScopes:\nCatalogs Read
Input
type: object
properties:
parameters:
type: object
properties:
fields[catalog-item-bulk-create-job]:
type: array
items:
type: string
enum:
- job_id
- status
- created_at
- total_count
- completed_count
- failed_count
- completed_at
- expires_at
- errors
description: >-
For more information please visit
https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
filter:
type: string
description: >-
For more information please visit
https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed
field(s)/operator(s):<br>`status`: `equals`
page[cursor]:
type: string
description: >-
For more information please visit
https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
revision:
type: string
default: '2023-02-22'
description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
required:
- revision
title: Parameters
Output
type: object
required:
- data
- links
properties:
data:
type: array
items:
type: object
required:
- type
- attributes
- links
properties:
type:
type: string
enum:
- catalog-item-bulk-create-job
attributes:
type: object
required:
- job_id
- status
- created_at
- total_count
properties:
job_id:
type: string
description: Unique identifier for retrieving the job. Generated by Klaviyo.
status:
type: string
enum:
- cancelled
- complete
- processing
- queued
description: Status of the asynchronous job.
example: processing
created_at:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: >-
The date and time the job was created in ISO 8601 format
(YYYY-MM-DDTHH:MM:SS.mmmmmm).
total_count:
type: integer
example: 10
description: >-
The total number of operations to be processed by the job. See
`completed_count` for the job's current progress.
completed_count:
type: integer
example: 9
description: >-
The total number of operations that have been completed by the
job.
failed_count:
type: integer
example: 1
description: >-
The total number of operations that have failed as part of the
job.
completed_at:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: >-
Date and time the job was completed in ISO 8601 format
(YYYY-MM-DDTHH:MM:SS.mmmmmm).
expires_at:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: >-
Date and time the job expires in ISO 8601 format
(YYYY-MM-DDTHH:MM:SS.mmmmmm).
errors:
type: array
description: Array of errors encountered during the processing of the job.
items:
type: object
required:
- id
- code
- title
- detail
- source
properties:
id:
type: string
example: e4eebb08-b055-4a6f-bb13-c8cb69c9eb94
description: Unique identifier for the error.
code:
type: string
example: invalid
description: A code for classifying the error type.
title:
type: string
example: Invalid input
description: A high-level message about the error.
detail:
type: string
example: The payload provided in the request is invalid.
description: Specific details about the error.
source:
type: object
required:
- pointer
properties:
pointer:
type: string
example: /data
default: /data
description: >-
A pointer to the source of the error in the request
payload.
links:
type: object
required:
- self
properties:
self:
type: string
format: uri
relationships:
type: object
properties:
items:
type: object
required:
- data
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- catalog-item
id:
type: string
links:
type: object
required:
- self
properties:
self:
type: string
format: uri
first:
type: string
format: uri
last:
type: string
format: uri
prev:
type: string
format: uri
next:
type: string
format: uri
included:
type: array
items:
type: object
required:
- type
- id
- attributes
- links
properties:
type:
type: string
enum:
- catalog-item
id:
type: string
example: $custom:::$default:::SAMPLE-DATA-ITEM-1
description: >-
The catalog item ID is a compound ID (string), with format:
`{integration}:::{catalog}:::{external_id}`. Currently, the only
supported integration type is `$custom`, and the only supported
catalog is `$default`.
attributes:
type: object
properties:
external_id:
type: string
example: SAMPLE-DATA-ITEM-1
description: The ID of the catalog item in an external system.
title:
type: string
example: Ocean Blue Shirt (Sample)
description: The title of the catalog item.
description:
type: string
example: >-
Ocean blue cotton shirt with a narrow collar and buttons down
the front and long sleeves. Comfortable fit and titled
kaleidoscope patterns.
description: A description of the catalog item.
price:
type: number
example: >-
Ocean blue cotton shirt with a narrow collar and buttons down
the front and long sleeves. Comfortable fit and titled
kaleidoscope patterns.
description: >-
This field can be used to set the price on the catalog item,
which is what gets displayed for the item when included in
emails. For most price-update use cases, you will also want to
update the `price` on any child variants, using the [Update
Catalog Variant
Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).
url:
type: string
example: https://via.placeholder.com/150
description: >-
URL pointing to the location of the catalog item on your
website.
image_full_url:
type: string
example: https://via.placeholder.com/300
description: >-
URL pointing to the location of a full image of the catalog
item.
image_thumbnail_url:
type: string
example: https://via.placeholder.com/150
description: >-
URL pointing to the location of an image thumbnail of the
catalog item
images:
type: array
example:
- https://via.placeholder.com/150
description: >-
List of URLs pointing to the locations of images of the catalog
item.
items:
type: string
custom_metadata:
type: object
example:
Top Pick: true
description: >-
Flat JSON blob to provide custom metadata about the catalog
item. May not exceed 100kb.
published:
type: boolean
example: true
description: Boolean value indicating whether the catalog item is published.
created:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: >-
Date and time when the catalog item was created, in ISO 8601
format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
updated:
type: string
format: date-time
example: '2022-11-08T00:00:00'
description: >-
Date and time when the catalog item was last updated, in ISO
8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
links:
type: object
required:
- self
properties:
self:
type: string
format: uri