Skip to main content

AdjustCustomerStoreCreditInput

No description

input AdjustCustomerStoreCreditInput {
  customerId: Int!
  amount: Float!
  reason: String
  orderId: Int
}

Fields​

customerId ● Int!​

ID of the customer.

amount ● Float!​

Adjustment amount to apply to the customer's store credit. Use a negative value to decrease the balance. The amount is expressed in the active context currency (currency header). If customer in question has a specified store credit currency, active context currency must match.

reason ● String​

Optional reason for the adjustment. Used for internal information.

orderId ● Int​

Optional order ID if the adjustment is connected to an order, such as a refund. Used for internal information.

Example​

{}