Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Bigcommerce Import Opus

Bigcommerce Import Opus

markdownView as Markdown

Create and manage data import and export jobs.

BigcommerceImportOpus: Create job

POSThttps://api.lytics.io/v2/job/bigcommerce-import-opus

Create a BigcommerceImportOpus job

Sample Request
1234567891011121314151617181920212223242526
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous_update": true,
    "day_of_week": "string",
    "include_fields": [
      "string"
    ],
    "run_frequency": "string",
    "skip_orders": true,
    "skip_users": true,
    "start_date": "2019-08-24T14:15:22Z",
    "time_of_day": "string",
    "timezone": "string"
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "continuous_update": true,
      "day_of_week": "string",
      "include_fields": [
        "string"
      ],
      "run_frequency": "string",
      "skip_orders": true,
      "skip_users": true,
      "start_date": "2019-08-24T14:15:22Z",
      "time_of_day": "string",
      "timezone": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

BigcommerceImportOpus: Get job

GEThttps://api.lytics.io/v2/job/bigcommerce-import-opus/{id}

Get the summary of a BigcommerceImportOpus job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "continuous_update": true,
      "day_of_week": "string",
      "include_fields": [
        "string"
      ],
      "run_frequency": "string",
      "skip_orders": true,
      "skip_users": true,
      "start_date": "2019-08-24T14:15:22Z",
      "time_of_day": "string",
      "timezone": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

BigcommerceImportOpus: Update job

PUThttps://api.lytics.io/v2/job/bigcommerce-import-opus/{id}

Update a BigcommerceImportOpus job

Sample Request
1234567891011121314151617181920212223242526
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "continuous_update": true,
    "day_of_week": "string",
    "include_fields": [
      "string"
    ],
    "run_frequency": "string",
    "skip_orders": true,
    "skip_users": true,
    "start_date": "2019-08-24T14:15:22Z",
    "time_of_day": "string",
    "timezone": "string"
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "continuous_update": true,
      "day_of_week": "string",
      "include_fields": [
        "string"
      ],
      "run_frequency": "string",
      "skip_orders": true,
      "skip_users": true,
      "start_date": "2019-08-24T14:15:22Z",
      "time_of_day": "string",
      "timezone": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.continuous_updateoptionalboolean

Select to continuously import data

config.day_of_weekoptionalstring

Day of week to run work

config.include_fieldsoptionalstring[]

Select additional customer fields to import

config.run_frequencyoptionalstring

Select the frequency to import

config.skip_ordersoptionalboolean

Select this to skip importing customer orders

config.skip_usersoptionalboolean

Select this to skip importing customer profiles

config.start_dateoptionalstring (date-time)

Import BigCommerce user and activity data from this date. If no date is selected, all users and activity data will be imported. Please use the format yyyy-mm-dd, e.g. 2021-01-25

config.time_of_dayoptionalstring

Select the time of day to start importing. This does not need to be set for hourly imports

config.timezoneoptionalstring

Select the timezone for time of day. This does not need to be set for hourly imports

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.continuous_updateoptionalboolean

Select to continuously import data

config.day_of_weekoptionalstring

Day of week to run work

config.include_fieldsoptionalstring[]

Select additional customer fields to import

config.run_frequencyoptionalstring

Select the frequency to import

config.skip_ordersoptionalboolean

Select this to skip importing customer orders

config.skip_usersoptionalboolean

Select this to skip importing customer profiles

config.start_dateoptionalstring (date-time)

Import BigCommerce user and activity data from this date. If no date is selected, all users and activity data will be imported. Please use the format yyyy-mm-dd, e.g. 2021-01-25

config.time_of_dayoptionalstring

Select the time of day to start importing. This does not need to be set for hourly imports

config.timezoneoptionalstring

Select the timezone for time of day. This does not need to be set for hourly imports

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring