# Schemas **CreateMemberDto** | merchantId\* | string | | --------------------------- | --------- | | customerId\* | string | | accountState\* | string | | anonymized\* | boolean | | contractId\* | number | | createdAt\* | string | | credit\* | number | | creditsEarned\* | number | | email\* | string | | firstName\* | string | | joinedAt\* | string | | lastCreditRedemptionAt\* | string | | lastName\* | string | | lastPurchaseAt\* | string | | notes\* | string | | numberOfCreditRedemptions\* | number | | orderCount\* | number | | orderIds\* | \[number] | | paymentId\* | number | | phoneNumber\* | string | | referrals\* | number | | referredBy\* | number | | revenue\* | number | | status\* | string | | totalSpend\* | number | | updatedAt\* | string | **ResponseBodyDto** | message\* |

string

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

| | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | data\* | The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error. | **UpdateMemberDto** | firstName\* |

string

The customer's first name.

| | ------------- | ------------------------------------------------------------------------------------ | | lastName\* |

string

The customer's last name.

| | notes\* |

string

Internal notes for this customer. Only viewable by the merchant.

| | phoneNumber\* |

string

The customer's phone number.

| **CreateCreditDto** | amount\* |

number
minimum: 1

The amount of credits to add to the customer's account.

| | -------- | ----------------------------------------------------------------------------------------- | **SignupStoreCreditsDto** | creditAmount\* |

number

The amount to be awarded upon sign-up.

| | -------------- | ---------------------------------------------------------------------- | | name\* |

string

The name (appearance only) of this benefit.

| | days\* |

number

The number of days to delay the credit award.

| | description\* |

string

The description of this benefit (appearance only).

| | type\* | This is an internal identifier, leave default. | **RecurringStoreCreditsDto** | creditAmount\* |

number

The amount to be awarded each recurrence.

| | -------------- | ---------------------------------------------------------------------- | | name\* |

string

The name (appearance only) of this benefit.

| | description\* |

string

The description of this benefit (appearance only).

| | frequency\* |

number

How often (in days) you want to award this credit.

| | type\* | This is an internal identifier, leave default. | **CreditsforOrdersDto** | internalTitle\* |

string

The internal identifier, leave default.

| | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type\* | This is an internal identifier, leave default. | | description: | This is an internal identifier, leave default. | | name\* |

string

The name (appearance only) of this benefit.

| | description\* |

string

The description of this benefit (appearance only).

| | enabled\* |

boolean

Whether this benefit is enabled or not.

| | rule\* |

string

Which credit rule: "PERCENTAGE\_BACK\_ON\_PURCHASE", "EARN\_EVERY\_ORDER", or "SPEND\_AND\_EARN".

Enum:
\[ PERCENTAGE\_BACK\_ON\_PURCHASE, EARN\_EVERY\_ORDER, SPEND\_AND\_EARN ]

| | rewardValue\* |

number

The amount of credits (or percent) to give as an award.

| | excludeInveterateMembershipProducts\* |

boolean

Whether or not to include the membership product for credit.

| | minimumPurchaseAmount\* |

number

The minimum individual purchase amount to award credit for orders.

| | maximumRewardValue\* |

string

The discount code to use for this benefit.

| | allowRefunds\* |

boolean

Whether or not this benefit is displayed on the landing page.

| | appliesTo\* |

string

Which products or collections this benefit applies to: "ALL\_PRODUCTS", "SPECIFIC\_PRODUCTS", or "SPECIFIC\_COLLECTIONS".

Enum:
\[ ALL\_PRODUCTS, SPECIFIC\_PRODUCTS, SPECIFIC\_COLLECTIONS ]

| | applicableTo\* |

If appliesTo is either of the latter two values, this is a string array of Shopify Product IDs or Collection IDs (i.e. "gid://shopify/Collection/266717724758").

string]

| **AnniversaryCreditsDto** | creditAmount\* |

number

The amount of credits to award on anniversary.

| | -------------- | ---------------------------------------------------------------------- | | name\* |

string

The name (appearance only) of this benefit.

| | description\* |

string

The description of this benefit (appearance only).

| | type\* | This is an internal identifier, leave default. | **StoreCreditsforReferralDto** | creditAmount\* |

number

The amount of credits to award on referral.

| | -------------- | ---------------------------------------------------------------------- | | name\* |

string

The name (appearance only) of this benefit.

| | description\* |

string

