Articles in this section

See more

API Changelog

Avatar
Doug Gledhill
  • Updated
Follow

Legend

  • ✔ Non-breaking change
  • ✖ Breaking change
  • ⚠ Dangerous change

r3.232 Released 2025-04-22

✔  Field notes was added to object type ShowBalanceWorkSheet

r3.230 Released 2025-04-08

 ✔  Type MerchItemAttributes was added

 ✔  Field updateMerchItemAndVariants was added to object type RootMutations

 ✔  Type UpdateMerchItemAndVariantsInput was added

 ✔  Type UpdateMerchItemAndVariantsPayload was added

 ✔  Type UpdateMerchVariantAttributes was added

r3.229 Released 2025-04-02

✖  Input field brand was removed from input object type CreateMerchItemAttributes

 ✖  Input field customFieldOne was removed from input object type CreateMerchItemAttributes

 ⚠  Input field colorName was added to input object type CreateMerchItemAttributes

 ✔  Type AddPromoTemplateToScanCodesInput was added

 ✔  Type AddPromoTemplateToScanCodesPayload was added

 ✔  Field warnings was added to object type CreateMerchItemPayload

 ✔  Type DiscountTemplateInterface was added

 ✔  Type PromoTemplate was added

 ✔  Type PromoTemplateConnection was added

 ✔  Type PromoTemplateEdge was added

 ✔  Field salesCampaigns was added to object type Promoter

 ✔  Field shows was added to object type Promoter

 ✔  Field addPromoTemplateToScanCodes was added to object type RootMutations

 ✔  Type SalesCampaign was added

 ✔  Type SalesCampaignConnection was added

 ✔  Type SalesCampaignEdge was added

 ✔  Type ValidationWarning was added

r3.227 Released 2025-03-18

 ✖  Field itemType was renamed to itemizationType on object type TransactionItemization

 ⚠  Input field sex was added to input object type CreateMerchItemAttributes

 ✔  Type TransactionDiscount was added

 ✔  Type TransactionDiscountTypeEnum was added

 ✔  Field discountAmount was added to object type TransactionItemization

 ✔  Field grossRefundedAmount was added to object type TransactionItemization

 ✔  Field grossSoldAmount was added to object type TransactionItemization

 ✔  Field listPriceAmount was added to object type TransactionItemization

 ✔  Field refundedDiscountAmount was added to object type TransactionItemization

 ✔  Field refundedTaxOneAmount was added to object type TransactionItemization

 ✔  Field refundedTaxTwoAmount was added to object type TransactionItemization

 ✔  Field subtotalRefundedAmount was added to object type TransactionItemization

 ✔  Field subtotalSoldAmount was added to object type TransactionItemization

 ✔  Field taxOneAmount was added to object type TransactionItemization

 ✔  Field taxTwoAmount was added to object type TransactionItemization

 ✔  Field totalRefundedAmount was added to object type TransactionItemization

 ✔  Field totalSalesAmount was added to object type TransactionItemization

 ✔  Field totalSoldAmount was added to object type TransactionItemization

 ✔  Field discounts was added to object type TransactionOrderDetail

 ✔  Field issuer was added to object type TransactionTender

 ✔  Field wallet was added to object type TransactionTender

r3.225 Released 2025-03-05

Type CreateMerchItemAttributes was added

✔  Type CreateMerchItemInput was added

✔  Type CreateMerchItemPayload was added

✔  Type CreateMerchVariantAttributes was added

✔  Type DestinationUUID was added

✔  Type ItemGroupTableSortingColumnEnum was added

✔  Field customFieldOne was added to object type MerchItem

✔  Field createMerchItem was added to object type RootMutations

r3.223 Released 2025-02-19

