Skip to main content

List claims​

Retrieve a list of claims (returns/exchanges) for the authenticated store.

Query Parameters
  • customerEmail string

    The email address of the customer to filter claims by.

  • externalId string

    The external ID of the claim to filter by.

  • after string

    Cursor for forward pagination. Pass the endCursor from a previous response to fetch the next page.

  • before string

    Cursor for backward pagination. Pass the startCursor from a previous response to fetch the previous page.

  • first number

    Number of items to return when paginating forward (used with after). Defaults to 50.

  • last number

    Number of items to return when paginating backward (used with before).

  • orderBy string

    Possible values: [asc, desc]

    Sort order for results. Defaults to descending.

Responses

OK

Schema
  • claims object[] required
  • Array [
  • storeId number required

    The Corso ID of the store that the claim belongs to.

  • claimId number required

    The Corso ID of the claim.

  • externalId string required

    The external claim ID, used for customer-facing references.

  • resolutionSummary object

    The resolution summary of the claim, consists of what was actually issued when the claim was finalized.

  • giftCards object[] required
  • Array [
  • giftCardId number required

    The Corso ID of the gift card.

  • amount currency required

    The amount of the gift card.

  • createdOn date-time

    The date/time when the gift card was created.

  • ]
  • refunds object[] required
  • Array [
  • refundId number required

    The Corso ID of the refund.

  • amount currency required

    The amount of the refund.

  • createdOn date-time

    The date/time when the refund was created.

  • ]
  • replacementOrders object[] required
  • Array [
  • orderId number

    The ID of the order in Corso, used to interact with Corso systems.

  • sourceOrderId string required

    The order identifier from the source platform. Is unique across the store, and typically across the entire platform used by the merchant.

  • orderNumber string

    The order number from the source platform, if none is provided. sourceOrderId will be used

  • createdOn date-time

    Date/time when the order was created in Corso systems.

  • orderName string

    Customer-facing identifier for the order the source platform. Often composed of the store-unique order number plus some modifying prefixes and suffixes.

  • lineItems object[] required
  • Array [
  • lineItemId number required

    The ID of the line item in Corso systems.

  • sourceLineItemId string required

    The line item ID (from the source system).

  • productId string

    The product ID for the line item (from the source system).

  • variantId string

    The variant ID for the line item (from the source system). For the line item that represents the Corso Green Shipping Product (if purchased on the order), this should match the corresponding variant ID stored by Corso in our system, so that we can identify the order as protected.

  • sku string required

    The SKU of product/variant of the line item.

  • name string required

    The line item name, typically the value shown to the customer representing the product/variant combination purchased.

  • quantity number required

    The quantity purchased for the line item.

  • imgUrl string

    URL of the product image, if available.

  • ]
  • ]
  • wasCreatedFromRegistration boolean required

    Whether the claim was created from a registration order.

  • requestSummary object

    A snapshot of the current estimate of what will be issued when the claim is finalized. This represents the pending state of approvals and resolutions. This property does not exist after the claim is finalized, please use Resolution Summary instead.

  • monetaryTotals object required
  • giftCard currency required

    The total amount of gift cards in the request summary.

  • refund currency required

    The total amount of refunds set to be approved when the claim is finalized.

  • approvedLineItems object[] required

    The line items set to be approved when the claim is finalized.

  • Array [
  • claimLineItemId number required

    The Corso ID of the claim line item.

  • quantity number required

    The quantity of items in this claim line item.

  • amount currency required

    The issued monetary value of this claim line item in the store currency.

  • resolutionMethod string

    Possible values: [Refund, Variant_Exchange, Gift_Card, Repair, Replacement_Order, Warranty_Review, Other]

    The resolution method of the line item, may be different from the requested resolution method if the claim line item value was applied to a replacement order or other deduction.

  • estimatedAmount currency

    The estimated amount of the line item, accounting for deductions across all line items.

  • wasZeroedThroughDeduction boolean

    Whether the line item was zeroed through deduction, applies to claim line items where the amount was applied to a replacement order or other deduction.

  • ]
  • shippingAddress object required
  • name string

    The name line on an address. Often the name of the customer, or the business name something is shipped to.

  • firstName string

    The first name for the address.

  • lastName string

    The last name for the address.

  • line1 string required

    Address line 1, generally the street number and name.

  • line2 string

    Address line 2. Not mandatory, but often used for an apartment or suite number.

  • city string required

    City of the Address

  • stateOrProvinceCode string required

    State or province code, typically 2 characters.

  • postalCode string required

    Postal Code

  • countryCode string required

    ISO 3166-1 alpha-2 country code

  • latitude number

    Latitude coordinate of the address.

  • longitude number

    Longitude coordinate of the address.

  • billingAddress object required
  • name string

    The name line on an address. Often the name of the customer, or the business name something is shipped to.

  • firstName string

    The first name for the address.

  • lastName string

    The last name for the address.

  • line1 string required

    Address line 1, generally the street number and name.

  • line2 string

    Address line 2. Not mandatory, but often used for an apartment or suite number.

  • city string required

    City of the Address

  • stateOrProvinceCode string required

    State or province code, typically 2 characters.

  • postalCode string required

    Postal Code

  • countryCode string required

    ISO 3166-1 alpha-2 country code

  • latitude number

    Latitude coordinate of the address.

  • longitude number

    Longitude coordinate of the address.

  • currencyCode string required

    The currency code of the claim.

  • shipments object[]

    The shipments associated with the claim.

  • Array [
  • shipmentId number required

    The Corso ID of the shipment.

  • toAddress object required
  • name string

    The name line on an address. Often the name of the customer, or the business name something is shipped to.

  • firstName string

    The first name for the address.

  • lastName string

    The last name for the address.

  • line1 string required

    Address line 1, generally the street number and name.

  • line2 string

    Address line 2. Not mandatory, but often used for an apartment or suite number.

  • city string required

    City of the Address

  • stateOrProvinceCode string required

    State or province code, typically 2 characters.

  • postalCode string required

    Postal Code

  • countryCode string required

    ISO 3166-1 alpha-2 country code

  • latitude number

    Latitude coordinate of the address.

  • longitude number

    Longitude coordinate of the address.

  • fromAddress object required
  • name string

    The name line on an address. Often the name of the customer, or the business name something is shipped to.

  • firstName string

    The first name for the address.

  • lastName string

    The last name for the address.

  • line1 string required

    Address line 1, generally the street number and name.

  • line2 string

    Address line 2. Not mandatory, but often used for an apartment or suite number.

  • city string required

    City of the Address

  • stateOrProvinceCode string required

    State or province code, typically 2 characters.

  • postalCode string required

    Postal Code

  • countryCode string required

    ISO 3166-1 alpha-2 country code

  • latitude number

    Latitude coordinate of the address.

  • longitude number

    Longitude coordinate of the address.

  • expiresOn date-time

    The date/time when the shipment expires.

  • inTransitOn date-time

    The date/time when the shipment was put in transit.

  • isReturnShipment boolean required

    Whether the shipment is a return shipment.

  • createdOn date-time

    The date/time when the shipment was created.

  • qrCodeUrl string

    The URL to retrieve the QR code for the shipment.

  • labelUrl string

    The URL to retrieve the label for the shipment, if applicable.

  • packingSlipUrl string

    The URL to retrieve the packing slip for the shipment, if applicable.

  • method string required

    Possible values: [Packing_Slip, Label]

    The method of the shipment.

  • carrier string

    The carrier of the shipment.

  • carrierTrackingUrl string

    The URL of the carrier tracking page.

  • carrierTrackingStatus string

    The status of the carrier tracking.

  • carrierServiceName string

    The name of the carrier service.

  • ]
  • order object required
  • orderId number

    The ID of the order in Corso, used to interact with Corso systems.

  • sourceOrderId string required

    The order identifier from the source platform. Is unique across the store, and typically across the entire platform used by the merchant.

  • orderNumber string

    The order number from the source platform, if none is provided. sourceOrderId will be used

  • createdOn date-time

    Date/time when the order was created in Corso systems.

  • orderName string

    Customer-facing identifier for the order the source platform. Often composed of the store-unique order number plus some modifying prefixes and suffixes.

  • isInstantExchange boolean required

    Whether this claim is an instant exchange.

  • claimType string required

    Possible values: [Warranty, Return]

    The type of claim.

  • status string required

    Possible values: [In_Progress, Ready_For_Review, Completed]

    The rollup status of the claim.

  • feeAmountApplied currency required

    The amount of the fee applied to the claim.

  • feeName string

    The name of the fee applied to the claim.

  • exchangeOrderShippingAmountApplied currency required

    The amount of the shipping applied to the exchange order.

  • returnShippingAmountApplied currency required

    The amount of the shipping applied to the return order.

  • shopNowIncentiveAmountApplied currency required

    The amount of the shop now incentive applied to the claim.

  • customerEmail string required

    The email address of the customer who filed the claim, may be different from the email on the order.

  • customerName string

    The name of the customer who filed the claim.

  • tags string[] required

    Tags applied to this claim for categorization.

  • claimLineItems object[] required

    The line items included in this claim.

  • Array [
  • sourceLineItem object required
  • lineItemId number required

    The ID of the line item in Corso systems.

  • sourceLineItemId string required

    The line item ID (from the source system).

  • productId string

    The product ID for the line item (from the source system).

  • variantId string

    The variant ID for the line item (from the source system). For the line item that represents the Corso Green Shipping Product (if purchased on the order), this should match the corresponding variant ID stored by Corso in our system, so that we can identify the order as protected.

  • sku string required

    The SKU of product/variant of the line item.

  • name string required

    The line item name, typically the value shown to the customer representing the product/variant combination purchased.

  • quantity number required

    The quantity purchased for the line item.

  • imgUrl string

    URL of the product image, if available.

  • claimLineItemId number required

    The Corso ID of the claim line item.

  • customFields object[] required
  • Array [
  • name string required

    The name of the custom field.

  • value string required

    The value of the custom field.

  • ]
  • quantity number required

    The quantity of items in this claim line item.

  • variantExchangeLineItem object

    The variant exchange line item associated with this claim line item, if applicable.

  • variantId string required

    The variant ID of the exchange line item in the source system.

  • quantity number required

    The quantity of the exchange line item.

  • price currency required

    The price of the exchange line item.

  • imgUrl string

    The URL of the image of the exchange line item.

  • sku string

    The SKU of the exchange line item.

  • title string

    The title of the exchange line item.

  • options object[]

    The options of the exchange line item.

  • Array [
  • name string required

    The name of the option.

  • value string required

    The value of the option.

  • ]
  • isShopNow boolean required

    Whether this claim line item resulted from a shop now session.

  • replacementItems object[]

    The replacement items associated with this claim line item, if applicable.

  • Array [
  • variantId string required

    The variant ID of the exchange line item in the source system.

  • quantity number required

    The quantity of the exchange line item.

  • price currency required

    The price of the exchange line item.

  • imgUrl string

    The URL of the image of the exchange line item.

  • sku string

    The SKU of the exchange line item.

  • title string

    The title of the exchange line item.

  • options object[]

    The options of the exchange line item.

  • Array [
  • name string required

    The name of the option.

  • value string required

    The value of the option.

  • ]
  • ]
  • amount currency required

    The issued monetary value of this claim line item in the store currency.

  • requestedAmount currency required

    The requested monetary value of this claim line item in the store currency.

  • reason string required

    The name of the reason selected for this claim line item.

  • reasonDetail string

    The name of the reason detail selected for this claim line item, if applicable.

  • status string required

    Possible values: [Open, Approved, Denied, Closed, Awaiting_Return, In_Transit, At_Return_Location]

    The status of the claim line item.

  • statusDetail string required

    Possible values: [Final_Sale, Pending_Review, Pending_Additional_Info, Awaiting_Customer_Dropoff_Label_Provided, Awaiting_Customer_Dropoff_Packing_Slip_Provided, In_Transit, Pending_Inspection, Pending_Approval, Variant_Exchange, Gift_Card_Issued, Refunded, Refunded_Partial, Gift_Card_Issued_Partial, Replacement_Order, Repaired, Wrong_Item, Item_Not_Returned, Noncompliant_Return, Not_Covered_Under_Warranty, Pending_Return_Shipment_Creation, Return_Not_Required, Additional_Info_Not_Provided, No_Action_Taken, Item_Credit_Applied_To_Claim]

    The status detail of the claim line item.

  • imageUrls string[]

    The images associated with the claim line item.

  • requestedResolutionMethod string required

    Possible values: [Refund, Variant_Exchange, Gift_Card, Repair, Replacement_Order, Warranty_Review, Other]

    The resolution method requested by the customer for this line item.

  • resolutionMethod string

    Possible values: [Refund, Variant_Exchange, Gift_Card, Repair, Replacement_Order, Warranty_Review, Other]

    The actual resolution method applied to this line item, if resolved.

  • noteFromCustomer string

    Notes provided by the customer about the claim line item.

  • deniedOn date-time

    The date/time when the claim line item was denied.

  • canceledOn date-time

    The date/time when the claim line item was canceled.

  • ]
  • noteToCustomer string

    Notes provided by the merchant about the claim.

  • createdOn date-time

    The date/time when the claim was created.

  • updatedOn date-time

    The date/time when the claim was last updated.

  • finalizedOn date-time

    The date/time when the claim was finalized, if applicable.

  • ]
  • pageInfo object required

    Information about the pagination of a list.

  • hasNextPage boolean required

    Whether there are more items after the last returned item.

  • hasPreviousPage boolean required

    Whether there are more items before the first returned item.

  • startCursor string nullable required

    An opaque cursor pointing to the first item in the current page. Pass as before to paginate backwards.

  • endCursor string nullable required

    An opaque cursor pointing to the last item in the current page. Pass as after to paginate forwards.

Loading...