Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
Credit

Add Transaction

Adds a credit transaction.

post/commerce/customer/credits/{code}/transactions

Path parameters

codestring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

commentsstring nullable

Comments about the transaction. Depending on the user interface, these comments may be readable by authorized users or customers.

{"stackTrail":"components:schemas:CreditTransaction:properties:data","oasType":"schema","type":"unknown","description":"Custom data for credit transactions","nullable":true}
idinteger nullable

Id unique within the tenant ReadOnly

impactAmountnumber double nullable

Amount to apply to Credit Balance Required

orderIdstring nullable
transactionTypestring nullable

Mozu.Customer.Contracts.Credit.CreditTransaction.CreditTransactionType Requried

Response

OK

commentsstring nullable

Comments about the transaction. Depending on the user interface, these comments may be readable by authorized users or customers.

{"stackTrail":"components:schemas:CreditTransaction:properties:data","oasType":"schema","type":"unknown","description":"Custom data for credit transactions","nullable":true}
idinteger nullable

Id unique within the tenant ReadOnly

impactAmountnumber double nullable

Amount to apply to Credit Balance Required

orderIdstring nullable
transactionTypestring nullable

Mozu.Customer.Contracts.Credit.CreditTransaction.CreditTransactionType Requried