v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

Customer

Update customer balance

Updates the store-specific balance for a customer. Requires the stores.customers.update permission.

patch/stores/{storeId}/customers/{customerId}/balance

Path parameters

storeIdstring uuid required

The ID of the store.

customerIdstring uuid required

The ID of the customer whose balance to update.

Request body

newBalancenumber required

The new balance to set for the customer. Must be zero or positive.

commentstring nullable

Optional comment or reason for this balance update, for audit purposes.

Response

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

{"stackTrail":"components:schemas:ObjectResponse:properties:data","oasType":"schema","type":"unknown","description":"Represents the data associated with a response.","nullable":true}