Files

1081 lines
21 KiB
TypeScript

import type { INodeProperties } from 'n8n-workflow';
export const shipmentsDescription: INodeProperties[] = [
{
"displayName": "Operation",
"name": "operation",
"type": "options",
"noDataExpression": true,
"displayOptions": {
"show": {
"resource": [
"Shipments"
]
}
},
"options": [
{
"name": "Shipment Get Ping",
"value": "Shipment Get Ping",
"action": "Shipment Get Ping",
"description": "",
"routing": {
"request": {
"method": "GET",
"url": "=/api/v1/shipment/ping"
}
}
},
{
"name": "Shipment Post Shipment",
"value": "Shipment Post Shipment",
"action": "Creates a new shipment with the selected Shippingprovider",
"description": "Creates a new shipment with the selected Shippingprovider",
"routing": {
"request": {
"method": "POST",
"url": "=/api/v1/shipment/shipment"
}
}
},
{
"name": "Shipment Get List",
"value": "Shipment Get List",
"action": "Get a list of all shipments optionally filtered by date. All parameters are optional.",
"description": "Get a list of all shipments optionally filtered by date. All parameters are optional.",
"routing": {
"request": {
"method": "GET",
"url": "=/api/v1/shipment/shipments"
}
}
},
{
"name": "Shipment Get Shipping Carrier",
"value": "Shipment Get Shipping Carrier",
"action": "Queries the currently available shipping carriers.",
"description": "Queries the currently available shipping carriers.",
"routing": {
"request": {
"method": "GET",
"url": "=/api/v1/shipment/shippingcarriers"
}
}
},
{
"name": "Shipment Get Shippingproviders",
"value": "Shipment Get Shippingproviders",
"action": "Query all defined shipping providers",
"description": "Query all defined shipping providers",
"routing": {
"request": {
"method": "GET",
"url": "=/api/v1/shipment/shippingproviders"
}
}
},
{
"name": "Shipment Ship With Label",
"value": "Shipment Ship With Label",
"action": "Creates a shipment for an order in billbee",
"description": "Creates a shipment for an order in billbee",
"routing": {
"request": {
"method": "POST",
"url": "=/api/v1/shipment/shipwithlabel"
}
}
}
],
"default": ""
},
{
"displayName": "GET /api/v1/shipment/ping",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get Ping"
]
}
}
},
{
"displayName": "POST /api/v1/shipment/shipment",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Client Reference",
"name": "ClientReference",
"type": "string",
"default": "",
"description": "Optional specify a text to be included on the label. Not possible with all carriers",
"routing": {
"send": {
"property": "ClientReference",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Content",
"name": "Content",
"type": "string",
"default": "",
"description": "Optional specify a text describing the content of the shipment. Used for export shipments",
"routing": {
"send": {
"property": "Content",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Customer Number",
"name": "CustomerNumber",
"type": "string",
"default": "",
"description": "Not used anymore",
"routing": {
"send": {
"property": "CustomerNumber",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Dimension",
"name": "Dimension",
"type": "json",
"default": "{}",
"routing": {
"send": {
"property": "Dimension",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ JSON.parse($value) }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Order Currency Code",
"name": "OrderCurrencyCode",
"type": "string",
"default": "",
"description": "The Currency if the ordersum",
"routing": {
"send": {
"property": "OrderCurrencyCode",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Order Sum",
"name": "OrderSum",
"type": "number",
"default": 0,
"description": "The value of the shipments content",
"routing": {
"send": {
"property": "OrderSum",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Printer ID For Export Docs",
"name": "PrinterIdForExportDocs",
"type": "number",
"default": 0,
"description": "The id of a connected Cloudprinter to sent the export docs to",
"routing": {
"send": {
"property": "PrinterIdForExportDocs",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Printer Name",
"name": "PrinterName",
"type": "string",
"default": "",
"description": "The name of a connected Cloudprinter to sent the label to",
"routing": {
"send": {
"property": "PrinterName",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Product Code",
"name": "ProductCode",
"type": "string",
"default": "",
"description": "The productcode to be used when creating the shipment. Values depends on the carrier used",
"routing": {
"send": {
"property": "ProductCode",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Provider Name",
"name": "ProviderName",
"type": "string",
"default": "",
"description": "The name of the provider as specified in the billbee account",
"routing": {
"send": {
"property": "ProviderName",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Receiver Address",
"name": "ReceiverAddress",
"type": "json",
"default": "{}",
"routing": {
"send": {
"property": "ReceiverAddress",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ JSON.parse($value) }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Services",
"name": "Services",
"type": "json",
"default": "[\n {\n \"PossibleValueLists\": [\n {\n \"value\": [\n {}\n ]\n }\n ]\n }\n]",
"description": "A list of services to be used when creating the shipment",
"routing": {
"send": {
"property": "Services",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ JSON.parse($value) }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Ship Date",
"name": "ShipDate",
"type": "string",
"default": "",
"description": "Optional overwrite the shipdate to be transferred to the carrier",
"routing": {
"send": {
"property": "ShipDate",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Total Net",
"name": "TotalNet",
"type": "number",
"default": 0,
"description": "The value of the shipments content (net)",
"routing": {
"send": {
"property": "TotalNet",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Weight In Gram",
"name": "WeightInGram",
"type": "number",
"default": 0,
"description": "Optional specify the weight in gram of the shipment",
"routing": {
"send": {
"property": "WeightInGram",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "Shipping Carrier",
"name": "shippingCarrier",
"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
},
{
"name": "5",
"value": 5
},
{
"name": "6",
"value": 6
},
{
"name": "7",
"value": 7
},
{
"name": "8",
"value": 8
},
{
"name": "9",
"value": 9
},
{
"name": "10",
"value": 10
},
{
"name": "11",
"value": 11
},
{
"name": "12",
"value": 12
},
{
"name": "13",
"value": 13
},
{
"name": "14",
"value": 14
},
{
"name": "15",
"value": 15
},
{
"name": "16",
"value": 16
},
{
"name": "17",
"value": 17
},
{
"name": "18",
"value": 18
}
],
"routing": {
"send": {
"property": "shippingCarrier",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Post Shipment"
]
}
}
},
{
"displayName": "GET /api/v1/shipment/shipments",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Page",
"name": "page",
"description": "Specifies the page to request.",
"default": 0,
"type": "number",
"routing": {
"send": {
"type": "query",
"property": "page",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Page Size",
"name": "pageSize",
"description": "Specifies the pagesize. Defaults to 50, max value is 250",
"default": 0,
"type": "number",
"routing": {
"send": {
"type": "query",
"property": "pageSize",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Created At Min",
"name": "createdAtMin",
"description": "Specifies the oldest shipment date to include in the response",
"default": "",
"type": "string",
"routing": {
"send": {
"type": "query",
"property": "createdAtMin",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Created At Max",
"name": "createdAtMax",
"description": "Specifies the newest shipment date to include in the response",
"default": "",
"type": "string",
"routing": {
"send": {
"type": "query",
"property": "createdAtMax",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Order ID",
"name": "orderId",
"description": "Get shipments for this order only.",
"default": 0,
"type": "number",
"routing": {
"send": {
"type": "query",
"property": "orderId",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Minimum Shipment ID",
"name": "minimumShipmentId",
"description": "Get Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments.",
"default": 0,
"type": "number",
"routing": {
"send": {
"type": "query",
"property": "minimumShipmentId",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "Shipping Provider ID",
"name": "shippingProviderId",
"description": "Get Shippings for the specified shipping provider only. <seealso cref=\"M:Rechnungsdruck.WebApp.Controllers.Api.ShipmentController.GetShippingproviders\" />",
"default": 0,
"type": "number",
"routing": {
"send": {
"type": "query",
"property": "shippingProviderId",
"value": "={{ $value }}",
"propertyInDotNotation": false
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get List"
]
}
}
},
{
"displayName": "GET /api/v1/shipment/shippingcarriers",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get Shipping Carrier"
]
}
}
},
{
"displayName": "GET /api/v1/shipment/shippingproviders",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Get Shippingproviders"
]
}
}
},
{
"displayName": "POST /api/v1/shipment/shipwithlabel",
"name": "operation",
"type": "notice",
"typeOptions": {
"theme": "info"
},
"default": "",
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Change State To Send",
"name": "ChangeStateToSend",
"type": "boolean",
"default": true,
"description": "Optional parameter to automatically change the orderstate to sent after creating the shipment",
"routing": {
"send": {
"property": "ChangeStateToSend",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Client Reference",
"name": "ClientReference",
"type": "string",
"default": "",
"description": "Optional specify a reference text to be included on the label. Works not with all carriers",
"routing": {
"send": {
"property": "ClientReference",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Dimension",
"name": "Dimension",
"type": "json",
"default": "{}",
"routing": {
"send": {
"property": "Dimension",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ JSON.parse($value) }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Order ID",
"name": "OrderId",
"type": "number",
"default": 0,
"description": "The Billbee internal id of the order to ship",
"routing": {
"send": {
"property": "OrderId",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Printer Name",
"name": "PrinterName",
"type": "string",
"default": "",
"description": "Optional the name of a connected cloudprinter to send the label to",
"routing": {
"send": {
"property": "PrinterName",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Product ID",
"name": "ProductId",
"type": "number",
"default": 0,
"description": "the id of the shipping provider product to be used",
"routing": {
"send": {
"property": "ProductId",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Provider ID",
"name": "ProviderId",
"type": "number",
"default": 0,
"description": "The id of the provider. You can query all providers with the shippingproviders endpoint",
"routing": {
"send": {
"property": "ProviderId",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Ship Date",
"name": "ShipDate",
"type": "string",
"default": "",
"description": "Optional specify the shipdate to be transmitted to the carrier",
"routing": {
"send": {
"property": "ShipDate",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
{
"displayName": "Weight In Gram",
"name": "WeightInGram",
"type": "number",
"default": 0,
"description": "Optional the shipments weight in gram to override the calculated weight",
"routing": {
"send": {
"property": "WeightInGram",
"propertyInDotNotation": false,
"type": "body",
"value": "={{ $value }}"
}
},
"displayOptions": {
"show": {
"resource": [
"Shipments"
],
"operation": [
"Shipment Ship With Label"
]
}
}
},
];