✖  Type CreateExternalSalePayload was removed

 ✖  Type CreateExternalSalesPayload was removed

 ✖  Type ExternalSale was removed

 ✖  Type ExternalSaleAttributes was removed

 ✖  Type ExternalSaleConnection was removed

 ✖  Type ExternalSaleEdge was removed

 ✖  Type ExternalSaleRegionEnum was removed

 ⚠  Field createExternalSale (deprecated) was removed from object type RootMutations

 ⚠  Field createExternalSales (deprecated) was removed from object type RootMutations

 ⚠  Field externalSale (deprecated) was removed from object type RootQueries

 ⚠  Field externalSales (deprecated) was removed from object type RootQueries

 ✔  Field transactionOrderDetails was added to object type Show

 ✔  Type TransactionFee was added

 ✔  Type TransactionFeeTypeEnum was added

 ✔  Type TransactionItemTypeEnum was added

 ✔  Type TransactionItemization was added

 ✔  Type TransactionOrderDetail was added

 ✔  Type TransactionOrderDetailConnection was added

 ✔  Type TransactionOrderDetailEdge was added

 ✔  Type TransactionRefund was added

 ✔  Type TransactionTender was added

 ✔  Type TransactionTip was added

Notes:

  • External Sales were previously deprecated, and are now no longer supported
  • transactionOrderDetails is in BETA and requires a special BETA permission

r3.222 Released 2025-02-11

⚠  Enum value PAID_TO_ARTIST was added to enum ExpenseTypeEnum

r3.221 Released 2025-02-05

✖  Type DiscountInterfaceEdge was removed

✖  Type MainCountConnection was removed

✖  Type PromoterEdge was removed

✖  Field Settlement.mainCounts changed type from MainCountConnection! to MainCountSinceConnection!

✔  Type MainCountSinceConnection was added

✔  Field RootMutations.createExternalSale is deprecated

✔  Field RootMutations.createExternalSale has deprecation reason Public import of external sales is being discontinued

✔  Field RootMutations.createExternalSales is deprecated

✔  Field RootMutations.createExternalSales has deprecation reason Public import of external sales is being discontinued

✔  Field RootQueries.externalSale is deprecated

✔  Field RootQueries.externalSale has deprecation reason Public import of external sales is being discontinued

✔  Field RootQueries.externalSales is deprecated

✔  Field RootQueries.externalSales has deprecation reason Public import of external sales is being discontinued

Potentially Breaking Change 1

When validation errors occur in relation to input variables we now warp them in an error that indicates what input variable is at fault. All previous error detail is contained within the nested extension object. Behaviour is consistent for queries and mutations.

Example

 query($uuid: UUID!){ 
   node(uuid: $uuid ) { 
     uuid 
   }
 }

with parameters

{ 
 "uuid": "f98ec2e3-c786-4365-82b7-80823a514080" 
}

This would previously have returned

 { 
    "errors": [ {
      "message": "invalid UUID format for `f98ec2e3-c786-4365-82b7-80823a514080`", 
      "extensions": { 
         "type": "FORMAT_ERROR" 
       } 
     } ]
}

it will now look like

{
 "errors": [
   {
     "message": "Variable $uuid of type UUID! was provided invalid value",
     "locations": [
       {
         "line": 1,
         "column": 8
       }
     ],
     "extensions": {
       "value": "f98ec2e3-c786-4365-82b7-80823a514080",
       "problems": [
         {
           "path": [],
           "explanation": "invalid UUID format for 
f98ec2e3-c786-4365-82b7-80823a514080.",
           "extensions": {
             "type": "FORMAT_ERROR"
           },
           "message": "invalid UUID format for f98ec2e3-c786-4365-82b7-80823a514080."
         }
       ]
     }
   }
 ]
}

Potentially Breaking Change 2

Empty parentheses used to work, but now they no longer work

This is now an error:

query{
 organization() {
   name
 }
}

Do this instead:

query{
 organization {
   name
 }
}

r3.220 Released 2025-01-28

✔  Field descriptionSubtitle was added to object type Show

✔  Field descriptionTitle was added to object type Show

r3.214 Released 2024-12-03

⚠  Input field metadata was added to input object type ScanCodeAttributes

⚠  Input field metadata was added to input object type WristbandAttributes

✔  Type FanMetadataAttributes was added

r3.213 Released 2024-11-27

⚠  Input field metadata was added to input object type ScanCodeAttributes

⚠  Input field metadata was added to input object type WristbandAttributes

✔  Type FanMetadataAttributes was added

r3.203 Released 2024-09-17

✔  Type AddPromoToScanCodesInput was added

✔  Type AddPromoToScanCodesPayload was added

✔  Field scanCodesEnabled was added to object type Promo

