createSale

Method allows to create order with specific details (in account selected currency).
Make sure you have all your account information set (contact, invoice data, etc.) on the website before submitting your first order!

Usage URL: https://magboss.pl/api/createSale.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)

fkshipmenttype | required
integer
Shipment type internal identifier
{"name":"fkshipmenttype","propertyName":"fkShipmentType","type":{"format":null},"description":"Shipment type internal identifier","example":null,"required":true,"children":[]}
fkpaymenttype | required
integer
Payment type internal identifier
{"name":"fkpaymenttype","propertyName":"fkPaymentType","type":{"format":null},"description":"Payment type internal identifier","example":null,"required":true,"children":[]}
doc_type | required
string
Which document should be assigned to sale. Available: "receipt" or "invoice"
{"name":"doc_type","propertyName":"docType","type":{"format":null},"description":"Which document should be assigned to sale. Available: \"receipt\" or \"invoice\"","example":null,"required":true,"children":[]}
shipment_diff_invoice
boolean (1 = true, 0 = false)
Points whether shipping address is different from client (invoice) address.
If set to yes, you have to fill "shipping" data
This field is mandatory if you are using a drop-shipping client
{"name":"shipment_diff_invoice","propertyName":"shipmentDiffInvoice","type":{"format":"1 = true, 0 = false"},"description":"Points whether shipping address is different from client (invoice) address.\r\nIf set to yes, you have to fill \"shipping\" data\r\nThis field is mandatory if you are using a drop-shipping client<\/b>","example":null,"required":false,"children":[]}
currency
string
Currency symbol. If omitted - account currency will be picked
Example: Three letters format ie: PLN, EUR, USD.
{"name":"currency","propertyName":"currency","type":{"format":null},"description":"Currency symbol. If omitted - account currency will be picked","example":"Three letters format ie: PLN, EUR, USD.","required":false,"children":[]}
is_assembling
boolean (1 = true, 0 = false)
Points whether order is going to be modified or more products added
{"name":"is_assembling","propertyName":"isAssembling","type":{"format":"1 = true, 0 = false"},"description":"Points whether order is going to be modified or more products added","example":null,"required":false,"children":[]}
pickup_point
string
Unique ID of selected pickup point. Required only if fkshipmenttype points at the pickup point delivery type.
This field replaces 6 old separate fields for each pickup point delivery shipment type.
- For Poczta Polska - it's PNI,
- For DHL - it's SAP
{"name":"pickup_point","propertyName":"pickupPoint","type":{"format":null},"description":"Unique ID of selected pickup point. Required only if fkshipmenttype points at the pickup point delivery type.\r\nThis field replaces 6 old separate fields for each pickup point delivery shipment type.\r\n- For Poczta Polska - it's PNI,\r\n- For DHL - it's SAP","example":null,"required":false,"children":[]}
notice
string
Order's notice
{"name":"notice","propertyName":"notice","type":{"format":null},"description":"Order's notice","example":null,"required":false,"children":[]}
products | required
object[]
An array with requested products.
- id | required
  integer
  Product internal ID
  {"name":"id","propertyName":"id","type":{"format":null},"description":"Product internal ID","example":null,"required":true,"children":[]}
- qty | required
  float
  Product quantity you want to order
  {"name":"qty","propertyName":"qty","type":{"format":null},"description":"Product quantity you want to order","example":null,"required":true,"children":[]}
{"name":"products","propertyName":"products","type":{"format":null},"description":"An array with requested products.","example":null,"required":true,"children":[{"name":"id","propertyName":"id","type":{"format":null},"description":"Product internal ID","example":null,"required":true,"children":[]},{"name":"qty","propertyName":"qty","type":{"format":null},"description":"Product quantity you want to order","example":null,"required":true,"children":[]}]}
shipping
object
Array with shipping address - required only if "shipment_diff_invoice" = true
- receiver_name | required
  string
  Receiver's full name / company name
  {"name":"receiver_name","propertyName":"receiverName","type":{"format":null},"description":"Receiver's full name \/ company name","example":null,"required":true,"children":[]}
- postal_code | required
  string
  Receiver's postal code
  {"name":"postal_code","propertyName":"postalCode","type":{"format":null},"description":"Receiver's postal code","example":null,"required":true,"children":[]}
- city | required
  string
  Receiver's city
  {"name":"city","propertyName":"city","type":{"format":null},"description":"Receiver's city","example":null,"required":true,"children":[]}
- street | required
  string
  Receiver's street
  {"name":"street","propertyName":"street","type":{"format":null},"description":"Receiver's street","example":null,"required":true,"children":[]}
