--- title: Get Redemption Items slug: get-redemption-items docTags: createdAt: 2025-09-12T20:51:27.708Z --- { "id": "KpAijRsP1pKUy_p7RVX8o", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.b.preview.loyaltyservices.io/api/v3/redemption-items", "servers": [ { "url": "https://api.b.preview.loyaltyservices.io/api/v3/redemption-items" } ], "name": "Get Redemption Items", "description": "

Warning: Deprecated\nRetrieve redemption items. Deprecated in favor of GET /v3/rewards/redemption-rules

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "memberIdentifier", "type": "string", "description": "Member identifier. If this is provided it will retrieve the redemption items specific to member.", "minLength": 1, "maxLength": 200 }, { "kind": "optional", "name": "code", "type": "string", "description": "The redemption item code" }, { "kind": "optional", "name": "typeCode", "type": "string", "description": "The redemption item type code" }, { "kind": "optional", "name": "description", "type": "string", "description": "The redemption description" }, { "kind": "optional", "name": "convertCurrencyAttributes", "type": "boolean", "description": "

If true, convert the fiat currency attributes to a local currency

" }, { "kind": "optional", "name": "convertToIsoCurrencyCode", "type": "string", "description": "

If convertCurrencyAttributes is true, the ISO currency to convert to (or will utilize a location's currency if one provided; dependent on client configuration)

", "minLength": 0, "maxLength": 3 }, { "kind": "optional", "name": "ace01Keys", "type": "array", "description": "

The redemption ace01 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace02Keys", "type": "array", "description": "

The redemption ace02 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace03Keys", "type": "array", "description": "

The redemption ace03 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace04Keys", "type": "array", "description": "

The redemption ace04 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace05Keys", "type": "array", "description": "

The redemption ace05 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace06Keys", "type": "array", "description": "

The redemption ace06 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace07Keys", "type": "array", "description": "

The redemption ace07 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace08Keys", "type": "array", "description": "

The redemption ace08 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace09Keys", "type": "array", "description": "

The redemption ace09 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace10Keys", "type": "array", "description": "

The redemption ace10 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace11Keys", "type": "array", "description": "

The redemption ace11 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace12Keys", "type": "array", "description": "

The redemption ace12 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace13Keys", "type": "array", "description": "

The redemption ace13 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace14Keys", "type": "array", "description": "

The redemption ace14 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "ace15Keys", "type": "array", "description": "

The redemption ace15 key value(s)

", "schema": [], "itemType": "string", "customType": "string[]" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

See https://docs.wearephaedon.com/docs/platform-api-authentication

", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications" } } }, "requiredScopes": [ "api:redemption:read" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "RedemptionItem[]", "schema": [ { "name": "redemptionItemId", "kind": "optional", "type": "integer", "description": "

Redemption Item Id (null on create requests)

", "format": "int64" }, { "name": "redemptionItemCode", "kind": "optional", "type": "string", "description": "Redemption Item Code" }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Indicates the Type of thing being redeemed for - DataCode Type: RedemptionType Example: A (Award), I (Item), T (Travel), P (Points)

" }, { "name": "description", "kind": "optional", "type": "string", "description": "Friendly identifier for redemption item" }, { "name": "currencyRequired", "kind": "optional", "type": "number", "description": "Currency required for one item" }, { "name": "minimumQuantity", "kind": "optional", "type": "integer", "description": "The minimum number of items that can be redeemed", "format": "int32" }, { "name": "maximumQuantity", "kind": "optional", "type": "integer", "description": "The maximum number of items that can be redeemed", "format": "int32" }, { "name": "redeemIncrement", "kind": "optional", "type": "integer", "description": "The number of items the redemption must increment by", "format": "int32" }, { "name": "faceValue", "kind": "optional", "type": "number", "description": "USD equivalent value of the item" }, { "name": "convertedFaceValue", "kind": "optional", "type": "number", "description": "

If convertCurrencyAttributes is true, the local currency face value

" }, { "name": "convertedFaceValueIsoCurrencyCode", "kind": "optional", "type": "string", "description": "

If convertCurrencyAttributes is true, the local ISO currency code

" }, { "name": "amountProvided", "kind": "optional", "type": "boolean", "description": "

Is the currency to be redeemed variable (or provided)?

" }, { "name": "companyCode", "kind": "optional", "type": "string", "description": "Short identifier of the Partner that owns the item" }, { "name": "redeemText", "kind": "optional", "type": "string", "description": "

Indicates text to show with item - ie. 'Click to Redeem' or 'Call'

" }, { "name": "redeemable", "kind": "optional", "type": "boolean", "description": "

Indicates if the member can actually redeem for item. If False, it may mean the member does not yet have enough currency for the item, the rule itself is set to not be redeemable, or the redemption is part of a RedemptionGroup and would exceed group rules.

" }, { "name": "poolRedeemable", "kind": "optional", "type": "boolean", "nullable": true, "description": "

True if the member lacks sufficient currency for the item, but belongs to a points pool where members can combine their currencies.

" }, { "name": "requireAddress", "kind": "optional", "type": "boolean", "description": "Indicates if an address needs to be collected at the time of redemption." }, { "name": "requirePartnerAccountNumber", "kind": "optional", "type": "boolean", "description": "

Indicates if a partner account number (member alias) needs to be collected at the time of redemption.

" }, { "name": "fulfillmentPathCode", "kind": "optional", "type": "string", "description": "

Indicates how Member shall receive the item - DataCode Type: FulfillmentPathCode Example: COUPON

" }, { "name": "sortValue", "kind": "optional", "type": "string", "description": "How to sort the items" }, { "name": "customData", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SmartGroupCustomData", "customType": "SmartGroupCustomData", "schema": [ { "name": "ace01", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace01Description field.

" }, { "name": "ace01Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace01 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace02", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace02Description field.

" }, { "name": "ace02Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace02 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace03", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace03Description field.

" }, { "name": "ace03Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace03 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace04", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace04Description field.

" }, { "name": "ace04Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace04 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace05", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace05Description field.

" }, { "name": "ace05Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace05 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace06", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace06Description field.

" }, { "name": "ace06Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace06 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace07", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace07Description field.

" }, { "name": "ace07Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace07 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace08", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace08Description field.

" }, { "name": "ace08Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace08 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace09", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace09Description field.

" }, { "name": "ace09Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace09 code value. Use this field to interpret the meaning of ace09 within the context of the client program.

" }, { "name": "ace10", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace10Description field.

" }, { "name": "ace10Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace10 code value. Use this field to interpret the meaning of ace10 within the context of the client program.

" }, { "name": "ace11", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace11Description field.

" }, { "name": "ace11Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace11 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace12", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace12Description field.

" }, { "name": "ace12Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace12 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace13", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace13Description field.

" }, { "name": "ace13Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace13 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace14", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace14Description field.

" }, { "name": "ace14Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace14 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace15", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace15Description field.

" }, { "name": "ace15Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace15 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace01SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE01 Smart Group Id", "format": "int64" }, { "name": "ace02SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE02 Smart Group Id", "format": "int64" }, { "name": "ace03SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE03 Smart Group Id", "format": "int64" }, { "name": "ace04SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE04 Smart Group Id", "format": "int64" }, { "name": "ace05SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE05 Smart Group Id", "format": "int64" }, { "name": "ace06SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE06 Smart Group Id", "format": "int64" }, { "name": "ace07SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE07 Smart Group Id", "format": "int64" }, { "name": "ace08SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE08 Smart Group Id", "format": "int64" }, { "name": "ace09SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE09 Smart Group Id", "format": "int64" }, { "name": "ace10SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE10 Smart Group Id", "format": "int64" }, { "name": "ace11SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE11 Smart Group Id", "format": "int64" }, { "name": "ace12SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE12 Smart Group Id", "format": "int64" }, { "name": "ace13SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE13 Smart Group Id", "format": "int64" }, { "name": "ace14SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE14 Smart Group Id", "format": "int64" }, { "name": "ace15SmartGroupId", "kind": "optional", "type": "integer", "description": "ACE15 Smart Group Id", "format": "int64" } ] }, { "name": "genericItem", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/GenericItem", "customType": "GenericItem", "schema": [ { "name": "contentCode", "kind": "required", "type": "string", "description": "Identifier that can be used to look up the desired content", "example": "Bonus100" }, { "name": "contentTypeCode", "kind": "optional", "type": "string", "description": "

DataCode Type: ContentType Example: HEADER, FOOTER

", "example": "HEADER" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name", "example": "Bonus 100 points", "maxLength": 50 }, { "name": "shortDescription", "kind": "optional", "type": "string", "description": "Short description", "example": "Award 100 points", "maxLength": 500 }, { "name": "description", "kind": "optional", "type": "string", "description": "Large description", "example": "Award 100 points on 100th stay" }, { "name": "alternateDescription", "kind": "optional", "type": "string", "description": "Alternate large description", "example": "Award 100 points on 100th stay" }, { "name": "termsAndConditions", "kind": "optional", "type": "string", "description": "

Terms and conditions, typically used as part of a coupon or redemption item

", "example": "Terms and conditions for this promotion" }, { "name": "title", "kind": "optional", "type": "string", "description": "Title content", "example": "Award 100 points", "maxLength": 200 }, { "name": "label", "kind": "optional", "type": "string", "description": "Label content", "example": "100 points awarded", "maxLength": 255 }, { "name": "logoKey", "kind": "optional", "type": "string", "description": "Image name or hosted image location'", "example": "100-points.png" }, { "name": "displayTypeKey", "kind": "optional", "type": "string", "description": "Interpreted by content display", "example": "100 points" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "The date and time the content becomes valid", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "The date and time the content is no longer valid", "format": "date-time" }, { "name": "url", "kind": "optional", "type": "string", "description": "A url for use in content", "example": "/loyaltyprogram/bonus/100-points", "maxLength": 1000 }, { "name": "tierCode", "kind": "optional", "type": "string", "description": "

A tier the content is related to; Value comes from Tier Definition

", "example": "B" }, { "name": "displayForAll", "kind": "optional", "type": "boolean", "description": "

True or False; interpreted by content display

", "example": true }, { "name": "descriptorCode", "kind": "optional", "type": "string", "description": "

DataCode Type: GenericItemDescriptor Example: LIMITED_TIME

", "example": "LIMITED_TIME" } ] }, { "name": "bonuses", "kind": "optional", "type": "array", "description": "

One or more Bonus rules that's awarded by the redemption. Example: Points to Miles Redemption

", "modelRef": "#/components/schemas/RedemptionItemBonus", "customType": "RedemptionItemBonus[]", "schema": [ { "name": "bonusCode", "kind": "optional", "type": "string", "description": "The bonus rule code" }, { "name": "minimumQuantity", "kind": "optional", "type": "integer", "description": "The minimum number of items that can be redeemed", "format": "int32" }, { "name": "maximumQuantity", "kind": "optional", "type": "integer", "description": "The maximum number of items that can be redeemed", "format": "int32" }, { "name": "resultAmount", "kind": "optional", "type": "number", "description": "Amount of currency to be awarded with the bonus" } ] } ], "modelRef": "#/components/schemas/RedemptionItem", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "List of errors", "modelRef": "#/components/schemas/ValidationError", "customType": "ValidationError[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code assigned to this violation" }, { "name": "fieldName", "kind": "optional", "type": "string", "description": "

Name of field that violated validation constraint (optional)

" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "deprecated": true, "examples": { "languages": [ { "id": "Ux6MtkzRZyHDXDiPN_W07", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.b.preview.loyaltyservices.io/api/v3/redemption-items \\\n --header 'accept: application/json'" }, { "id": "ztnvvZl-PJlkhcBKDWAGO", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/redemption-items\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "MyRJVsfmeUpEfek_fbWvw", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/redemption-items\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "XTI-HXmBNbuOwotejMeRw", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/redemption-items\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "Ux6MtkzRZyHDXDiPN_W07" }, "results": { "languages": [ { "id": "hs0g2mFTN4mqgsrsDqULV", "language": "200", "code": "// Success\n[\n {\n \"redemptionItemId\": \"\",\n \"redemptionItemCode\": \"\",\n \"typeCode\": \"\",\n \"description\": \"\",\n \"currencyRequired\": 0,\n \"minimumQuantity\": \"\",\n \"maximumQuantity\": \"\",\n \"redeemIncrement\": \"\",\n \"faceValue\": 0,\n \"convertedFaceValue\": 0,\n \"convertedFaceValueIsoCurrencyCode\": \"\",\n \"amountProvided\": false,\n \"companyCode\": \"\",\n \"redeemText\": \"\",\n \"redeemable\": false,\n \"poolRedeemable\": false,\n \"requireAddress\": false,\n \"requirePartnerAccountNumber\": false,\n \"fulfillmentPathCode\": \"\",\n \"sortValue\": \"\",\n \"customData\": {\n \"ace01\": \"\",\n \"ace01Description\": \"\",\n \"ace02\": \"\",\n \"ace02Description\": \"\",\n \"ace03\": \"\",\n \"ace03Description\": \"\",\n \"ace04\": \"\",\n \"ace04Description\": \"\",\n \"ace05\": \"\",\n \"ace05Description\": \"\",\n \"ace06\": \"\",\n \"ace06Description\": \"\",\n \"ace07\": \"\",\n \"ace07Description\": \"\",\n \"ace08\": \"\",\n \"ace08Description\": \"\",\n \"ace09\": \"\",\n \"ace09Description\": \"\",\n \"ace10\": \"\",\n \"ace10Description\": \"\",\n \"ace11\": \"\",\n \"ace11Description\": \"\",\n \"ace12\": \"\",\n \"ace12Description\": \"\",\n \"ace13\": \"\",\n \"ace13Description\": \"\",\n \"ace14\": \"\",\n \"ace14Description\": \"\",\n \"ace15\": \"\",\n \"ace15Description\": \"\",\n \"ace01SmartGroupId\": \"\",\n \"ace02SmartGroupId\": \"\",\n \"ace03SmartGroupId\": \"\",\n \"ace04SmartGroupId\": \"\",\n \"ace05SmartGroupId\": \"\",\n \"ace06SmartGroupId\": \"\",\n \"ace07SmartGroupId\": \"\",\n \"ace08SmartGroupId\": \"\",\n \"ace09SmartGroupId\": \"\",\n \"ace10SmartGroupId\": \"\",\n \"ace11SmartGroupId\": \"\",\n \"ace12SmartGroupId\": \"\",\n \"ace13SmartGroupId\": \"\",\n \"ace14SmartGroupId\": \"\",\n \"ace15SmartGroupId\": \"\"\n },\n \"genericItem\": {\n \"contentCode\": \"Bonus100\",\n \"contentTypeCode\": \"HEADER\",\n \"name\": \"Bonus 100 points\",\n \"shortDescription\": \"Award 100 points\",\n \"description\": \"Award 100 points on 100th stay\",\n \"alternateDescription\": \"Award 100 points on 100th stay\",\n \"termsAndConditions\": \"Terms and conditions for this promotion\",\n \"title\": \"Award 100 points\",\n \"label\": \"100 points awarded\",\n \"logoKey\": \"100-points.png\",\n \"displayTypeKey\": \"100 points\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"url\": \"/loyaltyprogram/bonus/100-points\",\n \"tierCode\": \"B\",\n \"displayForAll\": true,\n \"descriptorCode\": \"LIMITED_TIME\"\n },\n \"bonuses\": [\n {\n \"bonusCode\": \"\",\n \"minimumQuantity\": \"\",\n \"maximumQuantity\": \"\",\n \"resultAmount\": 0\n }\n ]\n }\n]" }, { "id": "32XJfZO0LuW0216MTKlFr", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "zqduS1IOiK31JiyazAaFr", "language": "401", "code": "// Unauthorized\n" }, { "id": "k6rscYYB7kozqvxG_qis5", "language": "403", "code": "// Forbidden\n" }, { "id": "mT5z2GBF81KU_pqbK_npS", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "hs0g2mFTN4mqgsrsDqULV" } }, "children": [ { "text": "" } ] }