Create order dispute

This endpoint allows you to create a dispute to an order, you need to reference the order with the order identifier, add the title and description of the dispute and optionally you can add attachments as part of the dispute definition.

This service will give as a response to the change of status of the order and the identifier of the dispute created.

💡 Remember that you must use the previously generated Bearer Token Access Token

ENDPOINT

POST  https://api.zenki.fi/v1/api/disputes

Headers
- Accept: application/json
- Authorization: Bearer Tokens
Authorization [Bearer Token]
- Token: (token)
Body [form-data]
- orderId : (string | required)
- title : (string)| required)
- description : (string)| required)
- attachments : (multipart )
Response attributes
- orderId: (string)
- status: (string)
- dispute: (object)
  - disputeId: (string)
  - OrderDisputeEnum: (string)

cURL

1
2
3
4
5
6
7
8
9


curl --request POST \
     --url https://api.zenki.fi/v1/api/disputes \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwenJMTnEwbzBab1R4NTlaeWVPaTI1RGxZLWl6cV91SVFSLThWS0RaWjlFIn0.eyJleHAiOjE2NjE3OTg0NDgsImlhdCI6MTY2MTc5NjY0OCwianRpIjoiOWNlZjIwNjItYTc1OS00NzllLWJlYTctZDQ1NzRiYWIzYzM5IiwiaXNzIjoiaHR0cHM6Ly9kZXYtYXV0aC56ZW5raS5maS9hdXRoL3JlYWxtcy9wYnciLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZWQ3ZWQ1ZmMtZjBmNy00OWEwLWEwNWYtNWNiZTFkMjZkYTlkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiemVua2ktcGF5Iiwic2Vzc2lvbl9zdGF0ZSI6IjdiOGJmOWQ5LWE5MjEtNDEzYi1hZTU5LWU4ODMwMDViMmViZCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJhcGkiLCJhcGlfemVua2lwYXkiLCJkZWZhdWx0LXJvbGVzLW1ldGFiYW4iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6InByb2ZpbGUgZW1haWwiLCJzaWQiOiI3YjhiZjlkOS1hOTIxLTQxM2ItYWU1OS1lODgzMDA1YjJlYmQiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IlJlYWwgTWFkcmlkIEZDIFJlYWwgTWFkcmlkIEZDIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiOGRjNDY5YTFkZTRiNDI3NTljMDdjNGYyYmQ2YzAzZjQiLCJnaXZlbl9uYW1lIjoiUmVhbCBNYWRyaWQgRkMiLCJsb2NhbGUiOiJlbiIsImZhbWlseV9uYW1lIjoiUmVhbCBNYWRyaWQgRkMiLCJlbWFpbCI6IjhkYzQ2OWExZGU0YjQyNzU5YzA3YzRmMmJkNmMwM2Y0In0.NxCesCEovDZoTXeLJqOnFdPPZ6WflbBdlokqcehmxRraGFxGQDsrVZTdvPa9JyaK86F4RzHBElZrGBbrKOgACxMXJHj-kbftxD3GCbvJIjtN1eTefhQE8q7D27wAKGMAMmRNKbGZ0mGiEpLDODQkNrcue6f3SnQv3ed4A7AeqfzxH02BrZpTHuq3ZL4_3JtlL5OvRcBQ8hA7pnnDA5ukSlcfuztnNzxkd7o3ktM1Wclni4RKtl_Flu4Du2FaFU9sub7LPJMb_BlHmXphWUNOe5JF_csncvPK-6O0qYokMUWlxi48O2y8fNkC0kWlUZHqEjm2PT7QeHW3oq515kV3Vg' \
     --header 'Content-Type: multipart/form-data' \
     --form 'attachments=@"/Users/attachments/evidence.png"' \
     --form 'title="Dispute title"' \
     --form 'description="Dispute definition"' \
     --form 'orderId="0d3d7224373f40d4bf02051b423de80q"'

Response

1
2
3
4
5
6
7
8


{
    "orderId": "0d3d7224373f40d4bf02051b423de80q",
    "status": "DISPUTED",
    "dispute": {
            "disputeId": "cnv_r30o68c",
            "OrderDisputeEnum": "OPEN"
             }
}

Errors

Code	Description	json
401	The request has not been executed because it lacks valid authentication credentials for the requested resource.	Unauthorized