Order Management
Handle returns

Returns

POST: {api_url}/api/partner/payments/{purchaseid}/return
Authorization: Bearer {partner_access_token}

The method allows to submit a return or to make a price adjustment of goods purchased by a customer. The call is performed when the returned goods are received by the reseller or if some amount needs to be credited. All items submitted in the return call will be printed as negative invoice rows at the invoice.

NameData TypeDefault valueDescriptionRequired
ItemsCollection of ItemNoneA list of items representing the individual rows on an invoice.True
OrderReferencestringAn empty stringAn ID that identifies the order for which the purchase is to be madeTrue
TranIdstringAn empty stringA random unique ID generated by the calling party identifies the HTTP request. Although the property is not strictly required, we recommend generating a new random GUID and pass it.False
TrackingCodestringAn empty stringGenerated code by the delivery companyFalse
PosIdstringAn empty stringPOS ID is the device number. It is visible on every printout from the POS terminal in the left top corner of the receipt below your contact detaild or on a sticker on the POS terminal.False
{
  "Items": [
    {
      "Description": "Description",
      "Notes": "Notes",
      "Amount": 1
    }
  ],
  "OrderReference": "ue12345",
  "TranId": "123456",
  "TrackingCode": "123456",
  "PosId": "Id123456"
}

Return Value

If successful, the method returns a HTTP status code 204 (OK with no content).