--- schema_version: "1" id: eab4acb55bc7b89a8660238a8170f5809c8733b469f6fbe13f5f0ae430e3e636 title: Retail and Restaurant POS API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/loyalty/references/generated-api-specs/loyalty_unlocked_api.md canonical_url: https://developer.salesforce.com/docs/industries/loyalty/references/loyalty_unlocked_api source_site: developer.salesforce.com content_type: documentation content_hash: 893e4d6ebc1ab435fc05f389ce0c1fbac7882934871067d79915ef29f825f0a3 products: - Loyalty Management Integrations API - Industries Integrations --- Retail and Restaurant POS API # Retail and Restaurant POS API Integrate your product with point-of-sale systems, and help businesses streamline their processes. Use this API to enroll members to loyalty programs, search members, apply vouchers, and checkout items from cart. **Version:** v1 Protocols: https. ## Operations ### POST Enroll member to loyalty program `POST /members` Enrolls a member to the Loyalty program. #### Parameters * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Request body Media type: `application/json`. Schema: `member-enrollment-request`. _Example_ ``` enrollmentDate: 2021-01-01T00:00:00 membershipNumber: Member1 associatedContactDetails: firstName: Name1 lastName: Name2 email: ab@email.com allowDuplicateRecords: "false" additionalContactFieldValues: attributes: PersonMailingCity: Delhi CustomNumber__c: "20.0" memberStatus: Active referredBy: Member2 referredByMemberReferralCode: MPX12adf createTransactionJournals: "true" transactionJournalStatementFrequency: Monthly transactionJournalStatementMethod: Mail enrollmentChannel: Email canReceivePromotions: "true" canReceivePartnerPromotions: "true" membershipEndDate: 2022-01-01T00:00:00 relatedCorporateMembershipNumber: Member3 additionalMemberFieldValues: attributes: CustomBoolean__c: "true" posName__c: RetailAndEcommerce posMemMobile__c: 123456 posMemId__c: 1234567 posOrderCount__c: "10" ``` #### Responses * **201** Media type: `application/json`. Schema: `object`. * `contactId` (_string_, required) The contactId generated in Salesforce. * `loyaltyProgramMemberId` (_string_, required) Members ID generated while enrolling in the program. * `loyaltyProgramName` (_string_, required) Name of the loyalty program. * `membershipNumber` (_string_, required) Membership number provided by the POS. * `transactionJournals` (_array of object_, required) Minimum items: 0. * `activityDate` (_datetime_, required) Timestamp of the transaction. * `journalSubType` (_string_, required) The sub type of the journal. * `loyaltyProgram` (_string_, required) Name of the loyatly program corresponding to the transaction * `loyaltyProgramMember` (_string_, required) The POS provided memebership ID associated with the member. * `referredMember` (_boolean | any_, required) Value indicating if the member is referred or not. One of: `boolean`, `any`. * `status` (_string_, required) Stratus of the transaction. * `transactionJournalId` (_string_, required) The Id of the transaction journal. _Example_ ``` contactId: 003Dn00000OVHwc loyaltyProgramMemberId: 0lMDn000001qkDa loyaltyProgramName: NTO Insider membershipNumber: Member 1 transactionJournals: - activityDate: 2023-09-01T17:30:34.000Z journalSubType: Member Enrollment journalType: Accrual loyaltyProgram: Cloud Kicks Inner Circle loyaltyProgramMember: SANEUSER1234 referredMember: null status: Pending transactionJournalId: 0lV1Q0000008PXM ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ### GET Retrieve member profile details `GET /members` Retrieves member details based on the membershipNumber, membershipId, or posMemId properties. #### Parameters * `membershipNumber` (query, string) Specifies the membership number of the loyalty program member. * `memberId` (query, string) Specifies the ID of the loyalty program member. * `posMemId` (query, string) Specifies the ID of the member in the Point of Sale (POS). * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Responses * **200** Media type: `application/json`. Schema: `object`. * `additionalLoyaltyProgramMemberFields` (_object_, required) * `posMemId__c` (_string_, required) Membership ID as specified by POS. * `City__c` (_string | any_, required) Member's city of residence. One of: `string`, `any`. * `Age__c` (_number | any_, required) The age of the member One of: `number`, `any`. * `Anniversary__c` (_date-only | any_, required) The date of anniversary. One of: `date-only`, `any`. * `posName__c` (_string_, required) The name of the POS. * `DateOfBirth__c` (_date-only | any_, required) Date of Birth of the member enrolled. One of: `date-only`, `any`. * `posOrderCount__c` (_number_, required) Number of orders placed at POS. * `Gender__c` (_string | any_, required) Members gender. One of: `string`, `any`. * `SeedData__c` (_boolean | any_, required) Boolean valud indicating if its a seed data. One of: `boolean`, `any`. * `posMemMobile__c` (_string_, required) Mobile number of the member. * `associatedAccount` (_string | any_, required) The associated accounts. One of: `string`, `any`. * `associatedContact` (_object_, required) * `contactId` (_string_, required) The ID of the contact in Salesforce. * `email` (_string_, required) Email ID of the contact associated. * `firstName` (_string_, required) First Name of the contact. * `lastName` (_string_, required) Last Name of the contact. * `canReceivePartnerPromotions` (_boolean | any_, required) Boolean value indicating if member opts for partner promotional communication. One of: `boolean`, `any`. * `canReceivePromotions` (_boolean | any_, required) Boolean value indicating whether the member wants to receive promotionla communication. One of: `boolean`, `any`. * `enrollmentChannel` (_string_, required) The channel that was used to enroll the member. * `enrollmentDate` (_date-only_, required) The date member was enrolled. * `groupCreatedByMember` (_string | any_, required) The group created by the member. One of: `string`, `any`. * `groupName` (_string | any_, required) The name of the group. One of: `string`, `any`. * `lastActivityDate` (_date-only | any_, required) The date when last activity was performed. One of: `date-only`, `any`. * `loyaltyProgramMemberId` (_string_, required) The Id of member in Salesforce. * `loyaltyProgramName` (_string_, required) The name of the loyalty program. * `memberCurrencies` (_array of object_, required) The details of member currency. * `additionalLoyaltyMemberCurrencyFields` (_object_, required) additionalLoyaltyMemberCurrencyFields * `escrowPointsBalance` (_number_, required) The escrow points balance. * `expirablePoints` (_number_, required) The expirable points. * `lastAccrualProcessedDate` (_string | any_, required) The lastAccrualProcessed date. One of: `string`, `any`. * `lastEscrowProcessedDate` (_datetime | any_, required) The last escrow processed date. One of: `datetime`, `any`. * `lastExpirationProcessRunDate` (_datetime | any_, required) The last expiration process run date. One of: `datetime`, `any`. * `lastPointsAggregationDate` (_datetime | any_, required) The last point aggregation date One of: `datetime`, `any`. * `lastPointsResetDate` (_date-only | any_, required) The date when points were last reset. One of: `date-only`, `any`. * `loyaltyMemberCurrencyName` (_string_, required) The name of currency applicatble for the loyalty member * `loyaltyProgramCurrencyId` (_string_, required) The Id in Salesforce associated with the currency. * `loyaltyProgramCurrencyName` (_string | any_, required) The curreny name applicable to the loyalty program. One of: `string`, `any`. * `memberCurrencyId` (_string_, required) The member currency Id. * `nextQualifyingPointsResetDate` (_string | any_, required) The next qualifying points reset date. One of: `string`, `any`. * `pointsBalance` (_number_, required) The points balance. * `qualifyingPointsBalanceBeforeReset` (_number_, required) The qualifying points balance before reset. * `totalEscrowPointsAccrued` (_number_, required) The total escrow points accrued. * `totalEscrowRolloverPoints` (_number_, required) The total escrow points that can be rolled over. * `totalPointsAccrued` (_number_, required) The total number of points accrued. * `totalPointsExpired` (_number_, required) The number of points expired. * `totalPointsRedeemed` (_number_, required) The number of points redeemed. * `memberStatus` (_string_, required) Status of the member. * `memberTiers` (_array of object_, required) * `additionalLoyaltyMemberTierFields` (_object_, required) The additional fields applicable for LoyaltyMember * `areTierBenefitsAssigned` (_boolean_, required) Indicates if tier benefits are assigned. * `loyaltyMemberTierId` (_string_, required) The tier ID of the loyalty member in Salesforce. * `loyaltyMemberTierName` (_string_, required) The tier name assigned to the loyalty member's membership. * `tierChangeReason` (_string | any_, required) The reason for tier change. One of: `string`, `any`. * `tierChangeReasonType` (_string | any_, required) The reason type for tier change. One of: `string`, `any`. * `tierEffectiveDate` (_date-only_, required) The date from which change in tier is effective. * `tierExpirationDate` (_date-only | any_, required) The expiration date of the tier. One of: `date-only`, `any`. * `tierGroupId` (_string_, required) The Salesforce ID associated with the tier group. * `tierGroupName` (_string | any_, required) The name of the tier group. One of: `string`, `any`. * `tierId` (_string_, required) The Salesforce Id associated with the tier. * `tierSequenceNumber` (_number_, required) The sequence number of the tier. * `memberType` (_string_, required) The member type * `membershipEndDate` (_date-only_, required) The date when membership ends. * `membershipLastRenewalDate` (_date-only | any_, required) The last date when membership was renewed. One of: `date-only`, `any`. * `membershipNumber` (_string_, required) The membership number. * `referredBy` (_string | any_, required) The individual who referred. One of: `string`, `any`. * `relatedCorporateMembershipNumber` (_string | any_, required) The related corporate membership number. One of: `string`, `any`. * `transactionJournalStatementFrequency` (_string | any_, required) The frequency at which the statment should be sent to the member. One of: `string`, `any`. * `transactionJournalStatementLastGeneratedDate` (_string | any_, required) The last generated date of the statement. One of: `string`, `any`. * `transactionJournalStatementMethod` (_string | any_, required) The transaction journal statement method. One of: `string`, `any`. _Example_ ``` additionalLoyaltyProgramMemberFields: posMemId__c: "675424" City__c: null Age__c: null Anniversary__c: null posName__c: TestPOSName DateOfBirth__c: null posOrderCount__c: 10.0 Gender__c: null SeedData__c: false posMemMobile__c: "1234567890" associatedAccount: null associatedContact: contactId: 003Dn00000OWs1yIAD email: abc@email.com firstName: Daisy lastName: Deeds canReceivePartnerPromotions: true canReceivePromotions: true enrollmentChannel: Email enrollmentDate: 2023-06-01 groupCreatedByMember: null groupName: null lastActivityDate: null loyaltyProgramMemberId: 0lMDn000001qkTHMAY loyaltyProgramName: NTO Insider memberCurrencies: - additionalLoyaltyMemberCurrencyFields: {} escrowPointsBalance: 0.0 expirablePoints: 0.0 lastAccrualProcessedDate: 2023-06-05T14:21:42.000Z lastEscrowProcessedDate: null lastExpirationProcessRunDate: null lastPointsAggregationDate: null lastPointsResetDate: null loyaltyMemberCurrencyName: NQP Currency test loyaltyProgramCurrencyId: 0lcDn0000000JUBIA2 loyaltyProgramCurrencyName: null memberCurrencyId: 0lzDn000003H3VOIA0 nextQualifyingPointsResetDate: null pointsBalance: 50.0 qualifyingPointsBalanceBeforeReset: 0.0 totalEscrowPointsAccrued: 0.0 totalEscrowRolloverPoints: 0.0 totalPointsAccrued: 50.0 totalPointsExpired: 0.0 totalPointsRedeemed: 0.0 - additionalLoyaltyMemberCurrencyFields: {} escrowPointsBalance: 0.0 expirablePoints: 0.0 lastAccrualProcessedDate: null lastEscrowProcessedDate: null lastExpirationProcessRunDate: null lastPointsAggregationDate: null lastPointsResetDate: null loyaltyMemberCurrencyName: QP Currency loyaltyProgramCurrencyId: 0lcDn0000000JUCIA2 loyaltyProgramCurrencyName: null memberCurrencyId: 0lzDn000003H3VPIA0 nextQualifyingPointsResetDate: 2024-03-15 pointsBalance: 0.0 qualifyingPointsBalanceBeforeReset: 0.0 totalEscrowPointsAccrued: 0.0 totalEscrowRolloverPoints: 0.0 totalPointsAccrued: 0.0 totalPointsExpired: 0.0 totalPointsRedeemed: 0.0 memberStatus: Active memberTiers: - additionalLoyaltyMemberTierFields: {} areTierBenefitsAssigned: false loyaltyMemberTierId: 0lyDn000001yfVBIAY loyaltyMemberTierName: Gold tierChangeReason: null tierChangeReasonType: null tierEffectiveDate: 2023-06-01 tierExpirationDate: null tierGroupId: 0ltDn0000000JiWIAU tierGroupName: null tierId: 0lgDn0000000JY8IAM tierSequenceNumber: 1 memberType: Individual membershipEndDate: 2024-01-01 membershipLastRenewalDate: null membershipNumber: Member111459889 referredBy: null relatedCorporateMembershipNumber: null transactionJournalStatementFrequency: Monthly transactionJournalStatementLastGeneratedDate: null transactionJournalStatementMethod: Mail ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ### GET Retrieve voucher details `GET /members/{membershipNumber}/vouchers` Retrieves voucher details based on the voucherStatus, productId, productName, productCategoryId, and productCategoryName properties. If there’s no search query parameter, this API retrieves all the vouchers. #### Parameters * `membershipNumber` (path, string, required) Unique identifier of the member whose vouchers are being retrieved. * `voucherStatus` (query, string) Specifies the status of the voucher. * `productId` (query, string) The ID of the product associated with the voucher definition. * `productName` (query, string) The type of voucher issued to the member. * `productCategoryId` (query, string) The ID of product category associated with the voucher definition. * `productCategoryName` (query, string) The name of the product category associated with the voucher definition. * `pageNumber` (query, string) The page number to be returned. If you don’t specify a value, the first page is returned. Each page contains 200 vouchers, sorted by their date of creation. * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Responses * **200** Media type: `application/json`. Schema: `object`. * `voucherCount` (_number_, required) Total number of vouchers available for the member. * `vouchers` (_array of object_, required) Minimum items: 0. * `effectiveDate` (_date-only_, required) The date from which the voucher is effective. * `expirationDate` (_date-only_, required) The date until which the voucher is valid. * `faceValue` (_number_) The value of the voucher. * `isVoucherDefinitionActive` (_boolean_, required) Indicates if the definition of the voucher is active. * `status` (_string_, required) Status of the voucher * `type` (_string_, required) The type of the voucher. * `voucherCode` (_string_, required) The voucher code. * `voucherId` (_string_, required) The ID associated with the voucher. * `voucherNumber` (_string_, required) The voucher number. _Example_ ``` voucherCount: 3 vouchers: - effectiveDate: 2023-06-12 expirationDate: 2023-09-12 faceValue: 200.0 isVoucherDefinitionActive: true isVoucherPartiallyRedeemable: false status: Issued type: FixedValue voucherCode: TestFixed voucherDefinition: Fixed OneTimeUse Vouchers voucherId: 0kDDn0000022pHOMAY voucherNumber: "00000026" - discountPercent: 20 effectiveDate: 2023-06-12 expirationDate: 2023-09-12 isVoucherDefinitionActive: true isVoucherPartiallyRedeemable: false productId: 01tDn000004z9R7IAI productName: Checked Silk Tie status: Issued type: DiscountPercentage voucherCode: TestDiscount voucherDefinition: DiscountProductVouchers voucherId: 0kDDn0000022pHPMAY voucherNumber: "00000028" - effectiveDate: 2023-06-12 expirationDate: 2023-09-12 faceValue: 200.0 isVoucherDefinitionActive: true isVoucherPartiallyRedeemable: false status: Issued type: FixedValue voucherCode: TestPartial voucherDefinition: Partial Redeemable Voucher Definiton voucherId: 0kDDn0000022pHTMAY voucherNumber: "00000027" ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ### POST Create orders `POST /orders` Creates accrual and redemption orders #### Parameters * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Request body Media type: `application/json`. Schema: `orders`. _Example_ ``` requestType: placeOrder newExternalTransactionNumber: "8888" isOrderFinalCancellation: true currencyName: Reward Points redemptionJournalId: "" order: loyaltyProgramName: NTO Insider membershipNumber: deh9GiaYSgvBcX1YT30UJMOb7L id: 1073459966 admin_graphql_api_id: gid://retailandecommerce/Order/1073459966 app_id: 755357713 browser_ip: null buyer_accepts_marketing: false cancel_reason: null cancelled_at: null cart_token: null checkout_id: null checkout_token: null client_details: null closed_at: null confirmed: true contact_email: null created_at: 2023-04-24T14:19:30-04:00 currency: EUR pointsRedemption: points: 30 additionalNotes: Testing programCurrencyName: Reward Points current_subtotal_price: "224.97" current_subtotal_price_set: shop_money: amount: "224.97" currency_code: EUR presentment_money: amount: "224.97" currency_code: EUR current_total_additional_fees_set: null current_total_discounts: "0.00" current_total_discounts_set: shop_money: amount: "0.00" currency_code: EUR presentment_money: amount: "0.00" currency_code: EUR current_total_duties_set: null current_total_price: "238.47" current_total_price_set: shop_money: amount: "238.47" currency_code: EUR presentment_money: amount: "238.47" currency_code: EUR current_total_tax: "13.50" current_total_tax_set: shop_money: amount: "13.50" currency_code: EUR presentment_money: amount: "13.50" currency_code: EUR customer_locale: null device_id: null discount_codes: - voucherCode: one20 redeemAmount: 20 email: "" estimated_taxes: false financial_status: paid fulfillment_status: null landing_site: null landing_site_ref: null location_id: null merchant_of_record_app_id: null name: "#1002" note: null note_attributes: [] number: 2 order_number: 1002 order_status_url: https://jsmith.retailandecommerce.com/548380009/orders/f20dce2f40beaba28ec8c091f94876ce/authenticate?key=07bb8a7c94be78901e2938cfb217ebbd original_total_additional_fees_set: null original_total_duties_set: null payment_gateway_names: [] phone: null presentment_currency: EUR processed_at: 2023-04-24T14:19:30-04:00 reference: null referring_site: null source_identifier: null source_name: "755357713" source_url: null subtotal_price: "224.97" subtotal_price_set: shop_money: amount: "224.97" currency_code: EUR presentment_money: amount: "224.97" currency_code: EUR tags: "" tax_lines: - price: "13.50" rate: 0.06 title: State tax price_set: shop_money: amount: "13.50" currency_code: EUR presentment_money: amount: "13.50" currency_code: EUR channel_liable: null taxes_included: false test: false token: f20dce2f40beaba28ec8c091f94876ce total_discounts: "0.00" total_discounts_set: shop_money: amount: "0.00" currency_code: EUR presentment_money: amount: "0.00" currency_code: EUR total_line_items_price: "224.97" total_line_items_price_set: shop_money: amount: "224.97" currency_code: EUR presentment_money: amount: "224.97" currency_code: EUR total_outstanding: "0.00" total_price: "238.47" total_price_set: shop_money: amount: "238.47" currency_code: EUR presentment_money: amount: "238.47" currency_code: EUR total_shipping_price_set: shop_money: amount: "0.00" currency_code: EUR presentment_money: amount: "0.00" currency_code: EUR total_tax: "13.50" total_tax_set: shop_money: amount: "13.50" currency_code: EUR presentment_money: amount: "13.50" currency_code: EUR total_tip_received: "0.00" total_weight: 0 updated_at: 2023-04-24T14:19:30-04:00 user_id: null billing_address: null customer: null discount_applications: [] fulfillments: [] line_items: - id: 1071823176 admin_graphql_api_id: gid://retailandecommerce/LineItem/1071823176 productCode: GC1060 fulfillable_quantity: 3 fulfillment_service: manual fulfillment_status: null gift_card: false grams: 1300 name: Modern Striped Dress Shirt price: "74.99" price_set: shop_money: amount: "74.99" currency_code: EUR presentment_money: amount: "74.99" currency_code: EUR product_exists: false product_id: null properties: [] quantity: 3 requires_shipping: true sku: null taxable: true title: Big Brown Bear Boots total_discount: "0.00" total_discount_set: shop_money: amount: "0.00" currency_code: EUR presentment_money: amount: "0.00" currency_code: EUR variant_id: null variant_inventory_management: null variant_title: null vendor: null tax_lines: - channel_liable: null price: "13.50" price_set: shop_money: amount: "13.50" currency_code: EUR presentment_money: amount: "13.50" currency_code: EUR rate: 0.06 title: State tax duties: [] discount_allocations: [] payment_terms: null refunds: [] shipping_address: null shipping_lines: [] ``` #### Responses * **201** Media type: `application/json`. Schema: `object`. * `correlationId` (_string_, required) A unique ID corresponding to the request. * `message` (_string_, required) The message indicating the order was placed successfully. _Example_ ``` correlationId: 4b15eb3a-a0ea-4ba2-9ba7-06e37d25b2a3 message: Order acknowledged successfully ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ### POST Search, Inquire, Redeem and Accrue transactions `POST /loyalty-integrations/restaurants/pos` This is used to create pos #### Parameters * `Transaction-Type` (header, string, required) Transaction type valid values are Allowed values: `LOYALTY_SEARCH`, `LOYALTY_INQUIRE`, `LOYALTY_REDEEM`, `LOYALTY_ACCRUE`. * `Transaction-GUID` (header, string) Unique identifier that identifies transactions when making API requests. * `Authorization` (header, string, required) Alphanumeric token to authorize the request. #### Request body Media type: `application/json`. Schema: `transactions-request`. _Example: loyalty-search_ ``` transactionType: LOYALTY_SEARCH searchTransactionInformation: searchCriteria: firstName: Greg lastName: "" email: "" phone: "14200000000" ``` _Example: loyatly-inquire_ ``` transactionType: LOYALTY_INQUIRE checkTransactionInformation: loyaltyIdentifier: "24345677" check: guid: 9d2dee33-7803-485a-a2b1-2c7538e597ee entityType: null paymentStatus: OPEN amount: 97.42 taxExempt: false totalAmount: 103.51 selections: - guid: 5e4fa4aa-4269-4383-9bbd-774591bbfb3c entityType: null externalId: null fulfillmentStatus: NEW item: guid: 5abf524e-31b5-4c1b-a797-7a44d888d071 entityType: MenuItem externalId: "100000000100004071" quantity: 8 ``` _Example: loyalty-redeem_ ``` transactionType: LOYALTY_REDEEM checkTransactionInformation: loyaltyIdentifier: "24345677" check: guid: 9c1opk33-7803-485a-a2b1-2c7538e597ee entityType: Check selections: [] redemptions: - identifier: 0kDHu000000QiyqMAC_00000006_HLDY2002SEAS amount: 19.24 ``` _Example: loyalty-accrue_ ``` transactionType: LOYALTY_ACCRUE searchTransactionInformation: null checkTransactionInformation: loyaltyIdentifier: "24345677" check: guid: 9d2dee33-7803-485a-a2b1-2c7538e597ee entityType: Check externalId: null displayNumber: "183" payments: - guid: 8b251345-3cda-486e-91c9-cd760c6087c6 entityType: OrderPayment houseAccount: null amount: 8 tipAmount: 0 amountTendered: 9 type: CASH paidDate: 2019-04-08T21:16:46.738Z paymentStatus: CAPTURED paymentStatus: CLOSED amount: 8 openedDate: 2023-11-21T08:16:45.862Z selections: - guid: c3283098-44c1-4712-866a-2b53cdc39w25 entityType: MenuItemSelection externalId: null fulfillmentStatus: SENT selectionType: NONE price: 8 quantity: 1 item: guid: 859d3db8-9dd4-42ab-9f6a-374d09e27825 entityType: MenuItem externalId: null createdDate: 2019-04-08T21:16:46.345Z closedDate: 2019-04-08T21:16:46.767Z ``` #### Responses * **200** Media type: `application/json`. Schema: `transactions-response`. _Example: loyalty-search_ ``` searchResponse: accounts: - identifier: "24345677" firstName: Greg lastName: Thompson phone: "14200000000" email: gregthompson@sfloyaltymanagementdemo.org transactionStatus: ACCEPT ``` _Example: loyalty-inquire_ ``` checkResponse: accountInfo: identifier: "24345677" firstName: Greg lastName: Thompson email: gregthompson@sfloyaltymanagementdemo.org offers: - identifier: 0kDHu000000QiyqMAC_00000006_HLDY2002SEAS name: HLDY2002SEAS applicable: true selectionType: CHECK amount: 19.4840 quantity: 1 expiration: - date: 2023-12-21T00:00:00Z quantity: 1 itemApplicable: [] rejectedRedemptions: [] appliedRedemptions: [] userMessage: Visit https://salesforce.com for exciting offers! transactionStatus: ACCEPT ``` _Example: loyalty-redeem_ ``` transactionStatus: ACCEPT checkResponse: accountInfo: identifier: "24345677" firstName: Greg lastName: Thompson email: gregthompson@sfloyaltymanagementdemo.org rejectedRedemptions: [] appliedRedemptions: - amount: 19.24 identifier: 0kDHu000000QiyqMAC_00000006_HLDY2002SEAS itemApplication: [] userMessage: Login to your loyalty account for some exciting offers! ``` _Example: loyalty-accrue_ ``` transactionStatus: ACCEPT ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `transactionStatus` (_string_, required) The error code corresponding to the error. * `message` (_string_) A short description of the error. _Example: invalid-toast-transaction-type_ ``` transactionStatus: ERROR_INVALID_TRANSACTION_TYPE ``` _Example: invalid-account_ ``` transactionStatus: ERROR_ACCOUNT_INVALID ``` _Example: invalid-token_ ``` transactionStatus: ERROR_INVALID_TOKEN ``` _Example_ ``` transactionStatus: NOT_FOUND message: Resource Not Found ``` _Example_ ``` transactionStatus: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` transactionStatus: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` transactionStatus: ERROR message: Internal Server Error ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `transactionStatus` (_string_, required) The error code corresponding to the error. * `message` (_string_) A short description of the error. _Example: invalid-toast-transaction-type_ ``` transactionStatus: ERROR_INVALID_TRANSACTION_TYPE ``` _Example: invalid-account_ ``` transactionStatus: ERROR_ACCOUNT_INVALID ``` _Example: invalid-token_ ``` transactionStatus: ERROR_INVALID_TOKEN ``` _Example_ ``` transactionStatus: NOT_FOUND message: Resource Not Found ``` _Example_ ``` transactionStatus: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` transactionStatus: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` transactionStatus: ERROR message: Internal Server Error ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `transactionStatus` (_string_, required) The error code corresponding to the error. * `message` (_string_) A short description of the error. _Example: invalid-toast-transaction-type_ ``` transactionStatus: ERROR_INVALID_TRANSACTION_TYPE ``` _Example: invalid-account_ ``` transactionStatus: ERROR_ACCOUNT_INVALID ``` _Example: invalid-token_ ``` transactionStatus: ERROR_INVALID_TOKEN ``` _Example_ ``` transactionStatus: NOT_FOUND message: Resource Not Found ``` _Example_ ``` transactionStatus: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` transactionStatus: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` transactionStatus: ERROR message: Internal Server Error ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `transactionStatus` (_string_, required) The error code corresponding to the error. * `message` (_string_) A short description of the error. _Example: invalid-toast-transaction-type_ ``` transactionStatus: ERROR_INVALID_TRANSACTION_TYPE ``` _Example: invalid-account_ ``` transactionStatus: ERROR_ACCOUNT_INVALID ``` _Example: invalid-token_ ``` transactionStatus: ERROR_INVALID_TOKEN ``` _Example_ ``` transactionStatus: NOT_FOUND message: Resource Not Found ``` _Example_ ``` transactionStatus: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` transactionStatus: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` transactionStatus: ERROR message: Internal Server Error ``` * **500** Internal Server Error Media type: `application/json`. Schema: `object`. * `transactionStatus` (_string_, required) The error code corresponding to the error. * `message` (_string_) A short description of the error. _Example: invalid-toast-transaction-type_ ``` transactionStatus: ERROR_INVALID_TRANSACTION_TYPE ``` _Example: invalid-account_ ``` transactionStatus: ERROR_ACCOUNT_INVALID ``` _Example: invalid-token_ ``` transactionStatus: ERROR_INVALID_TOKEN ``` _Example_ ``` transactionStatus: NOT_FOUND message: Resource Not Found ``` _Example_ ``` transactionStatus: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` transactionStatus: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` transactionStatus: ERROR message: Internal Server Error ``` ### POST Get eligible promotions `POST /global-promotions-management/get-eligible-promotions` Retrieves list of eligible promotions based on the cart line item details. #### Parameters * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Request body Media type: `application/json`. Schema: `cart`. _Example_ ``` cart: cartDetails: - cartLineDetails: - cartLineProduct: Iphone 13 cartLineProductCatalog: Electronics Devices cartLineItemQuantity: 1 cartLineItemAmount: 59000 cartLineProductCategory: cartLineProductCategory brand: Apple currencyISOCode: USD ProductCategoryId: "" ProductId: "" engagementChannelName: Facebook/Web/WhatsApp/Instagram/Twitter establishment: "" sourceLocation: WalmartRetailStore transactionLocation: HitechCity membershipNumber/emailId/contactNumber: LOYALTY00001 activityStartDate: 2024-01-06T00:00:00Z journalDate: 2024-01-06T00:00:00Z externalTransactionNumber: P1-981951 journalTypeName: Accrual voucherCode: "" status: Pending - cartLineDetails: - cartLineProduct: Iphone 14 cartLineProductCatalog: Electronics Devices cartLineItemQuantity: 1 cartLineItemAmount: 89000 brand: Apple - cartLineProduct: Iphone 15 cartLineProductCatalog: Electronics Devices cartLineItemQuantity: 1 cartLineItemAmount: 159000 brand: Apple currencyISOCode: USD engagementChannelName: Facebook/Web/WhatsApp/Instagram/Twitter establishment: "" sourceLocation: WalmartRetailStore transactionLocation: HitechCity membershipNumber/emailId/contactNumber: LOYALTY00001 activityStartDate: 2024-01-06T00:00:00Z journalDate: 2024-01-06T00:00:00Z externalTransactionNumber: P1-981952 journalTypeName: Accrual voucherCode: "" status: Pending ``` #### Responses * **200** Media type: `application/json`. Schema: `promotions`. _Example_ ``` - promotionName: Promo-001-Loyalty-Template promotionLimits: [] promotionEligibleRules: - ruleRewards: - rewardType: AssignGame rewardDetails: gameType: SpintheWheel gameDefinitionName: Game-002 outcomeType: nonPricingReward - rewardType: CreditFixedPoints rewardDetails: pointsExpiryDate: 2025-03-31 points: "400.0" loyaltyProgramCurrencyName: NQP outcomeType: nonPricingReward - rewardType: ProvideDiscount rewardDetails: discountValue: "1.0" discountType: PercentageOff discountLevel: Line discountCategory: Soft Drinks discountAppliedAt: LineItem outcomeType: pricingReward - rewardType: IssueVoucher rewardDetails: voucherExpiryDate: 2025-03-27 voucherDefinitionName: POSFixedVoucherDef outcomeType: nonPricingReward - rewardType: AssignBadge rewardDetails: loyaltyProgramBadgeName: Badge Test 1 outcomeType: nonPricingReward rulePriority: 1 ruleName: testSpendX promotionCode: Promo001LoyaltyTemplate priorityNumber: 23 isPromotionAutomaticallyApplied: false doesPromotionUpdateCart: true displayName: Promo-001-Loyalty-Template currencyIsoCode: USD additionalPromotionFields: {} - promotionName: null promotionLimits: [] promotionEligibleRules: - ruleRewards: - rewardType: CreditPoints rewardDetails: pointsExpiryDate: 2025-01-01 points: "100.00" loyaltyProgramCurrencyName: NQP outcomeType: nonPricingReward - rewardType: IssueVoucher rewardDetails: voucherExpiryDate: 2025-02-02 voucherDefinitionName: POSFixedVoucherDef outcomeType: nonPricingReward - rewardType: AssignBadgeToMember rewardDetails: loyaltyProgramBadgeName: Badge Test 1 outcomeType: nonPricingReward - rewardType: AssignGame rewardDetails: gameType: SpintheWheel gameDefinitionName: Game-001 outcomeType: nonPricingReward rulePriority: null ruleName: TestWithoutPromo promotionCode: null priorityNumber: null isPromotionAutomaticallyApplied: true doesPromotionUpdateCart: false displayName: null currencyIsoCode: USD additionalPromotionFields: {} - promotionName: TestPromoPOS promotionLimits: [] promotionEligibleRules: - ruleRewards: - rewardType: CreditPoints rewardDetails: pointsExpiryDate: 2025-01-01 points: "100.00" loyaltyProgramCurrencyName: NQP outcomeType: nonPricingReward - rewardType: AssignBadgeToMember rewardDetails: loyaltyProgramBadgeName: Badge Test 1 outcomeType: nonPricingReward - rewardType: IssueVoucher rewardDetails: voucherExpiryDate: 2025-02-02 voucherDefinitionName: POSFixedVoucherDef outcomeType: nonPricingReward - rewardType: AssignGame rewardDetails: gameType: SpintheWheel gameDefinitionName: Game-002 outcomeType: nonPricingReward rulePriority: null ruleName: TestProcessRule promotionCode: PROMO0001 priorityNumber: null isPromotionAutomaticallyApplied: true doesPromotionUpdateCart: false displayName: TestPromoPOS currencyIsoCode: USD additionalPromotionFields: {} ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ### POST Apply promotions `POST /global-promotions-management/apply-promotions` Applies eligible promotions like discounts, vouchers, games and badges on the loyalty member's account. #### Parameters * `Authorization` (header, string, required) Access token, which is used to make requests to secure resources. #### Request body Media type: `application/json`. Schema: `transaction-journal`. _Example_ ``` transactionJournals: - ActivityDate: 2022-01-04T12:45:19Z JournalDate: 2022-01-04T00:45:19Z Brand: "" Establishment: Apple ExternalTransactionNumber: P1-981950 JournalTypeId: 0lET10000004CQp LoyaltyProgramId: 0lpT10000004CdN MemberId/ReferredPartyId: 0lMT10000004CfA TransactionAmount: "117" TransactionLocation: HitechCity VoucherCode: "" Origin: asdf Distance: "5" Destination: Hyderabad FlightNumber: SF-Ran-001 Status: Pending CurrencyIsoCode: USD appliedPromotions: - promotionId: "" promotionCode: "" rewards: - rewardType: Discount discountAmount: 15 - rewardType: Points loyaltyProgramCurrencyId: "***" loyaltyProgramCurrencyName: "" points: 100 pointsExpirationDate: 2023-10-10 relatedInformation: "" notes: "" - rewardType: Voucher voucherDefinitionId: "***" voucherDefinitionName: "" voucherCode: "" voucherExpirationDate: 2023-10-10 voucherEffectiveDate: "" voucherFaceValue: "" voucherDiscountPercentage: 10 notes: "" - rewardType: Badge loyaltyProgramBadgeId: "***" loyaltyProgramBadgeName: "" memberBadgeStatus: "" badgeValidityEndDate: "" reason: "" - rewardType: Game gameDefinitionName: "" gameExpirationDate: 2023-10-10 ``` #### Responses * **200** Media type: `application/json`. Schema: `post-facto-response`. _Example_ ``` processResult: transactionJournalResult: - id: "" badgesAssigned: - loyaltyProgramBadgeName: "" memberBadgeStatus: "" badgeValidityEndDate: null reason: "" gamesAssigned: - gameParticipantId: OldXXXX gameParticipantRewardId: 0ldXXX gameExpirationDate: null ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **404** Resource not found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **405** Method Not Allowed Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` * **415** Un supported media type Media type: `application/json`. Schema: `object`. * `errorCode` (_string_, required) The error code corresponding to the error. * `message` (_string_, required) A short description of the error. _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` _Example_ ``` errorCode: INVALID_API_INPUT message: The membership number M123456789 is already taken. Specify a unique membership number and try again ``` _Example_ ``` errorCode: NOT_FOUND message: Resource Not Found ``` _Example_ ``` errorCode: NOT_ALLOWED message: Method Not Allowed ``` _Example_ ``` errorCode: UNSUPPORTED_MEDIA_TYPE message: Media Type Not Supported ``` ## Schemas ### member-enrollment-request * `enrollmentDate` (_datetime-only_, required) The date on which the member is enrolled. * `membershipNumber` (_string_, required) The unique membership number of the member. * `associatedContactDetails` (_object_, required) The person account record details of the member. * `firstName` (_string_, required) The first name of the member being enrolled. * `lastName` (_string_, required) The last name of the member being enrolled. * `email` (_string_, required) The email address of the member being enrolled. * `allowDuplicateRecords` (_string_) Indicates whether a duplicate member record can be created, when a record with identical details exists in the org. Allowed values: `true`, `false`. * `additionalContactFieldValues` (_object_) The additional attributes that must be saved in the person account. * `attributes` (_object_) * `PersonMailingCity` (_string_) * `CustomNumber__c` (_string_) * `memberStatus` (_string_) The status of the member. Possible values are Active, Inactive, and Custom * `referredBy` (_string_) The membership number of the member who referred the member. * `referredByMemberReferralCode` (_string_) The referral code of the member who referred the member. * `createTransactionJournals` (_string_) Indicates whether to create transaction journal records (true) or not (false). Transaction journal records are created to Credit points to the member for enrolling and Credit points to the member who referred the new member. * `transactionJournalStatementFrequency` (_string_) The frequency at which transaction journal statements must be delivered to the member. Possible values are Monthly and Quarterly. * `transactionJournalStatementMethod` (_string_) The method that delivers transaction journal statements to the member. Possible values are Mail and Email. * `enrollmentChannel` (_string_) The channel used by members to enroll in the program. Possible values are POS, Web, Email, CallCenter, Social, Mobile, Store, Franchise, Partner, and Print. * `canReceivePromotions` (_string_) Indicates whether the member can receive promotions for the program (true) or not (false). Allowed values: `true`, `false`. * `membershipEndDate` (_datetime-only_) The date on which the membership ends. * `relatedCorporateMembershipNumber` (_string_) The external corporate membership number of the member. * `additionalMemberFieldValues` (_object_) The custom attributes of the member in the member record. Keys and Values * `attributes` (_object_) * `CustomBoolean__c` (_string_) The value for custom boolean, could be true or false. Allowed values: `true`, `false`. * `posName__c` (_string_) The name of the member from the Point Of Sale (POS) system. * `posMemMobile__c` (_number_) The phone number of the member from the POS system. * `posMemId__c` (_number_) The POS Member ID. * `posOrderCount__c` (_string_) The total count of orders processed through a POS system. ### orders * `requestType` (_string_, required) Indicates if the request is to place or cancel the order. * `newExternalTransactionNumber` (_string_) The new external transaction number. * `isOrderFinalCancellation` (_boolean_) Indicates the final cancellation of order. * `currencyName` (_string_) The currency used for placing the order. * `redemptionJournalId` (_string_) A unique value that references the redemption journal Id. * `order` (_object_, required) * `loyaltyProgramName` (_string_) Indicates the name of the loyalty program. * `membershipNumber` (_string_, required) Indicates the membership number of the loyalty member. * `id` (_number_) A unique ID represeting the order * `admin_graphql_api_id` (_string | any_) A unique ID representing the graphql API ID. One of: `string`, `any`. * `app_id` (_number | any_) A unique ID representing the application's ID. One of: `number`, `any`. * `browser_ip` (_string | any_) The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported. One of: `string`, `any`. * `buyer_accepts_marketing` (_boolean_) Indicates if the loyalty member wants to receive marketing notifications. * `cancel_reason` (_string | any_) Reason for cancelling the order. One of: `string`, `any`. * `cancelled_at` (_string | any_) The date and time when the order was canceled. Returns null if the order isn't canceled. One of: `string`, `any`. * `cart_token` (_string | any_) A unique value when referencing the cart that's associated with the order. One of: `string`, `any`. * `checkout_id` (_string | any_) ID referencing the checkout of the order. One of: `string`, `any`. * `checkout_token` (_string | any_) A unique value when referencing the checkout that's associated with the order. One of: `string`, `any`. * `client_details` (_string | any_) Details pertaining to the client that was used to place the order. One of: `string`, `any`. * `closed_at` (_string | any_) The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed. One of: `string`, `any`. * `confirmed` (_boolean_) Indicates order confirmation. * `contact_email` (_string | any_) Email address of the contact. One of: `string`, `any`. * `created_at` (_datetime_) The autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed. * `currency` (_string_) The three-letter code (ISO 4217 format) for the shop currency. * `pointsRedemption` (_object_) * `points` (_number_) The number of points to be redeemed Minimum: 0. * `additionalNotes` (_string_) Any notes pertaining to the redemption. * `programCurrencyName` (_string_) The currency code corresponding to the loyalty program. * `current_subtotal_price` (_string_) The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds. * `current_subtotal_price_set` (_object_) The current subtotal price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `current_total_additional_fees_set` (_string | any_) he current total additional fees on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds One of: `string`, `any`. * `current_total_discounts` (_string | any_) The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds. One of: `string`, `any`. * `current_total_discounts_set` (_object_) The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `current_total_duties_set` (_string | any_) The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. One of: `string`, `any`. * `current_total_price` (_string | any_) The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds. One of: `string`, `any`. * `current_total_price_set` (_object_) The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `current_total_tax` (_string_) The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. * `current_total_tax_set` (_object_) The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `customer_locale` (_string | any_) The two or three-letter language code, optionally followed by a region modifier. One of: `string`, `any`. * `device_id` (_string | any_) One of: `string`, `any`. * `discount_codes` (_array of object_) A list of discounts applied to the order. Each discount object includes the following properties (described in the array). * `voucherCode` (_string | any_, required) When the associated discount application is of type code, this property returns the discount code that was entered at checkout. Otherwise this property returns the title of the discount that was applied. One of: `string`, `any`. * `redeemAmount` (_number | any_) The amount that's deducted from the order total. When you create an order, this value is the percentage or monetary amount to deduct. After the order is created, this property returns the calculated amount. One of: `number`, `any`. * `email` (_string | any_) The customer's email address. One of: `string`, `any`. * `estimated_taxes` (_boolean | any_) Whether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. This property returns false when taxes on the order are finalized and aren't subject to any changes. One of: `boolean`, `any`. * `financial_status` (_string | any_) The status of payments associated with the order. Can only be set when the order is created. Valid values could be pending, authorized, partially\_paid, paid, partially\_refunded, refunded and voided. One of: `string`, `any`. * `fulfillment_status` (_string | any_) The order's status in terms of fulfilled line items. You can use the FulfillmentOrder resource for a more granular view. Valid values could be fulfilled, null, partial, restocked. One of: `string`, `any`. * `landing_site` (_string | any_) The URL for the page where the buyer landed when they entered the shop. One of: `string`, `any`. * `landing_site_ref` (_string | any_) The reference to the landing site. One of: `string`, `any`. * `location_id` (_string | any_) The ID of the physical location where the order was processed. One of: `string`, `any`. * `merchant_of_record_app_id` (_string | any_) The application acting as Merchant of Record for the order. One of: `string`, `any`. * `name` (_string | any_) The order name, generated by combining the order\_number property with the order prefix and suffix that are set in the merchant's general settings. This is different from the id property, which is the ID of the order used by the API. This field can also be set by the API to be any string value. One of: `string`, `any`. * `note` (_string | any_) An optional note that a shop owner can attach to the order. One of: `string`, `any`. * `note_attributes` (_array of string_) Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys. * `number` (_number_) The order's position in the shop's count of orders. Numbers are sequential and start at 1. * `order_number` (_number_, required) The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001. * `order_status_url` (_string | any_) The URL pointing to the order status web page, if applicable. One of: `string`, `any`. * `original_total_additional_fees_set` (_string | any_) The original total additional fees on the order in shop and presentment currencies. One of: `string`, `any`. * `original_total_duties_set` (_string | any_) The original total duties charged on the order in shop and presentment currencies. One of: `string`, `any`. * `payment_gateway_names` (_array of string_) The list of payment gateways used for the order. * `phone` (_number | any_) The customer's phone number for receiving SMS notifications. One of: `number`, `any`. * `presentment_currency` (_string | any_) The presentment currency that was used to display prices to the customer. One of: `string`, `any`. * `processed_at` (_datetime | any_) The date and time (ISO 8601 format) when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports. If you're importing orders from an app or another platform, then you can set processed\_at to a date and time in the past to match when the original order was created. One of: `datetime`, `any`. * `reference` (_string | any_) The website reference. One of: `string`, `any`. * `referring_site` (_string | any_) The website where the customer clicked a link to the shop. One of: `string`, `any`. * `source_identifier` (_string | any_) The ID of the order placed on the originating platform. This value doesn't correspond to the Shopify ID that's generated from a completed draft. One of: `string`, `any`. * `source_name` (_string | any_) The source of the checkout. One of: `string`, `any`. * `source_url` (_string | any_) A valid URL to the original order on the originating surface. This URL is displayed to merchants on the Order Details page. If the URL is invalid, then it won't be displayed. One of: `string`, `any`. * `subtotal_price` (_string | any_) The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips. One of: `string`, `any`. * `subtotal_price_set` (_object_) The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `tags` (_string_) Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length. * `tax_lines` (_array of object_) A list of tax line objects with details of tax applied to the order. * `price` (_string | any_, required) The tax charge in shop currency. One of: `string`, `any`. * `rate` (_number | any_, required) The rate of tax. One of: `number`, `any`. * `title` (_string | any_, required) The name of the tax. One of: `string`, `any`. * `price_set` (_object_, required) * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `channel_liable` (_string | any_, required) Indicates whether the channel that submitted the tax line is liable for remitting. A null value indicates an unknown liability for the tax line. One of: `string`, `any`. * `taxes_included` (_boolean | any_) Whether taxes are included in the order subtotal. One of: `boolean`, `any`. * `test` (_boolean | any_) Whether this is a test order. One of: `boolean`, `any`. * `token` (_string | any_) A unique value when referencing the order. One of: `string`, `any`. * `total_discounts` (_string | any_) The total discounts applied to the price of the order in the shop currency. One of: `string`, `any`. * `total_discounts_set` (_object_) The total discounts applied to the price of the order in shop and presentment currencies. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `total_line_items_price` (_string | any_) The sum of all line item prices in the shop currency. One of: `string`, `any`. * `total_line_items_price_set` (_object_) The total of all line item prices in shop and presentment currencies. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `total_outstanding` (_string | any_) The total outstanding amount of the order in the shop currency. One of: `string`, `any`. * `total_price` (_string | any_) The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive. One of: `string`, `any`. * `total_price_set` (_object_) The total price of the order in shop and presentment currencies. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `total_shipping_price_set` (_object_) The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes\_included is set to true, then total\_shipping\_price\_set includes taxes. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `total_tax` (_string | any_) The sum of all the taxes applied to the order in the shop currency. Must be positive. One of: `string`, `any`. * `total_tax_set` (_object_) The total tax applied to the order in shop and presentment currencies. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `total_tip_received` (_string | any_) The total tax applied to the order in shop and presentment currencies. One of: `string`, `any`. * `total_weight` (_number | any_) The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order. One of: `number`, `any`. * `updated_at` (_datetime | any_) The date and time (ISO 8601 format) when the order was last modified. One of: `datetime`, `any`. * `user_id` (_number | any_) The ID of the user logged into Shopify POS who processed the order, if applicable. One of: `number`, `any`. * `billing_address` (_string | any_) The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. One of: `string`, `any`. * `customer` (_object | any_) Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null if the order was created through Shopify POS. One of: `object`, `any`. * `discount_applications` (_array of object_) * `allocation_method` (_string_, required) The method by which the discount application value is allocated to entitled lines. Valid values are across, each, and one. * `code` (_string_, required) The discount code used to apply the discount. Available only for discount code applications. * `description` (_string_, required) The description of the discount application. Available only for manual and script discount applications. * `target_selection` (_string_, required) The order line, of the type defined by target\_type, that the discount is allocated over. Valid values are all, entitled, and explicit. * `target_type` (_string_, required) The type of order line that the discount is applicable to. Valid values are line\_item and shipping\_line. * `title` (_string_, required) The title of the discount application, as defined by the merchant. Available only for manual discount applications. * `type` (_string_, required) The discount application type. Valid values are automatic, discount\_code, manual, and script. * `value` (_string_, required) The decimal value by which the price of an order or a product is reduced, when a discount is applied. For example, to apply a 20% discount, the value is 20.0. * `value_type` (_string_, required) The type of the value. Valid values are fixed\_amount and percentage. * `fulfillments` (_array of string | any_) An array of fulfillments associated with the order. * `line_items` (_array of object_, required) A list of line item objects, each containing information about an item in the order. * `id` (_number_) The ID of the line item. * `admin_graphql_api_id` (_string | any_) One of: `string`, `any`. * `productCode` (_string | any_, required) Indicates the code associated with the product. One of: `string`, `any`. * `fulfillable_quantity` (_number | any_, required) Indicates the quantity that can be fulfilled. One of: `number`, `any`. * `fulfillment_service` (_string | any_) One of: `string`, `any`. * `fulfillment_status` (_string | any_) The fulfillment status. One of: `string`, `any`. * `gift_card` (_boolean | any_) Whether the item is a gift card. If true, then the item is not taxed or considered for shipping charges. One of: `boolean`, `any`. * `grams` (_number | any_) The weight of item in grams One of: `number`, `any`. * `name` (_string | any_) One of: `string`, `any`. * `price` (_string | any_, required) The price of the item before discounts have been applied in the shop currency. One of: `string`, `any`. * `price_set` (_object_) The price of the line item in shop and presentment currencies. * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `product_exists` (_boolean | any_) Indicates whether the product is in stock. One of: `boolean`, `any`. * `product_id` (_string | any_) A unique ID associated with the product. One of: `string`, `any`. * `properties` (_array of string_) An array of custom information for the item that has been added to the cart. Often used to provide product customization options. * `quantity` (_number | any_) The number of items that were purchased. One of: `number`, `any`. * `requires_shipping` (_boolean | any_) Whether the item requires shipping. One of: `boolean`, `any`. * `sku` (_string | any_) The item's SKU (stock keeping unit). One of: `string`, `any`. * `taxable` (_boolean | any_) Whether the item was taxable. One of: `boolean`, `any`. * `title` (_string | any_) The title of the product. One of: `string`, `any`. * `total_discount` (_string | any_) One of: `string`, `any`. * `total_discount_set` (_object_) * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `variant_id` (_string | any_) The variant ID. One of: `string`, `any`. * `variant_inventory_management` (_string | any_) The variant inventory management. One of: `string`, `any`. * `variant_title` (_string | any_) The title of the product variant. One of: `string`, `any`. * `vendor` (_string | any_) The name of the item's supplier. One of: `string`, `any`. * `tax_lines` (_array of object_) A list of tax line objects, each of which details a tax applied to the item. * `price` (_string | any_, required) The tax charge in shop currency. One of: `string`, `any`. * `rate` (_number | any_, required) The rate of tax. One of: `number`, `any`. * `title` (_string | any_, required) The name of the tax. One of: `string`, `any`. * `price_set` (_object_, required) * `shop_money` (_object_, required) A money value, in the shop’s currency. * `amount` (_string_, required) The amount used to show the prices. * `currency_code` (_string_, required) Three-letter ISO 4217 currency code of the monetary currency that the prices are shown in. * `presentment_money` (_object_, required) A money value, in the local (presentment) currency. * `amount` (_string_, required) The presentment amount that shows the prices. * `currency_code` (_string_, required) The presentment currency that the prices are shown in. * `channel_liable` (_string | any_, required) Indicates whether the channel that submitted the tax line is liable for remitting. A null value indicates an unknown liability for the tax line. One of: `string`, `any`. * `payment_terms` (_string | any_) One of: `string`, `any`. * `refunds` (_array of string | any_) * `shipping_address` (_string | any_) The shipping address One of: `string`, `any`. * `shipping_lines` (_array of string | any_) An array of string, each of which details a shipping method used. ### transactions-request * `transactionType` (_string_, required) The transaction type valid values are Allowed values: `LOYALTY_INQUIRE`, `LOYALTY_SEARCH`, `LOYALTY_REDEEM`, `LOYALTY_ACCRUE`. * `searchTransactionInformation` (_searchCriteria | any_) The details required to initiate a search transaction. One of: `searchCriteria`, `any`. * `checkTransactionInformation` (_checkTransactionInformation | any_) The details required to complete a transaction. One of: `checkTransactionInformation`, `any`. ### transactions-response * `searchResponse` (_object_) The response that provides the details when you search for a loyalty member. * `accounts` (_array of object_, required) Details of the accounts that match the search criteria. * `identifier` (_string_, required) The loyalty program membership number. * `firstName` (_string_, required) The first name of the member that you are searching for. * `lastName` (_string_, required) The last name of the member that you are searching for. * `phone` (_string | any_, required) The phone number of the member that you are searching for. One of: `string`, `any`. * `email` (_string | any_, required) The email address of the member that you are searching for. One of: `string`, `any`. * `checkResponse` (_object_) The response to a transaction request. * `accountInfo` (_object_) The details of the account whose vouchers you want to retrieve or redeem. * `identifier` (_string_, required) The loyalty program membership number of the member whose vouchers you want to retrieve or redeem. * `firstName` (_string_, required) The first name of the member whose vouchers you want to retrieve or redeem. * `lastName` (_string_, required) The last name of the member whose vouchers you want to retrieve or redeem. * `phone` (_string | any_) The phone number of the member whose vouchers you want to retrieve or redeem. One of: `string`, `any`. * `email` (_string | any_, required) The email address of the member whose vouchers you want to retrieve or redeem. One of: `string`, `any`. * `appliedRedemptions` (_array of object_) The details of successful voucher redemptions. Minimum items: 0. * `amount` (_number | any_, required) The dollar (or other currency) amount that this offer actually discounts. One of: `number`, `any`. * `appliedDiscountGuid` (_string | any_) The GUID of the AppliedDiscount on the Check or Selection object corresponding to the discount. This is required if the Redemption object is contained within the RejectionRedemption object and identifies the rejected redemption. This is included to differentiate if multiple redemptions of the same type are applied to the same check or item. One of: `string`, `any`. * `identifier` (_string_, required) Identifier of the Offer to be redeemed. The Offer must be one that was returned by the provider in response to an inquiry request. * `itemApplication` (_array of object_) Indicates the type of item. If the redemption offer is of type MULTI\_ITEM, this array includes the selections that the offer is applied to, along with the amount and the identifier of the discounts applied to each selection. If this field exists, then the selectionGuid, appliedDiscountGuid, and amount fields are blank because the values in this array conveys that information. Minimum items: 0. * `amount` (_number_, required) The currency amount of the discount applied to this item. This value can be updated in future calls. This field is optional in response to LOYALTY\_INQUIRE requests and required in response to LOYALTY\_REDEEM requests. * `appliedDiscountIdentifier` (_string_, required) If this redemption has been applied, this is the identifier of the applied discount created for this offer on this selection. It will correspond to the guid field of the AppliedDiscount object on the Selection. Response only. * `selectionIdentifier` (_string_, required) The identifier of the selection that discount is applied to. This will correspond to the guid field on the Selection object that is included with the Check. restaurant uses these values to determine which item(s) will have the offer applied. * `multiItemDiscountGuid` (_string | any_) The GUID of a Multi Item Redemption. A Multi Item Redemption is a single loyalty redemption that applied to multiple items on the check. For instance, a "$3 off burgers, $2 off fries, and $1 off a drink" would be a single loyalty redemption that applies to 3 separate items. This field is an identifier for a Multi Item redemption, but does not correspond to any one object on the Check. To see what items were discounted, refer to the itemApplication field. One of: `string`, `any`. * `quantity` (_number | any_) The number of times the offer has been applied to the item or check. For example, if an offer is a stackable "$5 off check" discount, this field could indicate that multiple copies of that offer have been applied. One of: `number`, `any`. * `selectionGuid` (_string | any_) If this is an item level discount, the guid of the selection that this redemption is attached to. If this redemption has not been added to a specific selection yet, this field will be absent. One of: `string`, `any`. * `offers` (_array of object_) The details of member vouchers. * `amount` (_number | any_, required) The value that the member can redeem using the voucher. One of: `number`, `any`. * `applicable` (_boolean_, required) Indicates whether the voucher is valid (true) or not (false). * `expiration` (_array of object_) The details of voucher expiration. * `date` (_string_, required) The date of expiry of the voucher. * `quantity` (_number_, required) The number of vouchers that expire on the expiration date. * `identifier` (_string_, required) The combination of voucher ID, voucher name, and voucher code. * `itemApplication` (_array of object_) Indicates if the offer or voucher is applicable on this item. Currently, we support only cart level vouchers. * `amount` (_number_, required) The currency amount of the discount applied to this item. This value can be updated in future calls. This field is optional in response to LOYALTY\_INQUIRE requests and required in response to LOYALTY\_REDEEM requests. * `appliedDiscountIdentifier` (_string_, required) If this redemption has been applied, this is the identifier of the applied discount created for this offer on this selection. It will correspond to the guid field of the AppliedDiscount object on the Selection. Response only. * `selectionIdentifier` (_string_, required) The identifier of the selection that discount is applied to. This will correspond to the guid field on the Selection object that is included with the Check. restaurant uses these values to determine which item(s) will have the offer applied. * `name` (_string_, required) The voucher code. * `quantity` (_number_, required) The number of redeemable vouchers. * `selectionType` (_string_, required) Describes what this offer covers. A CHECK level discount applies to the entire check, without requirements on the items contained within the check. An ITEM level discount applies to a specific item on the check. Allowed values: `CHECK`, `ITEM`, `MULTI_ITEM`. * `rejectedRedemptions` (_array of object_) The details of rejected voucher redemptions. Minimum items: 0. * `message` (_string_, required) An explanation of why the discount was rejected. * `redemption` (_object_, required) Information about an offer to be redeemed (or that was redeemed) to a check. * `amount` (_number | any_) The dollar (or other currency) amount that this offer actually discounts. One of: `number`, `any`. * `appliedDiscountGuid` (_string | any_) The GUID of the AppliedDiscount on the Check or Selection object corresponding to the discount. This is required if the Redemption object is contained within the RejectionRedemption object and identifies the rejected redemption. This is included to differentiate if multiple redemptions of the same type are applied to the same check or item. One of: `string`, `any`. * `identifier` (_string_, required) Identifier of the Offer to be redeemed. The Offer must be one that was returned by the provider in response to an inquiry request. * `itemApplication` (_array of object_) Minimum items: 0. * `amount` (_string_, required) The currency amount of the discount applied to this item. This value can be updated in future calls. This field is optional in response to LOYALTY\_INQUIRE requests and required in response to LOYALTY\_REDEEM requests. * `appliedDiscountIdentifier` (_string | any_) If this redemption has been applied, this is the identifier of the applied discount created for this offer on this selection. It will correspond to the guid field of the AppliedDiscount object on the Selection. Response only. One of: `string`, `any`. * `selectionIdentifier` (_string | any_) The identifier of the selection that discount is applied to. This will correspond to the guid field on the Selection object that is included with the Check. restaurant uses these values to determine which item(s) will have the offer applied. One of: `string`, `any`. * `multiItemDiscountGuid` (_string | any_) The GUID of a Multi Item Redemption. A Multi Item Redemption is a single loyalty redemption that applied to multiple items on the check. For instance, a "$3 off burgers, $2 off fries, and $1 off a drink" would be a single loyalty redemption that applies to 3 separate items. This field is an identifier for a Multi Item redemption, but does not correspond to any one object on the Check. To see what items were discounted, refer to the itemApplication field. One of: `string`, `any`. * `quantity` (_number | any_) The number of times the offer has been applied to the item or check. For example, if an offer is a stackable "$5 off check" discount, this field could indicate that multiple copies of that offer have been applied. One of: `number`, `any`. * `selectionGuid` (_string | any_) If this is an item level discount, the guid of the selection that this redemption is attached to. If this redemption has not been added to a specific selection yet, this field will be absent. One of: `string`, `any`. * `userMessage` (_string_, required) The optional message that you can include in a response. * `transactionStatus` (_string_, required) The status of a transaction. Possible values are ACCEPT, ERROR\_INVALID\_TRANSACTION\_TYPE, ERROR\_ACCOUNT\_INVALID and ERROR\_INVALID\_TOKEN ### cart * `cart` (_object_, required) * `cartDetails` (_array of object_, required) * `activityStartDate` (_datetime_, required) The start date of the activity to get the cart details. * `contactId` (_string_) The loyalty program memberId or the contactId. * `loyaltyProgramMemberId` (_string_) The ID of the loyalty program member whose cart details must be fetched. * `transactionAmount` (_number_) The absolute value of the transaction. * `currencyISOCode` (_string_, required) Three-letter ISO 4217 code of the active monetary currency associated with the promotion. * `engagementChannelId` (_string_) The identification number of the engagement channel. * `sourceLocation` (_string_) The location of the source. * `engagementChannelName` (_string_) The name of the engagement channel. * `establishment` (_string_) The name of the establishment. * `transactionLocation` (_string_) The location where the member performed the transaction. * `membershipNumber` (_string_) The membership number or email ID. * `emailId` (_string_) The email ID of the member. * `contactNumber` (_string_) The contact number of the member. * `journalDate` (_datetime_) The date when the transaction journal was created. * `externalTransactionNumber` (_string_, required) The external transaction number. * `journalTypeName` (_string_, required) The name of the journal type. * `voucherCode` (_string_) The voucher identifier that an external system generates. * `ProductId` (_string_) The product ID. * `ProductCategoryId` (_string_) The product category ID. * `status` (_string_, required) The status of the transaction. ### promotions Array of `object`. * `additionalPromotionFields` (_object_, required) The additional details of the promotion. * `promotionCode` (_string | any_, required) The unique code of the eligible promotion. One of: `string`, `any`. * `displayName` (_string | any_, required) The display name of the eligible promotion. One of: `string`, `any`. * `priorityNumber` (_number | any_, required) The number that determines the priority of the promotion in a list of eligible promotions. One of: `number`, `any`. * `currencyIsoCode` (_string_, required) Three-letter ISO 4217 code of the monetary currency associated with the promotion. * `promotionEligibleRules` (_array of object_, required) * `ruleName` (_string_, required) The name of the rule. * `rulePriority` (_number | any_, required) The order of priority that the rule is applied in. One of: `number`, `any`. * `ruleRewards` (_array of object_, required) * `rewardType` (_string_, required) The type of reward. * `rewardDetails` (_object_, required) The details of the reward. * `discountLevel` (_string_) The level of the discount. * `discountType` (_string_) The type of discount. * `discountValue` (_string_) The amount of discount to be offered. * `discountCategory` (_string_) The product category on which the discount applies. * `discountAppliedAt` (_string_) The line item to which the discount will be applied. * `pointsExpiryDate` (_date-only_) The date on which the points expire. * `points` (_string_) The points awarded. * `loyaltyProgramCurrencyName` (_string_) The name of the loyalty program currency. * `voucherExpiryDate` (_date-only_) The expiry date of the voucher. * `voucherDefinitionName` (_string_) The definition name of the voucher. * `gameType` (_string_) The type of the game. * `gameDefinitionName` (_string_) The name of the game definition. * `outcomeType` (_string_, required) The outcome of the reward. * `isPromotionAutomaticallyApplied` (_boolean | any_, required) Indicates if the promotion can be auto applied. One of: `boolean`, `any`. * `doesPromotionUpdateCart` (_boolean | any_, required) Indicates if any free product gets added to the cart based on the promotion. One of: `boolean`, `any`. * `errorMessage` (_string_) Indicates the details of error if any. * `promotionLimits` (_array of any | any_, required) Placeholder for promotionLimits One of: `array of any`, `any`. ### transaction-journal * `transactionJournals` (_array of object_, required) * `ActivityDate` (_datetime_) The date and time of the transaction. * `JournalDate` (_datetime_) The date of the journal. * `Brand` (_string_) The hotel chain where the member stayed or the brand of the purchased or rented goods or services. * `Establishment` (_string_) The unique identifier for the location that the member stayed at or purchased goods or services from. * `ExternalTransactionNumber` (_string_) The transaction number from the external systems. * `JournalTypeId` (_string_, required) The journal type ID of the transaction. * `LoyaltyProgramId` (_string_, required) The loyalty program associated with the transaction. * `MemberId` (_string_) The member ID associated with the transaction. * `ReferredPartyId` (_string_) The ID of the loyalty program member to whom the member referred. * `TransactionAmount` (_string_) For reservations, the total fees or prepaid balance. For goods and services, the total purchase price. * `TransactionLocation` (_string_) The location where the loyalty member purchased goods or services. * `VoucherCode` (_string_) The voucher identifier generated by an external system. * `Origin` (_string_) The starting location for a member's trip or the place where an order ships from. * `Distance` (_string_) The miles or kilometers that a member travels or an order's shipping distance. * `Destination` (_string_) The ending location for a member's trip or the place where an order ships to. * `FlightNumber` (_string_) The airline flight number the member booked. * `Status` (_string_) The status of the transaction. * `CurrencyIsoCode` (_string_) The currency ISO code. * `appliedPromotions` (_array of object_, required) The details of applied promotions. * `promotionId` (_string_) The ID of the eligible promotion. * `promotionCode` (_string_) The code of the eligible promotion. * `rewards` (_array of object_, required) The list of rewards that the eligible promotions offer. * `rewardType` (_string_, required) The type of reward that the promotion rule offers. Allowed values: `Discount`, `Points`, `Voucher`, `Badge`, `Game`. * `discountAmount` (_number_) The discount amount that the promotion offers. * `loyaltyProgramCurrencyId` (_string_) The loyalty program currency associated with the promotion. * `loyaltyProgramCurrencyName` (_string_) The name of the loyalty program currency for which points are debited from or credited to the loyalty program member associated with the transaction journal. * `points` (_number_) The points available to the loyalty program member. * `pointsExpirationDate` (_date-only_) The date when points expire. * `relatedInformation` (_string_) The related information on the points. * `notes` (_string_) The additional information. * `voucherDefinitionId` (_string_) The ID of the voucher definition. * `voucherDefinitionName` (_string_) The name of the voucher definition. * `voucherCode` (_string_) The unique code of the voucher. * `voucherExpirationDate` (_string_) The date when the voucher expires. * `voucherEffectiveDate` (_string_) The date that the voucher is effective from. * `voucherFaceValue` (_string_) The face value of the voucher that members can redeem. * `voucherDiscountPercentage` (_number_) The discount percentage on the product. * `loyaltyProgramBadgeId` (_string_) The loyalty program badge ID that's associated with the loyalty program member. * `loyaltyProgramBadgeName` (_string_) The name of the assigned badge. * `memberBadgeStatus` (_string_) The status of the assigned badge. * `badgeValidityEndDate` (_string_) The validity end date of the member badge. * `reason` (_string_) The reason the badge was assigned to the member. * `gameDefinitionName` (_string_) The name of the game definition. * `gameExpirationDate` (_date-only_) The date when the game expires. ### post-facto-response * `processResult` (_object_, required) * `transactionJournalResult` (_array of object_, required) * `id` (_string_, required) The ID of the transaction journal. * `badgesAssigned` (_array of object_, required) The list of badges assigned to the member for their cart. * `loyaltyProgramBadgeName` (_string_, required) The name of the assigned badge. * `memberBadgeStatus` (_string_, required) The status of the badge that's assigned to the member. * `badgeValidityEndDate` (_date-only | any_, required) The date on which the assigned badge is no longer assigned to the member. One of: `date-only`, `any`. * `reason` (_string_, required) The reason why the badge was assigned to the member. * `gamesAssigned` (_array of object_, required) The list of games assigned to the member for their cart. * `gameParticipantId` (_string_, required) The ID of the participant’s contact, account, or loyalty program member record. * `gameDefinitionName` (_string_) The name of the game definition that's assigned to the member. * `gameParticipantRewardId` (_string_, required) The ID of the game participant reward record that stores the details of the reward that the member receives after they play the game. The record is associated with the source transaction journal and the record that issues the reward to the participant. * `gameExpirationDate` (_date-only | any_, required) The date when the game expires for the member. One of: `date-only`, `any`. ### searchCriteria * `searchCriteria` (_object_, required) The criteria that you can use to search for the loyalty member. * `email` (_string | any_) The email address of the member that you are searching for. One of: `string`, `any`. * `firstName` (_string | any_) The first name of the member that you are searching for. One of: `string`, `any`. * `lastName` (_string | any_) The last name of the member that you are searching for. One of: `string`, `any`. * `phone` (_phoneNumber | any_) The phone number of the member that you are searching for. One of: `phoneNumber`, `any`. ### checkTransactionInformation * `check` (_object_) The details required to complete a transaction. * `amount` (_number_) The price of an item in a transaction. This value is used to calculate the amount that can be discounted when issuing a discount voucher. * `appliedDiscounts` (_array of object_) The discounts applied to this check. Minimum items: 0. * `appliedPromoCode` (_string | any_) The promo code that was applied for this discount. One of: `string`, `any`. * `approver` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `comboItems` (_array of entityWrapper | any_) A List of Menu Item Selections that this discount is applied to (empty for NonCombo Discounts). * `discount` (_object_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string_, required) The type of object this is. * `guid` (_string_, required) The GUID maintained by restaurant. * `discountAmount` (_number_) The discount amount in USD. This amount will be subtracted from the check or item. * `entityType` (_string_, required) The type of object this is. * `guid` (_string_, required) The GUID maintained by restaurant. * `loyaltyDetails` (_object_) Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check. * `referenceId` (_string_, required) The identifier of the loyalty program discount that is recognized by the loyalty program service provider. The restaurant POS transmits the discount identifier to the service provider to determine the validity and amount of the discount. * `vendor` (_string_, required) The specific loyalty program service provider that supports the loyalty account. * `name` (_string_, required) The name of the applied discount. * `nonTaxDiscountAmount` (_number_, required) The amount that a discount reduces a menu item price, excluding any discount amount applied to taxes. In most cases, a discount only applies to the menu item price and the nonTaxDiscountAmount is the same as the discountAmount. If you apply a discount to a menu item that includes tax in its price, the nonTaxDiscountAmount is less than the full discount amount. * `processingState` (_string | any_) * Applies to loyalty program discounts only. Loyalty program reward discounts are validated and then applied, or redeemed, by the third-party loyalty program service provider depending on the state of the restaurant POS order. This value indicates the state of the discount in that validation and application process. Response only. The processingState may be one of the following enumerated values. * PENDING\_APPLIED: The loyalty program service provider has confirmed that the reward discount is valid for the order and customer. The reward has not been redeemed, or applied to the customer's loyalty account. * APPLIED: The reward discount has been redeemed. The reward is no longer available from the customer's loyalty program account. * PENDING\_VOID: The reward discount has been removed from the restaurant POS order. The reward is not available from the customer's loyalty program account until the loyalty program service provider processes the void operation. * VOID: The reward discount has been removed from the restaurant POS order and the reward is available from the customer's loyalty program account again. One of: `string`, `any`. * `triggers` (_array of object_) Optional items which triggered this discount. * `quantity` (_number_) The amount of the selection used to trigger the applied discount. * `selection` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `appliedLoyaltyInfo` (_appliedLoyaltyInfo | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `appliedLoyaltyInfo`, `any`. * `appliedServiceCharges` (_array of object_) Any restaurant-configured service charges that applied to this check. Minimum items: 0. * `appliedTaxes` (_array of object_) Derived from serviceCharge - the taxes applied to the service * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `guid` (_string | any_, required) The GUID maintained by restaurant. One of: `string`, `any`. * `name` (_string | any_) The name of the tax rate. One of: `string`, `any`. * `rate` (_number | any_, required) The tax rate, which can be a fixed amount, a percentage, or null. One of: `number`, `any`. * `taxAmount` (_number | any_) The tax amount that was actually applied. One of: `number`, `any`. * `taxRate` (_object_, required) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `guid` (_string | any_, required) The GUID maintained by restaurant. One of: `string`, `any`. * `type` (_string | any_, required) The type of the tax rate. Default is percent if no tax rate config One of: `string`, `any`. * `chargeAmount` (_number_) The final applied amount excluding tax. This is required if the amountType is OPEN. * `chargeType` (_string_) Derived from serviceCharge. An OPEN service charge can either be a dollar amount or a percentage. Allowed values: `FIXED`, `PERCENT`, `OPEN`. * `delivery` (_boolean_) Derived from serviceCharge - whether this service charge is a delivery charge. * `entityType` (_string_, required) The type of object this is. * `externalId` (_string_) External identifier string that is prefixed by the naming authority. * `gratuity` (_boolean_) Derived from serviceCharge - whether this service charge is a gratuity. Can be used to derive required tip amount on the check. * `guid` (_string_, required) The GUID maintained by restaurant. * `name` (_string_) Derived from serviceCharge - the configured human readable label for the service charge. * `serviceCharge` (_object_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. Includes all fields of `entityWrapper`. * `taxable` (_boolean_) Derived from serviceCharge - whether this service charge is taxable. * `closedDate` (_datetime | any_) The date on which the order was closed. One of: `datetime`, `any`. * `createdDevice` (_createdDevice | any_) The Device ID value that the restaurant POS system assigns to a specific restaurant POS device. The id value is a unique identifier for a device. To find the ID for a restaurant POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab. One of: `createdDevice`, `any`. * `deleted` (_boolean_) True if this check has been deleted. * `deletedDate` (_datetime | any_) The date at which this check was deleted. deletedDate is only applicable when deleted is true One of: `datetime`, `any`. * `displayNumber` (_string_) The display number on the POS machine. Typically, this number starts with one and increases per day. * `entityType` (_string | any_, required) The type of object. This property is for future use. One of: `string`, `any`. * `externalId` (_string | any_) The unique identifier assigned to an object by an external source. One of: `string`, `any`. * `guid` (_string_, required) The Global Unique Identifier that represents the redemption and accrual transaction. This property is not used for the inquiry transaction. * `lastModifiedDevice` (_createdDevice | any_) The Device ID value that the restaurant POS system assigns to a specific restaurant POS device. The id value is a unique identifier for a device. To find the ID for a restaurant POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab. One of: `createdDevice`, `any`. * `modifiedDate` (_datetime | any_) The most recent date at which this check was modified. One of: `datetime`, `any`. * `openedDate` (_datetime | any_) The date on which the check was initiated. One of: `datetime`, `any`. * `paidDate` (_datetime | any_) The most recent date at which this check received payment. One of: `datetime`, `any`. * `payments` (_array of object_) The payment details of an accrual order for all selections. * `amount` (_number_, required) The payment amount excluding tips. * `amountTendered` (_number_) The amount tendered for this payment. * `cardEntryMode` (_string | any_) Indicates how credit card was obtained. Response only Enum SWIPED, KEYED, ONLINE, EMV\_CHIP\_SIGN, TOKENIZED, PRE\_AUTHED, SAVED\_CARD, FUTURE\_ORDER, CONTACTLESS, APPLE\_PAY\_CNP, GOOGLE\_PAY\_CNP, CLICK\_TO\_PAY\_CNP, INCREMENTAL\_PRE\_AUTHED,PARTNER\_ECOM\_COF. One of: `string`, `any`. * `cardType` (_string | any_) The type of card used, Enum values VISA,MASTERCARD,AMEX,DISCOVER,JCB,DINERS,CIT,MAESTRO,LASER,SOLO,UNKNOWN. One of: `string`, `any`. * `cashDrawer` (_object_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The GUID maintained by restaurant. * `createdDevice` (_createdDevice | any_) One of: `createdDevice`, `any`. * `entityType` (_string_, required) The type of object this is. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The GUID maintained by restaurant. * `houseAccount` (_houseAccount | any_, required) An internal account to track other business transactions. One of: `houseAccount`, `any`. * `last4Digits` (_string | any_) The last 4 digits of the card used. One of: `string`, `any`. * `lastModifiedDevice` (_object_) The Device ID value that the restaurant POS system assigns to a specific restaurant POS device. The id value is a unique identifier for a device. * `id` (_string_) The physical id of the device. * `mcaRepaymentAmount` (_number | any_) The total currency amount witheld as repayment for a merchant cash advance (MCA). The MCA repayment amount is set at the time the payment is captured and then updated when settlement occurs. One of: `number`, `any`. * `originalProcessingFee` (_number | any_) The original processing fee for this payment. This value is populated after the payment has been captured. One of: `number`, `any`. * `otherPayment` (_houseAccount | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `houseAccount`, `any`. * `paidBusinessDate` (_number_) The business date (yyyyMMdd) on which this payment was first applied. * `paidDate` (_datetime_, required) The date on which the payment is made. * `paymentStatus` (_string_, required) The status of payment. Possible values are Allowed values: `OPEN`, `PROCESSING`, `AUTHORIZED_AT_RISK`, `AUTHORIZED`, `ERROR`, `DENIED`, `VOIDED_AT_RISK`, `CANCELLED`, `CAPTURE_IN_PROGRESS`, `CAPTURED`, `VOIDED`, `PROCESSING_VOID`. * `refund` (_refund | any_) A discount applied to a check or item One of: `refund`, `any`. * `refundStatus` (_string_) Denotes the status of refund enum of PARTIAL, NONE, FULL Allowed values: `NONE`, `PARTIAL`, `FULL`. * `tipAmount` (_number_) The tip amount in this payment. * `type` (_string_, required) The method of payment. Possible values are Allowed values: `CASH`, `CREDIT`, `GIFTCARD`, `HOUSE_ACCOUNT`, `REWARDCARD`, `LEVELUP`, `OTHER`, `UNDETERMINED`. * `voidInfo` (_voidInfo | any_) Information about a void applied to a check or item. One of: `voidInfo`, `any`. * `paymentStatus` (_string_) The status of a payment transaction. Allowed values: `PAID`, `CLOSED`, `OPEN`. * `selections` (_array of object_, required) The details of selected items during a transaction. This property is for future use. * `appliedDiscounts` (_array of object_) The itemized discounts applied to this item. * `appliedPromoCode` (_string | any_) The promo code that was applied for this discount. One of: `string`, `any`. * `approver` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `comboItems` (_array of entityWrapper | any_) A List of Menu Item Selections that this discount is applied to (empty for NonCombo Discounts). * `discount` (_object_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string_, required) The type of object this is. * `guid` (_string_, required) The GUID maintained by restaurant. * `discountAmount` (_number_) The discount amount in USD. This amount will be subtracted from the check or item. * `entityType` (_string_, required) The type of object this is. * `guid` (_string_, required) The GUID maintained by restaurant. * `loyaltyDetails` (_object_) Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check. * `referenceId` (_string_, required) The identifier of the loyalty program discount that is recognized by the loyalty program service provider. The restaurant POS transmits the discount identifier to the service provider to determine the validity and amount of the discount. * `vendor` (_string_, required) The specific loyalty program service provider that supports the loyalty account. * `name` (_string_, required) The name of the applied discount. * `nonTaxDiscountAmount` (_number_, required) The amount that a discount reduces a menu item price, excluding any discount amount applied to taxes. In most cases, a discount only applies to the menu item price and the nonTaxDiscountAmount is the same as the discountAmount. If you apply a discount to a menu item that includes tax in its price, the nonTaxDiscountAmount is less than the full discount amount. * `processingState` (_string | any_) * Applies to loyalty program discounts only. Loyalty program reward discounts are validated and then applied, or redeemed, by the third-party loyalty program service provider depending on the state of the restaurant POS order. This value indicates the state of the discount in that validation and application process. Response only. The processingState may be one of the following enumerated values. * PENDING\_APPLIED: The loyalty program service provider has confirmed that the reward discount is valid for the order and customer. The reward has not been redeemed, or applied to the customer's loyalty account. * APPLIED: The reward discount has been redeemed. The reward is no longer available from the customer's loyalty program account. * PENDING\_VOID: The reward discount has been removed from the restaurant POS order. The reward is not available from the customer's loyalty program account until the loyalty program service provider processes the void operation. * VOID: The reward discount has been removed from the restaurant POS order and the reward is available from the customer's loyalty program account again. One of: `string`, `any`. * `triggers` (_array of object_) Optional items which triggered this discount. * `quantity` (_number_) The amount of the selection used to trigger the applied discount. * `selection` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `appliedTaxes` (_array of object_) An array of AppliedTaxRate objects that contain information about tax payments made for the selection. Minimum items: 0. * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `guid` (_string | any_, required) The GUID maintained by restaurant. One of: `string`, `any`. * `name` (_string | any_) The name of the tax rate. One of: `string`, `any`. * `rate` (_number | any_, required) The tax rate, which can be a fixed amount, a percentage, or null. One of: `number`, `any`. * `taxAmount` (_number | any_) The tax amount that was actually applied. One of: `number`, `any`. * `taxRate` (_object_, required) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `guid` (_string | any_, required) The GUID maintained by restaurant. One of: `string`, `any`. * `type` (_string | any_, required) The type of the tax rate. Default is percent if no tax rate config One of: `string`, `any`. * `createdDate` (_datetime | any_) The date on which the order was created. One of: `datetime`, `any`. * `deferred` (_boolean | any_) Whether this selection is a deferred revenue transaction, e.g. gift card sales. One of: `boolean`, `any`. * `displayName` (_string | any_) The display name of the selection. This field can be used to set a special request value, otherwise it will be generated from this Selection's item property. One of: `string`, `any`. * `entityType` (_string | any_, required) The type of object. This property is for future use. One of: `string`, `any`. * `externalId` (_string | any_, required) The unique identifier or reference assigned to an object within a system by an external source or another system. This property is for future use. One of: `string`, `any`. * `fulfillmentStatus` (_string_, required) The status of an order's fulfillment process. Allowed values: `NEW`, `HOLD`, `SENT`, `READY`. * `guid` (_string | any_, required) The Global Unique Identifier that represents the selection. This property is for future use. One of: `string`, `any`. * `item` (_object_, required) The details of the items selected during a transaction. Includes all fields of `entityWrapper`. * `multiLocationId` (_string | any_) A consistent identifier for restaurant platform entities, such as menu items, that applies to all versions of a shared entity at all locations in a restaurant group. One of: `string`, `any`. * `itemGroup` (_entityWithMultiLocationIdWrapper | any_) One of: `entityWithMultiLocationIdWrapper`, `any`. * `modifiedDate` (_datetime | any_) The date at which this selection was last modified. Defaults to current time if not specified. One of: `datetime`, `any`. * `modifiers` (_array of any_) A list of modifiers applying to this selection. * `optionGroup` (_entityWithMultiLocationIdWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWithMultiLocationIdWrapper`, `any`. * `preDiscountPrice` (_number_) Gross sale price for this selection. Excludes tax. * `preModifier` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `price` (_number_) The price of an item in a selection. * `quantity` (_number_, required) The quantity of items in a transaction. This property is for future use. * `salesCategory` (_entityWrapper | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `entityWrapper`, `any`. * `selectionType` (_string | any_) The type of menu selection in the accrual order. Possible values are One of: `string`, `any`. * `unitOfMeasure` (_string | any_) The unit of measure required for weighing the item. Default is NONE, which means the item is not meant to be weighed. One of: `string`, `any`. * `voidBusinessDate` (_number | any_) The business date (yyyyMMdd) on which this selection was voided. One of: `number`, `any`. * `voidDate` (_datetime | any_) The date at which this selection was voided. One of: `datetime`, `any`. * `voided` (_boolean | any_) True if this selection has been voided. One of: `boolean`, `any`. * `voidReason` (_entityWrapper | any_) A wrapper object with fields that allow reference to a Restaurant entity by Restaurant GUID. One of: `entityWrapper`, `any`. * `tabName` (_string | any_) The name of the tab on this check. This will show up on the KDS (Kitchen Display System) for pending orders. The tabName's length can be up to 255 characters. One of: `string`, `any`. * `taxAmount` (_number_) The computed tax amount in USD. Includes service charge and item level taxes * `taxExempt` (_boolean_) Indicates if the transaction is eligible for tax exemption (true) or not (false). This property is for future use. * `totalAmount` (_number_) The total amount of all items in a transaction. This property is for future use. * `voidBusinessDate` (_number | any_) The business date (yyyyMMdd) on which this check was voided. One of: `number`, `any`. * `voidDate` (_datetime-only | any_) The date at which this check was voided. Use ISO 8601 date and time format for all restaurant APIs. One of: `datetime-only`, `any`. * `voided` (_boolean_) True if this check has been voided. * `loyaltyIdentifier` (_string_) The loyalty program membership number. * `orderGuid` (_string_) The restaurant POS system identifier for the order that contains the check. * `redemptions` (_array of object_) The details of the redemptions in a transaction. * `amount` (_number | any_) The dollar (or other currency) amount that this offer actually discounts. One of: `number`, `any`. * `appliedDiscountGuid` (_string | any_) The GUID of the AppliedDiscount on the Check or Selection object corresponding to the discount. This is required if the Redemption object is contained within the RejectionRedemption object and identifies the rejected redemption. This is included to differentiate if multiple redemptions of the same type are applied to the same check or item. One of: `string`, `any`. * `identifier` (_string_, required) Identifier of the Offer to be redeemed. The Offer must be one that was returned by the provider in response to an inquiry request. * `itemApplication` (_array of object_) Minimum items: 0. * `amount` (_string_, required) The currency amount of the discount applied to this item. This value can be updated in future calls. This field is optional in response to LOYALTY\_INQUIRE requests and required in response to LOYALTY\_REDEEM requests. * `appliedDiscountIdentifier` (_string | any_) If this redemption has been applied, this is the identifier of the applied discount created for this offer on this selection. It will correspond to the guid field of the AppliedDiscount object on the Selection. Response only. One of: `string`, `any`. * `selectionIdentifier` (_string | any_) The identifier of the selection that discount is applied to. This will correspond to the guid field on the Selection object that is included with the Check. restaurant uses these values to determine which item(s) will have the offer applied. One of: `string`, `any`. * `multiItemDiscountGuid` (_string | any_) The GUID of a Multi Item Redemption. A Multi Item Redemption is a single loyalty redemption that applied to multiple items on the check. For instance, a "$3 off burgers, $2 off fries, and $1 off a drink" would be a single loyalty redemption that applies to 3 separate items. This field is an identifier for a Multi Item redemption, but does not correspond to any one object on the Check. To see what items were discounted, refer to the itemApplication field. One of: `string`, `any`. * `quantity` (_number | any_) The number of times the offer has been applied to the item or check. For example, if an offer is a stackable "$5 off check" discount, this field could indicate that multiple copies of that offer have been applied. One of: `number`, `any`. * `selectionGuid` (_string | any_) If this is an item level discount, the guid of the selection that this redemption is attached to. If this redemption has not been added to a specific selection yet, this field will be absent. One of: `string`, `any`. ### phoneNumber The phone number of the member that you are searching for. Type: `string`. Pattern: ^\[0-9\]{0,15}$. ### entityWrapper * `entityType` (_string | any_, required) The type of object. This property is for future use. One of: `string`, `any`. * `externalId` (_string | any_) The unique identifier or reference assigned to an object within a system by an external source or another system. This property is for future use One of: `string`, `any`. * `guid` (_string | any_, required) The global Unique Identifier that represents the item. One of: `string`, `any`. ### appliedLoyaltyInfo A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `accrualFamilyGuid` (_string_) An internal restaurant POS identifier for loyalty program transactions. * `accrualText` (_string_) A description of the loyalty program transaction that will be printed on the customer's reciept. For example, "Earned 27 points." The maximum length of the description string is 255 characters. * `entityType` (_string_, required) The type of object this is. * `guid` (_string_, required) The GUID maintained by restaurant. * `loyaltyIdentifier` (_string_, required) An identifier for the loyalty program account. * `vendor` (_string_, required) The specific loyalty program service provider that supports the loyalty account. For all interactions with the Loyalty Integration API, this value will be INTEGRATION. ### createdDevice The Device ID value that the restaurant POS system assigns to a specific restaurant POS device. The id value is a unique identifier for a device. To find the ID for a restaurant POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab. * `id` (_string | any_, required) The physical id of the device. One of: `string`, `any`. ### houseAccount A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. * `entityType` (_string_, required) The type the object is. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The GUID maintained by restaurant. ### refund A discount applied to a check or item * `refundAmount` (_number_) The amount of the refund excluding tip. * `refundBusinessDate` (_number_) The business date (yyyyMMdd) on which this refund was created. * `refundDate` (_datetime_) The date and time the refund was made. * `tipRefundAmount` (_number_) The amount of the tip refund. ### voidInfo * `voidApprover` (_voidApprover | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `voidApprover`, `any`. * `voidBusinessDate` (_number | any_) The business date (yyyyMMdd) on which this void was made. One of: `number`, `any`. * `voidDate` (_datetime | any_) The date at which the refund was made. One of: `datetime`, `any`. * `voidReason` (_voidReason | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `voidReason`, `any`. * `voidUser` (_voidUser | any_) A wrapper object with fields that allow reference to a restaurant entity by restaurant GUID. One of: `voidUser`, `any`. ### entityWithMultiLocationIdWrapper * `entityType` (_string | any_, required) The type of object this is. One of: `string`, `any`. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The Global Unique Identifier that represents the redemption and accrual transaction. This property is not used for the inquiry transaction. * `multiLocationId` (_string | any_) A consistent identifier for restaurant platform entities, such as menu items, that applies to all versions of a shared entity at all locations in a restaurant group. One of: `string`, `any`. ### voidApprover * `entityType` (_string_, required) The type of object this is. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The GUID maintained by restaurant. ### voidReason * `entityType` (_string_, required) The type of object this is. * `externalId` (_string | any_) External identifier string that is prefixed by the naming authority. One of: `string`, `any`. * `guid` (_string_, required) The GUID maintained by restaurant. ### voidUser * `entityType` (_string_, required) The type of object this is. * `externalId` (_string_) External identifier string that is prefixed by the naming authority. * `guid` (_string_, required) The GUID maintained by restaurant.