Skip to content

Returns

POST returns/create

Creates a return of an item

Required scopes: item, order

POST Params

param type/format required sample value description
item integer true 23901909 this is items.id from POST basket/{id}/payment response
quantity integer true 1 quantity of the product to be returned
order integer true 12074725 this is id from POST /basket response
returnToStock boolean true true default true
returnType integer true 0 default "0" currently not sure what are other possible values
NOTE: required fields need to be confirmed

Request

Sample curl

curl -X POST \
  https://app.inventorum.com/api/returns/create/ \
  -H 'Authorization: Bearer {{oauth_token}}' \
  -H 'Content-Type: application/json' \
  -d '{"returnToStock":"true","items":[{"item":1666188,"quantity":1}],"order":9943774,"returnType":"0"}'

Response

Sample response

{
    "basket": 11919887,
    "channel": "ipad",
    "created_at": "2018-08-30T10:38:22.033+02:00",
    "customer": null,
    "date": "30.08.2018 - 10:38",
    "gross": "9.24",
    "id": 152160,
    "order_id": 11919116,
    "payment_method": "0",
    "return_image": "http://app.inventorum.com/uploads/returns/8667/Fashionstore-81.png",
    "return_image_height": 1354,
    "return_image_width": 576,
    "return_items": [
        {
            "id": 244230,
            "name": "Burlington Preston",
            "price": "7.767813007600",
            "product": 6917541,
            "quantity": "1.00",
            "returnmodel": 152160
        }
    ],
    "return_number": "81",
    "return_pdf": "http://app.inventorum.com/uploads/returns/8667/Fashionstore-81.pdf",
    "return_printed": null,
    "total_price": "7.76",
    "transaction_id": "",
    "user": 11031
}