Thanks for being patient while we implement your feedback to improve the developer experience.

Get Global Order Settings

GET /orders/settings

Request

Returns global order settings.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/orders/settings' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

application/json

  • notifications    object

    Global notification settings.

  • meta    object

    Response metadata.

    Update Global Order Settings

    PUT /orders/settings

    Request

    Updates global order settings.

    Authentication

    • X-Auth-Token in header - required

    Parameters

    • store_hash in path - string
    • Content-Type in header with default of application/json - string - required

      The MIME type of the request body.

    Body

    object | application/json

    • notifications      object

      Global notification settings.

    EnableMultipleOrderNotifications

    {
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    },
    "forward_invoice": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    }
  }
}

    DisableOrderPlacedNotificatons

    {
  "notifications": {
    "order_placed": {
      "email_addresses": []
    }
  }
}

    Response

    OK

    Body

    application/json

      • notifications        object

        Global notification settings.

      • meta        object

        Response metadata.

        example

        {
  "$ref": "#/components/examples/EnableMultipleOrderNotifications/value",
  "meta": {}
}

        Get Channel Order Settings

        GET /orders/settings/channels/{channel_id}

        Request

        Returns order settings for a specific channel.

        Authentication

        • X-Auth-Token in header - required

        Parameters

        • store_hash in path - string
        • Accept in header with default of application/json - string - required

          The MIME type of the response body.

        • channel_id in path - string - required

          Channel ID

        example

        curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/orders/settings/channels/[channel_id]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

        Response

        OK

        Body

        application/json

        • notifications          object

          Channel notification settings.

        • meta          object

          Response metadata.

          Update Channel Order Settings

          PUT /orders/settings/channels/{channel_id}

          Request

          Updates order settings for a specific channel.

          Note: You must override both notifications email_addresses or neither, i.e. either both notification email_addresses are an array of valid email addresses, or both email_addresses must be null. You may not have one set to an array of addresses and the other set to null.

          Authentication

          • X-Auth-Token in header - required

          Parameters

          • store_hash in path - string
          • channel_id in path - string - required

            Channel ID

          • Content-Type in header with default of application/json - string - required

            The MIME type of the request body.

          Body

          object | application/json

          • notifications            object

            Channel notification settings.

          OverrideOrderPlacedEmailAddressesAndDisableForwardEmailAddresses

          {
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    },
    "forward_invoice": {
      "email_addresses": []
    }
  }
}

          ResetChannelSettings

          {
  "notifications": {
    "order_placed": {
      "email_addresses": null
    },
    "forward_invoice": {
      "email_addresses": null
    }
  }
}

          DisableMultipleNotificatonsForChannels

          {
  "notifications": {
    "order_placed": {
      "email_addresses": []
    },
    "forward_invoice": {
      "email_addresses": []
    }
  }
}

          Response

          OK

          Body

          application/json

          • notifications            object

            Channel notification settings.

          • meta            object

            Response metadata.

            example

            {
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "string"
      ]
    },
    "forward_invoice": {
      "email_addresses": [
        "string"
      ]
    }
  },
  "meta": {}
}