Skip to main content

List shipping claims​

Retrieve a list of shipping protection claims for the authenticated store.

Query Parameters
  • sourceOrderId string

    The order identifier from the source platform to filter claims by.

  • orderId number

    The Corso order ID to filter claims 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
  • shippingClaims object[] required
  • Array [
  • shippingClaimId number required

    The Corso ID of the shipping protection claim.

  • storeId number required

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

  • status string required

    Possible values: [Closed_Denied, Closed_Refunded, Closed_Reordered, Closed_Resolved, InProgress, Open]

    The status of the shipping protection claim.

  • reason string required

    Possible values: [Damaged, Lost, Stolen, Wrong_Item, Missing_Item, Quality_Issue, Incorrect_Address, Satisfaction_Guarantee]

    The reason for the shipping protection claim.

  • resolutionSummary object

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

  • 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.

  • ]
  • reorders 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.

  • ]
  • ]
  • resolutionMethod string

    Possible values: [Refund, Reorder]

    The resolution method applied to this claim, if resolved.

  • source string

    Possible values: [Customer_App, Merchant_App, Retool, Gorgias_Ticket_Widget, Zowie_Inbox_Integration, Gladly_Hero_Integration, Kustomer_App_Integration, Zendesk_App_Integration, Public_API]

    The source from which the claim was created.

  • customerEmail string

    The email address of the customer who filed the claim.

  • order object required

    The order associated with the shipping protection claim.

  • 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.

  • noteFromCustomer string

    Notes provided by the customer about the claim.

  • noteFromMerchant string

    Notes added by the merchant about the claim.

  • shippingAddress object

    The shipping address for the claim, when creating a new claim this can be used to provide an address different from the order address.

  • 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.

  • claimLineItems object[] required

    The line items included in this shipping protection claim.

  • Array [
  • claimLineItemId number required

    The Corso ID of the shipping protection claim line item.

  • quantity number required

    The quantity of items in this claim line item.

  • 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.

  • ]
  • images string[]

    URLs to images uploaded by the customer for the claim.

  • currencyCode string

    The currency code for monetary values in the claim.

  • createdOn date-time

    The date/time when the claim was created.

  • 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...