✔  Field scanCodesEnabled was added to interface PromoFieldsInterface

✔  Field addPromoToScanCodes was added to object type RootMutations

✔  Type ScanCodeAttributes was added

r3.201 Released 2024-09-04

⚠  Enum value UNCATEGORIZED was added to enum ItemizationTypeEnum

r3.198 Released 2024-08-13

✔  Type MerchItemModifier was added

✔  Field hasModifiers was added to object type Show

r3.193 Released 2024-07-09

✔  Field multipleStands was added to object type Show

r3.192 Released 2024-07-03

✔  Field brand was added to object type MerchItem

r3.190 Released 2024-06-18

✔  Field deleted was added to object type MerchItem

✔  Field deleted was added to object type MerchVariant

✔  Field scannableCodeOne was added to object type MerchVariant

✔  Field scannableCodeTwo was added to object type MerchVariant

✔  Field showName was added to object type Show

✔  Field transactionTenderTypes was added to object type Show

r3.189 Released 2024-06-11

⚠  Promo object implements PromoFieldsInterface interface

✔  Field color was added to object type MerchItem

✔  Field sex was added to object type MerchItem

✔  Type PromoFieldsInterface was added

✔  Type SexEnum was added

r3.179 Released 2024-04-03

✔  Type ItemizationModifier was added

✔  Field grossSoldAmountWithModifiers was added to object type ItemizedTransaction

✔  Field modifiers was added to object type ItemizedTransaction

✔  Field netSoldAmountWithModifiers was added to object type ItemizedTransaction

✔  Field totalRefundedAmountWithModifiers was added to object type ItemizedTransaction

r3.173 Released 2024-02-21

✔  Field overrides was added to object type CategorySettlement

✔  Field withoutOverrides was added to object type CategorySettlement

✔  Type OverrideSettlement was added

r3.164 Released 2023-12-07

✖  Field Promo.discountType changed type from PromoDiscountTypeEnum! to DiscountTypeEnum!

✖  Type PromoDiscountTypeEnum was removed

⚠  Promo object implements DiscountInterface interface

✔  Type DiscountInterface was added

✔  Type DiscountInterfaceEdge was added

✔  Type DiscountTypeEnum was added

2 breaking changes

r3.163 Released 2023-11-28

✔  Field productType was added to object type ItemizedTransaction

✔  Field numberOfLocations was added to object type Show

✔  Field numberOfVendors was added to object type Show

r3.154 Released 2023-09-27

✔  Field disbursement was added to object type Settlement

✔  Field showBalanceWorkSheet was added to object type Show

✔  Type ShowBalanceWorkSheet was added

r3.152 Released 2023-09-13

⚠  Argument paymentTimestampBetween: TimeRange added to field Show.itemizedTransactions

✔  Type TimeRange was added

r3.150 Released 2023-08-30

✔  Type AddPromoToWristbandsInput was added

✔  Type AddPromoToWristbandsPayload was added

✔  Field displayModifierNote was added to object type MerchItem

✔  Type Promo was added

✔  Type PromoConnection was added

✔  Type PromoDiscountTypeEnum was added

✔  Type PromoEdge was added

✔  Type Promoter was added

✔  Type PromoterEdge was added

✔  Field addPromoToWristbands was added to object type RootMutations

✔  Field promoter was added to object type RootQueries

✔  Type SalesEvent was added

✔  Type SalesEventConnection was added

✔  Type SalesEventEdge was added

✔  Type ValidationError was added

✔  Type WristbandAttributes was added

r3.146 Released 2023-08-02

✖  Field totalAmount was removed from object type OtherRegisterSalesEntry

✖  Field totalAmount was removed from object type RegisterSalesEntry

✔  Field collectedAmount was added to object type OtherRegisterSalesEntry

✔  Field collectedAmount was added to object type RegisterSalesEntry

r3.145 Released 2023-07-26

⚠  Enum value CUSTOM_AMOUNT was added to enum ItemizationTypeEnum

⚠  Enum value GIFT_CARD_ACTIVATION was added to enum ItemizationTypeEnum

⚠  Enum value GIFT_CARD_RELOAD was added to enum ItemizationTypeEnum

⚠  Enum value GIFT_CARD_UNKNOWN was added to enum ItemizationTypeEnum

