BigCommerce · Schema

Job

The job for theme upload or download

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
errors array The errors.
id string The identifier.
percent_complete number The percent complete.
result object The result.
status string The status.
time string The time.
warnings array The warnings.
View JSON Schema on GitHub

JSON Schema

bigcommerce-job-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Job",
  "title": "Job",
  "description": "The job for theme upload or download",
  "type": "object",
  "properties": {
    "errors": {
      "description": "The errors.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "error": {
            "description": "The error.",
            "type": "string"
          },
          "message": {
            "description": "The message.",
            "type": "string"
          }
        }
      }
    },
    "id": {
      "description": "The identifier.",
      "type": "string"
    },
    "percent_complete": {
      "description": "The percent complete.",
      "type": "number"
    },
    "result": {
      "description": "The result.",
      "type": "object",
      "additionalProperties": true,
      "properties": {}
    },
    "status": {
      "type": "string",
      "description": "The status.",
      "enum": [
        "COMPLETED",
        "QUEUED",
        "WORKING",
        "FAILED"
      ]
    },
    "time": {
      "type": "string",
      "description": "The time.",
      "format": "date-time"
    },
    "warnings": {
      "description": "The warnings.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "description": "The message.",
            "type": "string"
          },
          "warning": {
            "description": "The warning.",
            "type": "string"
          }
        }
      }
    }
  },
  "x-internal": false
}