change-group-in-order-desk

• Last updated on December 29, 2023
• •
• Less than a minute to read

This task changes the folder for an order in the Order Desk system. It moves the entire order to the folder specified in the destinationGroupName parameter.

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, Project.OrderId will be used.
• destinationGroupName (string) - (optional) The name of the folder where the order needs to be moved. The folder must already exist in the Order Desk system. If not specified, the order will be moved to the Prepared folder.

Example

{
    "description": "Move order in order desk to new folder",
    "name": "change-group-in-order-desk",
    "type": "change-group-in-order-desk",
    "inputArtifacts": [
        "result*"
    ],
    "parameters": {
        "storeUrl": "https://app.orderdesk.me/api/v2/",
        "storeId": 00000,
        "storeApiKey": "XXXXX",
        "orderLookupId": "{{project.orderId}}",
        "destinationGroupName": "Rendered"
    }
}