⚠  Enum value OTHER was added to enum ItemizationTypeEnum

⚠  Enum value SHIPPING was added to enum ItemizationTypeEnum

⚠  Enum value UNKNOWN was added to enum ItemizationTypeEnum

⚠  Argument orderId: String added to field Show.itemizedTransactions

✔  Field beforeTaxPriceAmount was added to object type ItemizedTransaction

✔  Field grossSoldAmount was added to object type ItemizedTransaction

✔  Field refundedDiscountAmount was added to object type ItemizedTransaction

✔  Field refundedTaxOneAmount was added to object type ItemizedTransaction

✔  Field refundedTaxTwoAmount was added to object type ItemizedTransaction

✔  Field taxOneAmount was added to object type ItemizedTransaction

✔  Field taxTwoAmount was added to object type ItemizedTransaction

r3.144 Released 2023-07-18

✔  Type Disbursement was added

✔  Type DisbursementConfiguration was added

✔  Type DisbursementConnection was added

✔  Type DisbursementDisplayStatusEnum was added

✔  Type DisbursementEdge was added

✔  Type DisbursementFilters was added

✔  Type DisbursementSorting was added

✔  Type DisbursementSortingColumnEnum was added

✔  Field metadata was added to object type Location

✔  Field disbursementConfiguration was added to object type Organization

✔  Field disbursements was added to object type Organization

✔  Type PaymentDetail was added

✔  Type PaymentTypeEnum was added

r3.140 Released 2023-06-20

⚠  Settlement object implements SoundscannableInterface interface

⚠  Settlement object implements UnlockableInterface interface

⚠  Enum value VENUE_CUT_ON_ADJUSTED_GROSS_WITHOUT_TAX_AND_FEES was added to enum SettlementVenueCutModeEnum

✔  Field productType was added to object type MerchItem

✔  Type OtherRegisterSalesEntry was added

✔  Type ProductType was added

✔  Type RegisterSales was added

✔  Type RegisterSalesEntry was added

✔  Field canRelock was added to object type Settlement

✔  Field canUnlock was added to object type Settlement

✔  Field settledAtTimestamp was added to object type Settlement

✔  Field settlementType was added to object type Settlement

✔  Field soundscanEnabled was added to object type Settlement

✔  Field soundscanVisible was added to object type Settlement

✔  Type SettlementTypeEnum was added

✔  Field concessionCompany was added to object type Show

✔  Field displayTimezone was added to object type Show

✔  Field registerSalesSummary was added to object type Show

✔  Type SoundscannableInterface was added

✔  Type Timezone was added

✔  Field reportCurrencyFormat was added to object type Tour

✔  Type UnlockableInterface was added

r3.122 Released 2023-02-15

⚠  Enum value ALCOHOL was added to enum MerchItemCategoryEnum

⚠  Enum value FNB_OTHER was added to enum MerchItemCategoryEnum

⚠  Enum value FOOD was added to enum MerchItemCategoryEnum

⚠  Enum value NON_ALCOHOL was added to enum MerchItemCategoryEnum

✔  Field description was added to object type MerchItem

✔  Field feuWithholdingPercent was added to object type Settlement

✔  Field isArtistFeu was added to object type Settlement

✔  Field venueFeuWithholdingAmount was added to object type SettlementOutputFields

✔  Field venueFeuWithholdingAmount was added to interface SettlementOutputFieldsInterface

✔  Field venueFeuWithholdingAmount was added to object type SettlementOutputTotals

r3.109 Released 2022-11-02

✔  Field merchItems was added to object type Account

✔  Type AdvancedComp was added

✔  Type AdvancedCompVariant was added

✔  Type AppliedToEnum was added

✔  Type BillToEnum was added

✔  Type CategorySettlement was added

✔  Type CollectedByEnum was added

✔  Type CollectedPayment was added

✔  Type CollectedPaymentEntryTypeEnum was added

✔  Type Expense was added

✔  Type ExpenseTypeEnum was added

✔  Type MainCount was added

✔  Type MainCountConnection was added

✔  Type MainCountEdge was added

✔  Type MerchAdd was added

✔  Type MerchItem was added

✔  Type MerchItemCategoryEnum was added

