import type { INodeProperties } from 'n8n-workflow'; export const ordersDescription: INodeProperties[] = [ { "displayName": "Operation", "name": "operation", "type": "options", "noDataExpression": true, "displayOptions": { "show": { "resource": [ "Orders" ] } }, "options": [ { "name": "Layout API Get List", "value": "Layout API Get List", "action": "Layout API Get List", "description": "", "routing": { "request": { "method": "GET", "url": "=/api/v1/layouts" } } }, { "name": "Order API Get List", "value": "Order API Get List", "action": "Get a list of all orders optionally filtered by date", "description": "Get a list of all orders optionally filtered by date", "routing": { "request": { "method": "GET", "url": "=/api/v1/orders" } } }, { "name": "Order API Post New Order", "value": "Order API Post New Order", "action": "Creates a new order in the Billbee account", "description": "To create an order POST an JSON object to the orders endpoint with the shown properties.\r\nNot all properties are required.", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders" } } }, { "name": "Order API Create Delivery Note", "value": "Order API Create Delivery Note", "action": "Create an delivery note for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.", "description": "Create an delivery note for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/CreateDeliveryNote/{{$parameter[\"id\"]}}" } } }, { "name": "Order API Create Invoice", "value": "Order API Create Invoice", "action": "Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.", "description": "Create an invoice for an existing order. This request is extra throttled by order and api key to a maximum of 1 per 5 minutes.", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/CreateInvoice/{{$parameter[\"id\"]}}" } } }, { "name": "Order API Get Patchable Fields", "value": "Order API Get Patchable Fields", "action": "Returns a list of fields which can be updated with the orders/{id} patch call", "description": "Returns a list of fields which can be updated with the orders/{id} patch call", "routing": { "request": { "method": "GET", "url": "=/api/v1/orders/PatchableFields" } } }, { "name": "Order API Get By Ext Ref", "value": "Order API Get By Ext Ref", "action": "Get a single order by its external order number", "description": "Get a single order by its external order number", "routing": { "request": { "method": "GET", "url": "=/api/v1/orders/findbyextref/{{$parameter[\"extRef\"]}}" } } }, { "name": "Order API Get Invoice List", "value": "Order API Get Invoice List", "action": "Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate", "description": "Get a list of all invoices optionally filtered by date. This request ist throttled to 1 per 1 minute for same page and minInvoiceDate", "routing": { "request": { "method": "GET", "url": "=/api/v1/orders/invoices" } } }, { "name": "Order API Get", "value": "Order API Get", "action": "Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute", "description": "Get a single order by its internal billbee id. This request is throttled to 6 calls per order in one minute", "routing": { "request": { "method": "GET", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}" } } }, { "name": "Order API Patch Order", "value": "Order API Patch Order", "action": "Updates one or more fields of an order", "description": "Updates one or more fields of an order", "routing": { "request": { "method": "PATCH", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}" } } }, { "name": "Order API Update State", "value": "Order API Update State", "action": "Changes the main state of a single order", "description": "### REMARKS ###\r\nUse this call to change the state of an order to i.e. paid or sent.\r\n\r\nThe state is transfered to the external shop/marketplace if configured.\r\nThis is the list of known states:\r\n- 1: ordered\r\n- 2: confirmed\r\n- 3: paid\r\n- 4: shipped\r\n- 5: reclamation\r\n- 6: deleted\r\n- 7: closed\r\n- 8: canceled\r\n- 9: archived\r\n- 10: not used\r\n- 11: demand note 1\r\n- 12: demand note 2\r\n- 13: packed\r\n- 14: offered\r\n- 15: payment reminder\r\n- 16: fulfilling", "routing": { "request": { "method": "PUT", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/orderstate" } } }, { "name": "Order API Parse Placeholders", "value": "Order API Parse Placeholders", "action": "Parses a text and replaces all placeholders", "description": "Parses a text and replaces all placeholders", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/parse-placeholders" } } }, { "name": "Order API Send Message", "value": "Order API Send Message", "action": "Sends a message to the buyer", "description": "Sends a message to the buyer", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/send-message" } } }, { "name": "Order API Add Shipment", "value": "Order API Add Shipment", "action": "Add a shipment to a given order", "description": "Add a shipment to a given order", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/shipment" } } }, { "name": "Order API Tags Create", "value": "Order API Tags Create", "action": "Attach one or more tags to an order", "description": "When a tag is already attached, it is ignored. Tags are not case sensitive. All given tags are added to the existing tags.", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/tags" } } }, { "name": "Order API Tags Update", "value": "Order API Tags Update", "action": "Sets the tags attached to an order", "description": "All existing tags will be replaced by the given list of new tags. To just add tags, use POST method.", "routing": { "request": { "method": "PUT", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/tags" } } }, { "name": "Order API Trigger Event", "value": "Order API Trigger Event", "action": "Triggers a rule event", "description": "Triggers a rule event", "routing": { "request": { "method": "POST", "url": "=/api/v1/orders/{{$parameter[\"id\"]}}/trigger-event" } } }, { "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/layouts", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Layout API Get List" ] } } }, { "displayName": "GET /api/v1/orders", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Min Order Date", "name": "minOrderDate", "description": "Specifies the oldest order date to include in the response", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "minOrderDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Max Order Date", "name": "maxOrderDate", "description": "Specifies the newest order date to include in the response", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "maxOrderDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API 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": [ "Orders" ], "operation": [ "Order API 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": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Shop ID", "name": "shopId", "description": "Specifies a list of shop ids for which invoices should be included", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "shopId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Order State ID", "name": "orderStateId", "description": "Specifies a list of state ids to include in the response", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "orderStateId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Tag", "name": "tag", "description": "Specifies a list of tags the order must have attached to be included in the response", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "tag", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Minimum Bill Bee Order ID", "name": "minimumBillBeeOrderId", "description": "If given, all delivered orders have an Id greater than or equal to the given minimumOrderId", "default": 0, "type": "number", "routing": { "send": { "type": "query", "property": "minimumBillBeeOrderId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Modified At Min", "name": "modifiedAtMin", "description": "If given, the last modification has to be newer than the given date", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "modifiedAtMin", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Modified At Max", "name": "modifiedAtMax", "description": "If given, the last modification has to be older or equal than the given date.", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "modifiedAtMax", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Article Title Source", "name": "articleTitleSource", "description": "The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text", "default": 0, "type": "options", "options": [ { "name": "0", "value": 0 }, { "name": "1", "value": 1 }, { "name": "2", "value": 2 }, { "name": "3", "value": 3 } ], "routing": { "send": { "type": "query", "property": "articleTitleSource", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "Exclude Tags", "name": "excludeTags", "description": "If true the list of tags passed to the call are used to filter orders to not include these tags", "default": true, "type": "boolean", "routing": { "send": { "type": "query", "property": "excludeTags", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get List" ] } } }, { "displayName": "POST /api/v1/orders", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shop ID", "name": "shopId", "description": "Deprecated, if orderData.ApiAccountId is set, it will be used instead of 'shopId'", "default": 0, "type": "number", "routing": { "send": { "type": "query", "property": "shopId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Accept Loss Of Return Right", "name": "AcceptLossOfReturnRight", "type": "boolean", "default": true, "description": "Customer accepts loss due to withdrawal", "routing": { "send": { "property": "AcceptLossOfReturnRight", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Adjustment Cost", "name": "AdjustmentCost", "type": "number", "default": 0, "routing": { "send": { "property": "AdjustmentCost", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Adjustment Reason", "name": "AdjustmentReason", "type": "string", "default": "", "routing": { "send": { "property": "AdjustmentReason", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "API Account ID", "name": "ApiAccountId", "type": "number", "default": 0, "description": "Id of the account, this order belongs to", "routing": { "send": { "property": "ApiAccountId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "API Account Name", "name": "ApiAccountName", "type": "string", "default": "", "description": "The name of the account, this order belongs to. Will be ignored on order creation.", "routing": { "send": { "property": "ApiAccountName", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Archived At", "name": "ArchivedAt", "type": "string", "default": "", "description": "If set, the order was already archived at the given date. Further modification is disabled.", "routing": { "send": { "property": "ArchivedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Bill Bee Order ID", "name": "BillBeeOrderId", "type": "number", "default": 0, "description": "The Order.Id from the Billbee database", "routing": { "send": { "property": "BillBeeOrderId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Bill Bee Parent Order ID", "name": "BillBeeParentOrderId", "type": "number", "default": 0, "description": "The Id of the parent order in the Billbee database", "routing": { "send": { "property": "BillBeeParentOrderId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Buyer", "name": "Buyer", "type": "json", "default": "{}", "routing": { "send": { "property": "Buyer", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Comments", "name": "Comments", "type": "json", "default": "[\n {}\n]", "description": "All messages / comments of the order", "routing": { "send": { "property": "Comments", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Confirmed At", "name": "ConfirmedAt", "type": "string", "default": "", "description": "The date on which the order was confirmed", "routing": { "send": { "property": "ConfirmedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Created At", "name": "CreatedAt", "type": "string", "default": "", "description": "The date on which the order was created", "routing": { "send": { "property": "CreatedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Currency", "name": "Currency", "type": "string", "default": "", "description": "The three letter currency code.", "routing": { "send": { "property": "Currency", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Custom Invoice Note", "name": "CustomInvoiceNote", "type": "string", "default": "", "description": "An optional multiline text which is printed on the invoice", "routing": { "send": { "property": "CustomInvoiceNote", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Customer", "name": "Customer", "type": "json", "default": "{\n \"DefaultCommercialMailAddress\": {},\n \"DefaultFax\": {},\n \"DefaultMailAddress\": {},\n \"DefaultPhone1\": {},\n \"DefaultPhone2\": {},\n \"DefaultStatusUpdatesMailAddress\": {},\n \"MetaData\": [\n {}\n ]\n}", "routing": { "send": { "property": "Customer", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Customer Number", "name": "CustomerNumber", "type": "string", "default": "", "description": "The customer number (not to be confused with the id of the customer)", "routing": { "send": { "property": "CustomerNumber", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Customer Vat ID", "name": "CustomerVatId", "type": "string", "default": "", "description": "The vat-id, that was given by the customer to fulfill this order", "routing": { "send": { "property": "CustomerVatId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Delivery Source Country Code", "name": "DeliverySourceCountryCode", "type": "string", "default": "", "description": "An optional Country ISO2 Code of the country where order is shipped from (FBA)", "routing": { "send": { "property": "DeliverySourceCountryCode", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Distribution Center", "name": "DistributionCenter", "type": "string", "default": "", "description": "An optional code for the distribution center delivering this order", "routing": { "send": { "property": "DistributionCenter", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "History", "name": "History", "type": "json", "default": "[\n {}\n]", "routing": { "send": { "property": "History", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "ID", "name": "Id", "type": "string", "default": "", "description": "Id of the order in the external system (marketplace)", "routing": { "send": { "property": "Id", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Invoice Address", "name": "InvoiceAddress", "type": "json", "default": "{}", "routing": { "send": { "property": "InvoiceAddress", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Invoice Date", "name": "InvoiceDate", "type": "string", "default": "", "description": "The date on which the invoice was created", "routing": { "send": { "property": "InvoiceDate", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Invoice Number", "name": "InvoiceNumber", "type": "number", "default": 0, "description": "The invoice number", "routing": { "send": { "property": "InvoiceNumber", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Invoice Number Postfix", "name": "InvoiceNumberPostfix", "type": "string", "default": "", "description": "The postfix of the invoice number", "routing": { "send": { "property": "InvoiceNumberPostfix", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Invoice Number Prefix", "name": "InvoiceNumberPrefix", "type": "string", "default": "", "description": "The prefix of the invoice number", "routing": { "send": { "property": "InvoiceNumberPrefix", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Is Cancelation For", "name": "IsCancelationFor", "type": "string", "default": "", "description": "An optional Order Id (externalid) for an order if this is a cancel order (shopify only at the moment)", "routing": { "send": { "property": "IsCancelationFor", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Is From Billbee API", "name": "IsFromBillbeeApi", "type": "boolean", "default": true, "description": "Indicates whether the order was created through the Billbee-Api or not.", "routing": { "send": { "property": "IsFromBillbeeApi", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Language Code", "name": "LanguageCode", "type": "string", "default": "", "description": "The two-letter language code of the customer", "routing": { "send": { "property": "LanguageCode", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Last Modified At", "name": "LastModifiedAt", "type": "string", "default": "", "description": "Date of the last update, the order got", "routing": { "send": { "property": "LastModifiedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Merchant Vat ID", "name": "MerchantVatId", "type": "string", "default": "", "description": "The vat-id, that should be displayed on the invoice and other order documents", "routing": { "send": { "property": "MerchantVatId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Order Items", "name": "OrderItems", "type": "json", "default": "[\n {\n \"Attributes\": [\n {}\n ],\n \"Product\": {\n \"Images\": [\n {}\n ]\n }\n }\n]", "description": "The list of items purchased like shirt, pant, toys etc", "routing": { "send": { "property": "OrderItems", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Order Number", "name": "OrderNumber", "type": "string", "default": "", "description": "Order number of the order in the external system (marketplace)", "routing": { "send": { "property": "OrderNumber", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Paid Amount", "name": "PaidAmount", "type": "number", "default": 0, "routing": { "send": { "property": "PaidAmount", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payed At", "name": "PayedAt", "type": "string", "default": "", "description": "The date on which the order was paid", "routing": { "send": { "property": "PayedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payment Instruction", "name": "PaymentInstruction", "type": "string", "default": "", "description": "A textfield optionaly filled with a payment instruction text for printout on the invoice (z.B. Ebay Kauf auf Rechnung)", "routing": { "send": { "property": "PaymentInstruction", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payment Method", "name": "PaymentMethod", "type": "options", "default": 1, "description": "The payment method", "options": [ { "name": "1", "value": 1 }, { "name": "2", "value": 2 }, { "name": "3", "value": 3 }, { "name": "4", "value": 4 }, { "name": "6", "value": 6 }, { "name": "19", "value": 19 }, { "name": "20", "value": 20 }, { "name": "21", "value": 21 }, { "name": "22", "value": 22 }, { "name": "23", "value": 23 }, { "name": "24", "value": 24 }, { "name": "25", "value": 25 }, { "name": "26", "value": 26 }, { "name": "27", "value": 27 }, { "name": "28", "value": 28 }, { "name": "29", "value": 29 }, { "name": "30", "value": 30 }, { "name": "31", "value": 31 }, { "name": "32", "value": 32 }, { "name": "33", "value": 33 }, { "name": "34", "value": 34 }, { "name": "35", "value": 35 }, { "name": "36", "value": 36 }, { "name": "37", "value": 37 }, { "name": "38", "value": 38 }, { "name": "39", "value": 39 }, { "name": "40", "value": 40 }, { "name": "41", "value": 41 }, { "name": "42", "value": 42 }, { "name": "43", "value": 43 }, { "name": "44", "value": 44 }, { "name": "45", "value": 45 }, { "name": "46", "value": 46 }, { "name": "47", "value": 47 }, { "name": "48", "value": 48 }, { "name": "49", "value": 49 }, { "name": "50", "value": 50 }, { "name": "51", "value": 51 }, { "name": "52", "value": 52 }, { "name": "53", "value": 53 }, { "name": "54", "value": 54 }, { "name": "55", "value": 55 }, { "name": "56", "value": 56 }, { "name": "57", "value": 57 }, { "name": "58", "value": 58 }, { "name": "59", "value": 59 }, { "name": "60", "value": 60 }, { "name": "61", "value": 61 }, { "name": "62", "value": 62 }, { "name": "63", "value": 63 }, { "name": "64", "value": 64 }, { "name": "65", "value": 65 }, { "name": "66", "value": 66 }, { "name": "67", "value": 67 }, { "name": "68", "value": 68 }, { "name": "69", "value": 69 }, { "name": "70", "value": 70 }, { "name": "71", "value": 71 }, { "name": "72", "value": 72 }, { "name": "73", "value": 73 }, { "name": "74", "value": 74 }, { "name": "75", "value": 75 }, { "name": "76", "value": 76 }, { "name": "77", "value": 77 }, { "name": "78", "value": 78 }, { "name": "79", "value": 79 }, { "name": "80", "value": 80 }, { "name": "81", "value": 81 }, { "name": "82", "value": 82 }, { "name": "83", "value": 83 }, { "name": "84", "value": 84 }, { "name": "85", "value": 85 }, { "name": "86", "value": 86 }, { "name": "87", "value": 87 }, { "name": "88", "value": 88 }, { "name": "89", "value": 89 }, { "name": "90", "value": 90 }, { "name": "91", "value": 91 }, { "name": "92", "value": 92 }, { "name": "93", "value": 93 }, { "name": "94", "value": 94 }, { "name": "95", "value": 95 }, { "name": "96", "value": 96 }, { "name": "97", "value": 97 }, { "name": "98", "value": 98 }, { "name": "99", "value": 99 }, { "name": "100", "value": 100 }, { "name": "101", "value": 101 }, { "name": "102", "value": 102 }, { "name": "103", "value": 103 }, { "name": "104", "value": 104 }, { "name": "105", "value": 105 }, { "name": "106", "value": 106 }, { "name": "107", "value": 107 }, { "name": "108", "value": 108 }, { "name": "109", "value": 109 }, { "name": "110", "value": 110 }, { "name": "111", "value": 111 }, { "name": "112", "value": 112 }, { "name": "113", "value": 113 }, { "name": "114", "value": 114 }, { "name": "115", "value": 115 }, { "name": "116", "value": 116 }, { "name": "117", "value": 117 }, { "name": "118", "value": 118 }, { "name": "119", "value": 119 }, { "name": "120", "value": 120 }, { "name": "121", "value": 121 }, { "name": "122", "value": 122 }, { "name": "123", "value": 123 }, { "name": "124", "value": 124 }, { "name": "125", "value": 125 }, { "name": "126", "value": 126 }, { "name": "127", "value": 127 }, { "name": "128", "value": 128 }, { "name": "129", "value": 129 }, { "name": "130", "value": 130 }, { "name": "131", "value": 131 }, { "name": "132", "value": 132 }, { "name": "133", "value": 133 }, { "name": "134", "value": 134 }, { "name": "135", "value": 135 }, { "name": "136", "value": 136 } ], "routing": { "send": { "property": "PaymentMethod", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payment Reference", "name": "PaymentReference", "type": "string", "default": "", "description": "A payment reference. Should not be used any more. Please use 'Payments' instead.", "routing": { "send": { "property": "PaymentReference", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payment Transaction ID", "name": "PaymentTransactionId", "type": "string", "default": "", "description": "The id of the payment transaction. For example the transaction id of PayPal payment. Should not be used any more. Please use 'Payments' instead.", "routing": { "send": { "property": "PaymentTransactionId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Payments", "name": "Payments", "type": "json", "default": "[\n {}\n]", "routing": { "send": { "property": "Payments", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Rebate Difference", "name": "RebateDifference", "type": "number", "default": 0, "routing": { "send": { "property": "RebateDifference", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Restored At", "name": "RestoredAt", "type": "string", "default": "", "description": "If set, the order was restored from the archive at the given date.", "routing": { "send": { "property": "RestoredAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Seller", "name": "Seller", "type": "json", "default": "{}", "routing": { "send": { "property": "Seller", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Seller Comment", "name": "SellerComment", "type": "string", "default": "", "description": "An internal seller comment", "routing": { "send": { "property": "SellerComment", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Ship Weight Kg", "name": "ShipWeightKg", "type": "number", "default": 0, "description": "The total weight of the shipment(s)", "routing": { "send": { "property": "ShipWeightKg", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipped At", "name": "ShippedAt", "type": "string", "default": "", "description": "The date on which the order was shipped", "routing": { "send": { "property": "ShippedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Address", "name": "ShippingAddress", "type": "json", "default": "{}", "routing": { "send": { "property": "ShippingAddress", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Cost", "name": "ShippingCost", "type": "number", "default": 0, "description": "The shipping cost", "routing": { "send": { "property": "ShippingCost", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Ids", "name": "ShippingIds", "type": "json", "default": "[\n {}\n]", "description": "The shipments of the order", "routing": { "send": { "property": "ShippingIds", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Profile ID", "name": "ShippingProfileId", "type": "string", "default": "", "description": "Internal Id for the shipping profile for that order", "routing": { "send": { "property": "ShippingProfileId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Profile Name", "name": "ShippingProfileName", "type": "string", "default": "", "description": "Display Name of Shipping profile, if available", "routing": { "send": { "property": "ShippingProfileName", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Provider ID", "name": "ShippingProviderId", "type": "number", "default": 0, "description": "Internal Id for the used shipping provider", "routing": { "send": { "property": "ShippingProviderId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Provider Name", "name": "ShippingProviderName", "type": "string", "default": "", "description": "The Name for of used shipping provider", "routing": { "send": { "property": "ShippingProviderName", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Provider Product ID", "name": "ShippingProviderProductId", "type": "number", "default": 0, "description": "Internal Id for the used shipping product", "routing": { "send": { "property": "ShippingProviderProductId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Provider Product Name", "name": "ShippingProviderProductName", "type": "string", "default": "", "description": "The Name of the used shipping product", "routing": { "send": { "property": "ShippingProviderProductName", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Shipping Services", "name": "ShippingServices", "type": "json", "default": "[\n {\n \"PossibleValueLists\": [\n {\n \"value\": [\n {}\n ]\n }\n ]\n }\n]", "description": "Additional services for the shipment", "routing": { "send": { "property": "ShippingServices", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "State", "name": "State", "type": "options", "default": 1, "description": "The current state of the order", "options": [ { "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 } ], "routing": { "send": { "property": "State", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Tags", "name": "Tags", "type": "json", "default": "[\n null\n]", "description": "The Tags of the order", "routing": { "send": { "property": "Tags", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Tax Rate 1", "name": "TaxRate1", "type": "number", "default": 0, "description": "The regular tax rate", "routing": { "send": { "property": "TaxRate1", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Tax Rate 2", "name": "TaxRate2", "type": "number", "default": 0, "description": "The reduced tax rate", "routing": { "send": { "property": "TaxRate2", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Total Cost", "name": "TotalCost", "type": "number", "default": 0, "description": "The total cost excluding shipping cost", "routing": { "send": { "property": "TotalCost", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Updated At", "name": "UpdatedAt", "type": "string", "default": "", "description": "The date on which the order was last updated", "routing": { "send": { "property": "UpdatedAt", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Vat ID", "name": "VatId", "type": "string", "default": "", "description": "The customers vat id", "routing": { "send": { "property": "VatId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "Vat Mode", "name": "VatMode", "type": "options", "default": 0, "description": "The vat mode of the order", "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 } ], "routing": { "send": { "property": "VatMode", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Post New Order" ] } } }, { "displayName": "POST /api/v1/orders/CreateDeliveryNote/{id}", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Delivery Note" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal billbee id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Delivery Note" ] } } }, { "displayName": "Include PDF", "name": "includePdf", "description": "If true, the PDF is included in the response as base64 encoded string", "default": true, "type": "boolean", "routing": { "send": { "type": "query", "property": "includePdf", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Delivery Note" ] } } }, { "displayName": "Send To Cloud ID", "name": "sendToCloudId", "description": "Optionally specify the id of a billbee connected cloud device to send the pdf to", "default": 0, "type": "number", "routing": { "send": { "type": "query", "property": "sendToCloudId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Delivery Note" ] } } }, { "displayName": "POST /api/v1/orders/CreateInvoice/{id}", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Invoice" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal billbee id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Invoice" ] } } }, { "displayName": "Include Invoice PDF", "name": "includeInvoicePdf", "description": "If true, the PDF is included in the response as base64 encoded string", "default": true, "type": "boolean", "routing": { "send": { "type": "query", "property": "includeInvoicePdf", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Invoice" ] } } }, { "displayName": "Template ID", "name": "templateId", "description": "You can pass the id of an invoice template to overwrite the assigned template for invoice creation", "default": 0, "type": "number", "routing": { "send": { "type": "query", "property": "templateId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Invoice" ] } } }, { "displayName": "Send To Cloud ID", "name": "sendToCloudId", "description": "You can pass the id of a connected cloud printer/storage to send the invoice to it", "default": 0, "type": "number", "routing": { "send": { "type": "query", "property": "sendToCloudId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Create Invoice" ] } } }, { "displayName": "GET /api/v1/orders/PatchableFields", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Patchable Fields" ] } } }, { "displayName": "GET /api/v1/orders/findbyextref/{extRef}", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get By Ext Ref" ] } } }, { "displayName": "Ext Ref", "name": "extRef", "required": true, "description": "The extern order number of the order", "default": "", "type": "string", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get By Ext Ref" ] } } }, { "displayName": "GET /api/v1/orders/invoices", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Min Invoice Date", "name": "minInvoiceDate", "description": "Specifies the oldest invoice date to include", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "minInvoiceDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Max Invoice Date", "name": "maxInvoiceDate", "description": "Specifies the newest invoice date to include", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "maxInvoiceDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice 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": [ "Orders" ], "operation": [ "Order API Get Invoice 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": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Shop ID", "name": "shopId", "description": "Specifies a list of shop ids for which invoices should be included", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "shopId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Order State ID", "name": "orderStateId", "description": "Specifies a list of state ids to include in the response", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "orderStateId", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Tag", "name": "tag", "default": "[\n null\n]", "type": "json", "routing": { "send": { "type": "query", "property": "tag", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Min Pay Date", "name": "minPayDate", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "minPayDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Max Pay Date", "name": "maxPayDate", "default": "", "type": "string", "routing": { "send": { "type": "query", "property": "maxPayDate", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Include Positions", "name": "includePositions", "default": true, "type": "boolean", "routing": { "send": { "type": "query", "property": "includePositions", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "Exclude Tags", "name": "excludeTags", "description": "If true the list of tags passed to the call are used to filter orders to not include these tags", "default": true, "type": "boolean", "routing": { "send": { "type": "query", "property": "excludeTags", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get Invoice List" ] } } }, { "displayName": "GET /api/v1/orders/{id}", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal billbee id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get" ] } } }, { "displayName": "Article Title Source", "name": "articleTitleSource", "description": "The source field for the article title. 0 = Order Position (default), 1 = Article Title, 2 = Article Invoice Text", "default": 0, "type": "options", "options": [ { "name": "0", "value": 0 }, { "name": "1", "value": 1 }, { "name": "2", "value": 2 }, { "name": "3", "value": 3 } ], "routing": { "send": { "type": "query", "property": "articleTitleSource", "value": "={{ $value }}", "propertyInDotNotation": false } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Get" ] } } }, { "displayName": "PATCH /api/v1/orders/{id}", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Patch Order" ] } } }, { "displayName": "ID", "name": "id", "required": true, "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Patch Order" ] } } }, { "displayName": "PUT /api/v1/orders/{id}/orderstate", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Update State" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Update State" ] } } }, { "displayName": "New State ID", "name": "NewStateId", "type": "options", "default": 1, "description": "The new state to set", "options": [ { "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 } ], "routing": { "send": { "property": "NewStateId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Update State" ] } } }, { "displayName": "POST /api/v1/orders/{id}/parse-placeholders", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "Is HTML", "name": "IsHtml", "type": "boolean", "default": true, "description": "If true, the string will be handled as html.", "routing": { "send": { "property": "IsHtml", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "Language", "name": "Language", "type": "string", "default": "", "description": "The ISO 639-1 code of the target language. Using default if not set.", "routing": { "send": { "property": "Language", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "Text To Parse", "name": "TextToParse", "type": "string", "default": "", "description": "The text to parse and replace the placeholders in.", "routing": { "send": { "property": "TextToParse", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "Trim", "name": "Trim", "type": "boolean", "default": true, "description": "If true, then the placeholder values are trimmed after usage.", "routing": { "send": { "property": "Trim", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Parse Placeholders" ] } } }, { "displayName": "POST /api/v1/orders/{id}/send-message", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "Alternative Mail", "name": "AlternativeMail", "type": "string", "default": "", "routing": { "send": { "property": "AlternativeMail", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "Body", "name": "Body", "type": "json", "default": "[\n {}\n]", "routing": { "send": { "property": "Body", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "Send Mode", "name": "SendMode", "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": "SendMode", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "Subject", "name": "Subject", "type": "json", "default": "[\n {}\n]", "routing": { "send": { "property": "Subject", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Send Message" ] } } }, { "displayName": "POST /api/v1/orders/{id}/shipment", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal billbee id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Carrier ID", "name": "CarrierId", "type": "number", "default": 0, "description": "Optional the id of a shipping carrier that should be assigend to the shipment\r\nWill override the carrier from the shipment product.\r\nPlease use the integer value from this Enumeration:\r\n{Billbee.Interfaces.Shipping.Enums.ShippingCarrier}", "routing": { "send": { "property": "CarrierId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Comment", "name": "Comment", "type": "string", "default": "", "description": "Optional a text stored with the shipment", "routing": { "send": { "property": "Comment", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Order ID", "name": "OrderId", "type": "string", "default": "", "description": "Optional a differing order number of the shipment if available", "routing": { "send": { "property": "OrderId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Shipment Type", "name": "ShipmentType", "type": "number", "default": 0, "description": "0 if Shipment, 1 if Retoure\r\n{Billbee.Interfaces.Shipping.Enums.ShipmentTypeEnum}", "routing": { "send": { "property": "ShipmentType", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Shipping ID", "name": "ShippingId", "type": "string", "default": "", "description": "The id of the shipment (Sendungsnummer/trackingid)", "routing": { "send": { "property": "ShippingId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Shipping Provider ID", "name": "ShippingProviderId", "type": "number", "default": 0, "description": "Optional the id of a shipping provider existing in the billbee account that should be assigned to the shipment", "routing": { "send": { "property": "ShippingProviderId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "Shipping Provider Product ID", "name": "ShippingProviderProductId", "type": "number", "default": 0, "description": "Optional the id of a shipping provider product that should be assigend to the shipment", "routing": { "send": { "property": "ShippingProviderProductId", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Add Shipment" ] } } }, { "displayName": "POST /api/v1/orders/{id}/tags", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Create" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Create" ] } } }, { "displayName": "Tags", "name": "Tags", "type": "json", "default": "[\n null\n]", "routing": { "send": { "property": "Tags", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Create" ] } } }, { "displayName": "PUT /api/v1/orders/{id}/tags", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Update" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The internal id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Update" ] } } }, { "displayName": "Tags", "name": "Tags", "type": "json", "default": "[\n null\n]", "routing": { "send": { "property": "Tags", "propertyInDotNotation": false, "type": "body", "value": "={{ JSON.parse($value) }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Tags Update" ] } } }, { "displayName": "POST /api/v1/orders/{id}/trigger-event", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Trigger Event" ] } } }, { "displayName": "ID", "name": "id", "required": true, "description": "The id of the order", "default": 0, "type": "number", "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Trigger Event" ] } } }, { "displayName": "Delay In Minutes", "name": "DelayInMinutes", "type": "number", "default": 0, "description": "The delay in minutes until the rule is executed", "routing": { "send": { "property": "DelayInMinutes", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Trigger Event" ] } } }, { "displayName": "Name", "name": "Name", "type": "string", "default": "", "description": "Name of the event", "routing": { "send": { "property": "Name", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "operation": [ "Order API Trigger Event" ] } } }, { "displayName": "POST /api/v1/search", "name": "operation", "type": "notice", "typeOptions": { "theme": "info" }, "default": "", "displayOptions": { "show": { "resource": [ "Orders" ], "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": [ "Orders" ], "operation": [ "Search Search" ] } } }, { "displayName": "Term", "name": "Term", "type": "string", "default": "", "routing": { "send": { "property": "Term", "propertyInDotNotation": false, "type": "body", "value": "={{ $value }}" } }, "displayOptions": { "show": { "resource": [ "Orders" ], "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": [ "Orders" ], "operation": [ "Search Search" ] } } }, ];