Back to KlaviyoSpawn Create Categories Job
Create a catalog category bulk create job to create a batch of catalog categories.\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.
Rate limits:
Burst: 75/s
Steady: 700/m
\n\nScopes:\nCatalogs Write
Input
type: object
properties:
parameters:
type: object
properties:
revision:
type: string
default: '2023-02-22'
description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
required:
- revision
title: Parameters
data:
type: object
required:
- data
properties:
data:
type: object
required:
- type
- attributes
properties:
type:
type: string
enum:
- catalog-category-bulk-create-job
attributes:
type: object
required:
- categories
properties:
categories:
type: array
description: Array of catalog categories to create.
items:
type: object
required:
- type
- attributes
properties:
type:
type: string
enum:
- catalog-category
attributes:
type: object
required:
- external_id
- name
properties:
external_id:
type: string
example: SAMPLE-DATA-CATEGORY-APPAREL
description: >-
The ID of the catalog category in an external
system.
name:
type: string
example: Sample Data Category Apparel
description: The name of the catalog category.
integration_type:
type: string
enum:
- $custom
description: >-
The integration type. Currently only \"$custom\" is
supported.
catalog_type:
type: string
example: $default
default: $default
description: >-
The type of catalog. Currently only \"$default\" is
supported.
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
title: Data
Output
type: object
required:
- data
properties:
data:
type: object
required:
- type
- attributes
- links
properties:
type:
type: string
enum:
- catalog-category-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.
relationships:
type: object
properties:
categories:
type: object
required:
- data
properties:
data:
type: array
items:
type: object
required:
- type
- id
properties:
type:
type: string
enum:
- catalog-category
id:
type: string
links:
type: object
required:
- self
properties:
self:
type: string
format: uri