> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/partner-api-reference/reference/conversions/models.md). # Models ## The ConversionType object ```json {"openapi":"3.1.0","info":{"title":"Conversions API","version":"16"},"components":{"schemas":{"ConversionType":{"type":"string","description":"The conversion type. The only accepted value is `CLO` or `clo`\n(case-insensitive). If absent or blank it'll default to partner.\nSimilarly, unknown non-empty values will queue with a warning and\ndefault to partner.\n\nThis field is required for CLO partners. To flag a conversion as a\ncard-linked offer, include the parameter `ConversionType=CLO`.\n"}}}} ``` ## The ConversionPayload object ```json {"openapi":"3.1.0","info":{"title":"Conversions API","version":"16"},"components":{"schemas":{"ConversionPayload":{"type":"object","description":"The details of a conversion event you submit.","required":["ActionTrackerId","CampaignId","EventDate","MediaId","MediaPartnerId","OrderId"],"properties":{"ActionTrackerId":{"type":"integer","description":"The action tracker associated with the conversion event."},"CampaignId":{"type":"integer","description":"The campaign this conversion should be attributed to."},"EventDate":{"type":"string","description":"The date/time of the transaction. Accepts `NOW` or an ISO 8601 timestamp."},"MediaId":{"type":"integer","description":"An alias for `MediaPartnerId`. Accepted when `MediaPartnerId` is omitted."},"MediaPartnerId":{"type":"integer","description":"Your account ID. You can use `MediaId` instead, but you must provide one of the two."},"OrderId":{"type":"string","description":"A unique identifier you supply for this transaction. Used for\ndeduplication. Example: `9217374917471`\n\nFor CLO partners, this should be mapped to the\n`CardLinkedTransactionId`. Example: `OrderId={CardLinkedTransactionId}`\n"},"Amount":{"type":"number","format":"decimal","description":"The total transaction (sale) amount for the conversion. Returns and\nnegative amounts are not currently supported and will result in an\nerror.\n\nDo not send `Amount` together with item-level fields (e.g.\n`ItemPrice1` or `ItemSubTotal1`). Once item fields are detected,\nitem parsing drives the sale items and the order-level `Amount`\nfallback will not be used.\n\n- For simple conversions, send order-level `Amount` and don't\n send item fields.\n- For itemized conversions, omit order-level `Amount`.\n- For each item, either send `ItemSubTotalN` or `ItemPriceN` and\n `ItemQuantityN`.\n- Don't send both `ItemPriceN` and `ItemSubTotalN` for the same\n item; if both are present, the item subtotal/amount will be\n used rather than `price * quantity`.\n"},"CardBin":{"type":"string","description":"Card BIN for CLO transactions. Must be exactly 6 or 8 digits; invalid values are ignored with a warning."},"CardLastFour":{"type":"string","description":"The last four digits of the card used. Must be exactly 4 digits; invalid values are ignored with a warning."},"ConversionType":{"$ref":"#/components/schemas/ConversionType"},"CurrencyCode":{"type":"string","description":"Three-letter ISO 4217 alpha currency code for the transaction. If omitted, your account's default currency is used."},"CustomerCity":{"type":"string","description":"City of the customer (billing city)."},"CustomerCountry":{"type":"string","description":"Country of the customer (billing country)."},"CustomerPostCode":{"type":"string","description":"Postal (ZIP) code of the customer (billing ZIP)."},"CustomerStatus":{"type":"string","maxLength":255,"description":"Status of the customer for this conversion (e.g. new or returning)."},"Date1-Date15":{"type":"string","format":"date-time","description":"General fields (Date1 through Date15) that accept a date and time in ISO 8601 format you want to send. Appears in brand reports."},"DeviceMfr":{"type":"string","description":"Mobile device's manufacturer. Pass `android.os.Build.MANUFACTURER` on Android or `\"Apple\"` on iOS."},"DeviceModel":{"type":"string","description":"Mobile device's model. Pass `android.os.Build.MODEL` on Android or the value from `systemInfo.machine` on iOS."},"IpAddress":{"type":"string","description":"Customer's IP address. Used for fraud detection and install attribution."},"ItemBrand[i]":{"type":"string","description":"Brand name for the product referenced. Can also be automatically pulled if a product catalog has been uploaded."},"ItemCategory[i]":{"type":"string","description":"Category of the item."},"ItemDeliveryType[i]":{"type":"string","description":"Type of delivery method specified for this item (e.g. INSTORE)."},"ItemDiscount[i]":{"type":"number","format":"decimal","description":"Discount applied to each item purchased of this type (not to the entire line item)."},"ItemDiscountRate[i]":{"type":"number","format":"decimal","description":"The discount rate (%) applied to each item purchased."},"ItemMpn[i]":{"type":"string","description":"Manufacturer part number (MPN) for the product referenced. Can also be automatically pulled if a product catalog has been uploaded."},"ItemName[i]":{"type":"string","description":"The name for the product referenced. Can also be automatically appended through uploading a product catalog."},"ItemPrice[i]":{"type":"number","format":"decimal","description":"Unit price for the item. Do not send if `ItemSubTotal[i]` is passed."},"ItemPromoCode[i]":{"type":"string","description":"Promotional code applied to the item for the order. Note that this parameter does not work with unique tracking codes set up for particular partners."},"ItemQuantity[i]":{"type":"integer","description":"Number of units for this line item."},"ItemSku[i]":{"type":"string","description":"SKU for the item (e.g., ItemSku1, ItemSku2)."},"ItemSubCategory[i]":{"type":"string","description":"If applicable, the subcategory for the product referenced at the item level. Can also be automatically pulled if a product catalog has been uploaded."},"ItemSubTotal[i]":{"type":"number","format":"decimal","description":"Total price for the line item. Do not send if `ItemPrice[i]` is passed."},"ItemTotalDiscount[i]":{"type":"number","format":"decimal","description":"Discount applied to this line item (not just for each product of this type). This amount is automatically subtracted from the `ItemSubTotal` to determine the final sale amount for payout and reporting purposes."},"LocationId":{"type":"string","description":"Identifier for the location associated with this conversion, such as a merchant ID (MID). Primarily used for accommodations and card-linked transactions."},"LocationName":{"type":"string","description":"Name of the location associated with this conversion, such as a physical store or website."},"Money1-Money3":{"type":"number","format":"decimal","description":"General money fields (Money1 through Money3) that accept any monetary data you want to send. Appears in brand reports. Format: decimal (18,2)."},"Note":{"type":"string","maxLength":255,"description":"General field used to pass information for event-level reporting purposes."},"Numeric1-Numeric10":{"type":"number","format":"decimal","description":"General numeric fields (Numeric1 through Numeric10) that accept any numeric data you want to send. Appears in brand reports. Format: decimal (18,2)."},"PayoutAmount":{"type":"number","format":"decimal","description":"Payout amount for CLO transactions. Optional. if present, must be a non-negative decimal or it will be ignored with a warning."},"SharedId":{"type":"string","maxLength":255,"description":"A free-form field that accepts any value brands can use to create custom payouts to partners."},"SubId1-SubId3":{"type":"string","maxLength":255,"description":"Custom text fields (SubId1 through SubId3) typically used by partners to segment their traffic. Appears in brand reports."},"Text1-Text50":{"type":"string","maxLength":255,"description":"General text fields (Text1 through Text50) that accept strings of any text data you want to send. Appears in brand reports."},"UserAgent":{"type":"string","description":"User agent of the customer, used to provide device reporting."}}},"ConversionType":{"type":"string","description":"The conversion type. The only accepted value is `CLO` or `clo`\n(case-insensitive). If absent or blank it'll default to partner.\nSimilarly, unknown non-empty values will queue with a warning and\ndefault to partner.\n\nThis field is required for CLO partners. To flag a conversion as a\ncard-linked offer, include the parameter `ConversionType=CLO`.\n"}}}} ``` ## The ConversionSubmissionResponse object ```json {"openapi":"3.1.0","info":{"title":"Conversions API","version":"16"},"components":{"schemas":{"ConversionSubmissionResponse":{"type":"object","description":"Returned when a conversion event is successfully queued for processing.","properties":{"Status":{"type":"string","description":"The submission status. `QUEUED` means the conversion was accepted for processing."},"QueuedUri":{"type":"string","format":"uri-reference","description":"URI of the queued submission record. Use this to poll for processing status."},"warnings":{"type":"array","description":"Included when one or more optional field values were invalid or not\nrecognized and were ignored or defaulted instead of causing an error.\n","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field the warning applies to."},"level":{"type":"string","description":"The severity of the warning."},"message":{"type":"string","description":"A human-readable message describing the warning."}}}}}}}}} ``` ## The ConversionError object ```json {"openapi":"3.1.0","info":{"title":"Conversions API","version":"16"},"components":{"schemas":{"ConversionError":{"type":"object","description":"Returned when the conversion submission request is invalid.","properties":{"Status":{"type":"string","description":"Indicates that the request failed."},"errors":{"type":"array","description":"One or more validation errors describing what was wrong with the request.","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field that caused the error."},"level":{"type":"string","description":"The severity of the error."},"message":{"type":"string","description":"A human-readable error message."}}}}}}}}} ``` ## The AuthError object ```json {"openapi":"3.1.0","info":{"title":"Conversions API","version":"16"},"components":{"schemas":{"AuthError":{"type":"object","description":"Returned when the request could not be authenticated or is not authorized.","properties":{"status":{"type":"integer","description":"The HTTP status code."},"title":{"type":"string","description":"A short, human-readable summary of the error."}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://integrations.impact.com/partner-api-reference/reference/conversions/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.