storeCreditInfo

query

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Query the store credits of a single customer, including the store credits code and current balance.

Arguments

customerId ● String!non-null

customer Id

Return

balance ● UnsignedInt64

Store credits current balance

code ● String

Store credits code

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

query store Credit Info

Code

query {
  storeCreditInfo(customerId: "gid://shopline/Customer/4602226680") {
    code
    balance
  }
}

Response

{
	"data": {
		"storeCreditInfo": {
			"code": "gid://shopline/StoreCredits/2e5c8b31edaf428b",
			"balance": "71200"
		}
	}
}

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy