A valid request URL is required to generate request examples{
"code": "<string>",
"activationDate": "2023-11-07T05:31:56Z",
"creditType": "<string>",
"customCreditType": "<string>",
"currencyCode": "<string>",
"initialBalance": 123,
"currentBalance": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"customerId": 123,
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"creditTypeId": 123
}Add Credit
Adds credit to user account. Store credit can represent a static amount the customer can redeem at any of the tenant’s sites, or a gift card registered for a customer account.
A valid request URL is required to generate request examples{
"code": "<string>",
"activationDate": "2023-11-07T05:31:56Z",
"creditType": "<string>",
"customCreditType": "<string>",
"currencyCode": "<string>",
"initialBalance": 123,
"currentBalance": 123,
"expirationDate": "2023-11-07T05:31:56Z",
"customerId": 123,
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"creditTypeId": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Represetation of a store credit or gift card.
Unique number identifier representing this credit. Number may be generated or set by the Tenant Number is unique within the Tenant context. ReadOnly after credit creation
Date the credit was activated. Null if card is not active. Credits must be activated before they can be used. ReadOnly after activation
Type of Credit. Mozu.Customer.Contracts.Credit.Credit.CreditTypeConst Required. ReadOnly after credit creation
Name of custom credit type Optional.
Currency Code
Balance assigned when credit was initially created. May be zero and updated later. ReadOnly after intial credit creation
Do we want to track this here? Current Balance ReadOnly
Date after which this credit is no longer valid Optional Defaults to 365 days
Id of the N:Mozu.Customer that this credit is assigned to. Optional.
Show child attributes
Show child attributes
Response
Success
Represetation of a store credit or gift card.
Unique number identifier representing this credit. Number may be generated or set by the Tenant Number is unique within the Tenant context. ReadOnly after credit creation
Date the credit was activated. Null if card is not active. Credits must be activated before they can be used. ReadOnly after activation
Type of Credit. Mozu.Customer.Contracts.Credit.Credit.CreditTypeConst Required. ReadOnly after credit creation
Name of custom credit type Optional.
Currency Code
Balance assigned when credit was initially created. May be zero and updated later. ReadOnly after intial credit creation
Do we want to track this here? Current Balance ReadOnly
Date after which this credit is no longer valid Optional Defaults to 365 days
Id of the N:Mozu.Customer that this credit is assigned to. Optional.
Show child attributes
Show child attributes