""" Possible values: `closed`, `extended`, `locked`, `new`. New: All transactions that have recently taken place begin in this status. These transactions remain 'new' until you either correct/reverse them, extend them, or they lock (normally 2am PST on the 11th of each month). Extended: In the standard transaction lifecycle, you are allowed to extend any or all transactions to the next payment cycle (one-time only), a fairly common practice for advertisers with lengthy product return periods/policies. If you extend a transaction, it will move from a status of New to Extended and will remain as such until either you correct/reverse the transaction or it locks on the 11th of the month after the extension ends. Locked: In the standard transaction lifecycle, transactions lock at 2am PST on the 11th of each month. Once a transaction has a status of locked, you can no longer correct or extend it - it has moved into the publisher payout cycle. Closed: Transaction has been prepared for payment. """ scalar ActionStatus """ Possible values: `bonus`, `click`, `imp`, `item_lead`, `item_sale`, `perf_inc`, `sim_lead`, `sim_sale`. Sim_sale (Simple Sale): Traditional sale type transaction, doesn't usually include product/item level detail. Sim_lead (Simple Lead): Lead based transaction type, doesn't usually include product/item level detail. Item_sale (Item Sale): Traditional sale transaction but includes item level details (i.e. quantity, sku, etc.). Item_lead (Item Lead): Lead based transaction with item level details. Imp (Impression): This will be used if an advertiser tracks/pays out on the impression. Click: This will be used if an advertiser tracks/pays out on the click. Perf_inc (Performance Incentive): Some advertisers will add performance incentives to their program terms and pay out if certain thresholds are met. Bonus: This will be used if the Advertiser needs to bonus a publisher a one time amount. """ scalar ActionType """ A record of an advertiser commission event, potentially including items purchased and custom attributes supplied by the advertiser. Computed fields: - `items` - `situations` - `customPixel` - `verticalAttributes` """ type AdvertiserCommission { "Status of the commission" actionStatus: ActionStatus! "Unique identifier of an advertiser\u2019s defined action associated with the commission" actionTrackerId: String! "Name of the action (as specified by the advertiser) for that commission" actionTrackerName: String! "Action type for the commission" actionType: ActionType! "Displays the CID of the advertiser the link was clicked through (only applies to cross correlated accounts)" adOwner: String "Advertiser commission amount in advertiser's currency (Advertiser-only attribute)" advCommissionAmountAdvCurrency: DecimalNumber "Advertiser commission amount in USD (Advertiser-only attribute)" advCommissionAmountUsd: DecimalNumber "CID of the advertiser for this commission" advertiserId: String! "Name of the advertiser for this commission" advertiserName: String! "Ad idenification number" aid: String "CJ fee in the advertiser's currency (Advertiser-only attribute)" cjFeeAdvCurrency: DecimalNumber "CJ fee in USD (Advertiser only attribute)" cjFeeUsd: DecimalNumber "Click date for the commission" clickDate: Instant "Click referring URL for the commission" clickReferringURL: String "Commission identification number" commissionId: String! "The associated browser that the transaction concluded in." concludingBrowser: String "The associated device name that the transaction concluded in." concludingDeviceName: String "The associated device type that the transaction concluded in." concludingDeviceType: String "If this is not an original transaction, the reason the transaction was corrected will be returned." correctionReason: CorrectionReason "Country where the transaction occurred" country: String "The coupon/voucher code used in the transaction" coupon: String "Event date for the commission in UTC time zone" eventDate: Instant! "The associated browser that the transaction initiated in." initiatingBrowser: String "The associated device name that the transaction initiated in." initiatingDeviceName: String "The associated device type that the transaction initiated in." initiatingDeviceType: String "Indicates if a transaction was attributed using cross-device tracking with \u2018true\u2019 or \u2018false\u2019" isCrossDevice: Boolean "The items associated with this commissionable action." items: [Item!]! "Date on which the commission is locked for extending or correcting" lockingDate: Instant! "Advertiser defined, indicates if the customer is new or existing to the advertiser (Advertiser only attribute)" newToFile: Boolean "Discount associated with the order in the advertiser's currency" orderDiscountAdvCurrency: DecimalNumber "Discount associated with the order in original currency" orderDiscountOrigCurrency: DecimalNumber "Discount associated with the order in the publisher's currency" orderDiscountPubCurrency: DecimalNumber "Discount associated with the order in USD" orderDiscountUsd: DecimalNumber "Advertiser-assigned identification number for the order" orderId: String "Displays either a '1' indicating an original transaction or a '0' indicating a non-original or corrected transaction" original: Boolean! "Identification number used for correlation between the original transaction and corrected transaction" originalActionId: String! "Date on which the commission is posted" postingDate: Instant! "Publisher commission amount in publisher's currency" pubCommissionAmountPubCurrency: DecimalNumber! "Publisher commission amount in USD" pubCommissionAmountUsd: DecimalNumber! "CID of the publisher for this commission" publisherId: String! "Name of the publisher for this commission" publisherName: String! "Indicates if an advertiser has reviewed a transaction." reviewedStatus: String "Sale amount in advertiser's currency" saleAmountAdvCurrency: DecimalNumber "Sale amount in publisher's currency" saleAmountPubCurrency: DecimalNumber "Sale amount in USD" saleAmountUsd: DecimalNumber "Displays coupon code used, indicates it was a site to store offer transaction" siteToStoreOffer: String "Indicates if situations were defined in commissioning structure" situations: [String!]! @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `situationDetails`.") "Indicates if situations were defined in commissioning structure" situationDetails: [Situation!]! "Source for the transaction" source: String """ Advertiser-supplied custom pixel attributes **Deprecated:** Field is deprecated and will be removed in a future release. Use `verticalAttributes`. """ customPixel: AdvertiserVerticalAttributes @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `verticalAttributes`.") "Advertiser-supplied vertical attributes" verticalAttributes: AdvertiserVerticalAttributes "Publisher website identification number" websiteId: String "Publisher website name" websiteName: String "The locking method for the commission based on program terms. Possible values:" lockingMethod: LockingMethod "The commission's validation status" validationStatus: ValidationStatus } "The result of making a `advertiserCommissions` query." type AdvertiserCommissions { "The number of commissions returned." count: Int! "The maximum number of returned commissions supported by the query." limit: Int! """ The unique id of the final commission returned by this call (useful as a cursor). """ maxCommissionId: String """ If `false`, use `maxCommissionId` as the `sinceCommissionId` argument to continue and retrieve the next batch of commissions. """ payloadComplete: Boolean! "The `AdvertiserCommission` records returned by the query." records: [AdvertiserCommission!]! } """ A record of advertiser vertical attributes that the advertiser may have supplied as part of a commissionable event. Computed fields: _none_ """ type AdvertiserVerticalAttributes { "Open field, could indicate customer age or age-range, depending on what's applicable" age: String @deprecated(reason: "Field is deprecated and will be removed in a future release.") "Annual fee associated with this product" annualFee: String "The ancillary spend amount for the transaction (Advertiser-only attribute)" ancillarySpend: String "Identifies the status of the application at the time the transaction is sent to CJ" applicationStatus: String "APR at time of application approval" apr: String "APR for transfers" aprTransfer: String "APR transfer period in months" aprTransferTime: String "The date booking was made; YYYY-MM-DD" bookingDate: String "The status of the booking; i.e. confirmed, pending, etc." bookingStatus: String "Value of booking after taxes" bookingValuePostTax: String "Value of booking before taxes" bookingValuePreTax: String "Brand of item(s) purchased" brand: String "Identifier of the brand of the item booked" brandId: String "Identifies the business unit the customer purchased through" businessUnit: String "Marketing Campaign ID; advertiser-specific" campaignId: String "Marketing Campaign name; advertiser-specific" campaignName: String "Name of the card category" cardCategory: String "Were other car option items chosen, i.e. \"insurance\"" carOptions: String "Cash advance fee associated with this product" cashAdvanceFee: String "Category of item.\u00A0example:\u00A0if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback" category: String "Location city name, i.e. for a hotel or event" city: String "Class rating of item booked/purchased" class: String "Confirmation number for provider (i.e. a flight confirmation number from the airline)" confirmationNumber: String "Contract length, in months" contractLength: String "Describe contract, advertiser-specific" contractType: String "Country where the transaction occurred" countryCode: String "Amount discounted from coupon used" couponDiscount: String "Indicates the coupon type" couponType: String "Amount of credit extended\u00A0" creditLine: String "Quality of customer's credit;\u00A0300-579=Very Poor, 580-669=Fair, 670-739=Good,740-799=Very Good, 800-850=Exceptional" creditQuality: String "Whether the customer received a credit report, purchased it, got a free report, or started a trial for a reporting service" creditReport: String "Type of cruise (Alaskan, Caribbean, etc.)" cruiseType: String "Country the customer purchasing is in, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" custCountry: String "Country the customer purchasing is in, per ISO 3166-1 alpha 3 country code" customerLocation: String "Postal code where customer is requesting service" custPostCode: String @deprecated(reason: "Field is deprecated and will be removed in a future release.") "Advertiser-specific customer segment definition" custSegment: String "Defines if a customer is new or existing" custStatus: String "Customer type: i.e. company, individual consumer, business, leisure" custType: String "Method of delivery" delivery: String "Product or card description" description: String "The service destination city name, eg. New York" destCity: String "The service destination country code, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" destCountry: String "The service destination state/province code, per ISO 3166 standards" destState: String "The service destination id, typically an advertiser-defined code representing a destination city or destination state/province, e.g. 728660" destinationId: String "Does the customer reside in the US: yes/no" domestic: String "IATA code for dropoff location if it's at an aiport" dropoffIata: String "Unique car rental agency ID for dropoff location" dropoffId: String "Duration of days, i.e. can be used for number of nights for a hotel stay; length of a trial" duration: String "Check-out date/time, departure date/time, etc." endDateTime: String "Type of flight fare; i.e. gotta get away" flightFareType: String "Were other flight items chosen; i.e. wifi" flightOptions: String "Type of flight; i.e. direct, layover, overnight" flightType: String "Were flyer miles earned from this flight" flyerMiles: String "Amount of account funding" fundedAmount: String "Currency for the account's initial funding" fundedCurrency: String "Entertainment category or genre (books, movies, streaming, music, etc.); transaction-level only" genre: String "Number of guests" guests: String "Code for each city in a flight schedule; comma-separated lists; commas must be URL-encoded" iata: String "The intro APR for purchases; if the intro APR is not different than overall APR, use the \"APR\" parameter" introductoryApr: String "Introductory APR period in months" introductoryAprTime: String "Id for item/s purchased. If multiple items, it will be a comma-separated lists." itemId: String "Name of the item purchased" itemName: String "Type of item.\u00A0example:\u00A0if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback" itemType: String "Booking itinerary id" itineraryId: String "General demographic (like new mover v. student v. Small biz) that an indicate how and why a card will be used\u00A0" lifestage: String "Can be used to identify the store or location the customer will visit or has visited; advertiser-specific ID or name" location: String "Indicates the level of the customer's loyalty status" loyaltyEarned: String "Indicates whether this order resulted in the consumer joining the loyalty program" loyaltyFirstTimeSignup: String "Indicates if loyalty points were used" loyaltyLevel: String "Indicates is loyalty points were earned" loyaltyRedeemed: String "Customers status of membership" loyaltyStatus: String "Advertiser-only attribute." margin: String "The profit margin for the transaction (Advertiser-only attribute)" marketingChannel: String "Value of the minimum cash balance requirement for the account" minBalance: String "Minimum deposit amount" minDeposit: String "Minimum stay duration required, in days" minStayDuration: String "Yes or no - yes means there was a \"no cancellation allowed\" policy on the transaction" noCancellation: String "The service origin city name, eg. New York" orCity: String "The service origin country code, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" orCountry: String "The service origin state/province code, per ISO 3166 standards" orState: String "Amount paid at booking after taxes" paidAtBookingPostTax: String "Amount paid at booking before taxes" paidAtBookingPreTax: String "Method of payment used, i.e. credit card, mastercard, paypal, wire transfer, etc." paymentMethod: String "Model of payment used; advertiser-specific" paymentModel: String "IATA code for pickup location if it's at an aiport" pickupIata: String "Unique car rental agency ID for pickup location" pickupId: String "Device platform customer is using (i.e. mobile, tablet, etc.)" platformId: String "The point of sale of the customer" pointOfSale: String "Departure port city i.e. for cruises" port: String "Indicates if the purchase was made in advance of the item being available for sale" preorder: String "Did the customer prepay on their transaction: yes or no" prepaid: String "Indicates if the applicant was pre-qualified for the card" prequalify: String "Promotion applied (i.e. \"summer sale\")" promotion: String "The numeric value associated with the promotion (i.e. if the promotion is $500 cash back, you would pass \"promotion=dollars&promotion_amt=500\")" promotionAmount: String "Threshold needed in order to get the discount" promotionConditionThreshold: String "Types of promotional conditions" promotionConditionType: String "Promotion end time. ISO 8601 standard yyyy-mm-ddThh24:mm:ss.sssZ" promotionEnds: String "Promotion start time. ISO 8601 standard yyyy-mm-ddThh24:mm:ss.sssZ" promotionStarts: String "Indicates the promotion type" promotionType: String "Quantity for a given sku, simple actions only; if using and item-based action, use QTYx" quantity: String "Star rating of item booked/purchased" rating: String "Number of rooms booked" rooms: String "Room type booked i.e. for hotel or cruise" roomType: String "This parameter indicates the type of financial service the customer signed up for or purchased" serviceType: String "Name of the cruise ship" shipName: String "Check-in date/time, arrival date/time, etc." startDateTime: String "Identifies the state/province code the store or location is in, per ISO 3166-2 country subdivision standards (e.g. Alaska would be \"or_state=US-AK\", Bangkok would be \"or_state=TH-10\")" state: String "Cost of Subscription fee featured when signing up for free trial" subscriptionFee: String "Product duration; e.g. \"indefinite\" or 1 month/3 months/6 months" subscriptionLength: String "Amount of the tax" taxAmount: String "Type of the tax" taxType: String "The transfer fee amount (i.e. for a credit card)" transferFee: String "Type of travel being booked, i.e. air, car, activities, cruise, events, hotel, package, restaurants, travel guides, vacation rental, other." travelType: String "Type of trip booked/purchased; i.e. one-way, round-trip, multi-city, round-trip + hotel" tripType: String "Indicates if someone converted from a trial to a subscription" upsell: String } "List of reasons for correcting a transaction" enum CorrectionReason { INVALID_CREDIT_CARD RETURNED_MERCHANDISE DUPLICATED_ORDER CANT_SHIP_OR_SOLD_OUT UNQUALIFIED_LEAD QUALIFIED_LEAD OTHER_REASON } """ A numerical value, rendered in JSON as a string. This allows for a greater range of expression than GraphQL's default `Float` type supports. For reliable client-side parsing, the string value will always match the regex pattern `(-)?[0-9]+(\.[0-9]+)?`. """ scalar DecimalNumber "A Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, rendered in JSON as a string." scalar Instant """ A record of an item that was purchased as part of a commissionable event. Computed fields: - `situations` Restricted fields: _none_ """ type Item { "The unique id of this item record." commissionItemId: String! "Item discount in USD" discountUsd: DecimalNumber "Item discount in publisher's currency" discountPubCurrency: DecimalNumber "Item discount in the advertiser's currency" discountAdvCurrency: DecimalNumber "Unique id of the item list which applies to this item record" itemListId: String "Total commission for the specified quantity of the item in advertiser's currency" totalCommissionAdvCurrency: DecimalNumber! "Total commission for the specified quantity of the item in publisher's currency" totalCommissionPubCurrency: DecimalNumber! "Total commission for the specified quantity of the item in USD" totalCommissionUsd: DecimalNumber! "Item quantity" quantity: Int! "Per item sale amount in advertiser's currency" perItemSaleAmountAdvCurrency: DecimalNumber! "Per item sale amount in publisher's currency" perItemSaleAmountPubCurrency: DecimalNumber! "Per item sale amount in USD" perItemSaleAmountUsd: DecimalNumber! "Indicates if situations were defined in commissioning structure" situations: [String!]! @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `situationDetails`.") "Indicates if situations were defined in commissioning structure" situationDetails: [Situation!]! "Advertiser's unique identifier for the item" sku: String! } "Locking Method for commissions." enum LockingMethod { "Actions will be locked as soon as they are posted or otherwise determined by CJ Affiliate (CJ)." IMMEDIATE "Actions will be locked after the 10th of the month." FIXED_DATE "Actions will be locked by advertisers." OPEN_ENDED "Actions will be locked given number days after event date." FIXED_DURATION } """ A record of a publisher commission event, potentially including items purchased and advertiser-supplied custom attributes. Computed fields: - `items` - `situations` - `customPixel` - `verticalAttributes` """ type PublisherCommission { "Status of the commission" actionStatus: ActionStatus! "Unique identifier of an advertiser\u2019s defined action associated with the commission" actionTrackerId: String! "Name of the action (as specified by the advertiser) for that commission" actionTrackerName: String! "Action type for the commission" actionType: ActionType! "CID of the advertiser for this commission" advertiserId: String! "Name of the advertiser for this commission" advertiserName: String! "Ad identification number" aid: String "Click date for the commission" clickDate: Instant "Click referring URL for the commission" clickReferringURL: String "Commission identification number" commissionId: String! "The associated browser that the transaction concluded in." concludingBrowser: String "The associated device name that the transaction concluded in." concludingDeviceName: String "The associated device type that the transaction concluded in." concludingDeviceType: String "If this is not an original transaction, the reason the transaction was corrected will be returned." correctionReason: CorrectionReason "Country where the transaction occurred" country: String "The coupon/voucher code used in the transaction" coupon: String "Event date for the commission in UTC time zone" eventDate: Instant! "The associated browser that the transaction initiated in." initiatingBrowser: String "The associated device name that the transaction initiated in." initiatingDeviceName: String "The associated device type that the transaction initiated in." initiatingDeviceType: String "Indicates if a transaction was attributed using cross-device tracking with \u2018true\u2019 or \u2018false\u2019" isCrossDevice: Boolean "The items associated with this commissionable action." items: [Item!]! "Date on which the commission is locked for extending or correcting" lockingDate: Instant! "Discount associated with the order in the advertiser's currency" orderDiscountAdvCurrency: DecimalNumber "Discount associated with the order in original currency" orderDiscountOrigCurrency: DecimalNumber "Discount associated with the order in the publisher's currency" orderDiscountPubCurrency: DecimalNumber "Discount associated with the order in USD" orderDiscountUsd: DecimalNumber "Advertiser-assigned identification number for the order" orderId: String "Displays either a '1' indicating an original transaction or a '0' indicating a non-original or corrected transaction" original: Boolean! "Identification number used for correlation between the original transaction and corrected transaction" originalActionId: String! "Date on which the commission is posted" postingDate: Instant! "Publisher commission amount in publisher's currency" pubCommissionAmountPubCurrency: DecimalNumber! "Publisher commission amount in USD" pubCommissionAmountUsd: DecimalNumber! "CID of the publisher for this commission" publisherId: String! "Name of the publisher for this commission" publisherName: String! "Indicates if an advertiser has reviewed a transaction." reviewedStatus: String """ Sale amount in advertiser's currency **Deprecated:** Field is deprecated and will be removed in a future release. Use `saleAmountPubCurrency`. """ saleAmountAdvCurrency: DecimalNumber @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `saleAmountPubCurrency`.") "Sale amount in publisher's currency" saleAmountPubCurrency: DecimalNumber "Sale amount in USD" saleAmountUsd: DecimalNumber """ Shopper ID for the transaction (Publisher-only attribute) **Deprecated:** Field is deprecated and will be removed in a future release. Use `shopperId`. """ sid: String @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `shopperId`.") "Shopper ID for the transaction (Publisher-only attribute)" shopperId: String "Displays coupon code used, indicates it was a site to store offer transaction" siteToStoreOffer: String "Indicates if situations were defined in commissioning structure" situations: [String!]! @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `situationDetails`.") "Indicates if situations were defined in commissioning structure" situationDetails: [Situation!]! "Source for the transaction" source: String """ Advertiser-supplied custom pixel attributes **Deprecated:** Field is deprecated and will be removed in a future release. Use `verticalAttributes`. """ customPixel: PublisherVerticalAttributes @deprecated(reason: "Field is deprecated and will be removed in a future release. Use `verticalAttributes`.") "Advertiser-suppliec vertical attributes" verticalAttributes: PublisherVerticalAttributes "Publisher website identification number" websiteId: String "Publisher website name" websiteName: String "The locking method for the commission based on program terms." lockingMethod: LockingMethod "The commission's validation status" validationStatus: ValidationStatus } "The result of making a `publisherCommissions` query." type PublisherCommissions { "The number of commissions returned." count: Int! "The maximum number of returned commissions supported by the query." limit: Int! """ The unique id of the final commission returned by this call (useful as a cursor). """ maxCommissionId: String """ If `false`, use `maxCommissionId` as the `sinceCommissionId` argument to continue and retrieve the next batch of commissions. """ payloadComplete: Boolean! "The `PublisherCommission` records returned by the query." records: [PublisherCommission!]! } """ A record of publisher vertical attributes that the advertiser may have supplied as part of a commissionable event. Computed fields: _none_ """ type PublisherVerticalAttributes { "Open field, could indicate customer age or age-range, depending on what's applicable" age: String @deprecated(reason: "Field is deprecated and will be removed in a future release.") "Annual fee associated with this product" annualFee: String "Identifies the status of the application at the time the transaction is sent to CJ" applicationStatus: String "APR at time of application approval" apr: String "APR for transfers" aprTransfer: String "APR transfer period in months" aprTransferTime: String "The date booking was made; YYYY-MM-DD" bookingDate: String "The status of the booking; i.e. confirmed, pending, etc." bookingStatus: String "Value of booking after taxes" bookingValuePostTax: String "Value of booking before taxes" bookingValuePreTax: String "Brand of item(s) purchased" brand: String "Identifier of the brand of the item booked" brandId: String "Identifies the business unit the customer purchased through" businessUnit: String "Marketing Campaign ID; advertiser-specific" campaignId: String "Marketing Campaign name; advertiser-specific" campaignName: String "Name of the card category" cardCategory: String "Were other car option items chosen, i.e. \"insurance\"" carOptions: String "Cash advance fee associated with this product" cashAdvanceFee: String "Category of item.\u00A0example:\u00A0if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback" category: String "Location city name, i.e. for a hotel or event" city: String "Class rating of item booked/purchased" class: String "Confirmation number for provider (i.e. a flight confirmation number from the airline)" confirmationNumber: String "Contract length, in months" contractLength: String "Describe contract, advertiser-specific" contractType: String "Identifies the country code the store or location is in, per ISO 3166-1 alpha 3 country code, eg. USA, GBR, SWE; transaction-level only" countryCode: String "Amount discounted from coupon used" couponDiscount: String "Indicates the coupon type" couponType: String "Amount of credit extended\u00A0" creditLine: String "Quality of customer's credit;\u00A0300-579=Very Poor, 580-669=Fair, 670-739=Good,740-799=Very Good, 800-850=Exceptional" creditQuality: String "Whether the customer received a credit report, purchased it, got a free report, or started a trial for a reporting service" creditReport: String "Type of cruise (Alaskan, Caribbean, etc.)" cruiseType: String "Country the customer purchasing is in, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" custCountry: String "Country the customer purchasing is in, per ISO 3166-1 alpha 3 country code" customerLocation: String "Postal code where customer is requesting service" custPostCode: String @deprecated(reason: "Field is deprecated and will be removed in a future release.") "Advertiser-specific customer segment definition" custSegment: String "Defines if a customer is new or existing" custStatus: String "Customer type: i.e. company, individual consumer, business, leisure" custType: String "Method of delivery" delivery: String "Product or card description" description: String "The service destination city name, eg. New York" destCity: String "The service destination country code, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" destCountry: String "The service destination state/province code, per ISO 3166 standards" destState: String "The service destination id, typically an advertiser-defined code representing a destination city or destination state/province, e.g. 728660" destinationId: String "Does the customer reside in the US: yes/no" domestic: String "IATA code for dropoff location if it's at an aiport" dropoffIata: String "Unique car rental agency ID for dropoff location" dropoffId: String "Duration of days, i.e. can be used for number of nights for a hotel stay; length of a trial" duration: String "Check-out date/time, departure date/time, etc." endDateTime: String "Type of flight fare; i.e. gotta get away" flightFareType: String "Were other flight items chosen; i.e. wifi" flightOptions: String "Type of flight; i.e. direct, layover, overnight" flightType: String "Were flyer miles earned from this flight" flyerMiles: String "Amount of account funding" fundedAmount: String "Currency for the account's initial funding" fundedCurrency: String "Entertainment category or genre (books, movies, streaming, music, etc.); transaction-level only" genre: String "Number of guests" guests: String "Code for each city in a flight schedule; comma-separated lists; commas must be URL-encoded" iata: String "The intro APR for purchases; if the intro APR is not different than overall APR, use the \"APR\" parameter" introductoryApr: String "Introductory APR period in months" introductoryAprTime: String "Id for item/s purchased. If multiple items, it will be a comma-separated lists." itemId: String "Name of the item purchased" itemName: String "Type of item.\u00A0example:\u00A0if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback" itemType: String "Booking itinerary id" itineraryId: String "General demographic (like new mover v. student v. Small biz) that an indicate how and why a card will be used\u00A0" lifestage: String "Can be used to identify the store or location the customer will visit or has visited; advertiser-specific ID or name" location: String "Indicates the level of the customer's loyalty status" loyaltyEarned: String "Indicates whether this order resulted in the consumer joining the loyalty program" loyaltyFirstTimeSignup: String "Indicates if loyalty points were used" loyaltyLevel: String "Indicates is loyalty points were earned" loyaltyRedeemed: String "Customers status of membership" loyaltyStatus: String "Value of the minimum cash balance requirement for the account" minBalance: String "Minimum deposit amount" minDeposit: String "Minimum stay duration required, in days" minStayDuration: String "Yes or no - yes means there was a \"no cancellation allowed\" policy on the transaction" noCancellation: String "The service origin city name, eg. New York" orCity: String "The service origin country code, per ISO 3166-1 alpha 2 country code, eg. US, UK, AU, FR" orCountry: String "The service origin state/province code, per ISO 3166 standards" orState: String "Amount paid at booking after taxes" paidAtBookingPostTax: String "Amount paid at booking before taxes" paidAtBookingPreTax: String "Method of payment used, i.e. credit card, mastercard, paypal, wire transfer, etc." paymentMethod: String "Model of payment used; advertiser-specific" paymentModel: String "IATA code for pickup location if it's at an aiport" pickupIata: String "Unique car rental agency ID for pickup location" pickupId: String "Device platform customer is using (i.e. mobile, tablet, etc.)" platformId: String "The point of sale of the customer" pointOfSale: String "Departure port city i.e. for cruises" port: String "Indicates if the purchase was made in advance of the item being available for sale" preorder: String "Did the customer prepay on their transaction: yes or no" prepaid: String "Indicates if the applicant was pre-qualified for the card" prequalify: String "Promotion applied (i.e. \"summer sale\")" promotion: String "The numeric value associated with the promotion (i.e. if the promotion is $500 cash back, you would pass \"promotion=dollars&promotion_amt=500\")" promotionAmount: String "Threshold needed in order to get the discount" promotionConditionThreshold: String "Types of promotional conditions" promotionConditionType: String "Promotion end time. ISO 8601 standard yyyy-mm-ddThh24:mm:ss.sssZ" promotionEnds: String "Promotion start time. ISO 8601 standard yyyy-mm-ddThh24:mm:ss.sssZ" promotionStarts: String "Indicates the promotion type" promotionType: String "Quantity for a given sku, simple actions only; if using and item-based action, use QTYx" quantity: String "Star rating of item booked/purchased" rating: String "Number of rooms booked" rooms: String "Room type booked i.e. for hotel or cruise" roomType: String "This parameter indicates the type of financial service the customer signed up for or purchased" serviceType: String "Name of the cruise ship" shipName: String "Check-in date/time, arrival date/time, etc." startDateTime: String "Identifies the state/province code the store or location is in, per ISO 3166-2 country subdivision standards (e.g. Alaska would be \"or_state=US-AK\", Bangkok would be \"or_state=TH-10\")" state: String "Cost of Subscription fee featured when signing up for free trial" subscriptionFee: String "Product duration; e.g. \"indefinite\" or 1 month/3 months/6 months" subscriptionLength: String "Amount of the tax" taxAmount: String "Type of the tax" taxType: String "The transfer fee amount (i.e. for a credit card)" transferFee: String "Type of travel being booked, i.e. air, car, activities, cruise, events, hotel, package, restaurants, travel guides, vacation rental, other." travelType: String "Type of trip booked/purchased; i.e. one-way, round-trip, multi-city, round-trip + hotel" tripType: String "Indicates if someone converted from a trial to a subscription" upsell: String } type Query { publisherCommissions( "List of publisher's unique company ids. Query will return only the commissions associated with the specified publishers." forPublishers: [String!]!, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose posting date is greater than or equal to the supplied argument. """ sincePostingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose posting date is less than the supplied argument. """ beforePostingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose event date is greater than or equal to the supplied argument. """ sinceEventDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose event date is less than the supplied argument. """ beforeEventDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose locking date is greater than or equal to the supplied argument. """ sinceLockingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose locking date is less than the supplied argument. """ beforeLockingDate: String, """ A unique id used for paginating a query result set. If a previous query returned a value of false for payloadComplete there are more results. To get the next page of results, read the value of maxCommissionId. In your subsequent query call, set the sinceCommissionId to this maxCommissionId value. Repeat this process until payloadComplete is true to get all query results. sinceCommissionId is intended for pagination of query result sets and should only be used for this purpose. """ sinceCommissionId: String, """ List of unique commission ids. If present, query will return only the specified commissions. """ commissionIds: [String!], """ List of unique advertiser company ids. If present, query will return only the commissions associated with the specified advertisers. """ advertiserIds: [String!], """ List of unique ad ids. If present, query will return only the commissions associated with the specified ads. """ adIds: [String!], """ List of unique website ids. If present, query will return only the commissions associated with the specified websites. """ websiteIds: [String!], """ List of action types. If present, query will return only the commissions with one of these types of actions. """ actionTypes: [String!], "If present and not empty, query will return only the commissions with one of these locking methods." lockingMethods: [LockingMethod!], """ List of order validation statuses. If present and not empty, query will return only the commissions with one of these locking methods. """ validationStatuses: [ValidationStatus!], """ List of action statuses. If present, query will return only the commissions with one of these action statuses. """ actionStatuses: [String!]): PublisherCommissions! "Returns list of commissions for the specified advertisers, filtered according to the supplied arguments." advertiserCommissions( """ List of advertiser's unique company ids. Query will return only the commissions associated with the specified advertisers. """ forAdvertisers: [String!]!, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose posting date is greater than or equal to the supplied argument. """ sincePostingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose posting date is less than the supplied argument. """ beforePostingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose event date is greater than or equal to the supplied argument. """ sinceEventDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose event date is less than the supplied argument. """ beforeEventDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose locking date is greater than or equal to the supplied argument. """ sinceLockingDate: String, """ Datetime in UTC ISO 8601 format with Z as the zone designator for the zero UTC offset, e.g. "1999-12-31T11:59:59Z". If present, query will return only the commissions whose locking date is less than the supplied argument. """ beforeLockingDate: String, """ A unique id used for paginating a query result set. If a previous query returned a value of false for payloadComplete there are more results. To get the next page of results, read the value of maxCommissionId. In your subsequent query call, set the sinceCommissionId to this maxCommissionId value. Repeat this process until payloadComplete is true to get all query results. sinceCommissionId is intended for pagination of query result sets and should only be used for this purpose. """ sinceCommissionId: String, """ List of unique commission ids. If present, query will return only the specified commissions. """ commissionIds: [String!], """ List of publisher's unique company ids. If present, query will return only the commissions associated with the specified publishers. """ publisherIds: [String!], """ List of unique ad ids. If present, query will return only the commissions associated with the specified ads. """ adIds: [String!], """ List of unique website ids. If present, query will return only the commissions associated with the specified websites. """ websiteIds: [String!], """ List of action types. If present, query will return only the commissions with one of these types of actions. """ actionTypes: [String!], "If present and not empty, query will return only the commissions with one of these locking methods." lockingMethods: [LockingMethod!], """ List of order validation statuses. If present and not empty, query will return only the commissions with one of these locking methods. """ validationStatuses: [ValidationStatus!], """ List of action statuses. If present, query will return only the commissions with one of these action statuses. """ actionStatuses: [String!]): AdvertiserCommissions! } "Situation used for commissioning" type Situation { "Situation name" name: String! "Situation id from CJ" id: String! } "Indicates whether an order is pending validation or has been validated by advertiser" enum ValidationStatus { "Pending validation to release payment" PENDING "Advertiser has validated that an order value is correct and may be locked" ACCEPTED "Advertiser has validated that an order has been fully corrected" DECLINED "Order is not open ended locking method" AUTOMATED }