Klaviyo · Schema

PostCatalogItemCreateJobResponse

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
data object
links object
View JSON Schema on GitHub

JSON Schema

klaviyo-postcatalogitemcreatejobresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostCatalogItemCreateJobResponse",
  "title": "PostCatalogItemCreateJobResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
        },
        "id": {
          "description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "status": {
              "description": "Status of the asynchronous job.",
              "type": "string",
              "example": "processing",
              "enum": [
                "cancelled",
                "complete",
                "processing",
                "queued"
              ]
            },
            "created_at": {
              "description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
              "type": "string",
              "format": "date-time",
              "example": "2022-11-08T00:00:00+00:00"
            },
            "total_count": {
              "description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
              "type": "integer",
              "example": 10
            },
            "completed_count": {
              "description": "The total number of operations that have been completed by the job.",
              "type": "integer",
              "example": 9,
              "default": 0,
              "nullable": true
            },
            "failed_count": {
              "description": "The total number of operations that have failed as part of the job.",
              "type": "integer",
              "example": 1,
              "default": 0,
              "nullable": true
            },
            "completed_at": {
              "description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
              "type": "string",
              "format": "date-time",
              "example": "2022-11-08T00:00:00+00:00",
              "nullable": true
            },
            "errors": {
              "description": "Array of errors encountered during the processing of the job.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/APIJobErrorPayload"
              },
              "nullable": true
            },
            "expires_at": {
              "description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
              "type": "string",
              "format": "date-time",
              "example": "2022-11-08T00:00:00+00:00",
              "nullable": true
            }
          },
          "required": [
            "status",
            "created_at",
            "total_count"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "items": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "type",
                      "id"
                    ],
                    "properties": {
                      "type": {
                        "$ref": "#/components/schemas/CatalogItemEnum"
                      },
                      "id": {
                        "description": "IDs of the created catalog items.",
                        "type": "string",
                        "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
                      }
                    }
                  }
                },
                "links": {
                  "$ref": "#/components/schemas/RelationshipLinks"
                }
              }
            }
          }
        },
        "links": {
          "$ref": "#/components/schemas/ObjectLinks"
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "links"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "data"
  ]
}