n8n/packages/nodes-base/nodes/ActiveCampaign/EcomOrderDescription.ts

716 lines
15 KiB
TypeScript
Raw Normal View History

2019-11-03 03:47:36 -08:00
import { INodeProperties } from "n8n-workflow";
import { allCurrencies } from './currencies';
export const ecomOrderOperations = [
2019-11-07 01:50:02 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'ecommerceOrder',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a order',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a order',
},
{
name: 'Get',
value: 'get',
description: 'Get data of a order',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all orders',
},
{
name: 'Update',
value: 'update',
description: 'Update a order',
},
],
default: 'create',
description: 'The operation to perform.',
},
2019-11-03 12:49:49 -08:00
] as INodeProperties[];
2019-11-03 03:47:36 -08:00
export const ecomOrderFields = [
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceOrder:create
// ----------------------------------
{
displayName: 'External ID',
name: 'externalid',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the order in the external service. ONLY REQUIRED IF EXTERNALCHECKOUTID NOT INCLUDED',
},
{
displayName: 'External checkout ID',
name: 'externalcheckoutid',
type: 'string',
default: '',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the cart in the external service. ONLY REQUIRED IF EXTERNALID IS NOT INCLUDED.',
},
{
displayName: 'Order source',
name: 'source',
type: 'number',
default: 0,
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The order source code (0 - will not trigger automations, 1 - will trigger automations).',
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The email address of the customer who placed the order.',
},
{
displayName: 'Total price',
name: 'totalPrice',
type: 'number',
default: 0,
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.',
},
{
displayName: 'Order currency',
name: 'currency',
type: 'options',
default: 'eur',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
options: allCurrencies,
description: 'The currency of the order (3-digit ISO code, e.g., "USD").',
},
{
displayName: 'Connection ID',
name: 'connectionid',
type: 'number',
default: 0,
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the connection from which this order originated.',
},
{
displayName: 'Customer ID',
name: 'customerid',
type: 'number',
default: 0,
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the customer associated with this order.',
},
{
displayName: 'Creation Date',
name: 'externalCreatedDate',
type: 'dateTime',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The date the order was placed.',
},
{
displayName: 'Abandoning Date',
name: 'abandonedDate',
type: 'dateTime',
default: '',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The date the cart was abandoned. REQUIRED ONLY IF INCLUDING EXTERNALCHECKOUTID.',
},
{
displayName: 'Products',
name: 'orderProducts',
type: 'collection',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add product',
},
displayOptions: {
show: {
operation: [
'create'
],
resource: [
'ecommerceOrder',
],
},
},
default: {},
description: 'All ordered products',
placeholder: 'Add product field',
options: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The name of the product',
},
{
displayName: 'Price',
name: 'price',
type: 'number',
default: 0,
description: 'The price of the product, in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.',
},
{
displayName: 'Product Quantity',
name: 'quantity',
type: 'number',
default: 0,
description: 'The quantity ordered.',
},
{
displayName: 'Product external ID',
name: 'externalid',
type: 'string',
default: '',
description: 'The id of the product in the external service.',
},
{
displayName: 'Product Category',
name: 'category',
type: 'string',
default: '',
description: 'The category of the product.',
},
{
displayName: 'SKU',
name: 'sku',
type: 'string',
default: '',
description: 'The SKU for the product.',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'The description of the product.',
},
{
displayName: 'Image URL',
name: 'imageUrl',
type: 'string',
default: '',
description: 'An Image URL that displays an image of the product.',
},
{
displayName: 'Product URL',
name: 'productUrl',
type: 'string',
default: '',
description: 'A URL linking to the product in your store.',
},
],
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'ecommerceOrder',
],
},
},
default: {},
options: [
{
displayName: 'Shipping Amount',
name: 'shippingAmount',
type: 'number',
default: 0,
description: 'The total shipping amount for the order in cents .',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
{
displayName: 'Tax Amount',
name: 'taxAmount',
type: 'number',
default: 0,
description: 'The total tax amount for the order in cents.',
},
{
displayName: 'Discount Amount',
name: 'discountAmount',
type: 'number',
default: 0,
description: 'The total discount amount for the order in cents.',
},
{
displayName: 'Order URL',
name: 'orderUrl',
type: 'string',
default: '',
description: 'The URL for the order in the external service.',
},
{
displayName: 'External updated date',
name: 'externalUpdatedDate',
type: 'dateTime',
default: '',
description: 'The date the order was updated.',
},
{
displayName: 'Shipping Method',
name: 'shippingMethod',
type: 'string',
default: '',
description: 'The shipping method of the order.',
},
{
displayName: 'Order Number',
name: 'orderNumber',
type: 'string',
default: '',
description: 'The order number. This can be different than the externalid.',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
]
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceOrder:update
// ----------------------------------
{
displayName: 'Order ID',
name: 'orderId',
type: 'number',
default: 0,
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the e-commerce order.',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
{
displayName: 'Add Field',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'ecommerceOrder',
],
},
},
default: {},
options: [
{
displayName: 'External ID',
name: 'externalid',
type: 'string',
default: '',
description: 'The id of the order in the external service. ONLY REQUIRED IF EXTERNALCHECKOUTID NOT INCLUDED',
},
{
displayName: 'External checkout ID',
name: 'externalcheckoutid',
type: 'string',
default: '',
description: 'The id of the cart in the external service. ONLY REQUIRED IF EXTERNALID IS NOT INCLUDED.',
},
{
displayName: 'Order source',
name: 'source',
type: 'number',
default: 0,
description: 'The order source code (0 - will not trigger automations, 1 - will trigger automations).',
},
{
displayName: 'Customer Email',
name: 'email',
type: 'string',
default: '',
description: 'The email address of the customer who placed the order.',
},
{
displayName: 'Total price',
name: 'totalPrice',
type: 'number',
default: 0,
description: 'The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.',
},
{
displayName: 'Order currency',
name: 'currency',
type: 'options',
default: 'eur',
options: allCurrencies,
description: 'The currency of the order (3-digit ISO code, e.g., "USD").',
},
{
displayName: 'Connection ID',
name: 'connectionid',
type: 'number',
default: 0,
description: 'The id of the connection from which this order originated.',
},
{
displayName: 'Customer ID',
name: 'customerid',
type: 'number',
default: 0,
description: 'The id of the customer associated with this order.',
},
{
displayName: 'Creation Date',
name: 'externalupdatedDate',
type: 'dateTime',
default: '',
description: 'The date the order was placed.',
},
{
displayName: 'Abandoning Date',
name: 'abandonedDate',
type: 'dateTime',
default: '',
description: 'The date the cart was abandoned. REQUIRED ONLY IF INCLUDING EXTERNALCHECKOUTID.',
},
{
displayName: 'Shipping Amount',
name: 'shippingAmount',
type: 'number',
default: 0,
description: 'The total shipping amount for the order in cents .',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
{
displayName: 'Tax Amount',
name: 'taxAmount',
type: 'number',
default: 0,
description: 'The total tax amount for the order in cents.',
},
{
displayName: 'Discount Amount',
name: 'discountAmount',
type: 'number',
default: 0,
description: 'The total discount amount for the order in cents.',
},
{
displayName: 'Order URL',
name: 'orderUrl',
type: 'string',
default: '',
description: 'The URL for the order in the external service.',
},
{
displayName: 'External updated date',
name: 'externalUpdatedDate',
type: 'dateTime',
default: '',
description: 'The date the order was updated.',
},
{
displayName: 'Shipping Method',
name: 'shippingMethod',
type: 'string',
default: '',
description: 'The shipping method of the order.',
},
{
displayName: 'Order Number',
name: 'orderNumber',
type: 'string',
default: '',
description: 'The order number. This can be different than the externalid.',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
{
displayName: 'Products',
name: 'orderProducts',
type: 'collection',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add product',
},
default: {},
description: 'All ordered products',
placeholder: 'Add product field',
options: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The name of the product',
},
{
displayName: 'Price',
name: 'price',
type: 'number',
default: 0,
description: 'The price of the product, in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.',
},
{
displayName: 'Product Quantity',
name: 'quantity',
type: 'number',
default: 0,
description: 'The quantity ordered.',
},
{
displayName: 'Product external ID',
name: 'externalid',
type: 'string',
default: '',
description: 'The id of the product in the external service.',
},
{
displayName: 'Product Category',
name: 'category',
type: 'string',
default: '',
description: 'The category of the product.',
},
{
displayName: 'SKU',
name: 'sku',
type: 'string',
default: '',
description: 'The SKU for the product.',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'The description of the product.',
},
{
displayName: 'Image URL',
name: 'imageUrl',
type: 'string',
default: '',
description: 'An Image URL that displays an image of the product.',
},
{
displayName: 'Product URL',
name: 'productUrl',
type: 'string',
default: '',
description: 'A URL linking to the product in your store.',
},
],
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
]
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceOrder:delete
// ----------------------------------
{
displayName: 'Order ID',
name: 'orderId',
type: 'number',
default: 0,
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the e-commerce order.',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceOrder:get
// ----------------------------------
{
displayName: 'Order ID',
name: 'orderId',
type: 'number',
default: 0,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'ecommerceOrder',
],
},
},
description: 'The id of the e-commerce order.',
},
2019-11-03 03:47:36 -08:00
2019-11-07 01:50:02 -08:00
// ----------------------------------
// ecommerceOrder:getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'ecommerceOrder',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'ecommerceOrder',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'How many results to return.',
},
2019-11-03 12:49:49 -08:00
] as INodeProperties[];