Skip to Content

BigCommerce Update Activity

Introduction

A BigCommerce Update activity, using its BigCommerce connection, updates an existing object record in BigCommerce, and is intended to be used as a target to consume data in an operation.

Create a BigCommerce Update Activity

An instance of a BigCommerce Update activity is created from a BigCommerce connection using its Update activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing BigCommerce Update activity can be edited from these locations:

Configure a BigCommerce Update Activity

Follow these steps to configure a BigCommerce Update activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

BigCommerce Update Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each BigCommerce Update activity and must not contain forward slashes (/) or colons (:).

  • Select an Object: This section displays objects available in the BigCommerce endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.

    • Selected Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the BigCommerce endpoint. This may be useful if objects have been added to BigCommerce. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the BigCommerce endpoint:

      • Name: The object name from BigCommerce.

      • Description: The object description from BigCommerce.

    Tip

    If the table does not populate with available objects, the BigCommerce connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a Sub-object

In this step, select a sub-object. Each user interface element of this step is described below.

BigCommerce Update Activity Configuration Step 2

  • Select a Sub-object: This section displays sub-objects available in the BigCommerce endpoint. When reopening an existing activity configuration, only the selected sub-object is displayed instead of reloading the entire sub-object list.

    • Selected Object: The object selected in the previous step is listed here.

    • Selected Sub-object: After a sub-object is selected, it is listed here.

    • Search: Enter any part of the sub-object name into the search box to filter the list of sub-objects. The search is not case-sensitive. If sub-objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload sub-objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload sub-objects from the BigCommerce endpoint. This may be useful if sub-objects have been added to BigCommerce. This action refreshes all metadata used to build the table of sub-objects displayed in the configuration.

    • Selecting a Sub-object: Within the table, click anywhere on a row to select a sub-object. Only one sub-object can be selected. The information available for each sub-object is fetched from the BigCommerce endpoint:

      • Name: The sub-object name from BigCommerce.

      • Description: The sub-object description from BigCommerce.

    Tip

    If the table does not populate with available sub-objects, the BigCommerce connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

BigCommerce Update Activity Configuration Step 3

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    The BigCommerce connector uses the BigCommerce REST API v3.0. Refer to the API documentation for information on the schema nodes and fields.

    The request and response data schemas consist of these nodes and fields:

    • Request:

      Request Schema Field/Node Notes
      updateRequest Node representing the update request
      items Node representing the line items to be created in the cart
      include Parameters used during updating
      cartId This cart's unique ID
      line_items Line items to be updated
      gift_certificates Node representing the line item gift certificate to be updated
      items Node representing the Given name for gift certificate line item
      amount Value of line item gift certificate. Must be between 1 and 1000
      quantity Number of line item gift certificate. Must be 1 or higher
      sender Node representing the Contact Entity
    • Response:

      Response Schema Field/Node Notes
      updateResponse Node representing the update response
      items Node representing the items that were updated
      created_time Time when the cart was updated
      updated_time Time when the cart was last updated
      discount_amount The discounted amount
      cart_amount Sum of cart line-item amounts minus cart-level discounts and coupons. This amount includes taxes (where applicable)
      tax_included Returns true if tax was included, or false if tax was not included
      line_items Node representing the line items updated
      items Node representing the items updated
      physical_items Node representing the physical attribrutes of the items updated
  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the BigCommerce endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a BigCommerce Update activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

BigCommerce Update activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.