Get Claims

GET

claims

curl --request GET \
  --url https://api.production.orderprotection.com/v1/claims \
  --header 'Authorization: Bearer <token>'

{
  "edges": [
    {
      "node": {
        "id": "cm0b57zjv00myq52xh0c590b8",
        "storeId": "teststore2",
        "orderId": "order_77",
        "sourceOrderId": "llhVsSDgn",
        "sourceOrderNumber": "xtwCvToLXq",
        "authorName": "Desiree Ward II",
        "authorEmail": "Garrison_Wehner88@gmail.com",
        "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": {
    "startCursor": "cm0b57zjv00myq52xh0c590b8",
    "endCursor": "cm0b57zjv00myq52xh0c590b8",
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

first

integer

last

integer

reverse

boolean

before

string

after

string

include

string[]

Response

200

application/json

edges

object[]

required

edges.node

object

required

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:

"Garrison_Wehner88@gmail.com"

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

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

required

edges.node.updatedAt

string

required

edges.node.deletedAt

string | 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

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

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

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

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

Example:

[
  {
    "node": {
      "id": "cm0b57zjv00myq52xh0c590b8",
      "storeId": "teststore2",
      "orderId": "order_77",
      "sourceOrderId": "llhVsSDgn",
      "sourceOrderNumber": "xtwCvToLXq",
      "authorName": "Desiree Ward II",
      "authorEmail": "Garrison_Wehner88@gmail.com",
      "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

Example:

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

Create Claim Get Claims By Order

curl --request GET \
  --url https://api.production.orderprotection.com/v1/claims \
  --header 'Authorization: Bearer <token>'

{
  "edges": [
    {
      "node": {
        "id": "cm0b57zjv00myq52xh0c590b8",
        "storeId": "teststore2",
        "orderId": "order_77",
        "sourceOrderId": "llhVsSDgn",
        "sourceOrderNumber": "xtwCvToLXq",
        "authorName": "Desiree Ward II",
        "authorEmail": "Garrison_Wehner88@gmail.com",
        "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": {
    "startCursor": "cm0b57zjv00myq52xh0c590b8",
    "endCursor": "cm0b57zjv00myq52xh0c590b8",
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

API Documentation

Orders

Fulfillments

Claims

Products

Quote

Tests

Authorizations

Query Parameters

Response