Get Claims

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

Show child attributes

filter.authorEmail

string

Example:

"[email protected]"

filter.claimState

enum<string>

Available options:

NEW,

OPEN,

DISMISSED,

DENIED,

APPROVED,

RESOLVED,

ARCHIVED,

COMMUNICATING,

WAITING_FOR_CUSTOMER,

WAITING_FOR_BRAND,

WAITING_FOR_OP,

RESOLVED_BY_BRAND,

TEMPORARILY_DISMISSED,

CLOSED

Example:

"NEW"

first

integer

last

integer

reverse

boolean

before

string

after

string

include

string[]

Response

edges

object[]

required

Show child attributes

edges.node

object

required

Show child attributes

edges.node.id

string

required

Example:

"cm0b57zjv00myq52xh0c590b8"

edges.node.storeId

string

required

Example:

"teststore2"

edges.node.orderId

string

required

Example:

"order_77"

edges.node.sourceOrderId

string

required

Example:

"llhVsSDgn"

edges.node.sourceOrderNumber

string

required

Example:

"xtwCvToLXq"

edges.node.authorName

string

required

Example:

"Desiree Ward II"

edges.node.authorEmail

string

required

Example:

"[email protected]"

edges.node.claimDescription

string

required

Example:

"Cito substantia dignissimos. Adhuc quibusdam capio odio aiunt ante stillicidium aegre. Deorsum cognomen thymbra umquam theca sodalitas."

edges.node.resolutionRequested

string

required

Example:

"RESHIP"

edges.node.resolutionDate

string<date-time>

required

Example:

"2024-08-26T15:18:28.795Z"

edges.node.claimState

object

required

Example:

"APPROVED"

edges.node.claimType

object

required

Example:

"DAMAGED"

edges.node.isOta

boolean

required

edges.node.otaDescription

string

required

Example:

"Pellentesque habitant morbi tristique senectus"

edges.node.externalSource

string

required

Example:

"api"

edges.node.policyId

string

required

Example:

"policy_77"

edges.node.createdAt

string<date-time>

required

edges.node.updatedAt

string<date-time>

required

edges.node.deletedAt

string<date-time> | null

required

edges.node.claimItems

object[]

required

Example:

[
  {
    "id": "cm0b57zjv00myq52xh0c590b8",
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "itemId": "item_77",
    "quantity": 1,
    "createdAt": "2024-08-26T15:18:28.795Z",
    "updatedAt": "2024-08-26T15:18:28.795Z",
    "deletedAt": null
  }
]

edges.node.claimMessages

object[]

required

Show child attributes

edges.node.claimMessages.messageContent

string

required

edges.node.claimMessages.senderName

string

required

edges.node.claimMessages.senderType

enum<string>

required

Available options:

customer,

brand,

admin,

automatic,

system

edges.node.claimMessages.senderId

object

required

edges.node.claimMessages.createdAt

string<date-time>

required

edges.node.claimMessages.updatedAt

object

required

edges.node.claimMessages.deletedAt

object

required

edges.node.claimMessages.htmlBody

object

required

edges.node.claimMessages.medias

object

required

Show child attributes

edges.node.claimMessages.medias.claimMessageId

string

required

edges.node.claimMessages.medias.fileKey

string

required

edges.node.claimMessages.medias.fileType

string

required

edges.node.claimMessages.medias.filename

string

required

edges.node.claimMessages.medias.downloadLink

string

required

edges.node.claimMessages.medias.url

string

required

edges.node.claimMessages.medias.caption

string

required

edges.node.claimMessages.medias.createdAt

string<date-time>

required

edges.node.claimMessages.medias.updatedAt

object

required

edges.node.claimMessages.medias.deletedAt

object

required

Example:

[
  {
    "senderType": "customer",
    "id": "cm0b57zjv00myq52xh0c590b8",
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "message": "Dolorum quidem quod. Deorsum cognomen thymbra umquam theca sodalitas.",
    "authorName": "Desiree Ward II",
    "medias": []
  },
  {
    "senderType": "brand",
    "id": "cm0b57zjv00myq52xh0c590b8",
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "message": "We are sorry for the inconvenience. We will process your refund as soon as possible.",
    "authorName": "Sarah",
    "medias": []
  }
]

edges.node.claimResolutions

