get https://{subdomain}.myshoplaza.com/openapi/2024-07/shoplazza-payment/disputes/
Requires
read_financeaccess scope.
The Get Dispute API retrieves the details of a specific dispute object by its unique identifier.
This API is especially useful for:
- Tracking the current status and reason for disputes.
- Accessing dispute details like amounts, fees, and related order IDs.
- Monitoring dispute timelines, including creation and expiration times.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Unique ID of the dispute object. | "1234567890" |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "Success" | Response code indicating the status of the API call. |
message | string | "Success" | Response message providing additional information. |
data | object | Contains the details of the dispute. | |
data.dispute | object | Detailed information about the dispute. | |
data.dispute.id | string | "1234567890" | Unique identifier for the dispute. |
data.dispute.transaction_order_id | string | "order_98765" | Transaction order ID related to the dispute. |
data.dispute.original_order_id | string | "order_12345" | Original order ID related to the dispute. |
data.dispute.store_id | string | "store_56789" | Unique identifier for the store. |
data.dispute.currency | string | "USD" | Currency code of the dispute amount. |
data.dispute.created_at | string | "2024-04-28T12:34:56Z" | Creation time of the dispute in ISO 8601 format. |
data.dispute.updated_at | string | "2024-04-29T15:20:10Z" | Last updated time of the dispute in ISO 8601 format. |
data.dispute.expiration_time | string | "2024-05-05T00:00:00Z" | Expiration time for responding to the dispute. |
data.dispute.dispute_reason | string | "Fraudulent" | Reason provided for the dispute. |
data.dispute.original_order_amount | string | "100.00" | Total amount of the original order. |
data.dispute.dispute_amount | string | "50.00" | Amount of the dispute. |
data.dispute.status | string | "won" | Current status of the dispute. Possible values: won, lost, under_review, etc. |
data.dispute.fee | string | "10.00" | Fees associated with the dispute. |
data.dispute.fee_currency | string | "USD" | Currency of the associated fee. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Description | Example |
|---|---|---|---|
code | string | The error code indicating the type of issue. | InvalidParameter |
message | string | A detailed message describing the error. | wrong cursor |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 500 | ServerError | Id is not found | record not found |