export-to-order-desk

• Last updated on December 29, 2023
• •
• 1 minute to read

This task exports data to the order metadata in the Order Desk system (specifically, to add links to completed artifacts) and uses the Order Desk API.

Parameters

• storeUrl (string) - The API address of the Order Desk system.
• storeId (number) - The ID of the store in the Order Desk system.
• storeApiKey (string) - The API key of the store in the Order Desk system.
• orderLookupId (string) - (optional) The order ID in the e-commerce system used for searching and matching the project in BackOffice and the order in Order Desk. If not specified, ProjectInfo.OrderId will be used.
• orderItemLookupName (string) - The parameter name in the order item metadata in the order for which the updated item will be searched (OrderItem).
• orderItemLookupValue (string) - The key value in the order item metadata in the order for which the updated item will be searched (OrderItem).
• data (object) - The information to be written to the order item metadata. If an item with the same key already exists in the metadata, its value will be updated. If the item is new, it will be created.
  • hiResUrl (hiResUrl2) (string) - Arbitrary parameters that will be uploaded to the metadata as specified in the task. In the following example, two items of the following format will appear in the order item metadata in Order Desk: "hiResUrl": "http://FILELINK" and "hiResUrl2": "http://FILELINK2".

Example

{           
    "description": "Update Metadata in Order Desk",
    "name": "export-to-order-desk",
    "type": "export-to-order-desk",
    "inputArtifacts": [
        "result1",
        "result2"
    ],
    "parameters": {
        "storeUrl": "https://app.orderdesk.me/api/v2/",
        "storeId": 00000,
        "storeApiKey": "XXXXXXX",
        "orderLookupId": "{{project.orderId}}",
        "orderItemLookupValue": "testId",
        "orderItemLookupName": "testIdField",
        "data": {
            "hiResUrl": "{{result1:url?}}",
            "hiResUrl2": "{{result2:url?}}"
        }
    }
}