object[]

required

Show child attributes

edges.node.claimResolutions.id

string

required

edges.node.claimResolutions.claimId

string

required

edges.node.claimResolutions.userId

string

required

edges.node.claimResolutions.resolutionType

enum<string>

required

Available options:

RESHIP,

REPLACEMENT,

REFUND,

FLAT_RATE,

CUSTOM,

EXPIRED30,

EXCHANGE,

CREDIT,

STORE_CREDIT,

RETURN,

OTHER,

NO_RESPONSE,

PACKAGE_ARRIVED,

CUSTOMER_RESPONDED,

FOLLOW_UP,

INSUFFICIENT_SHIPPER,

RETURN_TO_SENDER,

NOT_COVERED,

ADRESS_TYPO,

PHOTO_VERIFIED,

THRESHOLD_REACHED,

ADDRESS_TYPO,

ALREADY_REFUNDED,

ALREADY_REPLACED,

POTENTIAL_FRAUD

edges.node.claimResolutions.resolutionDetails

string

required

edges.node.claimResolutions.paidValue

number

required

edges.node.claimResolutions.paidCurrency

string

required

edges.node.claimResolutions.paidOriginalValue

number

required

edges.node.claimResolutions.includeShipping

boolean

required

edges.node.claimResolutions.shippingAmount

number

required

edges.node.claimResolutions.user

object

required

edges.node.claimResolutions.creditStore

boolean

required

edges.node.claimResolutions.createdAt

string<date-time>

required

edges.node.claimResolutions.updatedAt

object

required

edges.node.claimResolutions.deletedAt

object

required

Example:

[
  {
    "id": "cm0b57zjv00myq52xh0c590b8",
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "userId": "user_77",
    "resolutionType": "STORE_CREDIT",
    "resolutionDetails": "Dolorum quidem quod. Deorsum cognomen thymbra umquam theca sodalitas.",
    "paidValue": 100,
    "paidCurrency": "USD",
    "paidOriginalValue": 100,
    "includeShipping": true,
    "shippingAmount": 100,
    "creditStore": true,
    "createdAt": "2024-08-26T15:18:28.795Z",
    "updatedAt": "2024-08-26T15:18:28.795Z",
    "deletedAt": null
  }
]

edges.node.claimStoreCredits

object[]

required

Show child attributes

edges.node.claimStoreCredits.id

string

required

edges.node.claimStoreCredits.claimId

string

required

edges.node.claimStoreCredits.type

enum<string>

required

Available options:

GIFT_CARD,

DISCOUNT_CODE

edges.node.claimStoreCredits.code

string

required

edges.node.claimStoreCredits.emailStatus

string

required

edges.node.claimStoreCredits.emailTime

string<date-time>

required

edges.node.claimStoreCredits.creditValue

number

required

edges.node.claimStoreCredits.bonusValue

number

required

edges.node.claimStoreCredits.totalValue

number

required

edges.node.claimStoreCredits.bonus

number

required

edges.node.claimStoreCredits.bonusType

object

required

edges.node.claimStoreCredits.creditCurrency

string

required

edges.node.claimStoreCredits.exchangeRate

number

required

edges.node.claimStoreCredits.claim

object

required

edges.node.claimStoreCredits.createdAt

string<date-time>

required

edges.node.claimStoreCredits.updatedAt

object

required

edges.node.claimStoreCredits.deletedAt

object

required

Example:

[
  {
    "code": "cm0b57zjv00myq52xh0c590b8",
    "emailStatus": "SENT",
    "emailTime": "2024-08-26T15:18:28.795Z",
    "creditValue": 100,
    "bonusValue": 0,
    "totalValue": 100,
    "bonus": 0,
    "bonusType": "NONE",
    "creditCurrency": "USD",
    "exchangeRate": 1,
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "createdAt": "2024-08-26T15:18:28.795Z",
    "updatedAt": "2024-08-26T15:18:28.795Z",
    "deletedAt": null
  }
]

edges.node.claimDocuments

object[]

required

Show child attributes

edges.node.claimDocuments.id

string

required

edges.node.claimDocuments.url

string

required

edges.node.claimDocuments.claimId

string

required

edges.node.claimDocuments.documentType

object

required

edges.node.claimDocuments.createdAt

object

