Skip to main content
PUT
/
commerce
/
customer
/
credits
/
{code}
Error
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

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Represetation of a store credit or gift card.

code
string | null

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

activationDate
string<date-time> | null

Date the credit was activated. Null if card is not active. Credits must be activated before they can be used. ReadOnly after activation

creditType
string | null

Type of Credit. Mozu.Customer.Contracts.Credit.Credit.CreditTypeConst Required. ReadOnly after credit creation

customCreditType
string | null

Name of custom credit type Optional.

currencyCode
string | null

Currency Code

initialBalance
number<double> | null

Balance assigned when credit was initially created. May be zero and updated later. ReadOnly after intial credit creation

currentBalance
number<double> | null

Do we want to track this here? Current Balance ReadOnly

expirationDate
string<date-time> | null

Date after which this credit is no longer valid Optional Defaults to 365 days

customerId
integer<int32> | null

Id of the N:Mozu.Customer that this credit is assigned to. Optional.

auditInfo
object
creditTypeId
integer<int32>

Response

Success

Represetation of a store credit or gift card.

code
string | null

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

activationDate
string<date-time> | null

Date the credit was activated. Null if card is not active. Credits must be activated before they can be used. ReadOnly after activation

creditType
string | null

Type of Credit. Mozu.Customer.Contracts.Credit.Credit.CreditTypeConst Required. ReadOnly after credit creation

customCreditType
string | null

Name of custom credit type Optional.

currencyCode
string | null

Currency Code

initialBalance
number<double> | null

Balance assigned when credit was initially created. May be zero and updated later. ReadOnly after intial credit creation

currentBalance
number<double> | null

Do we want to track this here? Current Balance ReadOnly

expirationDate
string<date-time> | null

Date after which this credit is no longer valid Optional Defaults to 365 days

customerId
integer<int32> | null

Id of the N:Mozu.Customer that this credit is assigned to. Optional.

auditInfo
object
creditTypeId
integer<int32>