addProductsToSale

Method allows to add products order to specific sale.

Usage URL: https://magboss.pl/api/addProductsToSale.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}
test
boolean (1 = true, 0 = false)
Enables a sandbox mode - no data will be written on the server.
{"name":"test","propertyName":"test","type":{"format":"1 = true, 0 = false"},"description":"Enables a sandbox mode - no data will be written on the server.","example":null,"required":false,"children":[]}

POST data

(if any - change request to POST, put those in as form-data)

id | required
integer
Sale ID
{"name":"id","propertyName":"id","type":{"format":null},"description":"Sale ID","example":null,"required":true,"children":[]}
products | required
object[]
Array with products IDs and quantities
- id | required
  integer
  Product ID
  {"name":"id","propertyName":"id","type":{"format":null},"description":"Product ID","example":null,"required":true,"children":[]}
- qty | required
  float
  Quantity
  {"name":"qty","propertyName":"qty","type":{"format":null},"description":"Quantity","example":null,"required":true,"children":[]}
{"name":"products","propertyName":"products","type":{"format":null},"description":"Array with products IDs and quantities","example":null,"required":true,"children":[{"name":"id","propertyName":"id","type":{"format":null},"description":"Product ID","example":null,"required":true,"children":[]},{"name":"qty","propertyName":"qty","type":{"format":null},"description":"Quantity","example":null,"required":true,"children":[]}]}

messages
object
Generic success or failure message.
Click here for more information
- success
  string[]
  List of success messages
  {"name":"success","propertyName":"success","type":{"format":null},"description":"List of success messages","example":null,"required":false,"children":[]}
- danger
  string[]
  List of errors, blocks the operation
  {"name":"danger","propertyName":"danger","type":{"format":null},"description":"List of errors, blocks the operation","example":null,"required":false,"children":[]}
- warning
  string[]
  List of warnings, does not block the operation
  {"name":"warning","propertyName":"warning","type":{"format":null},"description":"List of warnings, does not block the operation","example":null,"required":false,"children":[]}
{"name":"messages","propertyName":"messages","type":{"format":null},"description":"Generic success or failure message.\n<a href=\"https:\/\/magboss.pl\/apidocs\/methods#generic-examples\" target='_blank'>Click here for more information<\/a>","example":null,"required":false,"children":[{"name":"success","propertyName":"success","type":{"format":null},"description":"List of success messages","example":null,"required":false,"children":[]},{"name":"danger","propertyName":"danger","type":{"format":null},"description":"List of errors, blocks the operation","example":null,"required":false,"children":[]},{"name":"warning","propertyName":"warning","type":{"format":null},"description":"List of warnings, does not block the operation","example":null,"required":false,"children":[]}]}

id=112087&
products[0][id]=45356&
products[0][qty]=1&
products[1][id]=47990&
products[1][qty]=1

Example URL: https://magboss.pl/api/addProductsToSale.json?key=YOURAPIKEY&lang=en

{
    "messages": {
        "success": [
            "Products have been successfully merged with selected sale."
        ]
    }
}

Example URL: https://magboss.pl/api/addProductsToSale.xml?key=YOURAPIKEY&lang=en

<?xml version="1.0" encoding="utf-8"?>
<root>
	<messages>
		<success>
			<item>Products have been successfully merged with selected sale.</item>
		</success>
	</messages>
</root>