createComplaint

Method allows to create complaint with specific details.

Pictures must be uploaded directly ($_FILES).

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

saleid | required
integer
Internal identifier of sale.
{"name":"saleid","propertyName":"saleId","type":{"format":null},"description":"Internal identifier of sale.","example":null,"required":true,"children":[]}
type | required
integer
Internal identifier of complaint type.
{"name":"type","propertyName":"type","type":{"format":null},"description":"Internal identifier of complaint type.","example":null,"required":true,"children":[]}
productid | required
integer
Internal identifier of product. Required in most cases
{"name":"productid","propertyName":"productId","type":{"format":null},"description":"Internal identifier of product. Required in most cases","example":null,"required":true,"children":[]}
qty | required
float
Quantity of products that complaint is about
{"name":"qty","propertyName":"quantity","type":{"format":null},"description":"Quantity of products that complaint is about","example":null,"required":true,"children":[]}
description | required
string
Description of complaint.
{"name":"description","propertyName":"description","type":{"format":null},"description":"Description of complaint.","example":null,"required":true,"children":[]}
bankaccount | required
string
Bank account number (required for refunds).
{"name":"bankaccount","propertyName":"bankAccount","type":{"format":null},"description":"Bank account number (required for refunds).","example":null,"required":true,"children":[]}
swift | required
string
SWIFT (required for refunds)
{"name":"swift","propertyName":"swift","type":{"format":null},"description":"SWIFT (required for refunds)","example":null,"required":true,"children":[]}
picture1
file upload
File key to upload first picture.
{"name":"picture1","propertyName":"picture1","type":{"format":null},"description":"File key to upload first picture.","example":null,"required":false,"children":[]}
picture2
file upload
File key for upload second picture.
{"name":"picture2","propertyName":"picture2","type":{"format":null},"description":"File key for upload second picture.","example":null,"required":false,"children":[]}
picture3
file upload
File key for upload third picture.
{"name":"picture3","propertyName":"picture3","type":{"format":null},"description":"File key for upload third picture.","example":null,"required":false,"children":[]}
return_address
object
Array with return address - if empty (not specified) data will be taken from sale
- 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 | required
  string
  Receiver's building number
  {"name":"home_number","propertyName":"homeNumber","type":{"format":null},"description":"Receiver's building number","example":null,"required":true,"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":"return_address","propertyName":"returnAddress","type":{"format":null},"description":"Array with return address - if empty (not specified) data will be taken from sale","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":true,"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":[]}]}
delivery
object
Array with delivery details - if empty (not specified) data will be taken from sale
- fkshipmenttype | required
  integer
  Shipment type internal identifier
  {"name":"fkshipmenttype","propertyName":"fkShipmentType","type":{"format":null},"description":"Shipment type internal identifier","example":null,"required":true,"children":[]}
- pickup_point
  string
  Unique ID of selected delivery point. Only required if fkshipmenttype points at pickup point delivery type
  {"name":"pickup_point","propertyName":"pickupPoint","type":{"format":null},"description":"Unique ID of selected delivery point. Only required if fkshipmenttype points at pickup point delivery type","example":null,"required":false,"children":[]}
{"name":"delivery","propertyName":"delivery","type":{"format":null},"description":"Array with delivery details - if empty (not specified) data will be taken from sale","example":null,"required":false,"children":[{"name":"fkshipmenttype","propertyName":"fkShipmentType","type":{"format":null},"description":"Shipment type internal identifier","example":null,"required":true,"children":[]},{"name":"pickup_point","propertyName":"pickupPoint","type":{"format":null},"description":"Unique ID of selected delivery point. Only required if fkshipmenttype points at pickup point delivery type","example":null,"required":false,"children":[]}]}

id
integer
Created complaint ID
{"name":"id","propertyName":"id","type":{"format":null},"description":"Created complaint ID","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":[]}]}

saleid=112087&
type=3&
productid=40161&
qty=1&
description=Not working&
bankaccount=PL 1234 1234 1234 1234 1234 1234&
swift=XYZ12345
-- Keys below are only for visual purposes on what to use for file transfer
picture0
picture1
picture2

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

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