- home_number
  string
  Receiver's building number
  {"name":"home_number","propertyName":"homeNumber","type":{"format":null},"description":"Receiver's building number","example":null,"required":false,"children":[]}
- flat_number
  string
  Receiver's flat nummber
  {"name":"flat_number","propertyName":"flatNumber","type":{"format":null},"description":"Receiver's flat nummber","example":null,"required":false,"children":[]}
- phone | required
  string
  Receiver's phone number
  {"name":"phone","propertyName":"phone","type":{"format":null},"description":"Receiver's phone number","example":null,"required":true,"children":[]}
- email | required
  string
  Receiver's email address
  {"name":"email","propertyName":"email","type":{"format":null},"description":"Receiver's email address","example":null,"required":true,"children":[]}
- country | required
  string
  Receiver's country - ISO2 code
  Example: Two letters format ie: DE, PL, GB, US
  {"name":"country","propertyName":"country","type":{"format":null},"description":"Receiver's country - ISO2 code","example":"Two letters format ie: DE, PL, GB, US","required":true,"children":[]}
{"name":"shipping","propertyName":"shipping","type":{"format":null},"description":"Array with shipping address - required only if \"shipment_diff_invoice\" = true","example":null,"required":false,"children":[{"name":"receiver_name","propertyName":"receiverName","type":{"format":null},"description":"Receiver's full name \/ company name","example":null,"required":true,"children":[]},{"name":"postal_code","propertyName":"postalCode","type":{"format":null},"description":"Receiver's postal code","example":null,"required":true,"children":[]},{"name":"city","propertyName":"city","type":{"format":null},"description":"Receiver's city","example":null,"required":true,"children":[]},{"name":"street","propertyName":"street","type":{"format":null},"description":"Receiver's street","example":null,"required":true,"children":[]},{"name":"home_number","propertyName":"homeNumber","type":{"format":null},"description":"Receiver's building number","example":null,"required":false,"children":[]},{"name":"flat_number","propertyName":"flatNumber","type":{"format":null},"description":"Receiver's flat nummber","example":null,"required":false,"children":[]},{"name":"phone","propertyName":"phone","type":{"format":null},"description":"Receiver's phone number","example":null,"required":true,"children":[]},{"name":"email","propertyName":"email","type":{"format":null},"description":"Receiver's email address","example":null,"required":true,"children":[]},{"name":"country","propertyName":"country","type":{"format":null},"description":"Receiver's country - ISO2 code","example":"Two letters format ie: DE, PL, GB, US","required":true,"children":[]}]}
own_label
object
Array with information about supplied own label. Required and processed only if you have selected a valid delivery method. Allows customer to send us their own delivery label for the package (as long as given provider is supported by us). Since 10th November 2022 it is possible to upload multiple files.
To get a valid fkshipmenttype value for this option - please refer to either of those methods: getAvailableDeliveryOptions, getShipmentTypes.
- mode | required
 string
 Allows us to identify which field should be use for file validation. Following values are allowed: pdf, url
 {"name":"mode","propertyName":"mode","type":{"format":null},"description":"Allows us to identify which field should be use for file validation. Following values are allowed: pdf, url","example":null,"required":true,"children":[]}
- provider
 string
 Delivery carrier for given label. Following values are allowed: dpd, dhl, inpost, pocztapolska, ups, orlen, emag, olzalogistic
 {"name":"provider","propertyName":"provider","type":{"format":null},"description":"Delivery carrier for given label. Following values are allowed: dpd, dhl, inpost, pocztapolska, ups, orlen, emag, olzalogistic","example":null,"required":false,"children":[]}
