logo
Complaints submitted via the ONe platform can be downloaded and synchronized with an external system

Table of contents

Glossary

Name
Explanation
complaintId
complaint identifier
offset
First index of the result rows
clientId
Client identifier
rows
Rows of the result to fetch
limit
numbers of rows (default: 100)
startId
first index of the result rows

GET complaint

In order to get information about complaint use GET /api/v1/rma/integrations/auth-required/complaint/{complaintId} using specific ID of complaint. The diagram below shows the dependence of communicating with the API:
Image without caption
Use the parameter in query below to get information about specified complaint:
  • complaintId
json
curl -X GET "https://api-preprod.one.unity.pl/api/v1/rma/integrations/auth-required/complaint/6a1becdb-c045-458d-890f-605622998987" -H "accept: */*" -H "one-tenant: {tenant}" -H "ApiAuth: {apiKey}"
In response you will receive information about complaint
Example response:
json
{ "id": "6a1becdb-c045-458d-890f-605622998987", "createDate": "2022-04-04 08:15:20", "userId": "d2aeff60-a715-4b6f-868e-ec8968139c81", "clientId": "org:7fe1fd60-2da4-49c1-a22e-950c630457b6", "number": "103/2022/04/04", "name": "ONe", "email": "admin@b2b.one", "phoneNumber": "607 700 669", "invoiceNumber": "FV/01/03/2022", "reason": "Gwarancja", "notes": "", "items": [ { "positionOnInvoice": 1, "productSku": "signy_41019600", "productName": "ลปarรณwka MASTER LEDspot LV 3.5-20W 827 MR11 24D A+ 2700 K", "quantityOnInvoice": 24, "advertisedQuantity": 1, "unit": "szt" } ] }

GET complaints

In order to get information about all complaints use GET /api/v1/rma/integrations/auth-required/complaints. The diagram below shows the dependence of communicating with the API:
Image without caption
Use the parameter in query below to get information all complaints:
  • clientId- we can narrow down the list to the customer's complaint, but it is not required
  • offset
  • rows
json
curl -X GET "https://api-preprod.one.unity.pl/api/v1/rma/integrations/auth-required/complaints?clientId=org%3A7fe1fd60-2da4-49c1-a22e-950c630457b6&offset=1&rows=1" -H "accept: */*" -H "one-tenant: {tenant}" -H "ApiAuth: {apiKey}"
In response you will receive information about all complaints (in the inquiry, we narrowed down the list to a specific customer and 1 complaint)
Example response:
json
{ "elementsAmount": 79, "elements": [ { "id": "6a1becdb-c045-458d-890f-605622998987", "createDate": "2022-04-04 08:15:20", "userId": "d2aeff60-a715-4b6f-868e-ec8968139c81", "clientId": "org:7fe1fd60-2da4-49c1-a22e-950c630457b6", "number": "103/2022/04/04", "name": "ONe", "email": "admin@b2b.one", "phoneNumber": "607 700 669", "invoiceNumber": "FV/01/03/2022", "reason": "Gwarancja", "notes": "", "items": [ { "positionOnInvoice": 1, "productSku": "signy_41019600", "productName": "ลปarรณwka MASTER LEDspot LV 3.5-20W 827 MR11 24D A+ 2700 K", "quantityOnInvoice": 24, "advertisedQuantity": 1, "unit": "szt" } ] } ] }

GET complaints for synchronization

In order to get information about complaints for synchronization use GET /api/v1/rma/integrations/auth-required/complaints/synchronization. The diagram below shows the dependence of communicating with the API: Use the following query parameters to find the events of the client:
Image without caption
  • limit - is possible to use to narrow down a list, but is not required
  • startId
Example request:
json
curl -X GET "https://api-preprod.one.unity.pl/api/v1/rma/integrations/auth-required/complaints/synchronization?limit=1&startId=1" -H "accept: */*" -H "one-tenant: {tenant}" -H "ApiAuth: {apiKey}"
In response you will receive a information about next step ID along complaint ID and type
Example response:
json
{ "nextId": 2, "events": [ { "complaintId": "91f93d6e-709a-4f81-9172-7b7a8cf17a30", "type": "CREATED" } ] }

Powered by Notaku