{"swagger":"2.0","basePath":"","info":{"title":"Rewardify API","version":"1.0.0","description":"Rewardify API Documentation based on Swagger"},"paths":{"\/customer\/account\/credit\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["CustomerAccountCredit"],"operationId":"getCustomerAccountCreditItem","produces":["application\/json","text\/html"],"summary":"Retrieves a CustomerAccountCredit resource.","responses":{"200":{"description":"CustomerAccountCredit resource response","schema":{"$ref":"#\/definitions\/CustomerAccountCredit-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/account\/debit\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["CustomerAccountDebit"],"operationId":"getCustomerAccountDebitItem","produces":["application\/json","text\/html"],"summary":"Retrieves a CustomerAccountDebit resource.","responses":{"200":{"description":"CustomerAccountDebit resource response","schema":{"$ref":"#\/definitions\/CustomerAccountDebit-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/account\/redeem\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["CustomerAccountRedeem"],"operationId":"getCustomerAccountRedeemItem","produces":["application\/json","text\/html"],"summary":"Retrieves a CustomerAccountRedeem resource.","responses":{"200":{"description":"CustomerAccountRedeem resource response","schema":{"$ref":"#\/definitions\/CustomerAccountRedeem-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/account\/reset\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["CustomerAccountReset"],"operationId":"getCustomerAccountResetItem","produces":["application\/json","text\/html"],"summary":"Retrieves a CustomerAccountReset resource.","responses":{"200":{"description":"CustomerAccountReset resource response","schema":{"$ref":"#\/definitions\/CustomerAccountReset-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/discount\/recover\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["CustomerDiscountRecover"],"operationId":"getCustomerDiscountRecoverItem","produces":["application\/json","text\/html"],"summary":"Retrieves a CustomerDiscountRecover resource.","responses":{"200":{"description":"CustomerDiscountRecover resource response","schema":{"$ref":"#\/definitions\/CustomerDiscountRecover-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/discount\/{id}\/recover":{"patch":{"summary":"Removes the Discount resource and recovers the amount back into the Customers account.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Discount ID"},{"in":"body","name":"customerDiscountRecover","description":"The new CustomerDiscountRecover resource","required":true,"schema":{"type":"object"}},{"name":"customerDiscountRecover","in":"body","description":"The updated CustomerDiscountRecover resource","schema":{"$ref":"#\/definitions\/CustomerDiscountRecover-Writable"}}],"tags":["CustomerDiscountRecover"],"operationId":"patchByShopifyIdCustomerDiscountRecoverItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerDiscountRecover resource updated","schema":{"$ref":"#\/definitions\/CustomerDiscountRecover-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/privileged-checkout\/discount\/{id}":{"get":{"summary":"Returns a CustomerPrivilegedCheckoutDiscount resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Discount ID"}],"tags":["CustomerPrivilegedCheckoutDiscount"],"operationId":"getCustomerPrivilegedCheckoutDiscountItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedCheckoutDiscount resource response","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutDiscount-API_READ"}},"404":{"description":"Resource not found"}}}},"\/customer\/privileged-checkout\/discount\/{id}\/recover":{"patch":{"summary":"Removes the Discount resource and recovers any combined credit amount back into the Customers account.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Discount ID"},{"in":"body","name":"customerPrivilegedCheckoutDiscount","description":"The new customerPrivilegedCheckoutDiscount resource","required":true,"schema":{"type":"object"}},{"name":"customerPrivilegedCheckoutDiscount","in":"body","description":"The updated CustomerPrivilegedCheckoutDiscount resource","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutDiscount-Writable"}}],"tags":["CustomerPrivilegedCheckoutDiscount"],"operationId":"patchByShopifyIdCustomerPrivilegedCheckoutDiscountItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedCheckoutDiscount resource updated","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutDiscount-API_READ"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"}],"tags":["Customer"],"operationId":"getByShopifyIdCustomerItem","produces":["application\/json","text\/html"],"summary":"Retrieves a Customer resource.","responses":{"200":{"description":"Customer resource response","schema":{"$ref":"#\/definitions\/Customer-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account":{"get":{"summary":"Retrieves a CustomerAccount resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"}],"tags":["CustomerAccount"],"operationId":"getByShopifyIdCustomerAccountItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerAccount resource response","schema":{"$ref":"#\/definitions\/CustomerAccount-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/credit":{"put":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"body","name":"customerAccountCredit","description":"The new CustomerAccountCredit resource","required":true,"schema":{"type":"object","required":["amount"],"properties":{"email":{"type":"string"},"amount":{"type":"string"},"memo":{"type":"string"},"expiresAt":{"type":"string","example":"2020-05-05T10:21:05.349Z"},"sendEmail":{"type":"boolean"},"emailNote":{"type":"string"}}}},{"name":"customerAccountCredit","in":"body","description":"The updated CustomerAccountCredit resource","schema":{"$ref":"#\/definitions\/CustomerAccountCredit-Writable"}}],"tags":["CustomerAccountCredit"],"operationId":"creditClientCustomerAccountCustomerAccountCreditItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"summary":"Replaces the CustomerAccountCredit resource.","responses":{"200":{"description":"CustomerAccountCredit resource updated","schema":{"$ref":"#\/definitions\/CustomerAccountCredit-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/debit":{"put":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"body","name":"customerAccountDebit","description":"The new CustomerAccountDebit resource","required":true,"schema":{"type":"object","required":["amount"],"properties":{"email":{"type":"string"},"amount":{"type":"string"},"memo":{"type":"string"},"sendEmail":{"type":"boolean"},"emailNote":{"type":"string"}}}},{"name":"customerAccountDebit","in":"body","description":"The updated CustomerAccountDebit resource","schema":{"$ref":"#\/definitions\/CustomerAccountDebit-Writable"}}],"tags":["CustomerAccountDebit"],"operationId":"debitClientCustomerAccountCustomerAccountDebitItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"summary":"Replaces the CustomerAccountDebit resource.","responses":{"200":{"description":"CustomerAccountDebit resource updated","schema":{"$ref":"#\/definitions\/CustomerAccountDebit-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/redeem":{"post":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"}],"tags":["CustomerAccountRedeem"],"operationId":"generateByShopifyCustomerIdCustomerAccountRedeemItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"summary":"Creates a CustomerAccountRedeem resource.","responses":{"201":{"description":"CustomerAccountRedeem resource created","schema":{"$ref":"#\/definitions\/CustomerAccountRedeem-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/reset":{"put":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"body","name":"customerAccountReset","description":"The new CustomerAccountReset resource","required":true,"schema":{"type":"object","required":["amount"],"properties":{"email":{"type":"string"},"amount":{"type":"string"},"memo":{"type":"string"},"expiresAt":{"type":"string","example":"2020-05-05T10:21:05.349Z"},"sendEmail":{"type":"boolean"},"emailNote":{"type":"string"}}}},{"name":"customerAccountReset","in":"body","description":"The updated CustomerAccountReset resource","schema":{"$ref":"#\/definitions\/CustomerAccountReset-Writable"}}],"tags":["CustomerAccountReset"],"operationId":"resetClientCustomerAccountCustomerAccountResetItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"summary":"Replaces the CustomerAccountReset resource.","responses":{"200":{"description":"CustomerAccountReset resource updated","schema":{"$ref":"#\/definitions\/CustomerAccountReset-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/total\/redeemed":{"get":{"summary":"Retrieves a CustomerAccountTotalRedeemed resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"}],"tags":["CustomerAccountTotalRedeemed"],"operationId":"getCustomerAccountTotalRedeemedItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerAccountTotalRedeemed resource response","schema":{"$ref":"#\/definitions\/CustomerAccountTotalRedeemed-Readable"}},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/account\/transactions":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"name":"page","in":"query","required":false,"description":"The collection page number","type":"integer"},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of items per page","type":"integer"}],"tags":["Transaction"],"operationId":"getByShopifyCustomerIdTransactionCollection","produces":["application\/json","text\/html"],"summary":"Retrieves the collection of Transaction resources.","responses":{"200":{"description":"Transaction collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/Transaction-Collection-Readable"}}}}}},"\/customer\/{id}\/discounts":{"get":{"summary":"Retrieves the collection of Discount resources for the given Customer.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"name":"page","in":"query","required":false,"description":"The collection page number","type":"integer"},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of items per page","type":"integer"}],"tags":["Discount"],"operationId":"getByShopifyCustomerIdDiscountCollection","produces":["application\/json","text\/html"],"responses":{"200":{"description":"Discount collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/Discount-Readable"}}}}}},"\/customer\/{id}\/privileged-checkout\/calculate":{"post":{"summary":"Calculates a CustomerPrivilegedCheckoutDiscount resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"body","name":"customerPrivilegedCheckoutDiscount","description":"An array of Variant IDs and Unit Quantities","required":true,"schema":{"type":"object","required":["cartItems"],"properties":{"cartItems":{"type":"array","items":{"required":["variantId","productId","quantity"],"type":"object","properties":{"variantId":{"type":"string","description":"Item Variant ID"},"productId":{"type":"string","description":"Item Product ID"},"quantity":{"type":"integer","description":"Variant Quantity"}}}},"creditToCombine":{"type":"number"}}}}],"tags":["CustomerPrivilegedCheckoutDiscount"],"operationId":"calculateByShopifyCustomerIdCustomerPrivilegedCheckoutDiscountItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"201":{"description":"CustomerPrivilegedCheckoutDiscount resource created","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutDiscount-CALCULATE_API_READ"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/privileged-checkout\/generate":{"post":{"summary":"Generates a CustomerPrivilegedCheckoutDiscount resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"body","name":"customerPrivilegedCheckoutDiscount","description":"An array of Variant IDs and Unit Quantities","required":true,"schema":{"type":"object","required":["cartItems","creditToCombine"],"properties":{"cartItems":{"type":"array","items":{"required":["variantId","productId","quantity"],"type":"object","properties":{"variantId":{"type":"string","description":"Item Variant ID"},"productId":{"type":"string","description":"Item Product ID"},"quantity":{"type":"integer","description":"Variant Quantity"}}}},"creditToCombine":{"type":"number"}}}}],"tags":["CustomerPrivilegedCheckoutDiscount"],"operationId":"generateByShopifyCustomerIdCustomerPrivilegedCheckoutDiscountItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"201":{"description":"CustomerPrivilegedCheckoutDiscount resource created","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutDiscount-API_READ_CALCULATE_API_READ"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/privileged-checkout\/product-tag\/{productTag}":{"get":{"summary":"Retrieves a CustomerPrivilegedCheckoutProductTag resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"path","name":"productTag","type":"string","required":true,"description":"Product Tag"}],"tags":["CustomerPrivilegedCheckoutProductTag"],"operationId":"getByShopifyIdAndProductTagCustomerPrivilegedCheckoutProductTagItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedCheckoutProductTag resource response","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutProductTag-Readable"}},"404":{"description":"Resource not found"}}},"post":{"summary":"Creates the CustomerPrivilegedCheckoutProductTag resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"path","name":"productTag","type":"string","required":true,"description":"Product Tag"}],"tags":["CustomerPrivilegedCheckoutProductTag"],"operationId":"createByShopifyIdAndProductTagCustomerPrivilegedCheckoutProductTagItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"201":{"description":"CustomerPrivilegedCheckoutProductTag resource created","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutProductTag-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}},"put":{"summary":"Replaces the CustomerPrivilegedCheckoutProductTag resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"path","name":"productTag","type":"string","required":true,"description":"Product Tag"},{"name":"customerPrivilegedCheckoutProductTag","in":"body","description":"The updated CustomerPrivilegedCheckoutProductTag resource","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutProductTag-Writable"}}],"tags":["CustomerPrivilegedCheckoutProductTag"],"operationId":"putByShopifyIdAndProductTagCustomerPrivilegedCheckoutProductTagItem","consumes":["application\/json","text\/html"],"produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedCheckoutProductTag resource updated","schema":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutProductTag-Readable"}},"400":{"description":"Invalid input"},"404":{"description":"Resource not found"}}},"delete":{"summary":"Removes the CustomerPrivilegedCheckoutProductTag resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"in":"path","name":"productTag","type":"string","required":true,"description":"Product Tag"}],"tags":["CustomerPrivilegedCheckoutProductTag"],"operationId":"deleteByShopifyIdAndProductTagCustomerPrivilegedCheckoutProductTagItem","responses":{"204":{"description":"CustomerPrivilegedCheckoutProductTag resource deleted"},"404":{"description":"Resource not found"}}}},"\/customer\/{id}\/privileged-checkout\/product-tags":{"get":{"summary":"Retrieves the collection of CustomerPrivilegedCheckoutProductTag resources.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"},{"name":"page","in":"query","required":false,"description":"The collection page number","type":"integer"},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of items per page","type":"integer"}],"tags":["CustomerPrivilegedCheckoutProductTag"],"operationId":"getByShopifyCustomerIdCustomerPrivilegedCheckoutProductTagCollection","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedCheckoutProductTag collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/CustomerPrivilegedCheckoutProductTag-Collection-Readable"}}}}}},"\/customer\/{id}\/privileged-status":{"get":{"summary":"Retrieves a CustomerPrivilegedStatus resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Customer ID"}],"tags":["CustomerPrivilegedStatus"],"operationId":"getCustomerPrivilegedStatusItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"CustomerPrivilegedStatus resource response","schema":{"$ref":"#\/definitions\/CustomerPrivilegedStatus-Readable"}},"404":{"description":"Resource not found"}}}},"\/discount\/{id}":{"get":{"summary":"Retrieves a Discount resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Discount ID"}],"tags":["Discount"],"operationId":"getByShopifyIdDiscountItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"Discount resource response","schema":{"$ref":"#\/definitions\/Discount-Readable"}},"404":{"description":"Resource not found"}}}},"\/order\/{id}\/transactions":{"get":{"parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Shopify Order ID"},{"name":"page","in":"query","required":false,"description":"The collection page number","type":"integer"},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of items per page","type":"integer"}],"tags":["Transaction"],"operationId":"getByShopifyOrderIdTransactionCollection","produces":["application\/json","text\/html"],"summary":"Retrieves the collection of Transaction resources.","responses":{"200":{"description":"Transaction collection response","schema":{"type":"array","items":{"$ref":"#\/definitions\/Transaction-Collection-Readable"}}}}}},"\/transaction\/{id}":{"get":{"summary":"Retrieves a Transaction resource.","parameters":[{"in":"path","name":"id","type":"string","required":true,"description":"Transaction ID"}],"tags":["Transaction"],"operationId":"getTransactionItem","produces":["application\/json","text\/html"],"responses":{"200":{"description":"Transaction resource response","schema":{"$ref":"#\/definitions\/Transaction-Readable"}},"404":{"description":"Resource not found"}}}}},"securityDefinitions":{"oauth":{"type":"oauth2","description":"OAuth client_credentials Grant","flow":"application","tokenUrl":"\/oauth\/v2\/token","authorizationUrl":"\/oauth\/v2\/auth","scopes":[]}},"security":[{"oauth":[]}],"definitions":{"Customer-Readable":{"type":"object","description":"","properties":{"shopifyId":{"readOnly":true},"email":{"readOnly":true},"phone":{"readOnly":true},"acceptsMarketing":{"readOnly":true},"firstName":{"readOnly":true},"lastName":{"readOnly":true},"totalSpent":{"readOnly":true},"subtotalSpent":{"readOnly":true},"shopifyState":{"readOnly":true},"note":{"readOnly":true},"deletedAt":{"readOnly":true}}},"CustomerAccount-Readable":{"type":"object","description":"","properties":{"currency":{"readOnly":true},"amount":{},"customer":{"readOnly":true}}},"CustomerAccountCredit-Readable":{"type":"object","description":"CustomerAccountCredit","properties":{"transaction":{"readOnly":true,"type":"string"}}},"CustomerAccountCredit-Writable":{"type":"object","description":"CustomerAccountCredit","properties":{"email":{"type":"string"},"amount":{"description":"Numeric String. Maximum 4 decimal places. ie, 4.0125, 51.2345, 220.01, etc.","type":"string"},"memo":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"sendEmail":{"description":"Send an email along with this transaction?","type":"boolean"},"emailNote":{"type":"string"}},"required":["amount"]},"CustomerAccountDebit-Readable":{"type":"object","description":"CustomerAccountDebit","properties":{"transaction":{"readOnly":true,"type":"string"}}},"CustomerAccountDebit-Writable":{"type":"object","description":"CustomerAccountDebit","properties":{"email":{"type":"string"},"amount":{"description":"Numeric String. Maximum 4 decimal places. ie, 4.0125, 51.2345, 220.01, etc.","type":"string"},"memo":{"type":"string"},"sendEmail":{"description":"Send an email along with this transaction?","type":"boolean"},"emailNote":{"type":"string"}},"required":["amount"]},"CustomerAccountRedeem-Readable":{"type":"object","description":"CustomerAccountRedeem","properties":{"discount":{"readOnly":true,"type":"string"},"transaction":{"readOnly":true,"type":"string"}}},"CustomerAccountRedeem-Writable":{"type":"object","description":"CustomerAccountRedeem","required":["amount"],"properties":{"amount":{"description":"Numeric String. Maximum 4 decimal places. ie, 4.0125, 51.2345, 220.01, etc.","type":"string"},"currency":{"type":"string"},"memo":{"type":"string"}}},"CustomerAccountReset-Readable":{"type":"object","description":"CustomerAccountReset","properties":{"transaction":{"readOnly":true,"type":"string"}}},"CustomerAccountReset-Writable":{"type":"object","description":"CustomerAccountReset","properties":{"email":{"type":"string"},"amount":{"description":"Numeric String. Maximum 4 decimal places. ie, 4.0125, 51.2345, 220.01, etc.","type":"string"},"memo":{"type":"string"},"expiresAt":{"description":"Expiry only applies when a Customer accounts are credited.","type":"string","format":"date-time"},"sendEmail":{"description":"Send an email along with this transaction?","type":"boolean"},"emailNote":{"type":"string"}},"required":["amount"]},"CustomerAccountTotalRedeemed-Readable":{"type":"object","description":"CustomerAccountTotalRedeemed","properties":{"amount":{"readOnly":true,"description":"Total amount of credit redeemed through Order submission.","type":"string"},"currency":{"readOnly":true,"type":"string"}}},"CustomerDiscountRecover-Readable":{"type":"object","description":"CustomerDiscountRecover","properties":{"discount":{"readOnly":true,"type":"string"},"transactions":{"readOnly":true,"type":"array","items":{"type":"string"}}}},"CustomerDiscountRecover-Writable":{"type":"object","description":"CustomerDiscountRecover"},"CustomerPrivilegedCheckoutDiscount-API_READ":{"type":"object","description":"CustomerPrivilegedCheckoutDiscount","properties":{"discount":{"readOnly":true,"type":"string"},"transactions":{"readOnly":true,"type":"array","items":{"type":"string"}}}},"CustomerPrivilegedCheckoutDiscount-API_READ_CALCULATE_API_READ":{"type":"object","description":"CustomerPrivilegedCheckoutDiscount","properties":{"discount":{"readOnly":true,"type":"string"},"transactions":{"readOnly":true,"type":"array","items":{"type":"string"}},"cartDiscounts":{"type":"array","items":{"properties":{"variantId":{"type":"string","description":"Item Variant ID"},"productId":{"type":"string","description":"Item Product ID"},"quantity":{"type":"integer","description":"Variant Quantity"},"price":{"type":"number","description":"Calculated Discounted Item Price"},"discount":{"type":"number","description":"Discount"}}},"readOnly":true},"subTotal":{"type":"string","readOnly":true},"totalProductDiscount":{"type":"string","readOnly":true},"totalOrderDiscount":{"type":"string","readOnly":true},"totalCouponDiscount":{"type":"string","readOnly":true},"totalDiscount":{"type":"string","readOnly":true},"customerLimitType":{"type":"string","readOnly":true},"customerLimitOverall":{"type":"string","readOnly":true},"customerLimitRemaining":{"type":"string","readOnly":true},"customerLimitBeforeCheckout":{"type":"string","readOnly":true},"totalCreditDiscount":{"type":"string","readOnly":true},"totalCombinedDiscount":{"type":"string","readOnly":true},"customerBalanceBeforeCheckout":{"type":"string","readOnly":true},"customerBalanceAfterCheckout":{"type":"string","readOnly":true}}},"CustomerPrivilegedCheckoutDiscount-CALCULATE_API_READ":{"type":"object","description":"CustomerPrivilegedCheckoutDiscount","properties":{"cartDiscounts":{"type":"array","items":{"properties":{"variantId":{"type":"string","description":"Item Variant ID"},"productId":{"type":"string","description":"Item Product ID"},"quantity":{"type":"integer","description":"Variant Quantity"},"price":{"type":"number","description":"Calculated Discounted Item Price"},"discount":{"type":"number","description":"Discount"}}},"readOnly":true},"subTotal":{"type":"string","readOnly":true},"totalProductDiscount":{"type":"string","readOnly":true},"totalOrderDiscount":{"type":"string","readOnly":true},"totalCouponDiscount":{"type":"string","readOnly":true},"totalDiscount":{"type":"string","readOnly":true},"customerLimitType":{"type":"string","readOnly":true},"customerLimitOverall":{"type":"string","readOnly":true},"customerLimitRemaining":{"type":"string","readOnly":true},"customerLimitBeforeCheckout":{"type":"string","readOnly":true},"totalCreditDiscount":{"type":"string","readOnly":true},"totalCombinedDiscount":{"type":"string","readOnly":true},"customerBalanceBeforeCheckout":{"type":"string","readOnly":true},"customerBalanceAfterCheckout":{"type":"string","readOnly":true}}},"CustomerPrivilegedCheckoutDiscount-Writable":{"type":"object","description":"CustomerPrivilegedCheckoutDiscount","required":["cartItems","creditToCombine"],"properties":{"cartItems":{"type":"array","items":{"required":["variantId","productId","quantity"],"properties":{"variantId":{"type":"string","description":"Item Variant ID"},"productId":{"type":"string","description":"Item Product ID"},"quantity":{"type":"integer","description":"Variant Quantity"}}}},"creditToCombine":{"type":"number","required":true}}},"CustomerPrivilegedCheckoutProductTag-Collection-Readable":{"type":"object","description":"","properties":{"productTag":{"readOnly":true},"effectiveDate":{},"limitQuantityRemainder":{},"limitQuantityRemainderExpiryDate":{}}},"CustomerPrivilegedCheckoutProductTag-Readable":{"type":"object","description":"","properties":{"productTag":{"readOnly":true},"effectiveDate":{},"limitQuantityRemainder":{},"limitQuantityRemainderExpiryDate":{},"customer":{"readOnly":true,"$ref":"#\/definitions\/Customer-Readable"}}},"CustomerPrivilegedCheckoutProductTag-Writable":{"type":"object","description":"","properties":{"effectiveDate":{},"limitQuantityRemainder":{},"limitQuantityRemainderExpiryDate":{}}},"CustomerPrivilegedStatus-Readable":{"type":"object","description":"CustomerPrivilegedStatus","properties":{"customerLimits":{"example":"{ customerLimits: { [ CustomerTag ]: { limitAmount, limitAmountFormatted, limitAmountRemaining, limitAmountRemainingFormatted, limitCurrency, limitType, productLimits: { [ ProductTag ]: { limitQuantity, limitType, effectiveDate, effectiveDateFormatted, limitQuantityRemaining } } } } }","readOnly":true,"type":"array","items":{"type":"string"}}}},"Discount-Readable":{"type":"object","description":"","properties":{"shopifyId":{"readOnly":true},"shopifyPriceRuleId":{"readOnly":true},"code":{"readOnly":true},"tag":{"readOnly":true},"endsAt":{"readOnly":true},"amount":{"readOnly":true},"amountType":{"readOnly":true},"minOrderAmount":{"readOnly":true},"currency":{"readOnly":true},"deletedAt":{"readOnly":true}}},"Transaction-Collection-Readable":{"type":"object","description":"","properties":{"id":{"readOnly":true},"shopifyId":{"readOnly":true},"shopifyCustomerId":{"readOnly":true},"effectiveAt":{"readOnly":true},"customerOpenBalance":{"readOnly":true},"amount":{"readOnly":true},"amountCurrency":{"readOnly":true},"memo":{"readOnly":true},"expiresAt":{"readOnly":true,"type":"string","format":"date-time"},"expiredAt":{"readOnly":true},"transType":{"readOnly":true,"type":"integer"}}},"Transaction-Readable":{"type":"object","description":"","properties":{"id":{"readOnly":true},"shopifyId":{"readOnly":true},"shopifyCustomerId":{"readOnly":true},"effectiveAt":{"readOnly":true},"customerOpenBalance":{"readOnly":true},"amount":{"readOnly":true},"amountCurrency":{"readOnly":true},"memo":{"readOnly":true},"expiresAt":{"readOnly":true,"type":"string","format":"date-time"},"expiredAt":{"readOnly":true},"customer":{"readOnly":true,"type":"string"},"transType":{"readOnly":true,"type":"integer"}}}}}