Implementation

This page covers how to build and submit an item list data file to CJ. Follow each step in order.


πŸ“‹Before You Implement
  • You have read the Overview page and understand the difference between the OVERWRITE and UPDATE processtype values.
  • At least one item list has been created in CJ Account Manager. The CJ-assigned List ID for each list is required in every body record.
  • You have an active item list data transfer subscription. Contact your CJ account representative to obtain your Subscription ID (SUBID).
  • Do not include characters that break your chosen file format (commas in CSV, tabs in tab-delimited, pipes in any format).
  • The processtype you specify in the header applies to every list referenced in the file. Do not mix OVERWRITE and UPDATE intent in a single file submission.

Step 1: Create Your Item Lists in CJ Account Manager

Before submitting a data file, you must create your item lists in CJ Account Manager. Log in and navigate to the Item Lists area of your account. Create a list for each grouping of items that will share a commission rate. CJ assigns a numeric List ID to each list at creation time. Record these List IDs. You will include the appropriate listid value in each body record of your data file to assign items to the correct list.


Step 2: Obtain Your Subscription ID

Your item list data transfer subscription is separate from other data transfer subscriptions in your account. Contact your CJ account representative if you have not yet set one up. CJ will provide a numeric Subscription ID (SUBID) that must appear in the header of every file you submit.


Step 3: Determine Your Process Type

Before building your file, decide whether this submission should overwrite or update your existing item list data:

  • Use OVERWRITE for your first file submission to a list, or any time you want to fully replace a list's contents. Items in the list that are not present in the file will be removed.
  • Use UPDATE for subsequent submissions where you are adding new items, changing item names, or adjusting a subset of a list. Existing items not referenced in the file are preserved.

The processtype value you set in the header applies to all lists referenced in the file. If your file touches multiple lists, confirm that the same processtype is appropriate for all of them before submitting.


Step 4: Build Your Data File Header

Every item list data file begins with a header that identifies your account and defines how the file should be processed.

Parameter
Description
Required
cid
Your advertiser account number with CJ.
Required
subid
Your subscription ID for item list data transfers, provided by CJ.
Required
processtype
Declares how the file should be processed against existing item list data. OVERWRITE replaces all existing items in every list referenced by the file with the contents of this submission. UPDATE adds or modifies only the items present in this file, leaving all other existing items unchanged. Applies to all lists referenced in the file. If omitted, the system applies the default processing behavior.
Optional
encoding
The character encoding of your file. Required only when using a non-default encoding. The default is CP1252 (Microsoft Codepage 1252).
Conditional

Step 5: Build Your Item Records

Each record in the body assigns one item to an item list. All three fields are required in every record, and they must appear in the order shown. Records must not be continued across multiple lines.

Parameter
Description
Required
itemname
The advertiser-assigned display name for the item. You can update the name of an existing item by submitting its existing itemid and listid with a new itemname value.
Required
itemid
The advertiser-assigned identifier for the item. This value is case-sensitive and must exactly match the value as entered in the Item Lists area of CJ Account Manager. Cannot contain spaces or any of the following characters: & = ; ? > <
Required
listid
The CJ-assigned ID for the item list this item belongs to. Generated when you create an item list in CJ Account Manager. A single data file can reference multiple item lists by using different listid values across records. The processtype in the header applies to all lists referenced in the file.
Required

Step 6: Format and Structure Your File

Header format for delimited files

For all delimited formats, header field names must be prefixed with &:

&CID=2532539845
&SUBID=123
&PROCESSTYPE=UPDATE

Full CSV file example

The following example adds three items across two item lists in a single UPDATE submission:

&CID=2532539845
&SUBID=123
&PROCESSTYPE=UPDATE
Polo Shirt,SKU-POLO-001,210
T-Shirt,SKU-TEE-002,210
Fleece Jacket,SKU-FLC-003,215

In this example, the first two records are assigned to list 210 and the third to list 215. Because the processtype is UPDATE, any items already in lists 210 and 215 that are not included in this file are preserved.

Format rules

  • Each item record must appear on a single line. Line breaks within a record are not permitted.
  • No control characters or extra spaces may appear in field values.
  • Header and body lines must not end in trailing whitespace, commas, or pipes.
  • For CSV files exported from Excel, open the resulting file in a text editor and remove any trailing commas Excel adds to header lines before submitting. Files with malformed headers will not generate a Receipt email from CJ.
  • Do not include the delimiter character within any field value.

Step 7: Submit Your File to CJ

Transfer your file to CJ using the delivery method specified in your item list data transfer subscription. After CJ receives the file, you will receive a Receipt email confirming it was accepted for processing. After processing completes, a Results email details the outcome of each record.

See the Testing page for guidance on interpreting these emails and resolving errors.


What’s Next