Skip to main content

Get a registration​

Retrieve a single product registration by its Corso ID.

Path Parameters
  • registrationId number required

    The Corso ID for the registration

    Example: 789012
Responses

OK

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

  • ]
Loading...