Create Return
POST/return
Create a Return Request (/return)
Creates a new return request, the same way as the Új visszaküldés button in the Kvikk app. Use it when a customer asks for a return through your own webshop or customer service instead of the Kvikk return portal.
A return can be created in two ways, exactly one of them is required:
- For an existing shipment: pass the Kvikk
trackingNumberof the original shipment. The customer's name, email, phone, order ID and home address (for home delivery shipments) are copied from the shipment. A shipment can only have one active return. - With customer details: pass a
customerobject, for orders that were not shipped with Kvikk.
Creating the return does not create a shipment or send an email to the customer. Once you've decided what should happen with the return, use Create Return Shipment to generate a return label, an exchange or a new package.
The _id field of the response is the returnID you need for the other return endpoints. returnNumber (e.g. RET-2610-0001) is the human readable identifier shown in the Kvikk app and in customer emails.
Attaching Photos
To attach photos of the returned product, send the request as multipart/form-data instead of JSON: put the same request body, JSON encoded, in a field called data, and add the images as file fields (PNG or JPEG). The photos are returned in the photos array of the return as temporary download links.
Return Reasons
The returnReason.reason field must be one of the following values:
| Reason | Shown as |
|---|---|
dislike | Nem tetszik |
wrong-size | Nem jó a méret |
wrong-color | Nem jó a szín |
faulty | Hibás termék |
wrong-item | Más terméket kaptam |
better-price | Máshol kedvezőbb áron megtaláltam |
color-differs-from-website | A szín eltér a weboldalon látottaktól |
incomplete-delivery | Hiányos a csomag |
not-working-as-expected | Nem úgy működik, ahogy vártam |
bad-fit | Nem megfelelő a szabása |
changed-mind | Meggondoltam magam |
incorrect-quantity-received | Nem a megfelelő mennyiséget kaptam |
package-damaged | A csomag sérülten érkezett |
late-delivery | A termék túl későn érkezett meg |
differs-from-description | A termék eltér a weboldalon szereplő leírástól |
differs-from-picture | A termék eltér a weboldalon látható képtől |
differs-from-website | A termék eltér a weboldalon szereplőtől |
too-large | A termék túl nagy |
too-small | A termék túl kicsi |
right-of-withdrawal | Elállási jog gyakorlása |
warranty | Garancia vagy jótállási igény |
Possible Error Codes
| Error Code | Description |
|---|---|
| validation_error | A field is missing or invalid, e.g. both or neither of trackingNumber and customer were sent, or the return reason is not in the list above. The message names the field. |
| shipment_not_found | No shipment with this trackingNumber exists in your account. |
| return_already_exists | The shipment already has an active return. Delete that one first if you want to create a new one. |
| missing_customer | The customer's name, phone and a valid email are required. |
| invalid_file_type | Only PNG and JPEG photos can be attached. |
| invalid_json | The data field of a multipart/form-data request is not valid JSON. |
Request
Responses
- 200
- 400
- 404
OK
Bad Request
Not Found