Refilliate Admin GraphQL API Reference

Welcome to Refilliate's Admin GraphQL API Reference Documentation. This API can be used to manage and extend your loyalty & ambassador experience.

Contact

GraphQL API Support

support@refilliate.com

https://www.refilliate.com

Terms of Service

https://www.refilliate.com/terms

API Endpoints

# Endpoint:
https://api.refilliate.com/graphql/admin

Headers

# Use a generated API Access Token
x-refilliate-access-token: <YOUR_TOKEN_HERE>

Authentication

To authenticate with the Refilliate Admin GraphQL API, you will need to generate an API Access Token.

This token should be included in the x-refilliate-access-token header for all requests.

You can generate an API Access Token from the Refilliate Admin Dashboard under Settings.

Security

It is important to keep your API Access Token secure.

The Refilliate Admin GraphQL API is designed to be used on server side. The Access Token should be kept secure and should not be exposed in public repositories or client-side code. You should not share your API Access Token with untrusted parties.

The API Access Tokens generated by a user carry the same permissions as the user who generated them.

Rate Limiting

The Refilliate Admin GraphQL API enforces rate limiting to ensure the stability and reliability of the service.

The rate limit is 3 requests per second per account. If you exceed this limit, you will receive a 429 Too Many Requests response.

Queries

`ambassador`

Description

Get Ambassador By UUID

Response

Returns an AccountAmbassador

Arguments

Name	Description
`id` - `ID!`

Example

Query

query Ambassador($id: ID!) {
  ambassador(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"ambassador": {}}}

Queries

`ambassadorLedgerEntries`

Response

Returns a LedgerEntryConnection!

Arguments

