FD1 Sales

Functions relating to complete sales, such as completed sales or sales that have been parked.

These functions are not used to build new sales using individual function calls (create sale, add product, add payment). Interactively building a sale uses the SalesBuilder functions

sales.sale_request

Requests actions to be undertaken on a sale. Actions in this context means things around the whole sale itself, not individual details within the sale

Type	RPC
Links	Handler Logic

Example

POST /fd1/sales/sale_request
{
  "a": "sales.sale_request",
  "v": {
    "sid": 12345,                       // The single Sale# to process against
    "action": "sendorderdispatched"     // What is requested to be done
  }
}

Action Keyword	Description
sendorderdispatched	This sale has been packed for shipment, send the customer an email/notification now if required. This action is mostly used by eCommerce sites to send a message to the customer, often including the courier tracking numbers in that email.

sales.sale_save_new

Takes a complete sale JSON and saves it.