required

edges.node.claimDocuments.updatedAt

object

required

edges.node.claimDocuments.deletedAt

object

required

Example:

[
  {
    "id": "cm0b57zjv00myq52xh0c590b8",
    "claimId": "cm0b57zjv00myq52xh0c590b8",
    "url": "https://storage.cloud.google.com/image.png",
    "documentType": "SIGNATURE",
    "createdAt": "2024-08-26T15:18:28.795Z",
    "updatedAt": "2024-08-26T15:18:28.795Z",
    "deletedAt": "2024-08-26T15:18:28.795Z"
  }
]

edges.node.policy

object

required

Show child attributes

edges.node.policy.id

string

required

Example:

"policy_77"

edges.node.policy.customerAmount

number

required

edges.node.policy.brandAmount

number

required

edges.node.policy.insuredAmount

number

required

edges.node.policy.premiumPaid

number

required

edges.node.policy.premiumDiscountedAmount

number

required

edges.node.policy.premiumCurrency

string

required

Example:

"USD"

edges.node.policy.fundedBy

string

required

Example:

"customer"

edges.node.policy.claim

object

required

edges.node.policy.createdAt

string<date-time>

required

edges.node.policy.updatedAt

string<date-time>

required

edges.node.policy.removedAt

string<date-time> | null

required

edges.node.policy.deletedAt

string<date-time> | null

required

edges.node.policy.hybridOperator

enum<string>

required

Available options:

AND,

OR

Example:

[
  {
    "node": {
      "id": "cm0b57zjv00myq52xh0c590b8",
      "storeId": "teststore2",
      "orderId": "order_77",
      "sourceOrderId": "llhVsSDgn",
      "sourceOrderNumber": "xtwCvToLXq",
      "authorName": "Desiree Ward II",
      "authorEmail": "[email protected]",
      "claimDescription": "Cito substantia dignissimos. Adhuc quibusdam capio odio aiunt ante stillicidium aegre. Deorsum cognomen thymbra umquam theca sodalitas.",
      "claimState": "APPROVED",
      "isOta": false,
      "otaDescription": null,
      "externalSource": "api",
      "claimType": null,
      "createdAt": "2024-08-26T15:18:28.795Z",
      "updatedAt": "2024-08-26T15:18:28.795Z",
      "deletedAt": null,
      "policyId": "policy_77",
      "claimResolutions": [
        {
          "id": "cm0b57zjv00myq52xh0c590b8",
          "claimId": "cm0b57zjv00myq52xh0c590b8",
          "resolution": "REFUND",
          "claimState": "APPROVED",
          "createdAt": "2024-08-26T15:18:28.795Z",
          "updatedAt": "2024-08-26T15:18:28.795Z",
          "deletedAt": null
        }
      ],
      "claimItems": [
        {
          "id": "cm0b57zjv00myq52xh0c590b8",
          "claimId": "cm0b57zjv00myq52xh0c590b8",
          "itemId": "item_77",
          "quantity": 1,
          "createdAt": "2024-08-26T15:18:28.795Z",
          "updatedAt": "2024-08-26T15:18:28.795Z",
          "deletedAt": null
        }
      ],
      "claimMessages": [
        {
          "id": "cm0b57zjv00myq52xh0c590b8",
          "claimId": "cm0b57zjv00myq52xh0c590b8",
          "message": "Dolorum quidem quod. Deorsum cognomen thymbra umquam theca sodalitas.",
          "authorName": "Desiree Ward II",
          "medias": []
        }
      ]
    }
  }
]

pageInfo

object

required

Show child attributes

pageInfo.startCursor

string

required

Example:

"cm0b57zjv00myq52xh0c590b8"

pageInfo.endCursor

string

required

Example:

"cm0b57zjv00myq52xh0c590b8"

pageInfo.hasNextPage

boolean

required

Example:

false

pageInfo.hasPreviousPage

boolean

required

Example:

false

Example:

{
  "startCursor": "cm0b57zjv00myq52xh0c590b8",
  "endCursor": "cm0b57zjv00myq52xh0c590b8",
  "hasNextPage": false,
  "hasPreviousPage": false
}

API Documentation

Orders

Fulfillments

Claims

Metadata

Products

Quote

Tests

Authorizations

Query Parameters

Response