The description of this benefit (appearance only).

| | type\* | This is an internal identifier, leave default. | **FreeShippingDto** | shippingType\* |

string

Which shipping type: "DISCOUNT\_CODE" or "SCRIPT".

Enum:
\[ DISCOUNT\_CODE, SCRIPT ]

| | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | code\* |

string

The name (appearance only) of this benefit.

| | minRequirements\* |

string

Which minumum requirements: "ITEM\_QUANTITY", "PURCHASE\_AMOUNT", or "NONE".

Enum:
\[ ITEM\_QUANTITY, PURCHASE\_AMOUNT, NONE ]

| | isRatesExcluded\* |

boolean

Whether or not to include purchases with shipping rates over a certain value.

| | maximumShippingPrice\* |

number

The maximum shipping rate over which shipping is not free (only with previous value true).

| | minimumQuantity\* |

number

If minRequirements is "ITEM\_QUANTITY", include this field to indicate minimum number of items.

| | minimumSubtotal\* |

number

If minRequirements is "PURCHASE\_AMOUNT", include this field to indicate the minumum purchase amount.

| | countryType\* |

string

Which country type: "ALL" or "SPECIFIC".

Enum:
\[ ALL, SPECIFIC ]

| | countries\* | If previous value is "SPECIFIC", this field contains the specific countries in the format: { "label": "United States", "value": "United States" } | | type\* | This is an internal identifier, leave default. | | description: | This is an internal identifier, leave default. | **MemberOnlyDiscountDto** | name\* |

string

The name (appearance only) of this benefit.

| | ------------- | ----------------------------------------------------------------- | | description\* |

string

The description of this benefit (appearance).

| | type\* | This is an internal identifier, leave default. | | description: | This is an internal identifier, leave default. | **SignupDiscountDto** | name\* |

string

The name (appearance only) of this benefit.

| | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | description\* |

string

The description of this benefit (appearance).

| | discountType\* |

string

Which discount type: "percentage" or "fixed".

Enum:
\[ percentage, fixed ]

| | value\* |

number

The fixed or percentage award value.

| | collectionIds\* |

If using collections, this is a string array of Shopify Collection IDs (i.e. "gid://shopify/Collection/266717724758").

string

| | productIds\* |

If using products, this is a string array of Shopify Product IDs (i.e. "gid://shopify/Product/266717724758").

string

| | minimumSubtotal\* |

number

The minimum subtotal for an individual purchase to qualify (null if using quantity).

| | minimumQuantity\* |

number

The minimum quantity of items in an individual purchase to qualify (null if using subtotal).

| | oneUsePerCustomer\* |

boolean

Whether or not this discount is single use per customer.

| | hasExpiration\* |

boolean

Whether or not this discount expires.

| | expirationDays\* |

number

If the previous value is true, this is the quantity, in days, before this discount expires.

| | type\* | This is an internal identifier, leave default. | **MemberPricingDto** | name\* |

string

The name (appearance only) of this benefit.

| | --------------------------- | ---------------------------------------------------------------------------- | | description\* |

string

The description of this benefit (appearance).

| | collectionId\* |

string

The Shopify collection ID link to apply this benefit to.

| | defaultDiscountPercentage\* |

number

The discount in pricing to apply to the collection.

| | type\* | This is an internal identifier, leave default. | **EarlyAccessCampaignDto** | name\* |

string

The name (appearance only) of this benefit.

| | --------------- | ---------------------------------------------------------------------------------- | | collectionIds\* | The Shopify collection IDs to apply this benefit to. | | startDate\* |

string

The Shopify discount code ID to apply to the collection.

| | endDate\* |

string

The end date that takes the format: YYYY-MM-DD HH:MM:SS +00:00

| **WebhookDto** | merchantId\* |

string

The ID of the merchant that owns this webhook.

| | -------------- | ----------------------------------------------------------------------------------------------- | | id\* |

string

The ID of the webhook.

| | createdByApp\* |

string

The entity that is requesting the webhook creation.

| | dateCreated\* |

string

The date the webhook was created.

| | dateUpdated\* |

string

The date the webhook was last updated.

| | name\* |

string

The name associated with the callback URL.

| | callbackUrl\* |

string

The callback URL that will be called when one of the webhooks is triggered.

| | token\* |

string

The token associated with the webhook.

| --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.inveterate.com/dev/api-reference-docs/public-api-2.0-reference/schemas.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.