Guides
  1. Returns & Cancellations
  2. Cancellations
  3. Cancellations Data File

Implementation

File Format Requirements

Submit restatement data to CJ as a CSV file with a header row defining the fields and one row per restatement record. CJ processes the file on a scheduled basis and applies each row as an update to the corresponding order.

📋Before you start
  • Use CSV (comma-separated values) format with UTF-8 encoding.
  • The first row must be a header row listing each field name.
  • Each subsequent row must contain values that map to the header columns.
  • Pass a blank value for any optional field where data is unavailable.
  • Do not include unescaped commas, line breaks, or quotation marks inside field values — these will break the file's structure.

Example File

Cancellation Data File - Sample CSV
UTF-8 · comma-delimited · 3 sample rows
Standard e-commerce order with line items, quantities, and subtotals.
Fields - hover for details
companyId
enterpriseId
subscriptionId
actionTrackerId
orderId
updateTime
correctionReason
companyIdenterpriseIdsubscriptionIdactionTrackerIdorderIdupdateTimecorrectionReason
3982101234567398210398210IO0392-9982322026-01-02T12:00:00ZInvalidCreditCard
3982101234567398210398210IO222-12223-987212026-01-10T05:04:11ZReturnedMerchandise
3982101234567398210398210OID-97124872026-01-11T07:26:31ZCannotShip

Required Fields

Every cancellation file must include the following fields:

Click any row to see type, format, and value examples.
Parameter
Description
Required
companyId
Advertiser Company ID (CID) assigned by CJ.
Required
enterpriseId
Advertiser account number provided by CJ. Include this field when your account uses multiple enterprise IDs.
Optional
subscriptionId
The Subscription ID for the Cancellations data file, provided by CJ. Only one subscriptionId and enterpriseId combination is accepted per file.
Required
actionTrackerId
The CJ-assigned Action Tracker ID for the commissionable sale or lead.
Required
orderId
Advertiser-supplied Order ID identifying the transaction. Maximum 96 alphanumeric characters.
Required
updateTime
The timestamp of the cancellation event. Must use ISO 8601 format. Future dates are not accepted.
Required
Type: StringFormat: ISO 8601: yyyy-mm-ddThh:mm:ss±hh:mm or Z for UTC
Examples
2025-06-18T14:00:00Z
2025-06-18T12:13:14-05:00
2025-06-18
Note: Future dates are rejected. Use the current date or a past date only.
correctionReason
The reason for cancelling the order. Optional but recommended for accurate reporting and compliance.
Optional
Type: String
Allowed Values
Credit card declined or invalidInvalidCreditCard
Lead did not meet qualification criteriaUnqualifiedLead
Item out of stock at time of orderCannotShipSoldOut
Same order submitted more than onceDuplicateOrder
Customer returned the itemReturnedMerchandise
Any reason not listed aboveOther

Status Fields

🚧

Only include this field if your program uses the Open-Ended Lifecycle solution (typical for travel and extended booking programs). Standard restatements should not include this field — passing a status value on a non Open-Ended Lifecycle program will cause an error.

Click any row to see type, format, and value examples.
Parameter
Description
Required
status
Required for orders with open-ended locking (Pending Actions). Do not include this field if your orders do not use open-ended locking. Note: Declined status is not valid in restatements — use Order Cancellations files instead.
Conditionally Required
Type: String
Allowed Values
Pending
Accepted
Note: Only include this field when restating orders that use open-ended locking.

Updated 11 days ago