2693 lines
49 KiB
TypeScript
2693 lines
49 KiB
TypeScript
import type { INodeProperties } from 'n8n-workflow';
|
|
|
|
export const customersDescription: INodeProperties[] = [
|
|
{
|
|
"displayName": "Operation",
|
|
"name": "operation",
|
|
"type": "options",
|
|
"noDataExpression": true,
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
]
|
|
}
|
|
},
|
|
"options": [
|
|
{
|
|
"name": "Customer Get All",
|
|
"value": "Customer Get All",
|
|
"action": "Get a list of all customers",
|
|
"description": "Get a list of all customers",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/customers"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Create",
|
|
"value": "Customer Create",
|
|
"action": "Creates a new customer",
|
|
"description": "Creates a new customer",
|
|
"routing": {
|
|
"request": {
|
|
"method": "POST",
|
|
"url": "=/api/v1/customers"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Get Customer Address",
|
|
"value": "Customer Get Customer Address",
|
|
"action": "Queries a single address from a customer",
|
|
"description": "Queries a single address from a customer",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/customers/addresses/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Patch Address",
|
|
"value": "Customer Patch Address",
|
|
"action": "Updates one or more fields of an address",
|
|
"description": "Id and CustomerId cannot be changed",
|
|
"routing": {
|
|
"request": {
|
|
"method": "PATCH",
|
|
"url": "=/api/v1/customers/addresses/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Update Address",
|
|
"value": "Customer Update Address",
|
|
"action": "Updates all fields of an address",
|
|
"description": "Id and CustomerId cannot be changed. Fields you do not send will become empty.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "PUT",
|
|
"url": "=/api/v1/customers/addresses/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Get One",
|
|
"value": "Customer Get One",
|
|
"action": "Queries a single customer by id",
|
|
"description": "Queries a single customer by id",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/customers/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Update",
|
|
"value": "Customer Update",
|
|
"action": "Updates a customer by id",
|
|
"description": "Updates a customer by id",
|
|
"routing": {
|
|
"request": {
|
|
"method": "PUT",
|
|
"url": "=/api/v1/customers/{{$parameter[\"id\"]}}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Get Customer Addresses",
|
|
"value": "Customer Get Customer Addresses",
|
|
"action": "Queries a list of addresses from a customer",
|
|
"description": "Queries a list of addresses from a customer",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/customers/{{$parameter[\"id\"]}}/addresses"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Add Customer Address",
|
|
"value": "Customer Add Customer Address",
|
|
"action": "Adds a new address to a customer",
|
|
"description": "Id and CustomerId will be ignored in model. If Id is set, the addition will be stopped.",
|
|
"routing": {
|
|
"request": {
|
|
"method": "POST",
|
|
"url": "=/api/v1/customers/{{$parameter[\"id\"]}}/addresses"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Customer Get Customer Orders",
|
|
"value": "Customer Get Customer Orders",
|
|
"action": "Queries a list of orders from a customer",
|
|
"description": "Queries a list of orders from a customer",
|
|
"routing": {
|
|
"request": {
|
|
"method": "GET",
|
|
"url": "=/api/v1/customers/{{$parameter[\"id\"]}}/orders"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "Search Search",
|
|
"value": "Search Search",
|
|
"action": "Search for products, customers and orders.\r\nType can be \"order\", \"product\" and / or \"customer\"\r\nTerm can contains lucene query syntax",
|
|
"description": "Search for products, customers and orders.\r\nType can be \"order\", \"product\" and / or \"customer\"\r\nTerm can contains lucene query syntax",
|
|
"routing": {
|
|
"request": {
|
|
"method": "POST",
|
|
"url": "=/api/v1/search"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"default": ""
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/customers",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get All"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page",
|
|
"name": "page",
|
|
"description": "The current page to request starting with 1",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "page",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get All"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page Size",
|
|
"name": "pageSize",
|
|
"description": "The pagesize for the result list. Values between 1 and 250 are allowed",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "pageSize",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get All"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "POST /api/v1/customers",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Address",
|
|
"name": "Address",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"description": "Container for passing address data",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Address",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Archived At",
|
|
"name": "ArchivedAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customer was already archived at the given date. Further modification is disabled.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "ArchivedAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Commercial Mail Address",
|
|
"name": "DefaultCommercialMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultCommercialMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Fax",
|
|
"name": "DefaultFax",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultFax",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Mail Address",
|
|
"name": "DefaultMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Phone 1",
|
|
"name": "DefaultPhone1",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultPhone1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Phone 2",
|
|
"name": "DefaultPhone2",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultPhone2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Status Updates Mail Address",
|
|
"name": "DefaultStatusUpdatesMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultStatusUpdatesMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Email",
|
|
"name": "Email",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Email",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The Billbee Id of the customer",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Language ID",
|
|
"name": "LanguageId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "LanguageId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Meta Data",
|
|
"name": "MetaData",
|
|
"type": "json",
|
|
"default": "[\n {}\n]",
|
|
"routing": {
|
|
"send": {
|
|
"property": "MetaData",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Name",
|
|
"name": "Name",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Name",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Number",
|
|
"name": "Number",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "Number",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Price Group ID",
|
|
"name": "PriceGroupId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "PriceGroupId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Restored At",
|
|
"name": "RestoredAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customer was restored from the archive at the given date.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "RestoredAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 1",
|
|
"name": "Tel1",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 2",
|
|
"name": "Tel2",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Type",
|
|
"name": "Type",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "Customer Type",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Type",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Vat ID",
|
|
"name": "VatId",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "VatId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Create"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/customers/addresses/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the address",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "PATCH /api/v1/customers/addresses/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Patch Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the address",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Patch Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "PUT /api/v1/customers/addresses/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the address",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Address Addition",
|
|
"name": "AddressAddition",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "AddressAddition",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Address Type",
|
|
"name": "AddressType",
|
|
"type": "options",
|
|
"default": 1,
|
|
"description": "The type of the address",
|
|
"options": [
|
|
{
|
|
"name": "1",
|
|
"value": 1
|
|
},
|
|
{
|
|
"name": "2",
|
|
"value": 2
|
|
}
|
|
],
|
|
"routing": {
|
|
"send": {
|
|
"property": "AddressType",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Archived At",
|
|
"name": "ArchivedAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customeraddress was already archived at the given date. Further modification is disabled.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "ArchivedAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "City",
|
|
"name": "City",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "City",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Company",
|
|
"name": "Company",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The name of the company",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Company",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Country Code",
|
|
"name": "CountryCode",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The ISO2 code of the country",
|
|
"routing": {
|
|
"send": {
|
|
"property": "CountryCode",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Customer ID",
|
|
"name": "CustomerId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The internal Billbee id of the customer the address belongs to",
|
|
"routing": {
|
|
"send": {
|
|
"property": "CustomerId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Email",
|
|
"name": "Email",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Email",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Fax",
|
|
"name": "Fax",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Fax",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "First Name",
|
|
"name": "FirstName",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "FirstName",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Housenumber",
|
|
"name": "Housenumber",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Housenumber",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The internal Billbee ID of the address record. Can be null if a new address is created",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Last Name",
|
|
"name": "LastName",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "LastName",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Name 2",
|
|
"name": "Name2",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "Optionally an additional name field",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Name2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Restored At",
|
|
"name": "RestoredAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customeraddress was restored from the archive at the given date.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "RestoredAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "State",
|
|
"name": "State",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "State",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Street",
|
|
"name": "Street",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Street",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 1",
|
|
"name": "Tel1",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 2",
|
|
"name": "Tel2",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Zip",
|
|
"name": "Zip",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Zip",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/customers/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get One"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the customer to query",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get One"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "PUT /api/v1/customers/{id}",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the customer",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Archived At",
|
|
"name": "ArchivedAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customer was already archived at the given date. Further modification is disabled.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "ArchivedAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Commercial Mail Address",
|
|
"name": "DefaultCommercialMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultCommercialMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Fax",
|
|
"name": "DefaultFax",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultFax",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Mail Address",
|
|
"name": "DefaultMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Phone 1",
|
|
"name": "DefaultPhone1",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultPhone1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Phone 2",
|
|
"name": "DefaultPhone2",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultPhone2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Default Status Updates Mail Address",
|
|
"name": "DefaultStatusUpdatesMailAddress",
|
|
"type": "json",
|
|
"default": "{}",
|
|
"routing": {
|
|
"send": {
|
|
"property": "DefaultStatusUpdatesMailAddress",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Email",
|
|
"name": "Email",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Email",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The Billbee Id of the customer",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Language ID",
|
|
"name": "LanguageId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "LanguageId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Meta Data",
|
|
"name": "MetaData",
|
|
"type": "json",
|
|
"default": "[\n {}\n]",
|
|
"routing": {
|
|
"send": {
|
|
"property": "MetaData",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Name",
|
|
"name": "Name",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Name",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Number",
|
|
"name": "Number",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "Number",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Price Group ID",
|
|
"name": "PriceGroupId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"routing": {
|
|
"send": {
|
|
"property": "PriceGroupId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Restored At",
|
|
"name": "RestoredAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customer was restored from the archive at the given date.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "RestoredAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 1",
|
|
"name": "Tel1",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 2",
|
|
"name": "Tel2",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Type",
|
|
"name": "Type",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "Customer Type",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Type",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Vat ID",
|
|
"name": "VatId",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The vat-id, that should be saved at the customer. Only used if CustomerVatId is not set on the order.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "VatId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Update"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/customers/{id}/addresses",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Addresses"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the customer",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Addresses"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page",
|
|
"name": "page",
|
|
"description": "The current page to request starting with 1",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "page",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Addresses"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page Size",
|
|
"name": "pageSize",
|
|
"description": "The pagesize for the result list. Values between 1 and 250 are allowed",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "pageSize",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Addresses"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "POST /api/v1/customers/{id}/addresses",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "CustomerId to attach the new address to.",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Address Addition",
|
|
"name": "AddressAddition",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "AddressAddition",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Address Type",
|
|
"name": "AddressType",
|
|
"type": "options",
|
|
"default": 1,
|
|
"description": "The type of the address",
|
|
"options": [
|
|
{
|
|
"name": "1",
|
|
"value": 1
|
|
},
|
|
{
|
|
"name": "2",
|
|
"value": 2
|
|
}
|
|
],
|
|
"routing": {
|
|
"send": {
|
|
"property": "AddressType",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Archived At",
|
|
"name": "ArchivedAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customeraddress was already archived at the given date. Further modification is disabled.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "ArchivedAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "City",
|
|
"name": "City",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "City",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Company",
|
|
"name": "Company",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The name of the company",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Company",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Country Code",
|
|
"name": "CountryCode",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "The ISO2 code of the country",
|
|
"routing": {
|
|
"send": {
|
|
"property": "CountryCode",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Customer ID",
|
|
"name": "CustomerId",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The internal Billbee id of the customer the address belongs to",
|
|
"routing": {
|
|
"send": {
|
|
"property": "CustomerId",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Email",
|
|
"name": "Email",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Email",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Fax",
|
|
"name": "Fax",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Fax",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "First Name",
|
|
"name": "FirstName",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "FirstName",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Housenumber",
|
|
"name": "Housenumber",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Housenumber",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "Id",
|
|
"type": "number",
|
|
"default": 0,
|
|
"description": "The internal Billbee ID of the address record. Can be null if a new address is created",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Id",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Last Name",
|
|
"name": "LastName",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "LastName",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Name 2",
|
|
"name": "Name2",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "Optionally an additional name field",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Name2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Restored At",
|
|
"name": "RestoredAt",
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "If set, the customeraddress was restored from the archive at the given date.",
|
|
"routing": {
|
|
"send": {
|
|
"property": "RestoredAt",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "State",
|
|
"name": "State",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "State",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Street",
|
|
"name": "Street",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Street",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 1",
|
|
"name": "Tel1",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel1",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Tel 2",
|
|
"name": "Tel2",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Tel2",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Zip",
|
|
"name": "Zip",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Zip",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Add Customer Address"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "GET /api/v1/customers/{id}/orders",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Orders"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "ID",
|
|
"name": "id",
|
|
"required": true,
|
|
"description": "The id of the customer",
|
|
"default": 0,
|
|
"type": "number",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Orders"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page",
|
|
"name": "page",
|
|
"description": "The current page to request starting with 1",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "page",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Orders"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Page Size",
|
|
"name": "pageSize",
|
|
"description": "The pagesize for the result list. Values between 1 and 250 are allowed",
|
|
"default": 0,
|
|
"type": "number",
|
|
"routing": {
|
|
"send": {
|
|
"type": "query",
|
|
"property": "pageSize",
|
|
"value": "={{ $value }}",
|
|
"propertyInDotNotation": false
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Customer Get Customer Orders"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "POST /api/v1/search",
|
|
"name": "operation",
|
|
"type": "notice",
|
|
"typeOptions": {
|
|
"theme": "info"
|
|
},
|
|
"default": "",
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Search Search"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Search Mode",
|
|
"name": "SearchMode",
|
|
"type": "options",
|
|
"default": 0,
|
|
"options": [
|
|
{
|
|
"name": "0",
|
|
"value": 0
|
|
},
|
|
{
|
|
"name": "1",
|
|
"value": 1
|
|
},
|
|
{
|
|
"name": "2",
|
|
"value": 2
|
|
},
|
|
{
|
|
"name": "3",
|
|
"value": 3
|
|
},
|
|
{
|
|
"name": "4",
|
|
"value": 4
|
|
}
|
|
],
|
|
"routing": {
|
|
"send": {
|
|
"property": "SearchMode",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Search Search"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Term",
|
|
"name": "Term",
|
|
"type": "string",
|
|
"default": "",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Term",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ $value }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Search Search"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"displayName": "Type",
|
|
"name": "Type",
|
|
"type": "json",
|
|
"default": "[\n null\n]",
|
|
"routing": {
|
|
"send": {
|
|
"property": "Type",
|
|
"propertyInDotNotation": false,
|
|
"type": "body",
|
|
"value": "={{ JSON.parse($value) }}"
|
|
}
|
|
},
|
|
"displayOptions": {
|
|
"show": {
|
|
"resource": [
|
|
"Customers"
|
|
],
|
|
"operation": [
|
|
"Search Search"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
];
|