docs
  1. SCAYLE Resource Center
  2. Voyado Add-On
  3. Manage Orders & Transactions

Manage Orders & Transactions

The Voyado Add-on allows you to retrieve order data with all related information such as address, customer, items and etc. Orders have different statuses that depend on the shipping, billing, and items statuses. These statuses help you to track the order progress (ex. confirmed, cancelled).
Order and transaction events are based on the SCAYLE webhook system. If a webhook is received the Add-on proxies this event to Voyado.\

SCAYLE WebhookVoyado Enage API
order-confirmed

POST, /api/v3/orders
and

OrderAction(ConfirmOrder) -> POST, /api/v3/orders/{orderId}/action

order-cancelledPUT, /api/v3/orders/{orderId}
order-item-cancelledPUT, /api/v3/orders/{orderId}
order-item-returnedPUT, /api/v3/orders/{orderId}
order-package-shipped

PUT, /api/v3/orders/{orderId}
and

OrderAction(ConfirmShipment) -> POST /api/v3/orders/{orderId}/action

order-invoicedPOST, /api/v3/receipts (transactions)
order-corrective-invoicedPOST, /api/v3/receipts (transactions)

Voyado Engage differentiates between order and transactions:

  • An order represents items being purchased or returned at the time of the order. This data is dynamic and can be updated multiple times throughout the order's lifecycle.
  • A transaction represents the final exchange of items between the retailer and the customer. Once a transaction is recorded, it remains unchanged.

Both events are used by different Engage modules. For further details we recommend to contact your Voyado Account Manager.

Configure Orders Synchronisation

The Voyado Add-on allows you to handle synchronisation of orders as the Add-on:

  • creates orders and order actions in Voyado, if customers create an order in SCAYLE
  • updates an order in Voyado, if order items are cancelled in SCAYLE
  • updates order in Voyado, if an order item is refunded in SCAYLE
  • updates an order and creates an order action in Voyado, if an SCAYLE order package shipment is shipped

Activate orders

  1. Go to Add-Ons > Voyado Engage Add-On > Orders & Transactions > Orders.
  2. Select the events you want to enable.
  3. Click SAVE.

Order field mappings

For the order synchronisation most of the field mappings are predefined (SCAYLE system fields are mapped to corresponding Vayado system fields). However, you can optionally remove some of the mappings.

  1. Go to Add-Ons > Voyado Add-On > Orders & Transactions > Orders.
  2. In the Order section, click More.
  3. Select the Field Mappings from the dropdown options.
  4. Remove the chosen field (optional).
  5. Click SAVE.

Orders Field Mappings

Configure Transactions Synchronisation

The Voyado Add-on allows you to handle synchronisation of transactions as the Add-on

  • creates a transaction in Voyado, if a SCAYLE order invoiced is created
  • updates a transactions in Voyado, if a SCAYLE corrective order invoiced is created

Activate Transactions

  1. Go to Add-Ons > Voyado Engage Add-On > Orders & Transactions > Transactions.
  2. Select the events you want to enable.
  3. Click SAVE.

Transactions field mappings

For the transaction synchronisation most of the field mappings are predefined (SCAYLE system fields are mapped to corresponding Vayado system fields). However, you can optionally remove some of the mappings.

  1. Go to Add-Ons > Voyado Add-On > Orders & Transactions > Transactions
  2. In the Order section, click More.
  3. Select the Field Mappings from the dropdown options.
  4. Remove the chosen field (optional).
  5. Click SAVE.