RevSend GraphQL Reference

Production API

Contact

Support

contact@revsend.com

https://www.revsend.com/faq

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

Terms of Service

https://www.revsend.com/termsandconditions

API Endpoints

https://graph.v2.revsend.com

Headers

# Your API Token
Authorization: <YOUR_TOKEN_HERE>

Queries

`_empty`

Response

Returns a Boolean

Example

Query

query _empty {
  _empty
}

Response

{"data": {"_empty": true}}

Queries

`allOrgs`

Response

Returns [Org!]!

Example

Query

query AllOrgs {
  allOrgs {
    id
    name
    formattedName
    users {
      totalCount
      nodes {
        ...UserFragment
      }
    }
    logoUrl
    logoBackgroundColor
    logoPrimaryColor
    isInternational
    hubSpotUserInfo {
      id
      displayName
    }
    hubSpotUsers {
      id
      name
      email
    }
    salesForceUserInfo {
      id
      username
      nickName
      displayName
    }
    salesForceUsers {
      id
      name
      email
    }
    teams {
      id
      name
      users {
        ...UsersWithTeamFragment
      }
    }
  }
}

Response

{
  "data": {
    "allOrgs": [
      {
        "id": "4",
        "name": "xyz789",
        "formattedName": "xyz789",
        "users": Users,
        "logoUrl": "abc123",
        "logoBackgroundColor": "abc123",
        "logoPrimaryColor": "xyz789",
        "isInternational": false,
        "hubSpotUserInfo": HubSpotUserInfo,
        "hubSpotUsers": [HubSpotUser],
        "salesForceUserInfo": SalesForceUserInfo,
        "salesForceUsers": [SalesForceUser],
        "teams": [Teams]
      }
    ]
  }
}

Queries

`allUsers`

Response

Returns [User!]

Example

Query

query AllUsers {
  allUsers {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Response

{
  "data": {
    "allUsers": [
      {
        "id": "4",
        "name": "xyz789",
        "email": "abc123",
        "role": "ADMIN",
        "password": "abc123",
        "budget": Budget,
        "salesForceUserId": "xyz789",
        "hubSpotUserId": "abc123",
        "teams": [UserTeams],
        "org": Org,
        "status": "ACTIVE",
        "googleEmail": "abc123",
        "microsoftEmail": "xyz789",
        "hubSpotToken": HubSpotToken,
        "apiPasswords": [ApiPassword]
      }
    ]
  }
}

Queries

`campaigns`

Response

Returns a Campaigns!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `CampaignSortKey`
`query` - `CampaignQuery`

Example

Query

query Campaigns(
  $skip: Int!,
  $take: Int!,
  $sort: CampaignSortKey,
  $query: CampaignQuery
) {
  campaigns(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      createdAt
      type
      name
    }
  }
}

Variables

{
  "skip": 987,
  "take": 987,
  "sort": "CREATED_AT_ASC",
  "query": CampaignQuery
}

Response

{
  "data": {
    "campaigns": {"totalCount": 123, "nodes": [Campaign]}
  }
}

Queries

`categories`

Response

Returns [Category!]!

Example

Query

query Categories {
  categories {
    id
    name
  }
}

Response

{
  "data": {
    "categories": [
      {"id": 4, "name": "xyz789"}
    ]
  }
}

Queries

`charges`

Response

Returns a Charges!

Arguments

Name	Description
`page` - `String`
`query` - `ChargeQuery`

Example

Query

query Charges(
  $page: String,
  $query: ChargeQuery
) {
  charges(
    page: $page,
    query: $query
  ) {
    totalCount
    nextPage
    nodes {
      id
      amount
      created
      description
      receiptUrl
    }
  }
}

Variables

{
  "page": "xyz789",
  "query": ChargeQuery
}

Response

{
  "data": {
    "charges": {
      "totalCount": 987,
      "nextPage": "abc123",
      "nodes": [Charge]
    }
  }
}

Queries

`checkPasswordReset`

Response

Returns a Boolean

Arguments

Name	Description
`email` - `String!`

Example

Query

query CheckPasswordReset($email: String!) {
  checkPasswordReset(email: $email)
}

Variables

{"email": "abc123"}

Response

{"data": {"checkPasswordReset": true}}

Queries

`creditCharges`

Response

Returns [Charge!]!

Example

Query

query CreditCharges {
  creditCharges {
    id
    amount
    created
    description
    receiptUrl
  }
}

Response

{
  "data": {
    "creditCharges": [
      {
        "id": "4",
        "amount": 987,
        "created": "2007-12-03T10:15:30Z",
        "description": "xyz789",
        "receiptUrl": "xyz789"
      }
    ]
  }
}

Queries

`customer`

Response

Returns a Customer

Example

Query

query Customer {
  customer {
    id
    name
    email
    card {
      id
      last4
      brand
    }
    balance
    spendableBalance
  }
}

Response

{
  "data": {
    "customer": {
      "id": 4,
      "name": "xyz789",
      "email": "abc123",
      "card": Card,
      "balance": 987,
      "spendableBalance": 123
    }
  }
}

Queries

`digitalBarcode`

Response

Returns a DigitalBarcode

Arguments

Name	Description
`digitalOrderCode` - `ID!`

Example

Query

query DigitalBarcode($digitalOrderCode: ID!) {
  digitalBarcode(digitalOrderCode: $digitalOrderCode) {
    id
    number
    csc
    barcodeKind
    barcodeValue
    viewCardUrl
  }
}

Variables

{"digitalOrderCode": "4"}

Response

{
  "data": {
    "digitalBarcode": {
      "id": 4,
      "number": "abc123",
      "csc": "xyz789",
      "barcodeKind": "abc123",
      "barcodeValue": "xyz789",
      "viewCardUrl": "abc123"
    }
  }
}

Queries

`digitalBrands`

Response

Returns [DigitalBrand!]!

Arguments

Name	Description
`query` - `DigitalBrandQuery`

Example

Query

query DigitalBrands($query: DigitalBrandQuery) {
  digitalBrands(query: $query) {
    id
    name
    iconUrl
    faceplateUrl
    legalTerms
    description
    redemptionDisclaimer
    redemptionMethods
    denominations
    increment
    maxValue
    minValue
    vendorId
    currency
  }
}

Variables

{"query": DigitalBrandQuery}

Response

{
  "data": {
    "digitalBrands": [
      {
        "id": 4,
        "name": "abc123",
        "iconUrl": "xyz789",
        "faceplateUrl": "xyz789",
        "legalTerms": "abc123",
        "description": "xyz789",
        "redemptionDisclaimer": "abc123",
        "redemptionMethods": ["xyz789"],
        "denominations": [987],
        "increment": 123,
        "maxValue": 987,
        "minValue": 987,
        "vendorId": "4",
        "currency": "USD"
      }
    ]
  }
}

Queries

`digitalCampaign`

Response

Returns a DigitalCampaign

Arguments

Name	Description
`id` - `ID!`

Example

Query

query DigitalCampaign($id: ID!) {
  digitalCampaign(id: $id) {
    id
    createdAt
    ref
    name
    rewardValue
    brands
    messageTemplate
    headlineTemplate
    allowCharity
    brandsSummary
    isArchived
    currency
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "digitalCampaign": {
      "id": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "ref": "xyz789",
      "name": "xyz789",
      "rewardValue": 987,
      "brands": ["4"],
      "messageTemplate": "xyz789",
      "headlineTemplate": "abc123",
      "allowCharity": false,
      "brandsSummary": "abc123",
      "isArchived": true,
      "currency": "USD"
    }
  }
}

Queries

`digitalCampaigns`

Response

Returns a DigitalCampaigns!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `DigitalCampaignSortKey`
`query` - `DigitalCampaignQuery`

Example

Query

query DigitalCampaigns(
  $skip: Int!,
  $take: Int!,
  $sort: DigitalCampaignSortKey,
  $query: DigitalCampaignQuery
) {
  digitalCampaigns(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      createdAt
      ref
      name
      rewardValue
      brands
      messageTemplate
      headlineTemplate
      allowCharity
      brandsSummary
      isArchived
      currency
    }
  }
}

Variables

{
  "skip": 123,
  "take": 123,
  "sort": "CREATED_AT_ASC",
  "query": DigitalCampaignQuery
}

Response

{
  "data": {
    "digitalCampaigns": {
      "totalCount": 987,
      "nodes": [DigitalCampaign]
    }
  }
}

Queries

`digitalOrder`

Response

Returns a DigitalOrder

Arguments

Name	Description
`orderRef` - `ID!`

Example

Query

query DigitalOrder($orderRef: ID!) {
  digitalOrder(orderRef: $orderRef) {
    id
    ref
    createdAt
    rewardValue
    status
    rewardLink
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    creator {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    campaign {
      id
      createdAt
      ref
      name
      rewardValue
      brands
      messageTemplate
      headlineTemplate
      allowCharity
      brandsSummary
      isArchived
      currency
    }
    description
    deliveryMethod
    events {
      id
      createdAt
      code
    }
    cancelledAt
    teamId
  }
}

Variables

{"orderRef": 4}

Response

{
  "data": {
    "digitalOrder": {
      "id": "4",
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "rewardValue": 123,
      "status": "PAYMENT_PENDING",
      "rewardLink": "abc123",
      "recipient": Recipient,
      "creator": User,
      "campaign": DigitalCampaign,
      "description": "abc123",
      "deliveryMethod": "LINK",
      "events": [DigitalOrderEvent],
      "cancelledAt": "2007-12-03T10:15:30Z",
      "teamId": "xyz789"
    }
  }
}

Queries

`digitalOrderBatch`

Response

Returns a DigitalOrderBatch

Arguments

Name	Description
`orderBatchRef` - `ID!`

Example

Query

query DigitalOrderBatch($orderBatchRef: ID!) {
  digitalOrderBatch(orderBatchRef: $orderBatchRef) {
    id
    ref
    creator {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    createdAt
    totalOrders
    totalDelivered
    totalPaid
    digitalOrders {
      totalCount
      nodes {
        ...DigitalOrderFragment
      }
    }
  }
}

Variables

{"orderBatchRef": 4}

Response

{
  "data": {
    "digitalOrderBatch": {
      "id": "4",
      "ref": "xyz789",
      "creator": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "totalOrders": 123,
      "totalDelivered": 987,
      "totalPaid": 987,
      "digitalOrders": DigitalOrders
    }
  }
}

Queries

`digitalOrderBatches`

Response

Returns a DigitalOrderBatches!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `DigitalOrderBatchSortKey`
`query` - `DigitalOrderBatchQuery`

Example

Query

query DigitalOrderBatches(
  $skip: Int!,
  $take: Int!,
  $sort: DigitalOrderBatchSortKey,
  $query: DigitalOrderBatchQuery
) {
  digitalOrderBatches(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      creator {
        ...UserFragment
      }
      createdAt
      totalOrders
      totalDelivered
      totalPaid
      digitalOrders {
        ...DigitalOrdersFragment
      }
    }
  }
}

Variables

{
  "skip": 123,
  "take": 123,
  "sort": "CREATED_AT_ASC",
  "query": DigitalOrderBatchQuery
}

Response

{
  "data": {
    "digitalOrderBatches": {
      "totalCount": 123,
      "nodes": [DigitalOrderBatch]
    }
  }
}

Queries

`digitalOrders`

Response

Returns a DigitalOrders!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `DigitalOrderSortKey`
`query` - `DigitalOrderQuery`

Example

Query

query DigitalOrders(
  $skip: Int!,
  $take: Int!,
  $sort: DigitalOrderSortKey,
  $query: DigitalOrderQuery
) {
  digitalOrders(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      createdAt
      rewardValue
      status
      rewardLink
      recipient {
        ...RecipientFragment
      }
      creator {
        ...UserFragment
      }
      campaign {
        ...DigitalCampaignFragment
      }
      description
      deliveryMethod
      events {
        ...DigitalOrderEventFragment
      }
      cancelledAt
      teamId
    }
  }
}

Variables

{
  "skip": 987,
  "take": 987,
  "sort": "CREATED_AT_ASC",
  "query": DigitalOrderQuery
}

Response

{
  "data": {
    "digitalOrders": {
      "totalCount": 123,
      "nodes": [DigitalOrder]
    }
  }
}

Queries

`digitalReward`

Response

Returns a DigitalReward

Arguments

Name	Description
`orderRef` - `ID!`

Example

Query

query DigitalReward($orderRef: ID!) {
  digitalReward(orderRef: $orderRef) {
    orderRef
    value
    hasOrderCode
    barcode {
      id
      number
      csc
      barcodeKind
      barcodeValue
      viewCardUrl
    }
    messageTemplate
    headlineTemplate
    orgName
    logoUrl
    logoBackgroundColor
    logoPrimaryColor
    recipientName
    recipientEmail
    recipientOrgName
    creatorName
    creatorEmail
    allowsCharity
    brands {
      id
      name
      iconUrl
      faceplateUrl
      legalTerms
      description
      redemptionDisclaimer
      redemptionMethods
      denominations
      increment
      maxValue
      minValue
      vendorId
      currency
    }
    brand {
      id
      name
      iconUrl
      faceplateUrl
      legalTerms
      description
      redemptionDisclaimer
      redemptionMethods
      denominations
      increment
      maxValue
      minValue
      vendorId
      currency
    }
    code
    tremendousUrl
    currency
    cancelledAt
  }
}

Variables

{"orderRef": "4"}

Response

