Skip to main content

Multicase - Send order

Multicase - SendOrderToBackoffice This document describes the process of sending an order from App4Sales to the Multicase backoffice. The ...

Updated over a week ago

Multicase - SendOrderToBackoffice

This document describes the process of sending an order from App4Sales to the Multicase backoffice. The process involves transforming the App4Sales order into the Multicase format and sending it to the Multicase API.

Data Source Configuration

The connector sends the order data to the following endpoint:

  • URL: The base URL is configured in the connector settings.

  • Endpoint: /orders/create

  • HTTP Method: POST

Data Mapping Table

The following tables describe the mapping of fields from the App4Sales order to the Multicase order.

Order Header

App4Sales Field

Source Field (API/Excel/DB)

Logic/Notes

OrderTypeID

Order.OrderType.ValueToBackoffice

The order type ID. Defaults to 1 (Sales order) if not provided.

ExtraInfoXML

Order.CurrentOrderXml

The XML representation of the App4Sales order.

OrderReference

Order.YourReference

The customer's reference for the order. Defaults to an empty string if not provided.

ReferencePerson

Order.Customer.MainContactPerson.FullName

The name of the contact person for the order. Defaults to an empty string if not provided.

ExternalOrderNumber

Order.OrderID

The App4Sales order ID.

CurrencyID

Order.Customer.Currency

The currency ID for the order. Defaults to the value of the Default currency id which is used for order create setting if not provided.

UserID

ConnectorSettings.DefaultUserId

The user ID for the order. This is a hardcoded value from the Default user id for administration setting.

PaymentTermID

Order.Customer.PaymentConditionCode

The payment term ID for the order. Defaults to the value of the Default payment term id which is used for order create setting if not provided.

WarehouseID

ConnectorSettings.DefaultWarehouseIdForOrder

The warehouse ID for the order. This is a hardcoded value from the Default warehouse id which is used for creating orders setting.

Freight.FreightId

Order.Customer.DeliveryMethod

The freight ID for the order. Defaults to the value of the Default freight id for order create setting if not provided.

UseMCPrice

ConnectorSettings.UseMulticasePricesInOrder

A boolean value indicating whether to use Multicase prices in the order. This is a hardcoded value from the Use Multicase prices in order setting.

WebServiceID

ConnectorSettings.DefaultWebServiceId

The web service ID for the order. This is a hardcoded value from the Default Web service ID (default 1) setting.

CustomerID

Order.Customer.InternalCode

The internal code of the customer.

Address

Order.AlternateAddress or Order.Customer.Addresses

The delivery address for the order. If an alternate address is provided, it is used. Otherwise, the customer's default delivery address is used.

Messages.SalesInformation

Order.Notes

The notes for the order.

Order Lines

App4Sales Field

Source Field (API/Excel/DB)

Logic/Notes

Amount

OrderLine.Quantity

The quantity of the item ordered.

ProductID

OrderLine.Item.InternalItemCode

The internal item code of the item ordered.

UnitPrice

OrderLine.Price

The price of the item ordered.

PosNo

OrderLine.LineNumber

The line number of the order line.

WarehouseID

ConnectorSettings.DefaultWarehouseIdForOrder

The warehouse ID for the order line. This is a hardcoded value from the Default warehouse id which is used for creating orders setting.

DeliveryDate

OrderLine.DeliveryDate or Order.OrderDate

The delivery date for the order line. If a delivery date is provided for the line, it is used. Otherwise, the order date is used.

Related Settings & Prerequisites

The following connector settings are used in the SendOrderToBackoffice process:

  • Default currency id which is used for order create: The default currency ID to use for orders if the customer does not have a currency specified.

  • Default payment term id which is used for order create: The default payment term ID to use for orders if the customer does not have a payment condition specified.

  • Default warehouse id which is used for creating orders: The default warehouse ID to use for orders.

  • Default freight id for order create: The default freight ID to use for orders if the customer does not have a delivery method specified.

  • Use Multicase prices in order: A boolean value indicating whether to use Multicase prices in the order.

  • Default Web service ID (default 1): The default web service ID to use for orders.

  • Default user id for administration: The user ID to use for orders.

Responses & Error Handling

The connector expects a response from the Multicase API containing the created order number. If a valid order number is received, the App4Sales order is updated with this number. If no order number is received, or if an error occurs during the process, an error is logged and a generic error message is returned to the user.

Did this answer your question?