List Claims

GET

/admin/claims

Retrieve a list of claims. The claims can be filtered by fields such as id. The claims can also be sorted or paginated.

Response Example

200 - Example 1

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","",""]

$eq

array[string]

optional

Example:

["","",""]

$not

array[string]

optional

Example:

["","",""]

string

optional

The claim's q.

optional

One of

array[string]

The claim's ID.

order_id

optional

One of

order_id

array[string]

The claim's order id.

status

optional

One of

status

array[string]

The claim's status.

Responses

🟢200OK

application/json

Body

The paginated list of claims.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

claims

array[object (AdminClaim) {20}]

required

The list of claims.

return

object (AdminReturn)

required

The return's details.

order

object (AdminOrder)

required

The order's details.

string

required

The claim's ID.

order_id

string

order_id

required

The ID of the order associated with the claim.

claim_items

array[object (BaseClaimItem) {10}]

required

The order items targetted by the claim.

additional_items

array[object (BaseClaimItem) {10}]

required

The outbound or new items of the claim.

return_id

string

return_id

optional

The ID of the associated return.

no_notification

boolean

no_notification

optional

Whether the customer should be notified about changes in the claim.

refund_amount

number

refund_amount

optional

The amount to be refunded.

display_id

number

display_id

required

The claim's display ID.

shipping_methods

array[object (AdminOrderShippingMethod) {22}]

optional

The claim's shipping methods.

metadata

object

optional

The claim's metadata, used to store custom key-value pairs.

created_at

string <date-time>

created_at

required

The claim's creation date.

updated_at

string <date-time>

updated_at

required

The claim's update date.

order_version

string

order_version

required

The version of the order when the claim is applied.

created_by

string

created_by

optional

The ID of the user that created the claim.

canceled_at

string <date-time>

canceled_at

required

The date the claim was canceled.

deleted_at

string <date-time>

deleted_at

optional

The date the claim was deleted.

transactions

array[object (BaseOrderTransaction) {9}]

optional

The claim's transactions.

type

enum<string>

required

The claim's type.

Allowed values:

replacerefund

estimate_count

number

estimate_count

optional

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create a Claim

Get a Currency