commerce/customer/credits/auditentries
Use the Customer Credit Audit Entries subresource to retrieve entries logged in the audit report of a store credit or gift card applied to a customer account. The system creates a new audit entry when the credit is created, deleted, activated, or deactivated. The system then creates a new audit entry each time the credit is updated or redeemed in a transaction.
JSON Example
CreditAuditEntry Properties
| Property | Description |
|---|---|
| activityType |
type: string The type of activity associated with the audit entry. Possible values are: Created, Updated, Deleted, Activated, Deactivated, or Transaction. |
| auditInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
| auditInfo |
type: string Identifier of the user that created the object. System created and read only. |
| auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
| auditInfo |
type: string Identifier of the user that updated the entity most recently. |
| auditInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
| details |
type: string Detail log that describes the activity performed for this credit audit entry. |
Operations
| Operation Name | Request URI | Description |
|---|---|---|
| GetAuditEntries | GET %7bcode%7d%2fauditentries%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves the list of audit entries for the credit, according to any filter or sort criteria specified in the request. |