Resource Center

Itemized List Resource

advertiser/itemized-list

 

The itemized list resource allows an advertiser to pull itemized list information, create a new itemized list, update a specific itemized list, and delete a specific itemized list.
 

GET
Request Parameters
Parameter Description Possible Values Default Required?
id The id, or comma-separated list of ids, of the itemized list(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned. * 987 OR 123,456,789 N/A No
name The name, or comma-separated list of names, to filter itemized lists by * Any generic string N/A No
Response Fields
Field Description Notes
id Itemized list id  
name Itemized list name  
default Whether the itemized list is the default or not  
product_count How many products are in the itemized list  

 

POST
Request Parameters
Parameter Description Possible Values Default Required?
N/A
Post Parameters
Parameter Description Possible Values Default Required?
name The name given to the itemized list being created * Any generic string N/A Yes
Response Fields
Field Description Notes
N/A

 

PUT
Request Parameters
Parameter Description Possible Values Default Required?
id The id of the itemized list being updated * 123 N/A Yes
Put Parameters
Parameter Description Possible Values Default Required?
name The name given to the itemized list being updated

PLEASE NOTE: 
This parameter is required if 'set_default' is not set
* Any generic string   Dependant
set_default Sets the itemized list being updated as the default

PLEASE NOTE: 
This parameter is required if 'name' is not set
1,true   Dependant
Response Fields
Field Description Notes
N/A

 

DELETE
Request Parameters
Parameter Description Possible Values Default Required?
id The itemized list id being deleted * 123 N/A Yes
Response Fields
Field Description Notes
N/A
 


* Values shown are placeholder values. Please replace with actual data.