- items
 object[]
 Array with data for each given label
 - url
 string
 URL address which points to your PDF label file. Make sure that given endpoint returns the correct PDF file and has 'Content-Type' header equal to 'application/pdf'. Required if mode = url
 {"name":"url","propertyName":"url","type":{"format":null},"description":"URL address which points to your PDF label file. Make sure that given endpoint returns the correct PDF file and has 'Content-Type' header equal to 'application\/pdf'. Required if mode = url<\/b>","example":null,"required":false,"children":[]}
 - data
 string
 Base64 string with valid PDF inside. Required if mode = pdf
 {"name":"data","propertyName":"data","type":{"format":null},"description":"Base64 string with valid PDF inside. Required if mode = pdf<\/b>","example":null,"required":false,"children":[]}
 - tracking_no | required
 string
 Comma separated tracking numbers from given label. If only one label is passed then put here that one tracking number.
 {"name":"tracking_no","propertyName":"trackingNo","type":{"format":null},"description":"Comma separated tracking numbers from given label. If only one label is passed then put here that one tracking number.","example":null,"required":true,"children":[]}
 {"name":"items","propertyName":"items","type":{"format":null},"description":"Array with data for each given label","example":null,"required":false,"children":[{"name":"url","propertyName":"url","type":{"format":null},"description":"URL address which points to your PDF label file. Make sure that given endpoint returns the correct PDF file and has 'Content-Type' header equal to 'application\/pdf'. Required if mode = url<\/b>","example":null,"required":false,"children":[]},{"name":"data","propertyName":"data","type":{"format":null},"description":"Base64 string with valid PDF inside. Required if mode = pdf<\/b>","example":null,"required":false,"children":[]},{"name":"tracking_no","propertyName":"trackingNo","type":{"format":null},"description":"Comma separated tracking numbers from given label. If only one label is passed then put here that one tracking number.","example":null,"required":true,"children":[]}]}
{"name":"own_label","propertyName":"ownLabel","type":{"format":null},"description":"Array with information about supplied own label. Required and processed only if you have selected a valid delivery method. Allows customer to send us their own delivery label for the package (as long as given provider is supported by us). Since 10th November 2022 it is possible to upload multiple files<\/b>.<br\/>To get a valid fkshipmenttype<\/i> value for this option - please refer to either of those methods: <a href='https:\/\/magboss.pl\/apidocs\/show\/getAvailableDeliveryOptions' target='_blank'>getAvailableDeliveryOptions<\/a>, <a href='https:\/\/magboss.pl\/apidocs\/show\/getShipmentTypes' target='_blank'>getShipmentTypes<\/a>.","example":null,"required":false,"children":[{"name":"mode","propertyName":"mode","type":{"format":null},"description":"Allows us to identify which field should be use for file validation. Following values are allowed: pdf, url","example":null,"required":true,"children":[]},{"name":"provider","propertyName":"provider","type":{"format":null},"description":"Delivery carrier for given label. Following values are allowed: dpd, dhl, inpost, pocztapolska, ups, orlen, emag, olzalogistic","example":null,"required":false,"children":[]},{"name":"items","propertyName":"items","type":{"format":null},"description":"Array with data for each given label","example":null,"required":false,"children":[{"name":"url","propertyName":"url","type":{"format":null},"description":"URL address which points to your PDF label file. Make sure that given endpoint returns the correct PDF file and has 'Content-Type' header equal to 'application\/pdf'. Required if mode = url<\/b>","example":null,"required":false,"children":[]},{"name":"data","propertyName":"data","type":{"format":null},"description":"Base64 string with valid PDF inside. Required if mode = pdf<\/b>","example":null,"required":false,"children":[]},{"name":"tracking_no","propertyName":"trackingNo","type":{"format":null},"description":"Comma separated tracking numbers from given label. If only one label is passed then put here that one tracking number.","example":null,"required":true,"children":[]}]}]}

ids
integer[]
Array with created sales IDs
{"name":"ids","propertyName":"ids","type":{"format":null},"description":"Array with created sales IDs","example":null,"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":[]}]}

fkshipmenttype=34&
fkpaymenttype=5&
notice=This is my notice&
doc_type=invoice&
inpost_box_name=WAW226M&
is_assembling=0&
shipment_diff_invoice=1&
products[0][id]=45356&
products[0][qty]=1&
products[1][id]=47990&
products[1][qty]=1&
shipping[receiver_name]=First and Last Name or Company Name&
shipping[postal_code]=23-456&
shipping[city]=Warsaw&
shipping[street]=Niepodleglosci&
shipping[home_number]=123&
shipping[flat_number]=&
shipping[phone]=+48 999-888-777&
shipping[email]=some-email@provider.com&
shipping[country]=PL&
invoice[vat_id]=DE8975305023&
invoice[regon]=&
invoice[name]=First and Last Name or Company Name&
invoice[firstname]=Test&
invoice[lastname]=Client&
invoice[postal_code]=12-345&
invoice[city]=Testing City&
invoice[street]=Test street&
invoice[home_number]=12&
invoice[flat_number]=34a&
invoice[phone]=+48 123-456-789&
invoice[country]=DE

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

{
    "messages": {
        "danger": [
            "You have unpaid overdue debts"
        ]
    }
}

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

<?xml version="1.0" encoding="utf-8"?>
<root>
	<messages>
		<danger>
			<item>You have unpaid overdue debts</item>
		</danger>
	</messages>
</root>