cancelSale

Method allow to cancel selected sale. Sale can be only cancelled when not packed and no document is generated (sale type must be = -1).

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

Query params

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

id | required
integer
Internal identifier of sale.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of sale.","example":null,"required":true,"children":[]}
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":[]}

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":[]}]}

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

{
    "messages": {
        "danger": [
            "You do not have permission to perform this action."
        ]
    }
}

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

<?xml version="1.0" encoding="utf-8"?>
<root>
	<messages>
		<danger>
			<item>You do not have permission to perform this action.</item>
		</danger>
	</messages>
</root>