Add Transaction

Adds a credit transaction.

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

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "comments": "<string>",
  "data": "<unknown>",
  "id": 123,
  "impactAmount": 123,
  "orderId": "<string>",
  "transactionType": "<string>"
}

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

Credit Transactions are used to make adjustments to a Credit Balance

auditInfo · object

Show child attributes

comments · string | null

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

data · any | null

Custom data for credit transactions

id · integer<int32> | null

Id unique within the tenant ReadOnly

impactAmount · number<double> | null

Amount to apply to Credit Balance Required

orderId · string | null

transactionType · string | null

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

Response

200

application/json

Success

Credit Transactions are used to make adjustments to a Credit Balance

auditInfo · object

Show child attributes

comments · string | null

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

data · any | null

Custom data for credit transactions

id · integer<int32> | null

Id unique within the tenant ReadOnly

impactAmount · number<double> | null

Amount to apply to Credit Balance Required

orderId · string | null

transactionType · string | null

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