NewsMAN API: remarketing.saveOrder

Sections

KB Newsman

HomeAPIRemarketingremarketing.saveOrder

Newsman Api Method: remarketing.saveOrder

Prototype: remarketing.saveOrder(list_id, order_details, order_products)

Description: Saves an order for the list that is linked to the website

HTTP method: POST

Endpoint HTTP: /remarketing.saveOrder.json

Endpoint XML-RPC: remarketing.saveOrder

Return type: string

Return info:

Request parameters POST

Variable	Type	Description
list_id	string\|int	The ID of the list linked to the website for which to save the order
order_details	struct\|array	Hash array with order details. Allowed keys are: order_no - the order id from the website. required lastname - the buyer's last name. required firstname - the buyer's first name. required email - the buyer's email address. required phone - the buyer's phone number. required status - the status of the order. optional created_at - the date at which the order was created (YYYY-mm-dd HH:ii:ss). optional discount_code - the discount code used when placing the order, if any. optional discount - the amount / value by which the total amount was reduced, if any. optional shipping - value / amount paid for the shipping (shipping fee). If there is no shipping charge, send value 0. required rebates - value/amount paid for the rebates. optional fees - value/amount paid for the fees. If there is no fees charge, send value 0. required total - amount / total amount of payment for the order sent. Note that this the total amount the buyer actually pays, the amount obtained after applying any discount and/or shipping fee. required currency - the currency in which the sales prices of products are denominated. required
order_products	struct\|array	Indexed array with associative arrays containing ordered products' details. Allowed keys are: id - the product id from the website. required quantity - the quantity ordered for the product. required price - the sale price of the product. required variation_code - variation code of the ordered product. If the product does not have variation will send a empty string (no character string ""). required

Response parameters

Parameter	Description
string	the NewsMAN id of the saved purchase

Output example

11111111

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
101	Not allowed for list_id = %s	Invalid access to list_id
407	Missing required param order_details	order_details param is required
407	Missing required param order_products	order_products param is required
1503	Missing order details param.	param not found in order_details
1504	Missing order products param.	param not found in order_products
1508	List does not have remarketing enabled	List does not have remarketing enabled

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}