Name	Description
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query AmbassadorLedgerEntries(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  ambassadorLedgerEntries(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}

Response

{
  "data": {
    "ambassadorLedgerEntries": {"pageInfo": PageInfo}
  }
}

Queries

`ambassadorOrders`

Description

Orders for the ambassador program

Response

Returns an AmbassadorOrderConnection!

Arguments

Name	Description
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query AmbassadorOrders(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  ambassadorOrders(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987
}

Response

{"data": {"ambassadorOrders": {"pageInfo": PageInfo}}}

Queries

`ambassadors`

Description

List ambassadors for the account

Response

Returns an AccountAmbassadorConnection!

Arguments

Name	Description
`status` - `[AmbassadorStatus!]`
`tierId` - `ID`
`sort` - `String`	Sort column and sort direction separated by __. Example: id__asc. Default = `"id__asc"`
`export` - `Boolean`	Export the ambassadors to a CSV file & email the current user
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query Ambassadors(
  $status: [AmbassadorStatus!],
  $tierId: ID,
  $sort: String,
  $export: Boolean,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  ambassadors(
    status: $status,
    tierId: $tierId,
    sort: $sort,
    export: $export,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "status": ["activated"],
  "tierId": "4",
  "sort": "id__asc",
  "export": true,
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}

Response

{"data": {"ambassadors": {"pageInfo": PageInfo}}}

Queries

`customerAmbassadors`

Description

List customers for the account

Response

Returns a CustomerAmbassadorConnection!

Arguments

Name	Description
`sort` - `String`	Sort column and sort direction separated by __. Example: id__asc. Default = `"id__asc"`
`export` - `Boolean`	Export the ambassadors to a CSV file & email the current user
`filters` - `CustomersFilterInput`	Filters for the query
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query CustomerAmbassadors(
  $sort: String,
  $export: Boolean,
  $filters: CustomersFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  customerAmbassadors(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "sort": "id__asc",
  "export": false,
  "filters": CustomersFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 123
}

Response

{"data": {"customerAmbassadors": {"pageInfo": PageInfo}}}

Queries

`customerOrders`

Description

Orders for the loyalty program

Response

Returns a CustomerOrderConnection!

Arguments

Name	Description
`sort` - `String`	Sort column and sort direction separated by __. Example: id__asc. Default = `"id__asc"`
`export` - `Boolean`	Export the Orders to a CSV file & email the current user
`filters` - `CustomerOrderFilterInput`	Filters for the query
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query CustomerOrders(
  $sort: String,
  $export: Boolean,
  $filters: CustomerOrderFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  customerOrders(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "sort": "id__asc",
  "export": false,
  "filters": CustomerOrderFilterInput,
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123
}

Response

{"data": {"customerOrders": {"pageInfo": PageInfo}}}

Queries

`ledgerEntries`

Response

Returns a LedgerEntryConnection!

Arguments

Name	Description
`sort` - `String`	Sort column and sort direction separated by __. Example: id__asc. Default = `"id__desc"`
`export` - `Boolean`	Export the Orders to a CSV file & email the current user
`filters` - `LedgerEntryFilterInput`	Filters for the query
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query LedgerEntries(
  $sort: String,
  $export: Boolean,
  $filters: LedgerEntryFilterInput,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  ledgerEntries(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "sort": "id__desc",
  "export": true,
  "filters": LedgerEntryFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 123
}

Response

{"data": {"ledgerEntries": {"pageInfo": PageInfo}}}

Queries

`loyaltyEarningRules`

Response

Returns [LoyaltyEarningRule!]

Arguments

Name	Description
`includeHidden` - `Boolean`	Include hidden earning rules. Defaults to false.

Example

Query

query LoyaltyEarningRules($includeHidden: Boolean) {
  loyaltyEarningRules(includeHidden: $includeHidden)
}

Variables

{"includeHidden": false}

Response

{"data": {"loyaltyEarningRules": [{}]}}

Queries

`mediaGalleries`

Description

Show All Media Galleries for an account

Response

Returns a MediaGalleryConnection!

Arguments

Name	Description
`galleryType` - `MediaGalleryGalleryType!`
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query MediaGalleries(
  $galleryType: MediaGalleryGalleryType!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  mediaGalleries(
    galleryType: $galleryType,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "galleryType": "ambassador",
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123
}

Response

{"data": {"mediaGalleries": {"pageInfo": PageInfo}}}

Queries

`mediaGallery`

Description

Get Media Gallery By ID

Response

Returns a MediaGallery

Arguments

Name	Description
`id` - `ID!`

Example

Query

query MediaGallery($id: ID!) {
  mediaGallery(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"mediaGallery": {}}}

Queries

`referralOrders`

Description

List referralOrders for the account

Response

Returns an AmbassadorOrderConnection!

Arguments

Name	Description
`sort` - `String`	Sort column and sort direction separated by __. Example: id__asc. Default = `"id__asc"`
`export` - `Boolean`	Export the ambassadors to a CSV file & email the current user
`filters` - `ReferralOrderFilterInput!`	Filters for the query
`after` - `String`	Returns the elements in the list that come after the specified cursor.
`before` - `String`	Returns the elements in the list that come before the specified cursor.
`first` - `Int`	Returns the first n elements from the list.
`last` - `Int`	Returns the last n elements from the list.

Example

Query

query ReferralOrders(
  $sort: String,
  $export: Boolean,
  $filters: ReferralOrderFilterInput!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  referralOrders(
    sort: $sort,
    export: $export,
    filters: $filters,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

{
  "sort": "id__asc",
  "export": true,
  "filters": ReferralOrderFilterInput,
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}

Response

{"data": {"referralOrders": {"pageInfo": PageInfo}}}

Queries

`webhookSubscriptions`

Response

Returns [WebhookSubscription!]

Example

Query

query WebhookSubscriptions {
  webhookSubscriptions
}

Response

{"data": {"webhookSubscriptions": [{}]}}

Mutations

`ambassadorAccessTokenCreate`

Response

Returns an AmbassadorAccessTokenCreatePayload

Arguments

Name	Description
`input` - `AmbassadorAccessTokenCreateInput!`

Example

Query

mutation AmbassadorAccessTokenCreate($input: AmbassadorAccessTokenCreateInput!) {
  ambassadorAccessTokenCreate(input: $input)
}

Variables

{"input": AmbassadorAccessTokenCreateInput}

Response

{"data": {"ambassadorAccessTokenCreate": {}}}

Mutations

`ambassadorCreate`

Response

Returns an AmbassadorCreatePayload

Arguments

Name	Description
`input` - `AmbassadorCreateInput!`

Example

Query

mutation AmbassadorCreate($input: AmbassadorCreateInput!) {
  ambassadorCreate(input: $input)
}

Variables

{"input": AmbassadorCreateInput}

Response

{"data": {"ambassadorCreate": {}}}

Mutations

`ambassadorDelete`

Response

Returns an AmbassadorDeletePayload

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation AmbassadorDelete($id: Int!) {
  ambassadorDelete(id: $id)
}

Variables

{"id": 987}

Response

{"data": {"ambassadorDelete": {}}}

Mutations

`ambassadorInvitationAccept`

Response

Returns an AmbassadorInvitationAcceptPayload

Arguments

Name	Description
`input` - `AmbassadorInvitationAcceptInput!`

Example

Query

mutation AmbassadorInvitationAccept($input: AmbassadorInvitationAcceptInput!) {
  ambassadorInvitationAccept(input: $input)
}

Variables

{"input": AmbassadorInvitationAcceptInput}

Response

{"data": {"ambassadorInvitationAccept": {}}}

Mutations

`ambassadorInvitationCreate`

Response

Returns an AmbassadorInvitationCreatePayload

Arguments

Name	Description
`input` - `AmbassadorInvitationCreateInput!`

Example

Query

mutation AmbassadorInvitationCreate($input: AmbassadorInvitationCreateInput!) {
  ambassadorInvitationCreate(input: $input)
}

Variables

{"input": AmbassadorInvitationCreateInput}

Response

{"data": {"ambassadorInvitationCreate": {}}}

Mutations

`ambassadorLoginTokenCreate`

Response

Returns an AmbassadorLoginTokenCreatePayload

Arguments

Name	Description
`email` - `String!`

Example

Query

mutation AmbassadorLoginTokenCreate($email: String!) {
  ambassadorLoginTokenCreate(email: $email)
}

Variables

{"email": "abc123"}

Response

{"data": {"ambassadorLoginTokenCreate": {}}}

Mutations

`ambassadorOneTimeUseCodeCreate`

Response

Returns an AmbassadorOneTimeUseCodeCreatePayload

Arguments

Name	Description
`input` - `AmbassadorOneTimeUseCodeCreateInput!`

Example

Query

mutation AmbassadorOneTimeUseCodeCreate($input: AmbassadorOneTimeUseCodeCreateInput!) {
  ambassadorOneTimeUseCodeCreate(input: $input)
}

Variables

{"input": AmbassadorOneTimeUseCodeCreateInput}

Response

{"data": {"ambassadorOneTimeUseCodeCreate": {}}}

Mutations

`ambassadorPasswordTokenCreate`

Response

Returns an AmbassadorPasswordTokenCreatePayload

Arguments

Name	Description
`email` - `String!`

Example

Query

mutation AmbassadorPasswordTokenCreate($email: String!) {
  ambassadorPasswordTokenCreate(email: $email)
}

Variables

{"email": "xyz789"}

Response

{"data": {"ambassadorPasswordTokenCreate": {}}}

Mutations

`ambassadorPasswordUpdate`

Response

Returns an AmbassadorPasswordUpdatePayload

Arguments

Name	Description
`input` - `PasswordUpdateInput!`

Example

Query

mutation AmbassadorPasswordUpdate($input: PasswordUpdateInput!) {
  ambassadorPasswordUpdate(input: $input)
}

Variables

{"input": PasswordUpdateInput}

Response

{"data": {"ambassadorPasswordUpdate": {}}}

Mutations

`ambassadorPayoutCreate`

Response

Returns an AmbassadorPayoutCreatePayload

Arguments

Name	Description
`payoutMethod` - `AmbassadorPayoutMethod!`

Example

Query

mutation AmbassadorPayoutCreate($payoutMethod: AmbassadorPayoutMethod!) {
  ambassadorPayoutCreate(payoutMethod: $payoutMethod)
}

Variables

{"payoutMethod": "BANK_TRANSFER"}

Response

{"data": {"ambassadorPayoutCreate": {}}}

Mutations

`ambassadorProfileUpdate`

Response

Returns an AmbassadorProfileUpdatePayload

Arguments

Name	Description
`input` - `AmbassadorProfileUpdateInput!`
`id` - `ID`

Example

Query

mutation AmbassadorProfileUpdate(
  $input: AmbassadorProfileUpdateInput!,
  $id: ID
) {
  ambassadorProfileUpdate(
    input: $input,
    id: $id
  )
}

Variables

{"input": AmbassadorProfileUpdateInput, "id": 4}

Response

{"data": {"ambassadorProfileUpdate": {}}}

Mutations

`ambassadorResendInvitation`

Response

Returns an AmbassadorResendInvitationPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation AmbassadorResendInvitation($id: ID!) {
  ambassadorResendInvitation(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"ambassadorResendInvitation": {}}}

Mutations

`ambassadorResendVerificationEmail`

Response

Returns an AmbassadorResendVerificationEmailPayload

Example

Query

mutation AmbassadorResendVerificationEmail {
  ambassadorResendVerificationEmail
}

Response

{"data": {"ambassadorResendVerificationEmail": {}}}

Mutations

`ambassadorShortCodeUpdate`

Response

Returns an AmbassadorShortCodeUpdatePayload

Arguments

Name	Description
`shortCode` - `String!`
`id` - `ID`

Example

Query

mutation AmbassadorShortCodeUpdate(
  $shortCode: String!,
  $id: ID
) {
  ambassadorShortCodeUpdate(
    shortCode: $shortCode,
    id: $id
  )
}

Variables

{"shortCode": "abc123", "id": 4}

Response

{"data": {"ambassadorShortCodeUpdate": {}}}

Mutations

`ambassadorUpdate`

Response

Returns an AmbassadorUpdatePayload

Arguments

Name	Description
`id` - `ID`
`input` - `AmbassadorUpdateInput!`

Example

Query

mutation AmbassadorUpdate(
  $id: ID,
  $input: AmbassadorUpdateInput!
) {
  ambassadorUpdate(
    id: $id,
    input: $input
  )
}

Variables

{
  "id": "4",
  "input": AmbassadorUpdateInput
}

Response

{"data": {"ambassadorUpdate": {}}}

Mutations

`customerAnniversaryUpdate`

Response

Returns a CustomerAnniversaryUpdatePayload

Arguments

Name	Description
`input` - `CustomerAnniversaryUpdateInput!`

Example

Query

mutation CustomerAnniversaryUpdate($input: CustomerAnniversaryUpdateInput!) {
  customerAnniversaryUpdate(input: $input)
}

Variables

{"input": CustomerAnniversaryUpdateInput}

Response

{"data": {"customerAnniversaryUpdate": {}}}

Mutations

`customerCreate`

Response

Returns a CustomerCreatePayload

Arguments

Name	Description
`input` - `CustomerCreateInput!`

Example

Query

mutation CustomerCreate($input: CustomerCreateInput!) {
  customerCreate(input: $input)
}

Variables

{"input": CustomerCreateInput}

Response

{"data": {"customerCreate": {}}}

Mutations

`customerLedgerEntryCreate`

Response

Returns a CustomerLedgerEntryCreatePayload

Arguments

Name	Description
`input` - `LedgerEntryCreateInput!`

Example

Query

mutation CustomerLedgerEntryCreate($input: LedgerEntryCreateInput!) {
  customerLedgerEntryCreate(input: $input)
}

Variables

{"input": LedgerEntryCreateInput}

Response

{"data": {"customerLedgerEntryCreate": {}}}

Mutations

`customerLoyaltyEarningRuleLinkVisitCreate`

Response

Returns a CustomerLoyaltyEarningRuleLinkVisitCreatePayload

Arguments

Name	Description
`customerUuid` - `ID!`
`ruleUuid` - `ID!`

Example

Query

mutation CustomerLoyaltyEarningRuleLinkVisitCreate(
  $customerUuid: ID!,
  $ruleUuid: ID!
) {
  customerLoyaltyEarningRuleLinkVisitCreate(
    customerUuid: $customerUuid,
    ruleUuid: $ruleUuid
  )
}

Variables

{"customerUuid": "4", "ruleUuid": 4}

Response

{"data": {"customerLoyaltyEarningRuleLinkVisitCreate": {}}}

Mutations

`shortCodeVisitCreate`

Response

Returns a ShortCodeVisitCreatePayload

Arguments

Name	Description
`shortCode` - `String!`
`ipAddress` - `String`
`userAgent` - `String`
`source` - `String`

Example

Query

mutation ShortCodeVisitCreate(
  $shortCode: String!,
  $ipAddress: String,
  $userAgent: String,
  $source: String
) {
  shortCodeVisitCreate(
    shortCode: $shortCode,
    ipAddress: $ipAddress,
    userAgent: $userAgent,
    source: $source
  )
}

Variables

{
  "shortCode": "abc123",
  "ipAddress": "abc123",
  "userAgent": "xyz789",
  "source": "abc123"
}

Response

{"data": {"shortCodeVisitCreate": {}}}

Mutations

`webhookSubscriptionCreate`

Response

Returns a WebhookSubscriptionCreatePayload

Arguments

Name	Description
`url` - `String!`
`topic` - `String!`

Example

Query

mutation WebhookSubscriptionCreate(
  $url: String!,
  $topic: String!
) {
  webhookSubscriptionCreate(
    url: $url,
    topic: $topic
  )
}

Variables

{
  "url": "xyz789",
  "topic": "abc123"
}

Response

{"data": {"webhookSubscriptionCreate": {}}}

Mutations

`webhookSubscriptionDelete`

Description

Delete a webhook subscription

Response

Returns a WebhookSubscriptionDeletePayload

Arguments

Name	Description
`id` - `ID!`	ID of the webhook subscription to delete

Example

Query

mutation WebhookSubscriptionDelete($id: ID!) {
  webhookSubscriptionDelete(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"webhookSubscriptionDelete": {}}}

Types

AccountAmbassador

Description

Represents an ambassador associated with an account.

Example

{}

Types

AccountAmbassadorConnection

Description

The connection type for AccountAmbassador.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

AmbassadorAccessTokenCreateInput

Fields

Input Field	Description
`email` - `String`
`password` - `String`
`loginType` - `String`
`socialIdentifier` - `String`

Example

{
  "email": "abc123",
  "password": "abc123",
  "loginType": "xyz789",
  "socialIdentifier": "abc123"
}

Types

AmbassadorAccessTokenCreatePayload

Description

Autogenerated return type of AmbassadorAccessTokenCreate.

Example

{}

Types

AmbassadorCreateInput

Fields

Input Field	Description
`email` - `String`
`password` - `String`
`loginType` - `SocialLogin`
`socialIdentifier` - `String`
`firstName` - `String`
`lastName` - `String`
`acceptsMarketing` - `Boolean`
`shortCode` - `String`
`acquisitionDetails` - `JSON`

Example

{
  "email": "xyz789",
  "password": "xyz789",
  "loginType": "GOOGLE",
  "socialIdentifier": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "acceptsMarketing": true,
  "shortCode": "xyz789",
  "acquisitionDetails": {}
}

Types

AmbassadorCreatePayload

Description

Autogenerated return type of AmbassadorCreate.

Example

{}

Types

AmbassadorDeletePayload

Description

Autogenerated return type of AmbassadorDelete.

Example

{}

Types

AmbassadorInvitationAcceptInput

Fields

Input Field	Description
`token` - `String!`
`password` - `String!`
`acceptsMarketing` - `Boolean`

Example

{
  "token": "xyz789",
  "password": "xyz789",
  "acceptsMarketing": false
}

Types

AmbassadorInvitationAcceptPayload

Description

Autogenerated return type of AmbassadorInvitationAccept.

Example

{}

Types

AmbassadorInvitationCreateInput

Fields

Input Field	Description
`email` - `String!`
`firstName` - `String!`
`lastName` - `String!`
`tierId` - `ID`

Example

{
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "tierId": 4
}

Types

AmbassadorInvitationCreatePayload

Description

Autogenerated return type of AmbassadorInvitationCreate.

Example

{}

Types

AmbassadorLoginTokenCreatePayload

Description

Autogenerated return type of AmbassadorLoginTokenCreate.

Example

{}

Types

AmbassadorOneTimeUseCodeCreateInput

Fields

Input Field	Description
`ambassadorUuid` - `String!`
`email` - `String`
`phoneNumber` - `String`
`source` - `String`
`analyticsVisitId` - `ID`
`widgetUuid` - `String`
`acquisitionDetails` - `JSON`

Example

{
  "ambassadorUuid": "xyz789",
  "email": "abc123",
  "phoneNumber": "abc123",
  "source": "abc123",
  "analyticsVisitId": 4,
  "widgetUuid": "xyz789",
  "acquisitionDetails": {}
}

Types

AmbassadorOneTimeUseCodeCreatePayload

Description

Autogenerated return type of AmbassadorOneTimeUseCodeCreate.

Example

{}

Types

AmbassadorOrderConnection

Description

The connection type for AmbassadorOrder.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

AmbassadorPasswordTokenCreatePayload

Description

Autogenerated return type of AmbassadorPasswordTokenCreate.

Example

{}

Types

AmbassadorPasswordUpdatePayload

Description

Autogenerated return type of AmbassadorPasswordUpdate.

Example

{}

Types

AmbassadorPayoutCreatePayload

Description

Autogenerated return type of AmbassadorPayoutCreate.

Example

{}

Types

AmbassadorPayoutMethod

Description

Ambassador Payout Method

Values

Enum Value	Description
`BANK_TRANSFER`	Bank Transfer and Gift Card
`DIGITAL_GIFT_CARD`	Digital Gift Card
`PAYPAL`	PayPal
`VENMO`	Venmo
`RECHARGE_STORE_CREDITS`	Recharge Store Credit
`SHOPIFY_GIFT_CARD`	Shopify Gift Card
`SHOPIFY_DISCOUNT_CODE`	Shopify Discount Code
`RECHARGE_DISCOUNT_CODE`	Recharge Discount Code
`FREE_PRODUCT`	Free Product

Example

"BANK_TRANSFER"

Types

AmbassadorProfileUpdateInput

Fields

Input Field	Description
`email` - `String`
`firstName` - `String`
`lastName` - `String`
`displayName` - `String`
`jobTitle` - `String`
`companyName` - `String`
`bio` - `String`
`currentPassword` - `String`
`password` - `String`
`acceptsMarketing` - `Boolean`

Example

{
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "displayName": "xyz789",
  "jobTitle": "xyz789",
  "companyName": "abc123",
  "bio": "abc123",
  "currentPassword": "xyz789",
  "password": "xyz789",
  "acceptsMarketing": false
}

Types

AmbassadorProfileUpdatePayload

Description

Autogenerated return type of AmbassadorProfileUpdate.

Example

{}

Types

AmbassadorResendInvitationPayload

Description

Autogenerated return type of AmbassadorResendInvitation.

Example

{}

Types

AmbassadorResendVerificationEmailPayload

Description

Autogenerated return type of AmbassadorResendVerificationEmail.

Example

{}

Types

AmbassadorShortCodeUpdatePayload

Description

Autogenerated return type of AmbassadorShortCodeUpdate.

Example

{}

Types

AmbassadorStatus

Description

Ambassador Status

Values

Enum Value	Description
`activated`	ACTIVATED
`invited`	INVITED

Example

"activated"

Types

AmbassadorUpdateInput

Fields

Input Field	Description
`firstName` - `String`
`lastName` - `String`
`displayName` - `String`
`email` - `String`
`tierId` - `ID`	Ambassador tier ID

Example

{
  "firstName": "xyz789",
  "lastName": "abc123",
  "displayName": "abc123",
  "email": "abc123",
  "tierId": 4
}

Types

AmbassadorUpdatePayload

Description

Autogenerated return type of AmbassadorUpdate.

Example

{}

Types

Boolean

Description

Represents true or false values.

Types

CustomerAmbassadorConnection

Description

The connection type for CustomerAmbassador.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

CustomerAnniversaryUpdateInput

Fields

Input Field	Description
`customerUuid` - `ID!`
`anniversaryType` - `LoyaltyEarningRuleAnniversaryEvent!`
`day` - `Int!`
`month` - `Int!`

Example

{
  "customerUuid": 4,
  "anniversaryType": "ACCOUNT_CREATION",
  "day": 123,
  "month": 123
}

Types

CustomerAnniversaryUpdatePayload

Description

Autogenerated return type of CustomerAnniversaryUpdate.

Example

{}

Types

CustomerCreateInput

Fields

Input Field	Description
`ecommerceCustomerId` - `String`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`acquisitionDetails` - `JSON`
`widgetUuid` - `String`

Example

{
  "ecommerceCustomerId": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "acquisitionDetails": {},
  "widgetUuid": "abc123"
}

Types

CustomerCreatePayload

Description

Autogenerated return type of CustomerCreate.

Example

{}

Types

CustomerLedgerEntryCreatePayload

Description

Autogenerated return type of CustomerLedgerEntryCreate.

Example

{}

Types

CustomerLoyaltyEarningRuleLinkVisitCreatePayload

Description

Autogenerated return type of CustomerLoyaltyEarningRuleLinkVisitCreate.

Example

{}

Types

CustomerOrderConnection

Description

The connection type for CustomerOrder.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

CustomerOrderFilterInput

Fields

Input Field	Description
`date` - `QueryDateFilterInput`

Example

{"date": QueryDateFilterInput}

Types

CustomerProfessionalFilter

Values

Enum Value	Description
`CUSTOMER`	CUSTOMER
`PROFESSIONAL`	PROFESSIONAL

Example

"CUSTOMER"

Types

CustomersFilterInput

Fields

Input Field	Description
`date` - `QueryDateFilterInput`
`loyaltyTierId` - `ID`

Example

{"date": QueryDateFilterInput, "loyaltyTierId": 4}

Types

Float

Description

Represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

Types

ID

Description

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

Types

ISO8601Date

Description

An ISO 8601-encoded date

Example

ISO8601Date

Types

Int

Description

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

JSON

Description

Represents untyped JSON

Example

{}

Types

LedgerEntryConnection

Description

The connection type for LedgerEntry.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

LedgerEntryCreateInput

Fields

Input Field	Description
`customerUuid` - `ID!`	The UUID of the customer. This value can be obtained from metafields on customer in Shopify. customer.metafields.refilliate.refilliate_uuid
`entryType` - `LedgerEntryEntry!`
`ruleUuid` - `ID`	The UUID of the rule to use for this entry. Required for credit entries.
`amount` - `Float`	The amount of points to credit or debit. Required for debit entries or custom rules that allow points override.
`description` - `String!`	A description of the entry. This will be displayed to the customer.

Example

{
  "customerUuid": 4,
  "entryType": "DEBIT",
  "ruleUuid": 4,
  "amount": 987.65,
  "description": "abc123"
}

Types

LedgerEntryEntry

Values

Enum Value	Description
`DEBIT`	DEBIT
`CREDIT`	CREDIT

Example

"DEBIT"

Types

LedgerEntryFilterInput

Fields

Input Field	Description
`date` - `QueryDateFilterInput`
`entryType` - `LedgerEntryEntry!`
`earningRuleId` - `ID`
`type` - `CustomerProfessionalFilter!`

Example

{
  "date": QueryDateFilterInput,
  "entryType": "DEBIT",
  "earningRuleId": 4,
  "type": "CUSTOMER"
}

Types

LoyaltyEarningRule

Example

{}

Types

LoyaltyEarningRuleAnniversaryEvent

Values

Enum Value	Description
`ACCOUNT_CREATION`	Account Creation
`BIRTHDAY`	Birthday
`CUSTOM`	Custom

Example

"ACCOUNT_CREATION"

Types

MediaGallery

Example

{}

Types

MediaGalleryConnection

Description

The connection type for MediaGallery.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.

Example

{"pageInfo": PageInfo}

Types

MediaGalleryGalleryType

Description

Medium Gallery Type

Values

Enum Value	Description
`ambassador`
`ambassador_faq`

Example

"ambassador"

Types

PageInfo

Description

Information about pagination in a connection.

Fields

Field Name	Description
`endCursor` - `String`	When paginating forwards, the cursor to continue.
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `String`	When paginating backwards, the cursor to continue.

Example

{
  "endCursor": "abc123",
  "hasNextPage": false,
  "hasPreviousPage": true,
  "startCursor": "xyz789"
}

Types

PasswordUpdateInput

Fields

Input Field	Description
`token` - `String!`
`password` - `String!`

Example

{
  "token": "abc123",
  "password": "abc123"
}

Types

QueryDateFilterInput

Fields

Input Field	Description
`dateFrom` - `ISO8601Date!`
`dateTo` - `ISO8601Date!`

Example

{
  "dateFrom": ISO8601Date,
  "dateTo": ISO8601Date
}

Types

ReferralOrderFilterInput

Fields

Input Field	Description
`date` - `QueryDateFilterInput`
`type` - `CustomerProfessionalFilter!`

Example

{"date": QueryDateFilterInput, "type": "CUSTOMER"}

Types

ShortCodeVisitCreatePayload

Description

Autogenerated return type of ShortCodeVisitCreate.

Example

{}

Types

SocialLogin

Description

Supported Social Login Methods

Values

Enum Value	Description
`GOOGLE`
`FACEBOOK`
`TIKTOK`
`INSTAGRAM`
`SHOPIFY`

Example

"GOOGLE"

Types

String

Description

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

WebhookSubscription

Example

{}

Types

WebhookSubscriptionCreatePayload

Description

Autogenerated return type of WebhookSubscriptionCreate.

Example

{}

Types

WebhookSubscriptionDeletePayload

Description

Autogenerated return type of WebhookSubscriptionDelete.

Example

{}

Documentation by Anvil SpectaQL