Get coupon information

This endpoint retrieves information about a specific coupon in the shopping cart.

Request

• cart: The identifier of the shopping cart (path parameter)

• coupon: The identifier of the coupon (path parameter)

Response

• data (object): The container for coupon information.

  • article (object): Details about the article.

    • prices (null): The prices of the article.

    • articleGroup (object): Information about the article group.

      • id (string): The ID of the article group.

      • name (string): The name of the article group.

      • description (null): The description of the article group.

      • sort (number): The sorting order of the article group.

      • isExpanded (boolean): Indicates if the article group is expanded.

      • configuration (object): Configuration details of the article group.

        • maxNumberOfTicketsPerSale (null): The maximum number of tickets per sale for the article group.

    • id (string): The ID of the article.

    • name (string): The name of the article.

    • internalName (string): The internal name of the article.

    • description (null): The description of the article.

    • image (object): Details about the article's image.

      • key (string): The key of the image.

      • uri (string): The URI of the image.

      • type (string): The type of the image.

    • sort (number): The sorting order of the article.

    • isLegitimationRequired (boolean): Indicates if legitimation is required for the article.

    • legitimationCategory (null): The legitimation category of the article.

    • type (string): The type of the article.

    • ticketValidity (string): The validity of the ticket.

    • articleNumber (string): The article number.

    • category (string): The category of the article.

    • amount (object): Details about the amount.

      • remaining (number): The remaining amount.

    • configuration (object): Configuration details of the article.

      • showRemainingAmount (boolean): Indicates if the remaining amount is shown.

      • showRemainingAmountPerTimeslot (boolean): Indicates if the remaining amount per timeslot is shown.

      • showIfSoldOut (boolean): Indicates if sold out information is shown.

      • soldOutText (null): The text displayed when sold out.

      • maxLengthOfDescription (number): The maximum length of the description.

      • maxNumberOfTicketsPerSale (number): The maximum number of tickets per sale.

      • minNumberOfTicketsPerSale (null): The minimum number of tickets per sale.

      • isInvitationEmailAddressChangePossible (boolean): Indicates if invitation email address change is possible.

    • timeslots (array): The timeslots of the article.

  • appearance (object): Details about the appearance.

    • id (string): The ID of the appearance.

    • number (string): The number of the appearance.

    • isIntern (boolean): Indicates if the appearance is internal.

    • welcomeText (string): The welcome text.

    • hasWelcomeBanner (boolean): Indicates if a welcome banner is present.

  • organization (object): Details about the organization.

    • id (string): The ID of the organization.

    • name (string): The name of the organization.