{
  "data": {
    "digitalReward": {
      "orderRef": "4",
      "value": 123,
      "hasOrderCode": true,
      "barcode": DigitalBarcode,
      "messageTemplate": "abc123",
      "headlineTemplate": "xyz789",
      "orgName": "xyz789",
      "logoUrl": "abc123",
      "logoBackgroundColor": "xyz789",
      "logoPrimaryColor": "xyz789",
      "recipientName": "xyz789",
      "recipientEmail": "abc123",
      "recipientOrgName": "abc123",
      "creatorName": "abc123",
      "creatorEmail": "abc123",
      "allowsCharity": false,
      "brands": [DigitalBrand],
      "brand": DigitalBrand,
      "code": "xyz789",
      "tremendousUrl": "abc123",
      "currency": "USD",
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`exchangeRates`

Response

Returns [ExchangeRate!]!

Example

Query

query ExchangeRates {
  exchangeRates {
    currency
    ratePerUsd
  }
}

Response

{"data": {"exchangeRates": [{"currency": "USD", "ratePerUsd": 987.65}]}}

Queries

`funds`

Response

Returns a Float

Example

Query

query Funds {
  funds
}

Response

{"data": {"funds": 123.45}}

Queries

`googleAuthCodeUrl`

Response

Returns a String!

Example

Query

query GoogleAuthCodeUrl {
  googleAuthCodeUrl
}

Response

{"data": {"googleAuthCodeUrl": "abc123"}}

Queries

`hubSpotContacts`

Response

Returns [HubSpotContact!]!

Arguments

Name	Description
`input` - `HubSpotContactsInput!`

Example

Query

query HubSpotContacts($input: HubSpotContactsInput!) {
  hubSpotContacts(input: $input) {
    id
    companyId
    name
    firstname
    lastname
    email
    company {
      id
      name
    }
    address
    city
    state
    zip
    phone
  }
}

Variables

{"input": HubSpotContactsInput}

Response

{
  "data": {
    "hubSpotContacts": [
      {
        "id": 4,
        "companyId": 4,
        "name": "abc123",
        "firstname": "abc123",
        "lastname": "xyz789",
        "email": "abc123",
        "company": HubSpotCompany,
        "address": "xyz789",
        "city": "abc123",
        "state": "xyz789",
        "zip": "xyz789",
        "phone": "xyz789"
      }
    ]
  }
}

Queries

`hubSpotToken`

Response

Returns a HubSpotToken

Example

Query

query HubSpotToken {
  hubSpotToken {
    user
    hubDomain
    hubId
    appId
    hubSpotUserId
  }
}

Response

{
  "data": {
    "hubSpotToken": {
      "user": "xyz789",
      "hubDomain": "abc123",
      "hubId": "4",
      "appId": 4,
      "hubSpotUserId": "4"
    }
  }
}

Queries

`integrationWebhookSample`

Response

Returns a WebhookSampleResponse

Example

Query

query IntegrationWebhookSample {
  integrationWebhookSample {
    order {
      id
      value
      message
      emailSubject
      deliveryMethod
      status
    }
    recipient {
      name
      email
      orgName
    }
    sender {
      id
      email
      name
      teamId
      teamName
    }
  }
}

Response

{
  "data": {
    "integrationWebhookSample": {
      "order": OrderSampleOrder,
      "recipient": OrderSampleRecipient,
      "sender": OrderSampleSender
    }
  }
}

Queries

`me`

Response

Returns a User

Example

Query

query Me {
  me {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Response

{
  "data": {
    "me": {
      "id": 4,
      "name": "xyz789",
      "email": "abc123",
      "role": "ADMIN",
      "password": "abc123",
      "budget": Budget,
      "salesForceUserId": "abc123",
      "hubSpotUserId": "xyz789",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "xyz789",
      "microsoftEmail": "xyz789",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Queries

`microsoftAuthCodeUrl`

Response

Returns a String!

Example

Query

query MicrosoftAuthCodeUrl {
  microsoftAuthCodeUrl
}

Response

{"data": {"microsoftAuthCodeUrl": "abc123"}}

Queries

`oAuthGetToken`

Response

Returns a String!

Arguments

Name	Description
`query` - `GetTokenQuery!`

Example

Query

query OAuthGetToken($query: GetTokenQuery!) {
  oAuthGetToken(query: $query)
}

Variables

{"query": GetTokenQuery}

Response

{"data": {"oAuthGetToken": "abc123"}}

Queries

`orders`

Response

Returns an Orders!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `OrderSortKey`
`myOrders` - `Boolean`
`getAll` - `Boolean`
`query` - `OrderQuery`

Example

Query

query Orders(
  $skip: Int!,
  $take: Int!,
  $sort: OrderSortKey,
  $myOrders: Boolean,
  $getAll: Boolean,
  $query: OrderQuery
) {
  orders(
    skip: $skip,
    take: $take,
    sort: $sort,
    myOrders: $myOrders,
    getAll: $getAll,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      createdAt
      creatorName
      recipientName
      recipientOrg
      events {
        ...DigitalOrderEventFragment
      }
      fulfillmentEvents {
        ...FulfillmentEventFragment
      }
      type
      totalCost
      description
      cancelledAt
    }
  }
}

Variables

{
  "skip": 987,
  "take": 123,
  "sort": "CREATED_AT_ASC",
  "myOrders": false,
  "getAll": false,
  "query": OrderQuery
}

Response

{
  "data": {
    "orders": {"totalCount": 123, "nodes": [Order]}
  }
}

Queries

`org`

Response

Returns an Org

Example

Query

query Org {
  org {
    id
    name
    formattedName
    users {
      totalCount
      nodes {
        ...UserFragment
      }
    }
    logoUrl
    logoBackgroundColor
    logoPrimaryColor
    isInternational
    hubSpotUserInfo {
      id
      displayName
    }
    hubSpotUsers {
      id
      name
      email
    }
    salesForceUserInfo {
      id
      username
      nickName
      displayName
    }
    salesForceUsers {
      id
      name
      email
    }
    teams {
      id
      name
      users {
        ...UsersWithTeamFragment
      }
    }
  }
}

Response

{
  "data": {
    "org": {
      "id": 4,
      "name": "xyz789",
      "formattedName": "abc123",
      "users": Users,
      "logoUrl": "xyz789",
      "logoBackgroundColor": "abc123",
      "logoPrimaryColor": "xyz789",
      "isInternational": true,
      "hubSpotUserInfo": HubSpotUserInfo,
      "hubSpotUsers": [HubSpotUser],
      "salesForceUserInfo": SalesForceUserInfo,
      "salesForceUsers": [SalesForceUser],
      "teams": [Teams]
    }
  }
}

Queries

`physicalCampaign`

Response

Returns a PhysicalCampaign

Arguments

Name	Description
`id` - `ID!`

Example

Query

query PhysicalCampaign($id: ID!) {
  physicalCampaign(id: $id) {
    id
    ref
    createdAt
    name
    gifts {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    messageTemplate
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "physicalCampaign": {
      "id": "4",
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "gifts": [PhysicalGift],
      "messageTemplate": "abc123"
    }
  }
}

Queries

`physicalCampaigns`

Response

Returns a PhysicalCampaigns!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `PhysicalCampaignSortKey`
`query` - `PhysicalCampaignQuery`

Example

Query

query PhysicalCampaigns(
  $skip: Int!,
  $take: Int!,
  $sort: PhysicalCampaignSortKey,
  $query: PhysicalCampaignQuery
) {
  physicalCampaigns(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      createdAt
      name
      gifts {
        ...PhysicalGiftFragment
      }
      messageTemplate
    }
  }
}

Variables

{
  "skip": 123,
  "take": 123,
  "sort": "CREATED_AT_ASC",
  "query": PhysicalCampaignQuery
}

Response

{
  "data": {
    "physicalCampaigns": {
      "totalCount": 987,
      "nodes": [PhysicalCampaign]
    }
  }
}

Queries

`physicalGift`

Response

Returns a PhysicalGift

Arguments

Name	Description
`id` - `ID!`

Example

Query

query PhysicalGift($id: ID!) {
  physicalGift(id: $id) {
    id
    title
    messageMaxLength
    messageMaxLines
    descriptionHtml
    featuredImageSrc
    initialShippingCost
    products {
      id
      org {
        ...OrgFragment
      }
      isAddon
      images {
        ...ImageFragment
      }
      variants {
        ...ProductVariantFragment
      }
    }
    productVariants {
      id
      price
    }
    isDisabled
    categories
    isThirdParty
    shipsThroughWarehouse
    purchaseUrl
    vendor {
      id
      name
      messageMaxLength
      messageMaxLines
    }
    orgId
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "physicalGift": {
      "id": 4,
      "title": "abc123",
      "messageMaxLength": 987,
      "messageMaxLines": 987,
      "descriptionHtml": "xyz789",
      "featuredImageSrc": "abc123",
      "initialShippingCost": 123,
      "products": [Product],
      "productVariants": [ProductVariant],
      "isDisabled": true,
      "categories": ["xyz789"],
      "isThirdParty": true,
      "shipsThroughWarehouse": false,
      "purchaseUrl": "xyz789",
      "vendor": PhysicalVendor,
      "orgId": "abc123"
    }
  }
}

Queries

`physicalGifts`

Response

Returns a PhysicalGifts!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`query` - `PhysicalGiftQuery`

Example

Query

query PhysicalGifts(
  $skip: Int!,
  $take: Int!,
  $query: PhysicalGiftQuery
) {
  physicalGifts(
    skip: $skip,
    take: $take,
    query: $query
  ) {
    totalCount
    nodes {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
  }
}

Variables

{"skip": 123, "take": 987, "query": PhysicalGiftQuery}

Response

{
  "data": {
    "physicalGifts": {
      "totalCount": 987,
      "nodes": [PhysicalGift]
    }
  }
}

Queries

`physicalOrder`

Response

Returns a PhysicalOrder

Arguments

Name	Description
`id` - `ID!`

Example

Query

query PhysicalOrder($id: ID!) {
  physicalOrder(id: $id) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "physicalOrder": {
      "id": 4,
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": true,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "abc123",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "abc123",
      "description": "abc123",
      "shopifyOrderId": "abc123",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "xyz789",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": true,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`physicalOrderByRef`

Response

Returns a PhysicalOrder

Arguments

Name	Description
`ref` - `ID!`

Example

Query

query PhysicalOrderByRef($ref: ID!) {
  physicalOrderByRef(ref: $ref) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{"ref": 4}

Response

{
  "data": {
    "physicalOrderByRef": {
      "id": "4",
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": false,
      "recipientSubmitsAddress": false,
      "creatorName": "xyz789",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "xyz789",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "xyz789",
      "shopifyOrderId": "abc123",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": true,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`physicalOrders`

Response

Returns a PhysicalOrders!

Arguments

Name	Description
`skip` - `Int!`
`take` - `Int!`
`sort` - `PhysicalOrderSortKey`
`query` - `PhysicalOrderQuery`

Example

Query

query PhysicalOrders(
  $skip: Int!,
  $take: Int!,
  $sort: PhysicalOrderSortKey,
  $query: PhysicalOrderQuery
) {
  physicalOrders(
    skip: $skip,
    take: $take,
    sort: $sort,
    query: $query
  ) {
    totalCount
    nodes {
      id
      ref
      createdAt
      recipient {
        ...RecipientFragment
      }
      isAddressConfirmed
      recipientSubmitsAddress
      creatorName
      orgName
      orgBranding {
        ...OrgBrandingFragment
      }
      vendorName
      message
      invoiceItems {
        ...InvoiceItemFragment
      }
      mailingAddress {
        ...MailingAddressFragment
      }
      purchaseUrl
      description
      shopifyOrderId
      shopifyOrderName
      vendorOrderId
      fulfillmentEvents {
        ...FulfillmentEventFragment
      }
      images {
        ...ImageFragment
      }
      giftChoices {
        ...PhysicalGiftFragment
      }
      selectedGift {
        ...PhysicalGiftFragment
      }
      isThirdParty
      shipsThroughWarehouse
      cancelledAt
    }
  }
}

Variables

{
  "skip": 987,
  "take": 123,
  "sort": "CREATED_AT_ASC",
  "query": PhysicalOrderQuery
}

Response

{
  "data": {
    "physicalOrders": {
      "totalCount": 987,
      "nodes": [PhysicalOrder]
    }
  }
}

Queries

`physicalOrdersAdmin`

Response

Returns [PhysicalOrder!]!

Example

Query

query PhysicalOrdersAdmin {
  physicalOrdersAdmin {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Response

{
  "data": {
    "physicalOrdersAdmin": [
      {
        "id": 4,
        "ref": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "recipient": Recipient,
        "isAddressConfirmed": false,
        "recipientSubmitsAddress": true,
        "creatorName": "abc123",
        "orgName": "xyz789",
        "orgBranding": OrgBranding,
        "vendorName": "abc123",
        "message": "xyz789",
        "invoiceItems": [InvoiceItem],
        "mailingAddress": MailingAddress,
        "purchaseUrl": "abc123",
        "description": "abc123",
        "shopifyOrderId": "xyz789",
        "shopifyOrderName": "xyz789",
        "vendorOrderId": "xyz789",
        "fulfillmentEvents": [FulfillmentEvent],
        "images": [Image],
        "giftChoices": [PhysicalGift],
        "selectedGift": PhysicalGift,
        "isThirdParty": true,
        "shipsThroughWarehouse": false,
        "cancelledAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`saasCharges`

Response

Returns [Charge!]!

Example

Query

query SaasCharges {
  saasCharges {
    id
    amount
    created
    description
    receiptUrl
  }
}

Response

{
  "data": {
    "saasCharges": [
      {
        "id": 4,
        "amount": 123,
        "created": "2007-12-03T10:15:30Z",
        "description": "abc123",
        "receiptUrl": "xyz789"
      }
    ]
  }
}

Queries

`salesForceContact`

Response

Returns a SalesForceContact

Arguments

Name	Description
`input` - `SalesForceContactInput!`

Example

Query

query SalesForceContact($input: SalesForceContactInput!) {
  salesForceContact(input: $input) {
    id
    phone
    email
    name
    account {
      id
      name
    }
    mailingAddress {
      city
      country
      postalCode
      state
      street
    }
  }
}

Variables

{"input": SalesForceContactInput}

Response

{
  "data": {
    "salesForceContact": {
      "id": 4,
      "phone": "xyz789",
      "email": "xyz789",
      "name": "abc123",
      "account": SalesForceAccount,
      "mailingAddress": SalesForceMailingAddress
    }
  }
}

Queries

`salesForceContacts`

Response

Returns [SalesForceContact!]!

Arguments

Name	Description
`input` - `SalesForceContactsInput!`

Example

Query

query SalesForceContacts($input: SalesForceContactsInput!) {
  salesForceContacts(input: $input) {
    id
    phone
    email
    name
    account {
      id
      name
    }
    mailingAddress {
      city
      country
      postalCode
      state
      street
    }
  }
}

Variables

{"input": SalesForceContactsInput}

Response

{
  "data": {
    "salesForceContacts": [
      {
        "id": "4",
        "phone": "xyz789",
        "email": "abc123",
        "name": "abc123",
        "account": SalesForceAccount,
        "mailingAddress": SalesForceMailingAddress
      }
    ]
  }
}

Queries

`salesForceReport`

Response

Returns a SalesForceReport

Arguments

Name	Description
`input` - `SalesForceReportInput!`

Example

Query

query SalesForceReport($input: SalesForceReportInput!) {
  salesForceReport(input: $input) {
    id
    startDate
    endDate
    currency
    opportunities {
      id
      accountId
      amount
      isWon
      isClosed
      timestamp
      orders {
        ...SalesForceReportOrderFragment
      }
    }
    orders {
      id
      campaignId
      salesForceAccountId
      amount
      timestamp
      campaignName
    }
  }
}

Variables

{"input": SalesForceReportInput}

Response

{
  "data": {
    "salesForceReport": {
      "id": 4,
      "startDate": "2007-12-03T10:15:30Z",
      "endDate": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "opportunities": [SalesForceReportOpportunity],
      "orders": [SalesForceReportOrder]
    }
  }
}

Queries

`salesForceToken`

Response

Returns a SalesForceToken

Example

Query

query SalesForceToken {
  salesForceToken {
    id
    instanceUrl
  }
}

Response

{
  "data": {
    "salesForceToken": {
      "id": "4",
      "instanceUrl": "abc123"
    }
  }
}

Queries

`salesForceUser`

Response

Returns a SalesForceUser

Example

Query

query SalesForceUser {
  salesForceUser {
    id
    name
    email
  }
}

Response

{
  "data": {
    "salesForceUser": {
      "id": 4,
      "name": "abc123",
      "email": "abc123"
    }
  }
}

Queries

`userByInviteCode`

Response

Returns a User

Arguments

Name	Description
`input` - `UserByInviteCodeInput!`

Example

Query

query UserByInviteCode($input: UserByInviteCodeInput!) {
  userByInviteCode(input: $input) {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Variables

{"input": UserByInviteCodeInput}

Response

{
  "data": {
    "userByInviteCode": {
      "id": 4,
      "name": "abc123",
      "email": "xyz789",
      "role": "ADMIN",
      "password": "xyz789",
      "budget": Budget,
      "salesForceUserId": "abc123",
      "hubSpotUserId": "xyz789",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "xyz789",
      "microsoftEmail": "xyz789",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Queries

`vendors`

Response

Returns [PhysicalVendor!]!

Example

Query

query Vendors {
  vendors {
    id
    name
    messageMaxLength
    messageMaxLines
  }
}

Response

{
  "data": {
    "vendors": [
      {
        "id": 4,
        "name": "xyz789",
        "messageMaxLength": 987,
        "messageMaxLines": 123
      }
    ]
  }
}

Mutations

`_empty`

Response

Returns a Boolean

Example

Query

mutation _empty {
  _empty
}

Response

{"data": {"_empty": true}}

Mutations

`apiPasswordCreate`

Response

Returns a String!

Example

Query

mutation ApiPasswordCreate {
  apiPasswordCreate
}

Response

{"data": {"apiPasswordCreate": "xyz789"}}

Mutations

`apiPasswordDelete`

Response

Returns a Boolean

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation ApiPasswordDelete($id: ID!) {
  apiPasswordDelete(id: $id)
}

Variables

{"id": 4}

Response

{"data": {"apiPasswordDelete": true}}

Mutations

`assetUploadUrlCreate`

Response

Returns an AssetUploadUrl

Arguments

Name	Description
`input` - `AssetUploadUrlInput!`

Example

Query

mutation AssetUploadUrlCreate($input: AssetUploadUrlInput!) {
  assetUploadUrlCreate(input: $input) {
    url
    key
  }
}

Variables

{"input": AssetUploadUrlInput}

Response

{
  "data": {
    "assetUploadUrlCreate": {
      "url": "abc123",
      "key": "xyz789"
    }
  }
}

Mutations

`budgetUpdate`

Response

Returns a Budget!

Arguments

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

Example

Query

mutation BudgetUpdate(
  $id: ID!,
  $input: BudgetInput!
) {
  budgetUpdate(
    id: $id,
    input: $input
  ) {
    id
    amount
    isPaymentFallbackEnabled
    refillAmount
    isRollover
  }
}

Variables

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

Response

{
  "data": {
    "budgetUpdate": {
      "id": "4",
      "amount": 987.65,
      "isPaymentFallbackEnabled": true,
      "refillAmount": 123,
      "isRollover": true
    }
  }
}

Mutations

`cardUpdate`

Response

Returns a Customer!

Arguments

Name	Description
`paymentMethodId` - `ID!`
`saasPaymentMethodId` - `ID!`

Example

Query

mutation CardUpdate(
  $paymentMethodId: ID!,
  $saasPaymentMethodId: ID!
) {
  cardUpdate(
    paymentMethodId: $paymentMethodId,
    saasPaymentMethodId: $saasPaymentMethodId
  ) {
    id
    name
    email
    card {
      id
      last4
      brand
    }
    balance
    spendableBalance
  }
}

Variables

{
  "paymentMethodId": 4,
  "saasPaymentMethodId": "4"
}

Response

{
  "data": {
    "cardUpdate": {
      "id": 4,
      "name": "abc123",
      "email": "abc123",
      "card": Card,
      "balance": 123,
      "spendableBalance": 987
    }
  }
}

Mutations

`digitalBarcodeCreate`

Response

Returns a DigitalBarcode!

Arguments

Name	Description
`digitalOrderCode` - `ID!`

Example

Query

mutation DigitalBarcodeCreate($digitalOrderCode: ID!) {
  digitalBarcodeCreate(digitalOrderCode: $digitalOrderCode) {
    id
    number
    csc
    barcodeKind
    barcodeValue
    viewCardUrl
  }
}

Variables

{"digitalOrderCode": 4}

Response

{
  "data": {
    "digitalBarcodeCreate": {
      "id": "4",
      "number": "abc123",
      "csc": "abc123",
      "barcodeKind": "xyz789",
      "barcodeValue": "abc123",
      "viewCardUrl": "abc123"
    }
  }
}

Mutations

`digitalCampaignCreate`

Response

Returns a DigitalCampaign!

Arguments

Name	Description
`input` - `DigitalCampaignInput!`

Example

Query

mutation DigitalCampaignCreate($input: DigitalCampaignInput!) {
  digitalCampaignCreate(input: $input) {
    id
    createdAt
    ref
    name
    rewardValue
    brands
    messageTemplate
    headlineTemplate
    allowCharity
    brandsSummary
    isArchived
    currency
  }
}

Variables

{"input": DigitalCampaignInput}

Response

{
  "data": {
    "digitalCampaignCreate": {
      "id": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "ref": "abc123",
      "name": "abc123",
      "rewardValue": 123,
      "brands": [4],
      "messageTemplate": "xyz789",
      "headlineTemplate": "abc123",
      "allowCharity": false,
      "brandsSummary": "abc123",
      "isArchived": true,
      "currency": "USD"
    }
  }
}

Mutations

`digitalCampaignUpdate`

Response

Returns a DigitalCampaign!

Arguments

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

Example

Query

mutation DigitalCampaignUpdate(
  $id: ID!,
  $input: DigitalCampaignInput!
) {
  digitalCampaignUpdate(
    id: $id,
    input: $input
  ) {
    id
    createdAt
    ref
    name
    rewardValue
    brands
    messageTemplate
    headlineTemplate
    allowCharity
    brandsSummary
    isArchived
    currency
  }
}

Variables

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

Response

{
  "data": {
    "digitalCampaignUpdate": {
      "id": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "ref": "abc123",
      "name": "xyz789",
      "rewardValue": 123,
      "brands": [4],
      "messageTemplate": "xyz789",
      "headlineTemplate": "abc123",
      "allowCharity": false,
      "brandsSummary": "xyz789",
      "isArchived": true,
      "currency": "USD"
    }
  }
}

Mutations

`digitalOrderBatchCsvCreate`

Response

Returns a String!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation DigitalOrderBatchCsvCreate($id: ID!) {
  digitalOrderBatchCsvCreate(id: $id)
}

Variables

{"id": 4}

Response

{
  "data": {
    "digitalOrderBatchCsvCreate": "abc123"
  }
}

Mutations

`digitalOrderBatchMarkDelivered`

Response

Returns a Boolean

Arguments

Name	Description
`batchRef` - `ID!`

Example

Query

mutation DigitalOrderBatchMarkDelivered($batchRef: ID!) {
  digitalOrderBatchMarkDelivered(batchRef: $batchRef)
}

Variables

{"batchRef": 4}

Response

{"data": {"digitalOrderBatchMarkDelivered": true}}

Mutations

`digitalOrderBulkCreate`

Response

Returns a DigitalOrderBatch!

Arguments

Name	Description
`input` - `DigitalOrderBulkInput!`

Example

Query

mutation DigitalOrderBulkCreate($input: DigitalOrderBulkInput!) {
  digitalOrderBulkCreate(input: $input) {
    id
    ref
    creator {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    createdAt
    totalOrders
    totalDelivered
    totalPaid
    digitalOrders {
      totalCount
      nodes {
        ...DigitalOrderFragment
      }
    }
  }
}

Variables

{"input": DigitalOrderBulkInput}

Response

{
  "data": {
    "digitalOrderBulkCreate": {
      "id": 4,
      "ref": "abc123",
      "creator": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "totalOrders": 123,
      "totalDelivered": 123,
      "totalPaid": 123,
      "digitalOrders": DigitalOrders
    }
  }
}

Mutations

`digitalOrderCancel`

Response

Returns a DigitalOrder!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation DigitalOrderCancel($id: ID!) {
  digitalOrderCancel(id: $id) {
    id
    ref
    createdAt
    rewardValue
    status
    rewardLink
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    creator {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    campaign {
      id
      createdAt
      ref
      name
      rewardValue
      brands
      messageTemplate
      headlineTemplate
      allowCharity
      brandsSummary
      isArchived
      currency
    }
    description
    deliveryMethod
    events {
      id
      createdAt
      code
    }
    cancelledAt
    teamId
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "digitalOrderCancel": {
      "id": "4",
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "rewardValue": 123,
      "status": "PAYMENT_PENDING",
      "rewardLink": "abc123",
      "recipient": Recipient,
      "creator": User,
      "campaign": DigitalCampaign,
      "description": "xyz789",
      "deliveryMethod": "LINK",
      "events": [DigitalOrderEvent],
      "cancelledAt": "2007-12-03T10:15:30Z",
      "teamId": "abc123"
    }
  }
}

Mutations

`digitalOrderCodeCreate`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `DigitalOrderCodeInput!`

Example

Query

mutation DigitalOrderCodeCreate($input: DigitalOrderCodeInput!) {
  digitalOrderCodeCreate(input: $input)
}

Variables

{"input": DigitalOrderCodeInput}

Response

{"data": {"digitalOrderCodeCreate": false}}

Mutations

`digitalOrderCodeEmailCreate`

Response

Returns a Boolean

Arguments

Name	Description
`orderRef` - `ID!`

Example

Query

mutation DigitalOrderCodeEmailCreate($orderRef: ID!) {
  digitalOrderCodeEmailCreate(orderRef: $orderRef)
}

Variables

{"orderRef": "4"}

Response

{"data": {"digitalOrderCodeEmailCreate": false}}

Mutations

`digitalOrderConfirmTremendous`

Response

Returns a Boolean

Arguments

Name	Description
`digitalOrderCode` - `ID!`

Example

Query

mutation DigitalOrderConfirmTremendous($digitalOrderCode: ID!) {
  digitalOrderConfirmTremendous(digitalOrderCode: $digitalOrderCode)
}

Variables

{"digitalOrderCode": 4}

Response

{"data": {"digitalOrderConfirmTremendous": false}}

Mutations

`digitalOrderCreate`

Response

Returns a DigitalOrder!

Arguments

Name	Description
`input` - `DigitalOrderInput!`

Example

Query

mutation DigitalOrderCreate($input: DigitalOrderInput!) {
  digitalOrderCreate(input: $input) {
    id
    ref
    createdAt
    rewardValue
    status
    rewardLink
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    creator {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    campaign {
      id
      createdAt
      ref
      name
      rewardValue
      brands
      messageTemplate
      headlineTemplate
      allowCharity
      brandsSummary
      isArchived
      currency
    }
    description
    deliveryMethod
    events {
      id
      createdAt
      code
    }
    cancelledAt
    teamId
  }
}

Variables

{"input": DigitalOrderInput}

Response

{
  "data": {
    "digitalOrderCreate": {
      "id": 4,
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "rewardValue": 123,
      "status": "PAYMENT_PENDING",
      "rewardLink": "xyz789",
      "recipient": Recipient,
      "creator": User,
      "campaign": DigitalCampaign,
      "description": "abc123",
      "deliveryMethod": "LINK",
      "events": [DigitalOrderEvent],
      "cancelledAt": "2007-12-03T10:15:30Z",
      "teamId": "abc123"
    }
  }
}

Mutations

`digitalOrderEmailCreate`

Response

Returns a Boolean

Arguments

Name	Description
`orderRef` - `ID!`

Example

Query

mutation DigitalOrderEmailCreate($orderRef: ID!) {
  digitalOrderEmailCreate(orderRef: $orderRef)
}

Variables

{"orderRef": "4"}

Response

{"data": {"digitalOrderEmailCreate": true}}

Mutations

`digitalOrderMarkDelivered`

Response

Returns a Boolean

Arguments

Name	Description
`orderRef` - `ID!`

Example

Query

mutation DigitalOrderMarkDelivered($orderRef: ID!) {
  digitalOrderMarkDelivered(orderRef: $orderRef)
}

Variables

{"orderRef": "4"}

Response

{"data": {"digitalOrderMarkDelivered": true}}

Mutations

`digitalOrdersCsvCreate`

Response

Returns a String!

Arguments

Name	Description
`query` - `DigitalOrderQuery`

Example

Query

mutation DigitalOrdersCsvCreate($query: DigitalOrderQuery) {
  digitalOrdersCsvCreate(query: $query)
}

Variables

{"query": DigitalOrderQuery}

Response

{
  "data": {
    "digitalOrdersCsvCreate": "abc123"
  }
}

Mutations

`fundsAdd`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `FundsInput!`

Example

Query

mutation FundsAdd($input: FundsInput!) {
  fundsAdd(input: $input)
}

Variables

{"input": FundsInput}

Response

{"data": {"fundsAdd": false}}

Mutations

`fundsAddBulk`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `[FundsInput!]!`

Example

Query

mutation FundsAddBulk($input: [FundsInput!]!) {
  fundsAddBulk(input: $input)
}

Variables

{"input": [FundsInput]}

Response

{"data": {"fundsAddBulk": false}}

Mutations

`fundsMove`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `FundsMoveInput!`

Example

Query

mutation FundsMove($input: FundsMoveInput!) {
  fundsMove(input: $input)
}

Variables

{"input": FundsMoveInput}

Response

{"data": {"fundsMove": false}}

Mutations

`googleTokenCreate`

Response

Returns a Boolean

Arguments

Name	Description
`code` - `String!`

Example

Query

mutation GoogleTokenCreate($code: String!) {
  googleTokenCreate(code: $code)
}

Variables

{"code": "xyz789"}

Response

{"data": {"googleTokenCreate": false}}

Mutations

`googleTokenDelete`

Response

Returns a Boolean

Example

Query

mutation GoogleTokenDelete {
  googleTokenDelete
}

Response

{"data": {"googleTokenDelete": false}}

Mutations

`hubSpotTokenCreate`

Response

Returns a HubSpotToken!

Arguments

Name	Description
`input` - `HubSpotTokenInput!`

Example

Query

mutation HubSpotTokenCreate($input: HubSpotTokenInput!) {
  hubSpotTokenCreate(input: $input) {
    user
    hubDomain
    hubId
    appId
    hubSpotUserId
  }
}

Variables

{"input": HubSpotTokenInput}

Response

{
  "data": {
    "hubSpotTokenCreate": {
      "user": "abc123",
      "hubDomain": "xyz789",
      "hubId": "4",
      "appId": "4",
      "hubSpotUserId": 4
    }
  }
}

Mutations

`hubSpotTokenDelete`

Response

Returns a Boolean

Example

Query

mutation HubSpotTokenDelete {
  hubSpotTokenDelete
}

Response

{"data": {"hubSpotTokenDelete": true}}

Mutations

`integrationWebhookCreate`

Response

Returns a WebhookCreateResponse!

Arguments

Name	Description
`input` - `WebhookCreateInput!`

Example

Query

mutation IntegrationWebhookCreate($input: WebhookCreateInput!) {
  integrationWebhookCreate(input: $input) {
    id
  }
}

Variables

{"input": WebhookCreateInput}

Response

{
  "data": {
    "integrationWebhookCreate": {
      "id": "abc123"
    }
  }
}

Mutations

`integrationWebhookDelete`

Response

Returns a String!

Arguments

Name	Description
`input` - `WebhookDeleteInput!`

Example

Query

mutation IntegrationWebhookDelete($input: WebhookDeleteInput!) {
  integrationWebhookDelete(input: $input)
}

Variables

{"input": WebhookDeleteInput}

Response

{
  "data": {
    "integrationWebhookDelete": "xyz789"
  }
}

Mutations

`inviteAccept`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `AcceptInviteInput!`

Example

Query

mutation InviteAccept($input: AcceptInviteInput!) {
  inviteAccept(input: $input)
}

Variables

{"input": AcceptInviteInput}

Response

{"data": {"inviteAccept": true}}

Mutations

`inviteResend`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `ResendInviteInput!`

Example

Query

mutation InviteResend($input: ResendInviteInput!) {
  inviteResend(input: $input)
}

Variables

{"input": ResendInviteInput}

Response

{"data": {"inviteResend": true}}

Mutations

`inviteRevoke`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `RevokeInviteInput!`

Example

Query

mutation InviteRevoke($input: RevokeInviteInput!) {
  inviteRevoke(input: $input)
}

Variables

{"input": RevokeInviteInput}

Response

{"data": {"inviteRevoke": false}}

Mutations

`invoiceItemCreate`

Response

Returns an InvoiceItem!

Arguments

Name	Description
`input` - `InvoiceItemInput!`

Example

Query

mutation InvoiceItemCreate($input: InvoiceItemInput!) {
  invoiceItemCreate(input: $input) {
    id
    createdAt
    amount
    description
  }
}

Variables

{"input": InvoiceItemInput}

Response

{
  "data": {
    "invoiceItemCreate": {
      "id": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "amount": 987,
      "description": "abc123"
    }
  }
}

Mutations

`login`

Response

Returns a String!

Arguments

Name	Description
`email` - `String!`
`password` - `String!`

Example

Query

mutation Login(
  $email: String!,
  $password: String!
) {
  login(
    email: $email,
    password: $password
  )
}

Variables

{
  "email": "xyz789",
  "password": "xyz789"
}

Response

{"data": {"login": "xyz789"}}

Mutations

`loginApi`

Response

Returns a String!

Arguments

Name	Description
`username` - `String!`
`password` - `String!`

Example

Query

mutation LoginApi(
  $username: String!,
  $password: String!
) {
  loginApi(
    username: $username,
    password: $password
  )
}

Variables

{
  "username": "abc123",
  "password": "xyz789"
}

Response

{"data": {"loginApi": "xyz789"}}

Mutations

`loginAsOrg`

Response

Returns a String!

Arguments

Name	Description
`input` - `LoginAsOrgInput!`

Example

Query

mutation LoginAsOrg($input: LoginAsOrgInput!) {
  loginAsOrg(input: $input)
}

Variables

{"input": LoginAsOrgInput}

Response

{"data": {"loginAsOrg": "abc123"}}

Mutations

`loginAsUser`

Response

Returns a String!

Arguments

Name	Description
`input` - `LoginAsUserInput!`

Example

Query

mutation LoginAsUser($input: LoginAsUserInput!) {
  loginAsUser(input: $input)
}

Variables

{"input": LoginAsUserInput}

Response

{"data": {"loginAsUser": "abc123"}}

Mutations

`loginWithGoogle`

Response

Returns a String!

Arguments

Name	Description
`credential` - `String!`

Example

Query

mutation LoginWithGoogle($credential: String!) {
  loginWithGoogle(credential: $credential)
}

Variables

{"credential": "abc123"}

Response

{"data": {"loginWithGoogle": "xyz789"}}

Mutations

`loginWithMicrosoft`

Response

Returns a String!

Arguments

Name	Description
`credential` - `String!`

Example

Query

mutation LoginWithMicrosoft($credential: String!) {
  loginWithMicrosoft(credential: $credential)
}

Variables

{"credential": "abc123"}

Response

{"data": {"loginWithMicrosoft": "xyz789"}}

Mutations

`microsoftTokenCreate`

Response

Returns a Boolean

Arguments

Name	Description
`code` - `String!`

Example

Query

mutation MicrosoftTokenCreate($code: String!) {
  microsoftTokenCreate(code: $code)
}

Variables

{"code": "xyz789"}

Response

{"data": {"microsoftTokenCreate": false}}

Mutations

`microsoftTokenDelete`

Response

Returns a Boolean

Example

Query

mutation MicrosoftTokenDelete {
  microsoftTokenDelete
}

Response

{"data": {"microsoftTokenDelete": true}}

Mutations

`oAuthGenerateCode`

Response

Returns a String!

Example

Query

mutation OAuthGenerateCode {
  oAuthGenerateCode
}

Response

{"data": {"oAuthGenerateCode": "xyz789"}}

Mutations

`ordersCsvCreate`

Response

Returns a String!

Arguments

Name	Description
`query` - `OrderQuery`
`myOrders` - `Boolean`
`sort` - `OrderSortKey`

Example

Query

mutation OrdersCsvCreate(
  $query: OrderQuery,
  $myOrders: Boolean,
  $sort: OrderSortKey
) {
  ordersCsvCreate(
    query: $query,
    myOrders: $myOrders,
    sort: $sort
  )
}

Variables

{
  "query": OrderQuery,
  "myOrders": false,
  "sort": "CREATED_AT_ASC"
}

Response

{"data": {"ordersCsvCreate": "abc123"}}

Mutations

`orgUpdate`

Response

Returns an Org!

Arguments

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

Example

Query

mutation OrgUpdate(
  $id: ID!,
  $input: OrgInput!
) {
  orgUpdate(
    id: $id,
    input: $input
  ) {
    id
    name
    formattedName
    users {
      totalCount
      nodes {
        ...UserFragment
      }
    }
    logoUrl
    logoBackgroundColor
    logoPrimaryColor
    isInternational
    hubSpotUserInfo {
      id
      displayName
    }
    hubSpotUsers {
      id
      name
      email
    }
    salesForceUserInfo {
      id
      username
      nickName
      displayName
    }
    salesForceUsers {
      id
      name
      email
    }
    teams {
      id
      name
      users {
        ...UsersWithTeamFragment
      }
    }
  }
}

Variables

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

Response

{
  "data": {
    "orgUpdate": {
      "id": "4",
      "name": "abc123",
      "formattedName": "abc123",
      "users": Users,
      "logoUrl": "abc123",
      "logoBackgroundColor": "xyz789",
      "logoPrimaryColor": "xyz789",
      "isInternational": true,
      "hubSpotUserInfo": HubSpotUserInfo,
      "hubSpotUsers": [HubSpotUser],
      "salesForceUserInfo": SalesForceUserInfo,
      "salesForceUsers": [SalesForceUser],
      "teams": [Teams]
    }
  }
}

Mutations

`passwordRequestReset`

Response

Returns a Boolean

Arguments

Name	Description
`email` - `String!`

Example

Query

mutation PasswordRequestReset($email: String!) {
  passwordRequestReset(email: $email)
}

Variables

{"email": "xyz789"}

Response

{"data": {"passwordRequestReset": false}}

Mutations

`passwordReset`

Response

Returns a String!

Arguments

Name	Description
`input` - `PasswordResetInput!`

Example

Query

mutation PasswordReset($input: PasswordResetInput!) {
  passwordReset(input: $input)
}

Variables

{"input": PasswordResetInput}

Response

{"data": {"passwordReset": "xyz789"}}

Mutations

`passwordUpdate`

Response

Returns a Boolean

Arguments

Name	Description
`input` - `PasswordUpdateInput!`

Example

Query

mutation PasswordUpdate($input: PasswordUpdateInput!) {
  passwordUpdate(input: $input)
}

Variables

{"input": PasswordUpdateInput}

Response

{"data": {"passwordUpdate": true}}

Mutations

`physicalCampaignCreate`

Response

Returns a PhysicalCampaign!

Arguments

Name	Description
`input` - `PhysicalCampaignInput!`

Example

Query

mutation PhysicalCampaignCreate($input: PhysicalCampaignInput!) {
  physicalCampaignCreate(input: $input) {
    id
    ref
    createdAt
    name
    gifts {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    messageTemplate
  }
}

Variables

{"input": PhysicalCampaignInput}

Response

{
  "data": {
    "physicalCampaignCreate": {
      "id": 4,
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "gifts": [PhysicalGift],
      "messageTemplate": "xyz789"
    }
  }
}

Mutations

`physicalCampaignUpdate`

Response

Returns a PhysicalCampaign!

Arguments

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

Example

Query

mutation PhysicalCampaignUpdate(
  $id: ID!,
  $input: PhysicalCampaignInput!
) {
  physicalCampaignUpdate(
    id: $id,
    input: $input
  ) {
    id
    ref
    createdAt
    name
    gifts {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    messageTemplate
  }
}

Variables

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

Response

{
  "data": {
    "physicalCampaignUpdate": {
      "id": 4,
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "gifts": [PhysicalGift],
      "messageTemplate": "xyz789"
    }
  }
}

Mutations

`physicalGiftCreate`

Response

Returns a PhysicalGift!

Arguments

Name	Description
`input` - `PhysicalGiftInput!`

Example

Query

mutation PhysicalGiftCreate($input: PhysicalGiftInput!) {
  physicalGiftCreate(input: $input) {
    id
    title
    messageMaxLength
    messageMaxLines
    descriptionHtml
    featuredImageSrc
    initialShippingCost
    products {
      id
      org {
        ...OrgFragment
      }
      isAddon
      images {
        ...ImageFragment
      }
      variants {
        ...ProductVariantFragment
      }
    }
    productVariants {
      id
      price
    }
    isDisabled
    categories
    isThirdParty
    shipsThroughWarehouse
    purchaseUrl
    vendor {
      id
      name
      messageMaxLength
      messageMaxLines
    }
    orgId
  }
}

Variables

{"input": PhysicalGiftInput}

Response

{
  "data": {
    "physicalGiftCreate": {
      "id": 4,
      "title": "xyz789",
      "messageMaxLength": 123,
      "messageMaxLines": 987,
      "descriptionHtml": "xyz789",
      "featuredImageSrc": "xyz789",
      "initialShippingCost": 987,
      "products": [Product],
      "productVariants": [ProductVariant],
      "isDisabled": false,
      "categories": ["abc123"],
      "isThirdParty": true,
      "shipsThroughWarehouse": false,
      "purchaseUrl": "xyz789",
      "vendor": PhysicalVendor,
      "orgId": "abc123"
    }
  }
}

Mutations

`physicalGiftUpdate`

Response

Returns a PhysicalGift!

Arguments

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

Example

Query

mutation PhysicalGiftUpdate(
  $id: ID!,
  $input: PhysicalGiftInput!
) {
  physicalGiftUpdate(
    id: $id,
    input: $input
  ) {
    id
    title
    messageMaxLength
    messageMaxLines
    descriptionHtml
    featuredImageSrc
    initialShippingCost
    products {
      id
      org {
        ...OrgFragment
      }
      isAddon
      images {
        ...ImageFragment
      }
      variants {
        ...ProductVariantFragment
      }
    }
    productVariants {
      id
      price
    }
    isDisabled
    categories
    isThirdParty
    shipsThroughWarehouse
    purchaseUrl
    vendor {
      id
      name
      messageMaxLength
      messageMaxLines
    }
    orgId
  }
}

Variables

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

Response

{
  "data": {
    "physicalGiftUpdate": {
      "id": 4,
      "title": "xyz789",
      "messageMaxLength": 987,
      "messageMaxLines": 123,
      "descriptionHtml": "xyz789",
      "featuredImageSrc": "abc123",
      "initialShippingCost": 123,
      "products": [Product],
      "productVariants": [ProductVariant],
      "isDisabled": false,
      "categories": ["xyz789"],
      "isThirdParty": false,
      "shipsThroughWarehouse": true,
      "purchaseUrl": "abc123",
      "vendor": PhysicalVendor,
      "orgId": "abc123"
    }
  }
}

Mutations

`physicalOrderCancel`

Response

Returns a PhysicalOrder!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation PhysicalOrderCancel($id: ID!) {
  physicalOrderCancel(id: $id) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "physicalOrderCancel": {
      "id": 4,
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": false,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "abc123",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "xyz789",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "xyz789",
      "shopifyOrderId": "abc123",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderComplete`

Response

Returns a PhysicalOrder!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation PhysicalOrderComplete($id: ID!) {
  physicalOrderComplete(id: $id) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "physicalOrderComplete": {
      "id": "4",
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": true,
      "recipientSubmitsAddress": false,
      "creatorName": "xyz789",
      "orgName": "abc123",
      "orgBranding": OrgBranding,
      "vendorName": "xyz789",
      "message": "abc123",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "abc123",
      "description": "abc123",
      "shopifyOrderId": "xyz789",
      "shopifyOrderName": "abc123",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderConfirm`

Response

Returns a PhysicalOrder!

Arguments

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

Example

Query

mutation PhysicalOrderConfirm(
  $input: PhysicalOrderInput!,
  $id: ID!
) {
  physicalOrderConfirm(
    input: $input,
    id: $id
  ) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

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

Response

{
  "data": {
    "physicalOrderConfirm": {
      "id": 4,
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": false,
      "recipientSubmitsAddress": false,
      "creatorName": "abc123",
      "orgName": "abc123",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "abc123",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "xyz789",
      "shopifyOrderId": "xyz789",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderCreate`

Response

Returns a PhysicalOrder!

Arguments

Name	Description
`input` - `PhysicalOrderInput!`

Example

Query

mutation PhysicalOrderCreate($input: PhysicalOrderInput!) {
  physicalOrderCreate(input: $input) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{"input": PhysicalOrderInput}

Response

{
  "data": {
    "physicalOrderCreate": {
      "id": "4",
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": true,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "abc123",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "abc123",
      "description": "abc123",
      "shopifyOrderId": "xyz789",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderMarkPurchased`

Response

Returns a PhysicalOrder!

Arguments

Name	Description
`id` - `ID!`
`vendorOrderId` - `String!`
`actualCost` - `Int!`

Example

Query

mutation PhysicalOrderMarkPurchased(
  $id: ID!,
  $vendorOrderId: String!,
  $actualCost: Int!
) {
  physicalOrderMarkPurchased(
    id: $id,
    vendorOrderId: $vendorOrderId,
    actualCost: $actualCost
  ) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

{
  "id": 4,
  "vendorOrderId": "xyz789",
  "actualCost": 123
}

Response

{
  "data": {
    "physicalOrderMarkPurchased": {
      "id": 4,
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": true,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "xyz789",
      "message": "xyz789",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "abc123",
      "shopifyOrderId": "abc123",
      "shopifyOrderName": "abc123",
      "vendorOrderId": "xyz789",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderUpdate`

Response

Returns a PhysicalOrder!

Arguments

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

Example

Query

mutation PhysicalOrderUpdate(
  $input: PhysicalOrderInput!,
  $id: ID!
) {
  physicalOrderUpdate(
    input: $input,
    id: $id
  ) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

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

Response

{
  "data": {
    "physicalOrderUpdate": {
      "id": "4",
      "ref": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": false,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "xyz789",
      "message": "xyz789",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "abc123",
      "shopifyOrderId": "xyz789",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": true,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`physicalOrderUpdateMailingAddress`

Response

Returns a PhysicalOrder!

Arguments

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

Example

Query

mutation PhysicalOrderUpdateMailingAddress(
  $input: MailingAddressInput!,
  $id: ID!
) {
  physicalOrderUpdateMailingAddress(
    input: $input,
    id: $id
  ) {
    id
    ref
    createdAt
    recipient {
      id
      org {
        ...OrgFragment
      }
      email
      name
      salesForceContactId
      salesForceAccountId
      hubSpotContactId
      hubSpotCompanyId
      orgName
    }
    isAddressConfirmed
    recipientSubmitsAddress
    creatorName
    orgName
    orgBranding {
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
    }
    vendorName
    message
    invoiceItems {
      id
      createdAt
      amount
      description
    }
    mailingAddress {
      address1
      address2
      city
      company
      country
      countryCodeV2
      firstName
      lastName
      id
      phone
      province
      provinceCode
      zip
    }
    purchaseUrl
    description
    shopifyOrderId
    shopifyOrderName
    vendorOrderId
    fulfillmentEvents {
      happenedAt
      id
      message
      status
    }
    images {
      altText
      height
      id
      url
      width
    }
    giftChoices {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    selectedGift {
      id
      title
      messageMaxLength
      messageMaxLines
      descriptionHtml
      featuredImageSrc
      initialShippingCost
      products {
        ...ProductFragment
      }
      productVariants {
        ...ProductVariantFragment
      }
      isDisabled
      categories
      isThirdParty
      shipsThroughWarehouse
      purchaseUrl
      vendor {
        ...PhysicalVendorFragment
      }
      orgId
    }
    isThirdParty
    shipsThroughWarehouse
    cancelledAt
  }
}

Variables

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

Response

{
  "data": {
    "physicalOrderUpdateMailingAddress": {
      "id": 4,
      "ref": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "recipient": Recipient,
      "isAddressConfirmed": true,
      "recipientSubmitsAddress": true,
      "creatorName": "abc123",
      "orgName": "xyz789",
      "orgBranding": OrgBranding,
      "vendorName": "abc123",
      "message": "abc123",
      "invoiceItems": [InvoiceItem],
      "mailingAddress": MailingAddress,
      "purchaseUrl": "xyz789",
      "description": "xyz789",
      "shopifyOrderId": "xyz789",
      "shopifyOrderName": "xyz789",
      "vendorOrderId": "abc123",
      "fulfillmentEvents": [FulfillmentEvent],
      "images": [Image],
      "giftChoices": [PhysicalGift],
      "selectedGift": PhysicalGift,
      "isThirdParty": false,
      "shipsThroughWarehouse": false,
      "cancelledAt": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`productCreate`

Description

Creates a product.

If you need to create a product with many variants that are active at several locations, especially with a lot of collections and tags, then you should first create the product with just the variants.

After the product is created, you can activate the variants at locations and add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will complete before the operation times out.

The following example shows how you might break up product creation and object association into multiple steps:

Create the product with variants. Don't specify any tags or collections on the product, and don't specify inventory quantities for each variant.
After the product is created, add tags to the product using the tagsAdd mutation, and add collections using the collectionsAddProducts mutation.
Use the inventoryBulkToggleActivation mutation on each inventory item to activate it at the appropriate locations.
After activating the variants at the locations, adjust inventory quantities at each location using the inventoryBulkAdjustQuantityAtLocation mutation.

Response

Returns a ProductCreatePayload

Arguments

Name	Description
`input` - `ProductInput!`	The properties of the new product.
`media` - `[CreateMediaInput!]`	List of new media to be added to the product.

Example

Query

mutation ProductCreate(
  $input: ProductInput!,
  $media: [CreateMediaInput!]
) {
  productCreate(
    input: $input,
    media: $media
  ) {
    product {
      id
      org {
        ...OrgFragment
      }
      isAddon
      images {
        ...ImageFragment
      }
      variants {
        ...ProductVariantFragment
      }
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": ProductInput,
  "media": [CreateMediaInput]
}

Response

{
  "data": {
    "productCreate": {
      "product": Product,
      "userErrors": [UserError]
    }
  }
}

Mutations

`resendInviteEmail`

Response

Returns a Boolean

Arguments

Name	Description
`email` - `String!`

Example

Query

mutation ResendInviteEmail($email: String!) {
  resendInviteEmail(email: $email)
}

Variables

{"email": "xyz789"}

Response

{"data": {"resendInviteEmail": true}}

Mutations

`salesForceTokenCreate`

Response

Returns a SalesForceToken

Arguments

Name	Description
`input` - `SalesForceTokenInput!`

Example

Query

mutation SalesForceTokenCreate($input: SalesForceTokenInput!) {
  salesForceTokenCreate(input: $input) {
    id
    instanceUrl
  }
}

Variables

{"input": SalesForceTokenInput}

Response

{
  "data": {
    "salesForceTokenCreate": {
      "id": 4,
      "instanceUrl": "xyz789"
    }
  }
}

Mutations

`salesForceTokenDelete`

Response

Returns a Boolean

Example

Query

mutation SalesForceTokenDelete {
  salesForceTokenDelete
}

Response

{"data": {"salesForceTokenDelete": true}}

Mutations

`setupIntentCreate`

Response

Returns a String!

Example

Query

mutation SetupIntentCreate {
  setupIntentCreate
}

Response

{"data": {"setupIntentCreate": "abc123"}}

Mutations

`signupAndCreateOrg`

Response

Returns a String!

Arguments

Name	Description
`orgName` - `String!`
`email` - `String!`
`password` - `String!`
`name` - `String!`

Example

Query

mutation SignupAndCreateOrg(
  $orgName: String!,
  $email: String!,
  $password: String!,
  $name: String!
) {
  signupAndCreateOrg(
    orgName: $orgName,
    email: $email,
    password: $password,
    name: $name
  )
}

Variables

{
  "orgName": "xyz789",
  "email": "abc123",
  "password": "abc123",
  "name": "abc123"
}

Response

{"data": {"signupAndCreateOrg": "xyz789"}}

Mutations

`teamCreate`

Response

Returns a Team!

Arguments

Name	Description
`input` - `TeamCreateInput!`

Example

Query

mutation TeamCreate($input: TeamCreateInput!) {
  teamCreate(input: $input) {
    id
    name
    users {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    isAdmin
  }
}

Variables

{"input": TeamCreateInput}

Response

{
  "data": {
    "teamCreate": {
      "id": 4,
      "name": "xyz789",
      "users": [User],
      "isAdmin": true
    }
  }
}

Mutations

`userAdd`

Response

Returns a User!

Arguments

Name	Description
`input` - `UserInput!`

Example

Query

mutation UserAdd($input: UserInput!) {
  userAdd(input: $input) {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Variables

{"input": UserInput}

Response

{
  "data": {
    "userAdd": {
      "id": "4",
      "name": "abc123",
      "email": "abc123",
      "role": "ADMIN",
      "password": "abc123",
      "budget": Budget,
      "salesForceUserId": "xyz789",
      "hubSpotUserId": "xyz789",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "xyz789",
      "microsoftEmail": "xyz789",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Mutations

`userChangeTeam`

Response

Returns a Team!

Arguments

Name	Description
`input` - `UserChangeTeamInput!`

Example

Query

mutation UserChangeTeam($input: UserChangeTeamInput!) {
  userChangeTeam(input: $input) {
    id
    name
    users {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    isAdmin
  }
}

Variables

{"input": UserChangeTeamInput}

Response

{
  "data": {
    "userChangeTeam": {
      "id": "4",
      "name": "abc123",
      "users": [User],
      "isAdmin": true
    }
  }
}

Mutations

`userChangeTeamRole`

Response

Returns a Team!

Arguments

Name	Description
`input` - `UserChangeTeamRoleInput!`

Example

Query

mutation UserChangeTeamRole($input: UserChangeTeamRoleInput!) {
  userChangeTeamRole(input: $input) {
    id
    name
    users {
      id
      name
      email
      role
      password
      budget {
        ...BudgetFragment
      }
      salesForceUserId
      hubSpotUserId
      teams {
        ...UserTeamsFragment
      }
      org {
        ...OrgFragment
      }
      status
      googleEmail
      microsoftEmail
      hubSpotToken {
        ...HubSpotTokenFragment
      }
      apiPasswords {
        ...ApiPasswordFragment
      }
    }
    isAdmin
  }
}

Variables

{"input": UserChangeTeamRoleInput}

Response

{
  "data": {
    "userChangeTeamRole": {
      "id": "4",
      "name": "abc123",
      "users": [User],
      "isAdmin": true
    }
  }
}

Mutations

`userReactivate`

Response

Returns a User!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation UserReactivate($id: ID!) {
  userReactivate(id: $id) {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "userReactivate": {
      "id": 4,
      "name": "xyz789",
      "email": "abc123",
      "role": "ADMIN",
      "password": "abc123",
      "budget": Budget,
      "salesForceUserId": "xyz789",
      "hubSpotUserId": "abc123",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "xyz789",
      "microsoftEmail": "abc123",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Mutations

`userRemove`

Response

Returns a User!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation UserRemove($id: ID!) {
  userRemove(id: $id) {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "userRemove": {
      "id": 4,
      "name": "xyz789",
      "email": "abc123",
      "role": "ADMIN",
      "password": "abc123",
      "budget": Budget,
      "salesForceUserId": "xyz789",
      "hubSpotUserId": "abc123",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "abc123",
      "microsoftEmail": "abc123",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Mutations

`userUpdate`

Response

Returns a User!

Arguments

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

Example

Query

mutation UserUpdate(
  $id: ID!,
  $input: UserInput!
) {
  userUpdate(
    id: $id,
    input: $input
  ) {
    id
    name
    email
    role
    password
    budget {
      id
      amount
      isPaymentFallbackEnabled
      refillAmount
      isRollover
    }
    salesForceUserId
    hubSpotUserId
    teams {
      userId
      teamId
      name
      isAdmin
    }
    org {
      id
      name
      formattedName
      users {
        ...UsersFragment
      }
      logoUrl
      logoBackgroundColor
      logoPrimaryColor
      isInternational
      hubSpotUserInfo {
        ...HubSpotUserInfoFragment
      }
      hubSpotUsers {
        ...HubSpotUserFragment
      }
      salesForceUserInfo {
        ...SalesForceUserInfoFragment
      }
      salesForceUsers {
        ...SalesForceUserFragment
      }
      teams {
        ...TeamsFragment
      }
    }
    status
    googleEmail
    microsoftEmail
    hubSpotToken {
      user
      hubDomain
      hubId
      appId
      hubSpotUserId
    }
    apiPasswords {
      id
      trailingChars
    }
  }
}

Variables

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

Response

{
  "data": {
    "userUpdate": {
      "id": "4",
      "name": "abc123",
      "email": "xyz789",
      "role": "ADMIN",
      "password": "xyz789",
      "budget": Budget,
      "salesForceUserId": "abc123",
      "hubSpotUserId": "xyz789",
      "teams": [UserTeams],
      "org": Org,
      "status": "ACTIVE",
      "googleEmail": "xyz789",
      "microsoftEmail": "xyz789",
      "hubSpotToken": HubSpotToken,
      "apiPasswords": [ApiPassword]
    }
  }
}

Types

AcceptInviteInput

Fields

Input Field	Description
`inviteCode` - `String!`

Example

{"inviteCode": "abc123"}

Types

ApiPassword

Fields

Field Name	Description
`id` - `ID!`
`trailingChars` - `String!`

Example

{
  "id": "4",
  "trailingChars": "xyz789"
}

Types

AssetUploadUrl

Fields

Field Name	Description
`url` - `String!`
`key` - `String!`

Example

{
  "url": "xyz789",
  "key": "xyz789"
}

Types

AssetUploadUrlInput

Fields

Input Field	Description
`contentType` - `String!`

Example

{"contentType": "xyz789"}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Budget

Fields

Field Name	Description
`id` - `ID!`
`amount` - `Float!`
`isPaymentFallbackEnabled` - `Boolean!`
`refillAmount` - `Int!`
`isRollover` - `Boolean!`

Example

{
  "id": 4,
  "amount": 123.45,
  "isPaymentFallbackEnabled": true,
  "refillAmount": 123,
  "isRollover": false
}

Types

BudgetInput

Fields

Input Field	Description
`isPaymentFallbackEnabled` - `Boolean`
`isRollover` - `Boolean`
`refillAmount` - `Int`

Example

{"isPaymentFallbackEnabled": true, "isRollover": false, "refillAmount": 987}

Types

Campaign

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`createdAt` - `DateTime!`
`type` - `CampaignType!`
`name` - `String`

Example

{
  "id": "4",
  "ref": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "type": "DIGITAL",
  "name": "xyz789"
}

Types

CampaignQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`isArchived` - `Boolean`
`teamId` - `String`
`type` - `CampaignType`
`text` - `String`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "isArchived": true,
  "teamId": "abc123",
  "type": "DIGITAL",
  "text": "xyz789"
}

Types

CampaignSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

CampaignType

Values

Enum Value	Description
`DIGITAL`
`PHYSICAL`

Example

"DIGITAL"

Types

Campaigns

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[Campaign!]!`

Example

{"totalCount": 987, "nodes": [Campaign]}

Types

Card

Fields

Field Name	Description
`id` - `ID!`
`last4` - `String!`
`brand` - `String!`

Example

{
  "id": "4",
  "last4": "abc123",
  "brand": "xyz789"
}

Types

Charge

Fields

Field Name	Description
`id` - `ID!`
`amount` - `Int!`
`created` - `DateTime!`
`description` - `String`
`receiptUrl` - `String`

Example

{
  "id": 4,
  "amount": 123,
  "created": "2007-12-03T10:15:30Z",
  "description": "xyz789",
  "receiptUrl": "abc123"
}

Types

ChargeQuery

Fields

Input Field	Description
`amountMin` - `Int`
`amountMax` - `Int`
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`

Example

{
  "amountMin": 123,
  "amountMax": 123,
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z"
}

Types

Charges

Fields

Field Name	Description
`totalCount` - `Int`
`nextPage` - `String`
`nodes` - `[Charge!]!`

Example

{
  "totalCount": 123,
  "nextPage": "xyz789",
  "nodes": [Charge]
}

Types

CreateMediaInput

Description

Specifies the input fields required to create a media object.

Fields

Input Field	Description
`originalSource` - `String!`	The original source of the media object. This might be an external URL or a staged upload URL.
`alt` - `String`	The alt text associated with the media.
`mediaContentType` - `MediaContentType!`	The media content type.

Example

{
  "originalSource": "xyz789",
  "alt": "xyz789",
  "mediaContentType": "VIDEO"
}

Types

Currency

Values

Enum Value	Description
`USD`
`CAD`

Example

"USD"

Types

Customer

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`
`email` - `String`
`card` - `Card`
`balance` - `Int`
`spendableBalance` - `Int`

Example

{
  "id": 4,
  "name": "abc123",
  "email": "abc123",
  "card": Card,
  "balance": 987,
  "spendableBalance": 123
}

Types

DateTime

Description

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example

"2007-12-03T10:15:30Z"

Types

DigitalBarcode

Description

Results of the Raise order

Fields

Field Name	Description
`id` - `ID!`	The Raise primary key. UUID.
`number` - `String`	Primary gift card number
`csc` - `String`	Secondary, security number
`barcodeKind` - `String`	Encoding for the raw card barcode. This is needed to render the barcode image.
`barcodeValue` - `String`	The raw value for the gift card barcode: the input for barcode rendering.
`viewCardUrl` - `String`	The URL for viewing the barcode

Example

{
  "id": 4,
  "number": "abc123",
  "csc": "abc123",
  "barcodeKind": "abc123",
  "barcodeValue": "abc123",
  "viewCardUrl": "xyz789"
}

Types

DigitalBrand

Description

Digital reward brand

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`iconUrl` - `String`
`faceplateUrl` - `String`	For displaying the card image
`legalTerms` - `String`
`description` - `String`
`redemptionDisclaimer` - `String`
`redemptionMethods` - `[String!]`
`denominations` - `[Int!]`	The possible values, in cents, that the card can be redeemed for. A null value means the possible redemption values are defined by the increment.
`increment` - `Int`	The valid redemption increment, in cents. A null value means the possible redemption values are defined by the denominations.
`maxValue` - `Int!`	Max redemption value of the card, in cents
`minValue` - `Int!`	Min redemption value of the card, in cents
`vendorId` - `ID!`	Vendor for this brand.
`currency` - `Currency!`	Denominated currency for this brand

Example

{
  "id": 4,
  "name": "abc123",
  "iconUrl": "abc123",
  "faceplateUrl": "xyz789",
  "legalTerms": "abc123",
  "description": "abc123",
  "redemptionDisclaimer": "abc123",
  "redemptionMethods": ["abc123"],
  "denominations": [987],
  "increment": 123,
  "maxValue": 123,
  "minValue": 123,
  "vendorId": 4,
  "currency": "USD"
}

Types

DigitalBrandQuery

Fields

Input Field	Description
`search` - `String`
`category` - `ID`

Example

{"search": "xyz789", "category": 4}

Types

DigitalCampaign

Fields

Field Name	Description
`id` - `ID!`
`createdAt` - `DateTime!`
`ref` - `String!`
`name` - `String!`
`rewardValue` - `Int!`
`brands` - `[ID!]!`
`messageTemplate` - `String`
`headlineTemplate` - `String`
`allowCharity` - `Boolean!`
`brandsSummary` - `String`
`isArchived` - `Boolean!`
`currency` - `Currency`

Example

{
  "id": "4",
  "createdAt": "2007-12-03T10:15:30Z",
  "ref": "abc123",
  "name": "abc123",
  "rewardValue": 123,
  "brands": [4],
  "messageTemplate": "abc123",
  "headlineTemplate": "xyz789",
  "allowCharity": true,
  "brandsSummary": "xyz789",
  "isArchived": false,
  "currency": "USD"
}

Types

DigitalCampaignInput

Fields

Input Field	Description
`name` - `String`
`messageTemplate` - `String`
`headlineTemplate` - `String`
`brands` - `[ID!]`
`rewardValue` - `Int`
`currency` - `Currency`
`allowCharity` - `Boolean`
`isArchived` - `Boolean`

Example

{
  "name": "xyz789",
  "messageTemplate": "abc123",
  "headlineTemplate": "xyz789",
  "brands": ["4"],
  "rewardValue": 987,
  "currency": "USD",
  "allowCharity": true,
  "isArchived": false
}

Types

DigitalCampaignQuery

Fields

Input Field	Description
`creatorEmail` - `String`
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`rewardValueMin` - `Int`
`rewardValueMax` - `Int`
`isArchived` - `Boolean`
`currency` - `Currency`

Example

{
  "creatorEmail": "xyz789",
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "rewardValueMin": 987,
  "rewardValueMax": 123,
  "isArchived": false,
  "currency": "USD"
}

Types

DigitalCampaignSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

DigitalCampaigns

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[DigitalCampaign!]!`

Example

{"totalCount": 987, "nodes": [DigitalCampaign]}

Types

DigitalOrder

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`createdAt` - `DateTime!`
`rewardValue` - `Int!`
`status` - `DigitalOrderStatus!`
`rewardLink` - `String!`
`recipient` - `Recipient!`
`creator` - `User!`
`campaign` - `DigitalCampaign`
`description` - `String`
`deliveryMethod` - `DigitalOrderDeliveryMethod!`
`events` - `[DigitalOrderEvent!]!`
`cancelledAt` - `DateTime`
`teamId` - `String`

Example

{
  "id": 4,
  "ref": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "rewardValue": 123,
  "status": "PAYMENT_PENDING",
  "rewardLink": "abc123",
  "recipient": Recipient,
  "creator": User,
  "campaign": DigitalCampaign,
  "description": "xyz789",
  "deliveryMethod": "LINK",
  "events": [DigitalOrderEvent],
  "cancelledAt": "2007-12-03T10:15:30Z",
  "teamId": "abc123"
}

Types

DigitalOrderBatch

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`creator` - `User!`
`createdAt` - `DateTime!`
`totalOrders` - `Int!`
`totalDelivered` - `Int!`
`totalPaid` - `Int!`
`digitalOrders` - `DigitalOrders!`
Arguments `skip` - `Int!` `take` - `Int!` `sort` - `DigitalOrderSortKey`

Example

{
  "id": 4,
  "ref": "abc123",
  "creator": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "totalOrders": 987,
  "totalDelivered": 987,
  "totalPaid": 987,
  "digitalOrders": DigitalOrders
}

Types

DigitalOrderBatchQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`teamId` - `String`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "teamId": "abc123"
}

Types

DigitalOrderBatchSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

DigitalOrderBatches

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[DigitalOrderBatch!]!`

Example

{"totalCount": 987, "nodes": [DigitalOrderBatch]}

Types

DigitalOrderBulkInput

Fields

Input Field	Description
`recipients` - `[RecipientInput!]!`
`campaignId` - `ID!`
`messageTemplate` - `String!`
`headlineTemplate` - `String`
`deliveryMethod` - `DigitalOrderDeliveryMethod`

Example

{
  "recipients": [RecipientInput],
  "campaignId": "4",
  "messageTemplate": "xyz789",
  "headlineTemplate": "xyz789",
  "deliveryMethod": "LINK"
}

Types

DigitalOrderCodeInput

Fields

Input Field	Description
`orderRef` - `ID!`
`brandId` - `ID!`
`email` - `String!`

Example

{
  "orderRef": 4,
  "brandId": "4",
  "email": "abc123"
}

Types

DigitalOrderDeliveryMethod

Values

Enum Value	Description
`LINK`
`EMAIL`

Example

"LINK"

Types

DigitalOrderEvent

Fields

Field Name	Description
`id` - `ID!`
`createdAt` - `DateTime!`
`code` - `DigitalOrderEventCode!`

Example

{
  "id": 4,
  "createdAt": "2007-12-03T10:15:30Z",
  "code": "CREATED"
}

Types

DigitalOrderEventCode

Values

Enum Value	Description
`CREATED`
`DELIVERED`
`PAYMENT_SUCCEEDED`
`REWARD_EMAIL_FAILED`
`REWARD_EMAIL_SUCCEEDED`
`EMAIL_OPENED`
`REDEEMED`

Example

"CREATED"

Types

DigitalOrderInput

Fields

Input Field	Description
`recipient` - `RecipientInput!`
`campaignId` - `ID`
`brandId` - `ID`
`currencyId` - `ID`
`rewardValue` - `Int`
`messageTemplate` - `String`
`headlineTemplate` - `String`
`deliveryMethod` - `DigitalOrderDeliveryMethod!`

Example

{
  "recipient": RecipientInput,
  "campaignId": "4",
  "brandId": "4",
  "currencyId": "4",
  "rewardValue": 987,
  "messageTemplate": "xyz789",
  "headlineTemplate": "xyz789",
  "deliveryMethod": "LINK"
}

Types

DigitalOrderQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`teamId` - `String`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "teamId": "abc123"
}

Types

DigitalOrderSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

DigitalOrderStatus

Values

Enum Value	Description
`PAYMENT_PENDING`
`PAYMENT_SUCCEEDED`
`REVOKED`

Example

"PAYMENT_PENDING"

Types

DigitalOrders

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[DigitalOrder!]!`

Example

{"totalCount": 987, "nodes": [DigitalOrder]}

Types

DigitalReward

Fields

Field Name	Description
`orderRef` - `ID!`
`value` - `Int!`
`hasOrderCode` - `Boolean!`
`barcode` - `DigitalBarcode`
`messageTemplate` - `String!`
`headlineTemplate` - `String`
`orgName` - `String!`
`logoUrl` - `String`
`logoBackgroundColor` - `String`
`logoPrimaryColor` - `String`
`recipientName` - `String!`
`recipientEmail` - `String`
`recipientOrgName` - `String`
`creatorName` - `String`
`creatorEmail` - `String`
`allowsCharity` - `Boolean!`
`brands` - `[DigitalBrand!]!`
`brand` - `DigitalBrand`
`code` - `String`
`tremendousUrl` - `String`
`currency` - `Currency!`
`cancelledAt` - `DateTime`

Example

{
  "orderRef": "4",
  "value": 123,
  "hasOrderCode": true,
  "barcode": DigitalBarcode,
  "messageTemplate": "abc123",
  "headlineTemplate": "abc123",
  "orgName": "abc123",
  "logoUrl": "xyz789",
  "logoBackgroundColor": "xyz789",
  "logoPrimaryColor": "abc123",
  "recipientName": "abc123",
  "recipientEmail": "xyz789",
  "recipientOrgName": "abc123",
  "creatorName": "abc123",
  "creatorEmail": "abc123",
  "allowsCharity": true,
  "brands": [DigitalBrand],
  "brand": DigitalBrand,
  "code": "abc123",
  "tremendousUrl": "abc123",
  "currency": "USD",
  "cancelledAt": "2007-12-03T10:15:30Z"
}

Types

DisplayableError

Description

Represents an error in the input of a mutation.

Fields

Field Name	Description
`field` - `[String!]`	The path to the input field that caused the error.
`message` - `String!`	The error message.

Possible Types

DisplayableError Types
`UserError`

Example

{
  "field": ["xyz789"],
  "message": "xyz789"
}

Types

ExchangeRate

Fields

Field Name	Description
`currency` - `Currency!`
`ratePerUsd` - `Float!`

Example

{"currency": "USD", "ratePerUsd": 123.45}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

FulfillmentEvent

Description

The fulfillment event that describes the fulfilllment status at a particular time.

Fields

Field Name	Description
`happenedAt` - `DateTime!`	The time at which this fulfillment event happened.
`id` - `ID!`	A globally-unique identifier.
`message` - `String`	A message associated with this fulfillment event.
`status` - `FulfillmentEventStatus!`	The status of this fulfillment event.

Example

{
  "happenedAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "message": "abc123",
  "status": "LABEL_PURCHASED"
}

Types

FulfillmentEventStatus

Description

The status that describes a fulfillment or delivery event.

Values

Enum Value	Description
`LABEL_PURCHASED`	A shipping label has been purchased.
`LABEL_PRINTED`	A purchased shipping label has been printed.
`READY_FOR_PICKUP`	The fulfillment is ready to be picked up.
`CONFIRMED`	The fulfillment is confirmed. This is the default value when no other information is available.
`IN_TRANSIT`	The fulfillment is in transit.
`OUT_FOR_DELIVERY`	The fulfillment is out for delivery.
`ATTEMPTED_DELIVERY`	A delivery was attempted.
`DELIVERED`	The fulfillment was successfully delivered.
`FAILURE`	The fulfillment request failed.

Example

"LABEL_PURCHASED"

Types

FundsInput

Fields

Input Field	Description
`userId` - `ID!`
`amount` - `Int!`

Example

{"userId": 4, "amount": 123}

Types

FundsMoveInput

Fields

Input Field	Description
`fromUserId` - `ID!`
`toUserId` - `ID!`
`amount` - `Int!`

Example

{"fromUserId": 4, "toUserId": 4, "amount": 123}

Types

GetTokenQuery

Fields

Input Field	Description
`code` - `String`

Example

{"code": "xyz789"}

Types

HubSpotCompany

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`

Example

{"id": 4, "name": "xyz789"}

Types

HubSpotContact

Fields

Field Name	Description
`id` - `ID!`
`companyId` - `ID`
`name` - `String!`
`firstname` - `String`
`lastname` - `String`
`email` - `String`
`company` - `HubSpotCompany`
`address` - `String`
`city` - `String`
`state` - `String`
`zip` - `String`
`phone` - `String`

Example

{
  "id": 4,
  "companyId": "4",
  "name": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "email": "xyz789",
  "company": HubSpotCompany,
  "address": "xyz789",
  "city": "abc123",
  "state": "abc123",
  "zip": "abc123",
  "phone": "abc123"
}

Types

HubSpotContactsInput

Fields

Input Field	Description
`email` - `String`
`name` - `String`

Example

{
  "email": "abc123",
  "name": "xyz789"
}

Types

HubSpotToken

Fields

Field Name	Description
`user` - `String`
`hubDomain` - `String`
`hubId` - `ID!`
`appId` - `ID!`
`hubSpotUserId` - `ID!`

Example

{
  "user": "xyz789",
  "hubDomain": "xyz789",
  "hubId": 4,
  "appId": "4",
  "hubSpotUserId": 4
}

Types

HubSpotTokenInput

Fields

Input Field	Description
`code` - `String!`

Example

{"code": "abc123"}

Types

HubSpotUser

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`email` - `String!`

Example

{
  "id": 4,
  "name": "xyz789",
  "email": "xyz789"
}

Types

HubSpotUserInfo

Description

UserInfo specific to the user who connected HubSpot to the org

Fields

Field Name	Description
`id` - `ID!`
`displayName` - `String!`

Example

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

Types

ID

Description

The ID scalar type represents a unique identifier, 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 "4") or integer (such as 4) input value will be accepted as an ID.

Example

Types

Image

Description

Represents an image resource.

Fields

Field Name	Description
`altText` - `String`	A word or phrase to share the nature or contents of an image.
`height` - `Int`	The original height of the image in pixels. Returns null if the image is not hosted by Shopify.
`id` - `ID`	A unique identifier for the image.
`url` - `String!`	The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use GraphQL aliases.
`width` - `Int`	The original width of the image in pixels. Returns null if the image is not hosted by Shopify.

Example

{
  "altText": "xyz789",
  "height": 987,
  "id": 4,
  "url": "xyz789",
  "width": 987
}

Types

ImageInput

Description

Specifies the input fields for an image.

Fields

Input Field	Description
`id` - `ID`	A globally-unique identifier.
`altText` - `String`	A word or phrase to share the nature or contents of an image.
`src` - `String`	The URL of the image. May be a staged upload URL.

Example

{
  "id": "4",
  "altText": "abc123",
  "src": "xyz789"
}

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

IntegrationPartners

Values

Enum Value	Description
`MAKE`
`ZAPIER`

Example

"MAKE"

Types

InvoiceItem

Fields

Field Name	Description
`id` - `ID!`
`createdAt` - `DateTime!`
`amount` - `Int!`
`description` - `String`

Example

{
  "id": "4",
  "createdAt": "2007-12-03T10:15:30Z",
  "amount": 123,
  "description": "abc123"
}

Types

InvoiceItemInput

Fields

Input Field	Description
`sendId` - `ID!`
`amountDollars` - `Float!`
`description` - `String!`

Example

{
  "sendId": "4",
  "amountDollars": 987.65,
  "description": "abc123"
}

Types

LoginAsOrgInput

Fields

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

Example

{
  "password": "xyz789",
  "orgId": "xyz789"
}

Types

LoginAsUserInput

Fields

Input Field	Description
`userId` - `String!`

Example

{"userId": "xyz789"}

Types

MailingAddress

Description

Represents a customer mailing address.

For example, a customer's default address and an order's billing address are both mailling addresses.

Fields

Field Name	Description
`address1` - `String`	The first line of the address. Typically the street address or PO Box number.
`address2` - `String`	The second line of the address. Typically the number of the apartment, suite, or unit.
`city` - `String`	The name of the city, district, village, or town.
`company` - `String`	The name of the customer's company or organization.
`country` - `String`	The name of the country.
`countryCodeV2` - `String`	The two-letter code for the country of the address. For example, US.
`firstName` - `String`	The first name of the customer.
`lastName` - `String`	The last name of the customer.
`id` - `ID!`	A globally-unique identifier.
`phone` - `String`	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
`province` - `String`	The region of the address, such as the province, state, or district.
`provinceCode` - `String`	The two-letter code for the region. For example, ON.
`zip` - `String`	The zip or postal code of the address.

Example

{
  "address1": "xyz789",
  "address2": "abc123",
  "city": "xyz789",
  "company": "abc123",
  "country": "xyz789",
  "countryCodeV2": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "id": "4",
  "phone": "abc123",
  "province": "abc123",
  "provinceCode": "abc123",
  "zip": "xyz789"
}

Types

MailingAddressInput

Description

The fields used to create or update a mailing address.

Fields

Input Field	Description
`address1` - `String`	The first line of the address. Typically the street address or PO Box number.
`address2` - `String`	The second line of the address. Typically the number of the apartment, suite, or unit.
`city` - `String`	The name of the city, district, village, or town.
`company` - `String`	The name of the customer's company or organization.
`countryCode` - `String`	The two-letter code for the country of the address.
`firstName` - `String`	The first name of the customer.
`lastName` - `String`	The last name of the customer.
`phone` - `String`	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
`provinceCode` - `String`	The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
`zip` - `String`	The zip or postal code of the address.

Example

{
  "address1": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "company": "xyz789",
  "countryCode": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "phone": "xyz789",
  "provinceCode": "abc123",
  "zip": "xyz789"
}

Types

MediaContentType

Description

The possible content types for a media object.

Values

Enum Value	Description
`VIDEO`	A Shopify-hosted video.
`EXTERNAL_VIDEO`	An externally hosted video.
`MODEL_3D`	A 3d model.
`IMAGE`	A Shopify-hosted image.

Example

"VIDEO"

Types

Node

Fields

Field Name	Description
`id` - `ID!`

Possible Types

Node Types
`Product`
`ProductVariant`
`MailingAddress`
`FulfillmentEvent`

Example

{"id": 4}

Types

Order

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`createdAt` - `DateTime!`
`creatorName` - `String`
`recipientName` - `String`
`recipientOrg` - `String`
`events` - `[DigitalOrderEvent!]`
`fulfillmentEvents` - `[FulfillmentEvent!]`
`type` - `OrderType!`
`totalCost` - `Int!`
`description` - `String`
`cancelledAt` - `DateTime`

Example

{
  "id": 4,
  "ref": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "creatorName": "xyz789",
  "recipientName": "xyz789",
  "recipientOrg": "abc123",
  "events": [DigitalOrderEvent],
  "fulfillmentEvents": [FulfillmentEvent],
  "type": "DIGITAL",
  "totalCost": 123,
  "description": "xyz789",
  "cancelledAt": "2007-12-03T10:15:30Z"
}

Types

OrderQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`type` - `OrderType`
`teamId` - `String`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "type": "DIGITAL",
  "teamId": "xyz789"
}

Types

OrderSampleOrder

Fields

Field Name	Description
`id` - `String!`
`value` - `Int!`
`message` - `String!`
`emailSubject` - `String!`
`deliveryMethod` - `String!`
`status` - `String!`

Example

{
  "id": "xyz789",
  "value": 123,
  "message": "abc123",
  "emailSubject": "abc123",
  "deliveryMethod": "abc123",
  "status": "xyz789"
}

Types

OrderSampleRecipient

Fields

Field Name	Description
`name` - `String!`
`email` - `String`
`orgName` - `String!`

Example

{
  "name": "abc123",
  "email": "abc123",
  "orgName": "abc123"
}

Types

OrderSampleSender

Fields

Field Name	Description
`id` - `String!`
`email` - `String!`
`name` - `String!`
`teamId` - `String!`
`teamName` - `String!`

Example

{
  "id": "xyz789",
  "email": "abc123",
  "name": "abc123",
  "teamId": "xyz789",
  "teamName": "abc123"
}

Types

OrderSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

OrderType

Values

Enum Value	Description
`DIGITAL`
`PHYSICAL`

Example

"DIGITAL"

Types

Orders

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[Order!]!`

Example

{"totalCount": 987, "nodes": [Order]}

Types

Org

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`formattedName` - `String!`
`users` - `Users!`
Arguments `skip` - `Int!` `take` - `Int!` `query` - `UserQuery`
`logoUrl` - `String`
`logoBackgroundColor` - `String`
`logoPrimaryColor` - `String`
`isInternational` - `Boolean`
`hubSpotUserInfo` - `HubSpotUserInfo`
`hubSpotUsers` - `[HubSpotUser!]!`
`salesForceUserInfo` - `SalesForceUserInfo`
`salesForceUsers` - `[SalesForceUser!]!`
`teams` - `[Teams!]!`

Example

{
  "id": 4,
  "name": "xyz789",
  "formattedName": "xyz789",
  "users": Users,
  "logoUrl": "abc123",
  "logoBackgroundColor": "abc123",
  "logoPrimaryColor": "abc123",
  "isInternational": false,
  "hubSpotUserInfo": HubSpotUserInfo,
  "hubSpotUsers": [HubSpotUser],
  "salesForceUserInfo": SalesForceUserInfo,
  "salesForceUsers": [SalesForceUser],
  "teams": [Teams]
}

Types

OrgBranding

Fields

Field Name	Description
`logoUrl` - `String`
`logoBackgroundColor` - `String`
`logoPrimaryColor` - `String`

Example

{
  "logoUrl": "xyz789",
  "logoBackgroundColor": "abc123",
  "logoPrimaryColor": "abc123"
}

Types

OrgInput

Fields

Input Field	Description
`logoUrl` - `String`
`logoBackgroundColor` - `String`
`logoPrimaryColor` - `String`

Example

{
  "logoUrl": "abc123",
  "logoBackgroundColor": "abc123",
  "logoPrimaryColor": "abc123"
}

Types

PasswordResetInput

Fields

Input Field	Description
`resetPasswordCode` - `String!`
`newPassword` - `String!`

Example

{
  "resetPasswordCode": "abc123",
  "newPassword": "xyz789"
}

Types

PasswordUpdateInput

Fields

Input Field	Description
`currentPassword` - `String!`
`newPassword` - `String!`

Example

{
  "currentPassword": "xyz789",
  "newPassword": "abc123"
}

Types

PhysicalCampaign

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`createdAt` - `DateTime!`
`name` - `String!`
`gifts` - `[PhysicalGift!]!`
`messageTemplate` - `String`

Example

{
  "id": "4",
  "ref": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "gifts": [PhysicalGift],
  "messageTemplate": "xyz789"
}

Types

PhysicalCampaignInput

Fields

Input Field	Description
`name` - `String`
`messageTemplate` - `String`
`gifts` - `[ID!]`
`isArchived` - `Boolean`

Example

{
  "name": "abc123",
  "messageTemplate": "abc123",
  "gifts": ["4"],
  "isArchived": true
}

Types

PhysicalCampaignQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`isArchived` - `Boolean`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "isArchived": true
}

Types

PhysicalCampaignSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

PhysicalCampaigns

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[PhysicalCampaign!]!`

Example

{"totalCount": 987, "nodes": [PhysicalCampaign]}

Types

PhysicalGift

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`messageMaxLength` - `Int`
`messageMaxLines` - `Int`
`descriptionHtml` - `String`
`featuredImageSrc` - `String`
`initialShippingCost` - `Int`
`products` - `[Product!]!`
`productVariants` - `[ProductVariant!]!`
`isDisabled` - `Boolean`
`categories` - `[String!]!`
`isThirdParty` - `Boolean`
`shipsThroughWarehouse` - `Boolean`
`purchaseUrl` - `String`
`vendor` - `PhysicalVendor`
`orgId` - `String`

Example

{
  "id": "4",
  "title": "xyz789",
  "messageMaxLength": 123,
  "messageMaxLines": 123,
  "descriptionHtml": "abc123",
  "featuredImageSrc": "xyz789",
  "initialShippingCost": 123,
  "products": [Product],
  "productVariants": [ProductVariant],
  "isDisabled": false,
  "categories": ["abc123"],
  "isThirdParty": true,
  "shipsThroughWarehouse": true,
  "purchaseUrl": "abc123",
  "vendor": PhysicalVendor,
  "orgId": "xyz789"
}

Types

PhysicalGiftInput

Fields

Input Field	Description
`vendorId` - `ID!`
`productIds` - `[ID!]!`
`productVariantIds` - `[ID!]`
`categoryIds` - `[ID!]!`
`isThirdParty` - `Boolean`
`shipsThroughWarehouse` - `Boolean`
`initialShippingCost` - `Int`
`purchaseUrl` - `String`
`isDisabled` - `Boolean`
`orgId` - `String`

Example

{
  "vendorId": 4,
  "productIds": ["4"],
  "productVariantIds": [4],
  "categoryIds": [4],
  "isThirdParty": false,
  "shipsThroughWarehouse": false,
  "initialShippingCost": 987,
  "purchaseUrl": "abc123",
  "isDisabled": false,
  "orgId": "xyz789"
}

Types

PhysicalGiftQuery

Fields

Input Field	Description
`category` - `String`
`search` - `String`

Example

{
  "category": "abc123",
  "search": "xyz789"
}

Types

PhysicalGifts

Fields

Field Name	Description
`totalCount` - `Int`
`nodes` - `[PhysicalGift!]!`

Example

{"totalCount": 987, "nodes": [PhysicalGift]}

Types

PhysicalOrder

Fields

Field Name	Description
`id` - `ID!`
`ref` - `String!`
`createdAt` - `DateTime!`
`recipient` - `Recipient!`
`isAddressConfirmed` - `Boolean`
`recipientSubmitsAddress` - `Boolean`
`creatorName` - `String!`
`orgName` - `String!`
`orgBranding` - `OrgBranding!`
`vendorName` - `String`
`message` - `String!`
`invoiceItems` - `[InvoiceItem!]!`
`mailingAddress` - `MailingAddress`
`purchaseUrl` - `String`
`description` - `String`
`shopifyOrderId` - `String`
`shopifyOrderName` - `String`
`vendorOrderId` - `String`
`fulfillmentEvents` - `[FulfillmentEvent!]!`
`images` - `[Image!]!`
`giftChoices` - `[PhysicalGift!]!`
`selectedGift` - `PhysicalGift`
`isThirdParty` - `Boolean`
`shipsThroughWarehouse` - `Boolean`
`cancelledAt` - `DateTime`

Example

{
  "id": "4",
  "ref": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "recipient": Recipient,
  "isAddressConfirmed": false,
  "recipientSubmitsAddress": false,
  "creatorName": "xyz789",
  "orgName": "xyz789",
  "orgBranding": OrgBranding,
  "vendorName": "abc123",
  "message": "abc123",
  "invoiceItems": [InvoiceItem],
  "mailingAddress": MailingAddress,
  "purchaseUrl": "abc123",
  "description": "abc123",
  "shopifyOrderId": "xyz789",
  "shopifyOrderName": "xyz789",
  "vendorOrderId": "abc123",
  "fulfillmentEvents": [FulfillmentEvent],
  "images": [Image],
  "giftChoices": [PhysicalGift],
  "selectedGift": PhysicalGift,
  "isThirdParty": false,
  "shipsThroughWarehouse": true,
  "cancelledAt": "2007-12-03T10:15:30Z"
}

Types

PhysicalOrderInput

Fields

Input Field	Description
`giftId` - `ID`	The ID of the specific gift for this order. One of giftId or campaignId must be provided.
`campaignId` - `ID`	The ID of the specific campaign for this order. One of giftId or campaignId must be provided. If a campaing is provided, the giftId will be determined by the campaign when the recipients chooses a gift from that campaign.
`recipient` - `RecipientInput`	The recipient information for this order.
`message` - `String`	The message that the recipient will receive with the gift. This message will be physically printed on a card.
`recipientSubmitsAddress` - `Boolean`	Indicates whether the recipient will submit their mailing address. If false, the mailing address must be provided by the creator.
`mailingAddress` - `MailingAddressInput`	The mailing address for the recipient.
`sendEmail` - `Boolean`	Whether to send the reward link immediately through email or if the user will share the link themselves
`headlineTemplate` - `String`	Subject line if sending email

Example

{
  "giftId": 4,
  "campaignId": 4,
  "recipient": RecipientInput,
  "message": "xyz789",
  "recipientSubmitsAddress": false,
  "mailingAddress": MailingAddressInput,
  "sendEmail": false,
  "headlineTemplate": "abc123"
}

Types

PhysicalOrderQuery

Fields

Input Field	Description
`createdAtMin` - `DateTime`
`createdAtMax` - `DateTime`
`isDelivered` - `Boolean`
`teamId` - `String`

Example

{
  "createdAtMin": "2007-12-03T10:15:30Z",
  "createdAtMax": "2007-12-03T10:15:30Z",
  "isDelivered": true,
  "teamId": "xyz789"
}

Types

PhysicalOrderSortKey

Values

Enum Value	Description
`CREATED_AT_ASC`
`CREATED_AT_DESC`

Example

"CREATED_AT_ASC"

Types

PhysicalOrders

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[PhysicalOrder!]!`

Example

{"totalCount": 123, "nodes": [PhysicalOrder]}

Types

PhysicalVendor

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`messageMaxLength` - `Int`
`messageMaxLines` - `Int`

Example

{
  "id": "4",
  "name": "abc123",
  "messageMaxLength": 987,
  "messageMaxLines": 987
}

Types

Product

Description

Represents a product, including information about related collections and product variants.

Fields

Field Name	Description
`id` - `ID!`	Globally unique identifier.
`org` - `Org`	Org that owns this product, if any
`isAddon` - `Boolean`	A product is an addon if it doesn't belong to a single gift, but can be added on to gifts. E.g. special wrapping paper, or a custom printed card.
`images` - `[Image!]!`	A list of images associated with this product
`variants` - `[ProductVariant!]!`	A list of variants associated with the product.

Example

{
  "id": "4",
  "org": Org,
  "isAddon": true,
  "images": [Image],
  "variants": [ProductVariant]
}

Types

ProductCreatePayload

Description

Return type for productCreate mutation.

Fields

Field Name	Description
`product` - `Product`	The product object.
`userErrors` - `[UserError!]!`	The list of errors that occurred from executing the mutation.

Example

{
  "product": Product,
  "userErrors": [UserError]
}

Types

ProductInput

Description

Specifies the input fields required to create a product.

Fields

Input Field	Description
`descriptionHtml` - `String`	The description of the product, complete with HTML formatting.
`productType` - `String`	The product type specified by the merchant.
`customProductType` - `String`	The custom product type specified by the merchant.
`tags` - `[String!]`	A comma separated list of tags that have been added to the product.
`templateSuffix` - `String`	The theme template used when viewing the product in a store.
`title` - `String`	The title of the product.
`vendor` - `String`	The name of the product's vendor.
`collectionsToJoin` - `[ID!]`	The IDs of the collections that this product will be added to.
`collectionsToLeave` - `[ID!]`	The IDs of collections that will no longer include the existing product.
`id` - `ID`	Specifies the product to update in productUpdate or creates a new product if absent in productCreate.
`images` - `[ImageInput!]`	The images to associate with the product.
`options` - `[String!]`	List of custom product options (maximum of 3 per product).
`variants` - `[ProductVariantInput!]`	A list of variants associated with the product.
`status` - `ProductStatus`	The status of the product.
`requiresSellingPlan` - `Boolean`	Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to true on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.

Example

{
  "descriptionHtml": "xyz789",
  "productType": "abc123",
  "customProductType": "abc123",
  "tags": ["abc123"],
  "templateSuffix": "abc123",
  "title": "xyz789",
  "vendor": "xyz789",
  "collectionsToJoin": ["4"],
  "collectionsToLeave": ["4"],
  "id": 4,
  "images": [ImageInput],
  "options": ["abc123"],
  "variants": [ProductVariantInput],
  "status": "ACTIVE",
  "requiresSellingPlan": false
}

Types

ProductStatus

Description

The possible product statuses.

Values

Enum Value	Description
`ACTIVE`	The product is ready to sell and can be published to sales channels and apps. Products with an active status aren't automatically published to sales channels, such as the online store, or apps. By default, existing products are set to active.
`ARCHIVED`	The product is no longer being sold and isn't available to customers on sales channels and apps.
`DRAFT`	The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.

Example

"ACTIVE"

Types

ProductVariant

Description

Represents a product variant.

Fields

Field Name	Description
`id` - `ID!`	Globally unique identifier.
`price` - `Int!`	Price, in cents

Example

{"id": "4", "price": 123}

Types

ProductVariantInput

Description

Specifies a product variant to create or update.

Fields

Input Field	Description
`id` - `ID`	Specifies the product variant to update or create a new variant if absent.
`imageId` - `ID`	The ID of the image that's associated with the variant.
`imageSrc` - `String`	The URL of an image to associate with the variant. This field can only be used through mutations that create product images and must match one of the URLs being created on the product.
`mediaSrc` - `[String!]`	The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value.
`inventoryPolicy` - `ProductVariantInventoryPolicy`	Whether customers are allowed to place an order for the product variant when it's out of stock.
`options` - `[String!]`	The custom properties that a shop owner uses to define product variants.
`position` - `Int`	The order of the product variant in the list of product variants. The first position in the list is 1.
`price` - `String`	The price of the variant.
`productId` - `ID`	The product to create the variant for. Used as input only to the productVariantCreate mutation.
`requiresShipping` - `Boolean`	Whether the variant requires shipping.
`sku` - `String`	The SKU for the variant.
`taxable` - `Boolean`	Whether the variant is taxable.
`taxCode` - `String`	The tax code associated with the variant.
`weight` - `Float`	The weight of the variant.

Example

{
  "id": "4",
  "imageId": 4,
  "imageSrc": "abc123",
  "mediaSrc": ["abc123"],
  "inventoryPolicy": "DENY",
  "options": ["xyz789"],
  "position": 987,
  "price": "abc123",
  "productId": 4,
  "requiresShipping": true,
  "sku": "abc123",
  "taxable": true,
  "taxCode": "xyz789",
  "weight": 987.65
}

Types

ProductVariantInventoryPolicy

Description

The valid values for the inventory policy of a product variant once it is out of stock.

Values

Enum Value	Description
`DENY`	Customers can't buy this product variant after it's out of stock.
`CONTINUE`	Customers can buy this product variant after it's out of stock.

Example

"DENY"

Types

Recipient

Fields

Field Name	Description
`id` - `ID!`
`org` - `Org`
`email` - `String`
`name` - `String!`
`salesForceContactId` - `ID`
`salesForceAccountId` - `ID`
`hubSpotContactId` - `ID`
`hubSpotCompanyId` - `ID`
`orgName` - `String`

Example

{
  "id": 4,
  "org": Org,
  "email": "xyz789",
  "name": "xyz789",
  "salesForceContactId": "4",
  "salesForceAccountId": "4",
  "hubSpotContactId": "4",
  "hubSpotCompanyId": 4,
  "orgName": "abc123"
}

Types

RecipientInput

Fields

Input Field	Description
`email` - `String`
`name` - `String!`
`salesForceContactId` - `String`
`salesForceAccountId` - `String`
`hubSpotContactId` - `String`
`hubSpotCompanyId` - `String`
`orgName` - `String`

Example

{
  "email": "abc123",
  "name": "abc123",
  "salesForceContactId": "abc123",
  "salesForceAccountId": "xyz789",
  "hubSpotContactId": "abc123",
  "hubSpotCompanyId": "xyz789",
  "orgName": "abc123"
}

Types

ResendInviteInput

Fields

Input Field	Description
`userId` - `ID!`

Example

{"userId": 4}

Types

RevokeInviteInput

Fields

Input Field	Description
`userId` - `ID!`

Example

{"userId": "4"}

Types

Role

Values

Enum Value	Description
`ADMIN`
`USER`
`RS_ADMIN`

Example

"ADMIN"

Types

SalesForceAccount

Fields

Field Name	Description
`id` - `ID!`
`name` - `String`

Example

{"id": 4, "name": "xyz789"}

Types

SalesForceContact

Fields

Field Name	Description
`id` - `ID!`
`phone` - `String`
`email` - `String`
`name` - `String`
`account` - `SalesForceAccount`
`mailingAddress` - `SalesForceMailingAddress`

Example

{
  "id": "4",
  "phone": "abc123",
  "email": "abc123",
  "name": "xyz789",
  "account": SalesForceAccount,
  "mailingAddress": SalesForceMailingAddress
}

Types

SalesForceContactInput

Fields

Input Field	Description
`id` - `ID!`
`accountId` - `ID`

Example

{"id": "4", "accountId": 4}

Types

SalesForceContactsInput

Fields

Input Field	Description
`contactName` - `String!`

Example

{"contactName": "abc123"}

Types

SalesForceMailingAddress

Fields

Field Name	Description
`city` - `String`
`country` - `String`
`postalCode` - `String`
`state` - `String`
`street` - `String`

Example

{
  "city": "xyz789",
  "country": "abc123",
  "postalCode": "abc123",
  "state": "abc123",
  "street": "xyz789"
}

Types

SalesForceReport

Description

Main report for SalesForce

Fields

Field Name	Description
`id` - `ID!`
`startDate` - `DateTime!`
`endDate` - `DateTime!`
`currency` - `String!`
`opportunities` - `[SalesForceReportOpportunity!]!`
`orders` - `[SalesForceReportOrder!]!`

Example

{
  "id": 4,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "currency": "abc123",
  "opportunities": [SalesForceReportOpportunity],
  "orders": [SalesForceReportOrder]
}

Types

SalesForceReportInput

Fields

Input Field	Description
`startDate` - `DateTime!`
`endDate` - `DateTime!`

Example

{
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z"
}

Types

SalesForceReportOpportunity

Description

A single Opportunity event for a SalesForce Report. In practice, this will be derived from Opportunities that are related to an order, through the recipient's salesForceAccountId.

Fields

Field Name	Description
`id` - `ID!`
`accountId` - `ID!`
`amount` - `Float!`
`isWon` - `Boolean!`
`isClosed` - `Boolean!`
`timestamp` - `DateTime!`
`orders` - `[SalesForceReportOrder!]!`

Example

{
  "id": 4,
  "accountId": "4",
  "amount": 987.65,
  "isWon": false,
  "isClosed": false,
  "timestamp": "2007-12-03T10:15:30Z",
  "orders": [SalesForceReportOrder]
}

Types

SalesForceReportOrder

Fields

Field Name	Description
`id` - `ID!`
`campaignId` - `ID!`
`salesForceAccountId` - `ID`
`amount` - `Int!`
`timestamp` - `DateTime!`
`campaignName` - `String!`

Example

{
  "id": 4,
  "campaignId": "4",
  "salesForceAccountId": 4,
  "amount": 987,
  "timestamp": "2007-12-03T10:15:30Z",
  "campaignName": "abc123"
}

Types

SalesForceToken

Fields

Field Name	Description
`id` - `ID!`
`instanceUrl` - `String!`

Example

{"id": 4, "instanceUrl": "xyz789"}

Types

SalesForceTokenInput

Fields

Input Field	Description
`code` - `String!`
`redirectUri` - `String!`

Example

{
  "code": "abc123",
  "redirectUri": "xyz789"
}

Types

SalesForceUser

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`email` - `String!`

Example

{
  "id": "4",
  "name": "abc123",
  "email": "xyz789"
}

Types

SalesForceUserInfo

Description

UserInfo specific to the user who connected SalesForce to the org

Fields

Field Name	Description
`id` - `ID!`
`username` - `String!`
`nickName` - `String!`
`displayName` - `String!`

Example

{
  "id": 4,
  "username": "xyz789",
  "nickName": "xyz789",
  "displayName": "abc123"
}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

Team

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`users` - `[User!]!`
`isAdmin` - `Boolean!`

Example

{
  "id": 4,
  "name": "abc123",
  "users": [User],
  "isAdmin": false
}

Types

TeamCreateInput

Fields

Input Field	Description
`name` - `String!`

Example

{"name": "xyz789"}

Types

Teams

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`
`users` - `[UsersWithTeam!]!`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "users": [UsersWithTeam]
}

Types

User

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`email` - `String!`
`role` - `Role!`
`password` - `String`
`budget` - `Budget`
`salesForceUserId` - `String`
`hubSpotUserId` - `String`
`teams` - `[UserTeams]`
`org` - `Org`
`status` - `UserStatus!`
`googleEmail` - `String`
`microsoftEmail` - `String`
`hubSpotToken` - `HubSpotToken`
`apiPasswords` - `[ApiPassword!]!`

Example

{
  "id": 4,
  "name": "xyz789",
  "email": "xyz789",
  "role": "ADMIN",
  "password": "xyz789",
  "budget": Budget,
  "salesForceUserId": "xyz789",
  "hubSpotUserId": "xyz789",
  "teams": [UserTeams],
  "org": Org,
  "status": "ACTIVE",
  "googleEmail": "xyz789",
  "microsoftEmail": "xyz789",
  "hubSpotToken": HubSpotToken,
  "apiPasswords": [ApiPassword]
}

Types

UserByInviteCodeInput

Fields

Input Field	Description
`inviteCode` - `String!`

Example

{"inviteCode": "xyz789"}

Types

UserChangeTeamInput

Fields

Input Field	Description
`userId` - `ID!`
`teamId` - `ID!`

Example

{"userId": 4, "teamId": "4"}

Types

UserChangeTeamRoleInput

Fields

Input Field	Description
`userId` - `ID!`
`teamId` - `ID!`
`isAdmin` - `Boolean!`

Example

{
  "userId": 4,
  "teamId": "4",
  "isAdmin": false
}

Types

UserError

Description

Represents an error in the input of a mutation.

Fields

Field Name	Description
`field` - `[String!]`	The path to the input field that caused the error.
`message` - `String!`	The error message.

Example

{
  "field": ["xyz789"],
  "message": "abc123"
}

Types

UserInput

Fields

Input Field	Description
`email` - `String`
`team` - `ID`
`salesForceUserId` - `String`
`name` - `String`

Example

{
  "email": "abc123",
  "team": 4,
  "salesForceUserId": "xyz789",
  "name": "xyz789"
}

Types

UserQuery

Fields

Input Field	Description
`text` - `String`
`status` - `UserStatus`

Example

{"text": "xyz789", "status": "ACTIVE"}

Types

UserStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`
`INVITED`

Example

"ACTIVE"

Types

UserTeams

Fields

Field Name	Description
`userId` - `String!`
`teamId` - `String!`
`name` - `String!`
`isAdmin` - `Boolean!`

Example

{
  "userId": "abc123",
  "teamId": "xyz789",
  "name": "xyz789",
  "isAdmin": true
}

Types

Users

Fields

Field Name	Description
`totalCount` - `Int!`
`nodes` - `[User!]!`

Example

{"totalCount": 987, "nodes": [User]}

Types

UsersWithTeam

Fields

Field Name	Description
`isAdmin` - `Boolean`
`user` - `User!`

Example

{"isAdmin": true, "user": User}

Types

WebhookCreateInput

Fields

Input Field	Description
`url` - `String!`
`source` - `IntegrationPartners!`
`type` - `WebhookTypes!`

Example

{
  "url": "xyz789",
  "source": "MAKE",
  "type": "ORDER_STATUS_UPDATE"
}

Types

WebhookCreateResponse

Fields

Field Name	Description
`id` - `String!`

Example

{"id": "xyz789"}

Types

WebhookDeleteInput

Fields

Input Field	Description
`id` - `String!`

Example

{"id": "xyz789"}

Types

WebhookSampleResponse

Fields

Field Name	Description
`order` - `OrderSampleOrder!`
`recipient` - `OrderSampleRecipient!`
`sender` - `OrderSampleSender!`

Example

{
  "order": OrderSampleOrder,
  "recipient": OrderSampleRecipient,
  "sender": OrderSampleSender
}

Types

WebhookTypes

Values

Enum Value	Description
`ORDER_STATUS_UPDATE`
`ORDER_CREATE`

Example

"ORDER_STATUS_UPDATE"

Documentation by Anvil SpectaQL