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

    Example: en, pl, cs

  • test

    boolean (1 = true, 0 = false)

    Enables a sandbox mode - no data will be written on the server.

POST data

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

  • saleid | required

    integer

    Internal identifier of sale.

  • type | required

    integer

    Internal identifier of complaint type.

  • productid | required

    integer

    Internal identifier of product. Required in most cases

  • qty | required

    float

    Quantity of products that complaint is about

  • description | required

    string

    Description of complaint.

  • bankaccount | required

    string

    Bank account number (required for refunds).

  • swift | required

    string

    SWIFT (required for refunds)

  • picture1

    file upload

    File key to upload first picture.

  • picture2

    file upload

    File key for upload second picture.

  • picture3

    file upload

    File key for upload third picture.

  • return_address

    object

    Array with return address - if empty (not specified) data will be taken from sale

    Nested fields:

    • receiver_name | required

      string

      Receiver's full name / company name

    • postal_code | required

      string

      Receiver's postal code

    • city | required

      string

      Receiver's city

    • street | required

      string

      Receiver's street

    • home_number | required

      string

      Receiver's building number

    • flat_number

      string

      Receiver's flat nummber

    • phone | required

      string

      Receiver's phone number

    • email | required

      string

      Receiver's email address

    • country | required

      string

      Receiver's country - ISO2 code

      Example: Two letters format ie: DE, PL, GB, US

  • delivery

    object

    Array with delivery details - if empty (not specified) data will be taken from sale

    Nested fields:

    • fkshipmenttype | required

      integer

      Shipment type internal identifier

    • pickup_point

      string

      Unique ID of selected delivery point. Only required if fkshipmenttype points at pickup point delivery type

  • id

    integer

    Created complaint ID

  • messages

    object

    Generic success or failure message.
    Click here for more information

    Nested fields:

    • success

      string[]

      List of success messages

    • danger

      string[]

      List of errors, blocks the operation

    • warning

      string[]

      List of warnings, does not block the operation

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