✔  Type MerchItemConnection was added

✔  Type MerchItemEdge was added

✔  Type MerchVariant was added

✔  Type PostSettlementAdjustment was added

✔  Type PostSettlementAdjustmentTypeEnum was added

✔  Type PullFromEnum was added

✔  Type Settlement was added

✔  Type SettlementOutput was added

✔  Type SettlementOutputFields was added

✔  Type SettlementOutputFieldsInterface was added

✔  Type SettlementOutputTotals was added

✔  Type SettlementStatusEnum was added

✔  Type SettlementTaxRetainmentOneEnum was added

✔  Type SettlementTaxRetainmentTwoEnum was added

✔  Type SettlementVenueCutModeEnum was added

✔  Field apparelTaxRateOne was added to object type Show

✔  Field apparelTaxRateTwo was added to object type Show

✔  Field attendance was added to object type Show

✔  Field isNotInTourCurrency was added to object type Show

✔  Field isTaxOnTop was added to object type Show

✔  Field musicTaxRateOne was added to object type Show

✔  Field musicTaxRateTwo was added to object type Show

✔  Field otherTaxRateOne was added to object type Show

✔  Field otherTaxRateTwo was added to object type Show

✔  Field settlements was added to object type Show

✔  Type Snapshot was added

r3.80 Released 2022-03-29

⚠  Argument withTips: Boolean added to field Show.itemizedTransactions

⚠  Enum value DELETED was added to enum ShowStateEnum

✔  Type ItemizationTypeEnum was added

✔  Field itemizationType was added to object type ItemizedTransaction

r3.76 Released 2022-03-01

✔  Field discountName was added to object type ItemizedTransaction

r3.59 Released 2021-07-30

⚠  Argument excludeSubOrgAccounts: Boolean added to field Organization.accounts

✔  Field metadata was added to object type ItemizedTransaction

✔  Field mobileOrdersDirectShowLink was added to object type Show

r3.21 Released 2020-07-20

⚠ Complexity calculation and limits updated

r3.17 Released 2020-06-18

⚠  Account object implements NodeInterface interface

⚠  Show object implements NodeInterface interface

⚠  Tour object implements NodeInterface interface

✔  Type NodeInterface was added

✔  Field node was added to object type RootQueries

r3.15 Released 2020-06-05

✖  Type AccountInterface was removed

✖  Type AccountInterfaceConnection was removed

✖  Type AccountInterfaceEdge was removed

✖  Type Festival was removed

✖  Field Organization.accounts changed type from AccountInterfaceConnection! to AccountConnection!

✖  Type Place was removed

✖  Type Talent was removed

✖  Type TalentEdge was removed

✔  Type Account was added

✔  Type AccountConnection was added

✔  Type AccountEdge was added

r3.14 Released 2020-05-29

✔ Type DateRange was added

✔ Type CurrencyFormat was added

✔ Type CurrencyFormatInterface was added

✔ Type ItemizedTransactionConnection was added

✔ Type ItemizedTransactionEdge was added

✔ Type ItemizedTransaction was added

✔ Type UUID was added

✔ Field tokenPermissions was added to object type RootQueries

✖ Argument id: ID was removed from field RootQueries.organization

✔ Field externalId was added to interface AccountInterface

✖ Field AccountInterface.uuid changed type from ID! to UUID!

✔ Argument showsOverlap: DateRange added to field Tour.shows

✖ Argument settled: Boolean was removed from field Tour.shows

✖ Field Tour.uuid changed type from ID! to UUID!

✔ Field currencyFormat was added to object type Show

✔ Field externalId was added to object type Show

✔ Field itemizedTransactions was added to object type Show

✖ Field Show.uuid changed type from ID! to UUID!

✖ Field Location.uuid changed type from ID! to UUID!

✔ Field success was added to object type CreateExternalSalePayload

✔ Field externalId was added to object type Festival

✖ Field Festival.uuid changed type from ID! to UUID!

✔ Field externalId was added to object type Place

✖ Field Place.uuid changed type from ID! to UUID!

✔ Field externalId was added to object type Talent

✖ Field Talent.uuid changed type from ID! to UUID!

 

Related articles

Comments

0 comments

Please sign in to leave a comment.