Skip to main content

List registrations​

Retrieve a list of product registrations for the authenticated store. Supports filtering by customer email, channel name, or external ID.

Query Parameters
  • customerEmail string

    Filter registrations by customer email address.

  • channelName string

    Filter registrations by channel name.

  • externalId string

    Filter registrations by external ID.

  • 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
  • registrations object[] required
  • Array [
  • registrationId number required

    The Corso ID of the registration.

  • storeId number required

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

  • externalId string required

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

  • customerEmail string required

    The email address of the customer who created the registration.

  • customerName string

    The name of the customer who created the registration.

  • channelName string required

    The name of the registration channel.

  • customerProvidedOrderNumber string

    The order number provided by the customer during registration, if applicable.

  • estimatedPurchaseDate date-time

    The estimated date of purchase provided by the customer, if applicable.

  • referrer string

    The referrer URL or source for this registration.

  • emailMarketingConsent boolean required

    Whether the customer consented to email marketing during registration.

  • emailMarketingConsentCollectedOn date-time

    The date/time when email marketing consent was collected, if applicable.

  • lineItems object[] required

    The product line items associated with this registration.

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

  • ]
  • customFields object[]

    Custom field values captured during registration.

  • Array [
  • name string required

    The name of the custom field.

  • value string required

    The value of the custom field.

  • ]
  • proofOfPurchaseFileUrls string[]

    URLs to proof-of-purchase files uploaded by the customer.

  • createdOn date-time

    The date/time when the registration was created.

  • updatedOn date-time

    The date/time when the registration was last updated.

  • canceledOn date-time

    The date/time when the registration was canceled, if applicable.

  • claims object[] required
  • Array [
  • claimId number required

    The Corso ID of the claim.

  • externalId string required

    The external ID of the claim.

  • claimType string required

    Possible values: [Warranty, Return]

    The type of the claim.

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