Boldem is a comprehensive digital marketing platform designed to streamline and optimize your marketing efforts. It provides robust features for email marketing, SMS campaigns, social media management, and marketing automation. Boldem helps businesses of all sizes enhance their marketing strategies, engage with their audience, and drive growth through targeted and personalized communication.
Connector that creates orders by Boldem API.
Prerequisites for calling Boldem API endpoints
To successfully call the endpoints of the Boldem API, ensure the following prerequisites are met:
-
Boldem account
-
Profi plan
-
API key (Client ID and Secret Key) generated in your Boldem account, which you will use to control the API
-
Access token and refresh token obtained by calling the appropriate endpoint using your API key
Generating an API Key
-
Log in to your Boldem account
-
Navigate to Settings/API
-
Click the New API Key button
-
Enter a name for the key for your reference
-
A dialog will appear with the API key details – Client ID and Client Secret
Configuration
Boldem - Connection (ver. 1.0.0)
Client ID
Client ID for Boldem API.
Client secret
Client secret for the connection.
Boldem - Create Order Settings (ver. 1.0.0)
Error behavior
The available values are:
-
Fail and return response: The connector fails at the specified line but generates output with error details.
-
Fail without response: The connector fails - the error will be displayed only in the log.
-
Do not fail and return response: The connector does not fail but generates output records that may be marked with an error and detailed information.
Input & Output Schema
Input
Boldem - Create Order Request (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| WebsiteID | Integer | No | The ID of the website where the order was created |
| CartID | Integer | Yes | The ID of the cart associated with the order |
| OrderExternalID | String | No | The external identifier for the order |
| String | No | The email address of the customer who placed the order | |
| Phone | String | Yes | The phone number of the customer who placed the order |
| Price | Double | No | The total price of the order excluding VAT |
| PriceVat | Double | No | The total price of the order including VAT |
| Currency | String | No | The currency in which the order is placed |
| Status | String | Yes | The status of the order |
| Payment | String | Yes | The payment method used for the order |
| Shipping | String | Yes | The shipping method used for the order |
| Delivered | DateTime | Yes | The date and time when the order was delivered |
| CreatedExternal | DateTime | Yes | The date and time when the order was created externally |
| CustomFields | Boldem - Order Custom Field v1.0.0 |
Yes | Custom fields for additional order details |
| OrderItems | Boldem - Order Item v1.0.0 |
No | Items included in the order |
Boldem - Order Custom Field (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| OrderID | Integer | No | The unique identifier for the order |
| CustomField1 | String | Yes | Additional custom field 1 for the order |
| CustomField2 | String | Yes | Additional custom field 2 for the order |
| CustomField3 | String | Yes | Additional custom field 3 for the order |
| CustomField4 | String | Yes | Additional custom field 4 for the order |
| CustomField5 | String | Yes | Additional custom field 5 for the order |
Boldem - Order Item (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| ExternalID | String | No | The external identifier for the order item |
| Variant | String | Yes | The variant of the product, if applicable |
| Quantity | Integer | No | The quantity of the item ordered |
| Name | String | No | The name of the product |
| Price | Double | No | The price of the item excluding VAT |
| PriceVat | Double | No | The price of the item including VAT |
| Manufacturer | String | Yes | The manufacturer of the product |
| Category | String | Yes | The category of the product |
| Url | String | No | The URL link to the product page |
| ImageUrl | String | Yes | The URL link to the product image |
| CustomFields | Boldem - Order Item Custom Field v1.0.0 |
Yes | Custom fields for additional item details |
Boldem - Order Item Custom Field (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| OrderItemID | Integer | No | The unique identifier for the order item |
| CustomField1 | String | Yes | Additional custom field 1 for the order item |
| CustomField2 | String | Yes | Additional custom field 2 for the order item |
| CustomField3 | String | Yes | Additional custom field 3 for the order item |
| CustomField4 | String | Yes | Additional custom field 4 for the order item |
| CustomField5 | String | Yes | Additional custom field 5 for the order item |
Output
Boldem - Create Order Response (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| StatusCode | Integer | No | A numerical response from the server to an HTTP request sent to an API |
| WebsiteID | Integer | Yes | The ID of the website where the order was created |
| CartID | Integer | Yes | The ID of the cart associated with the order |
| OrderExternalID | String | Yes | The external identifier for the order |
| String | Yes | The email address of the customer who placed the order | |
| Phone | String | Yes | The phone number of the customer who placed the order |
| Price | Double | Yes | The total price of the order excluding VAT |
| PriceVat | Double | Yes | The total price of the order including VAT |
| Currency | String | Yes | The currency in which the order is placed |
| Status | String | Yes | The status of the order |
| Payment | String | Yes | The payment method used for the order |
| Shipping | String | Yes | The shipping method used for the order |
| Delivered | DateTime | Yes | The date and time when the order was delivered |
| CreatedExternal | DateTime | Yes | The date and time when the order was created externally |
| OrderID | Integer | Yes | The unique identifier for the order |
| Created | DateTime | Yes | The date and time when the order was created |
| Updated | DateTime | Yes | The date and time when the order was last updated |
| CustomFields | Boldem - Order Custom Field v1.0.0 |
Yes | Custom fields for additional order details |
| OrderItems | Boldem - Order Item v1.0.0 |
Yes | Items included in the order |
| IsError | Bool | No | Indicates whether there was an error during the operation |
| Message | String | Yes | Error or status message providing additional information |
Status Code
- 200 Success
- 400 Bad request
- 500 Server error
Boldem - Order Custom Field (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| OrderID | Integer | No | The unique identifier for the order |
| CustomField1 | String | Yes | Additional custom field 1 for the order |
| CustomField2 | String | Yes | Additional custom field 2 for the order |
| CustomField3 | String | Yes | Additional custom field 3 for the order |
| CustomField4 | String | Yes | Additional custom field 4 for the order |
| CustomField5 | String | Yes | Additional custom field 5 for the order |
Boldem - Order Item (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| ExternalID | String | No | The external identifier for the order item |
| Variant | String | Yes | The variant of the product, if applicable |
| Quantity | Integer | No | The quantity of the item ordered |
| Name | String | No | The name of the product |
| Price | Double | No | The price of the item excluding VAT |
| PriceVat | Double | No | The price of the item including VAT |
| Manufacturer | String | Yes | The manufacturer of the product |
| Category | String | Yes | The category of the product |
| Url | String | No | The URL link to the product page |
| ImageUrl | String | Yes | The URL link to the product image |
| CustomFields | Boldem - Order Item Custom Field v1.0.0 |
Yes | Custom fields for additional item details |
Boldem - Order Item Custom Field (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| OrderItemID | Integer | No | The unique identifier for the order item |
| CustomField1 | String | Yes | Additional custom field 1 for the order item |
| CustomField2 | String | Yes | Additional custom field 2 for the order item |
| CustomField3 | String | Yes | Additional custom field 3 for the order item |
| CustomField4 | String | Yes | Additional custom field 4 for the order item |
| CustomField5 | String | Yes | Additional custom field 5 for the order item |
Release notes
3.0.1
- First release