BigCommerce · Schema

301RedirectImportExportJobRead

Full detail of a Redirect Import-Export job.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
id string The Import-Export job ID.
type object
status object
completed_items integer The number of items that were successfully imported or exported.
failed_items integer The number of items that were not successfully imported or exported.
total_items integer The number of items in the import or export job.
errors object
created_at string The date-time that the import-export job was created, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.
completed_at string The date-time that the import-export job was completed, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.
View JSON Schema on GitHub

JSON Schema

bigcommerce-301redirectimportexportjobread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/301RedirectImportExportJobRead",
  "title": "301RedirectImportExportJobRead",
  "type": "object",
  "description": "Full detail of a Redirect Import-Export job.",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The Import-Export job ID."
    },
    "type": {
      "$ref": "#/components/schemas/ImportExportJobType"
    },
    "status": {
      "$ref": "#/components/schemas/ImportExportJobStatus"
    },
    "completed_items": {
      "type": "integer",
      "description": "The number of items that were successfully imported or exported."
    },
    "failed_items": {
      "type": "integer",
      "description": "The number of items that were not successfully imported or exported."
    },
    "total_items": {
      "type": "integer",
      "description": "The number of items in the import or export job."
    },
    "errors": {
      "$ref": "#/components/schemas/ImportErrors"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date-time that the import-export job was created, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.",
      "example": "2022-01-04T04:15:50.000Z"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date-time that the import-export job was completed, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.",
      "example": "2022-01-04T04:15:50.000Z"
    }
  }
}