advertiser/itemized-list/product
The itemized list product resource allows an advertiser to pull product information, insert a product within a specific itemized list, update a product, and delete a product.
GET | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
listId | Itemized list id | * 123 | N/A | Yes |
id | The id, or comma-separated list of ids, of the itemized list product(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. | * Any generic string | N/A | No |
Response Fields | ||||
Field | Description | Notes | ||
id | Itemized list product id | |||
name | Itemized list product name | |||
list_id | Itemized list id |
POST | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
N/A | ||||
Post Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The id of the product being created | * Any generic string | N/A | Yes |
name | The name given to the product being created | * Any generic string | N/A | Yes |
list_id | The id of the itemized list the product will be added to | * 123 | N/A | Yes |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
PUT | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The product id of the product being updated | * 123 | N/A | Yes |
Put Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
name | The name given to the product being updated PLEASE NOTE: This parameter is required if 'list_id' is not set |
* Any generic string | Dependant | |
list_id | The itemized list id the product will be added to PLEASE NOTE: This parameter is required if 'name' is not set |
* 123 | Dependant | |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
DELETE | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The product id of the product being deleted | * Any generic string | N/A | Yes |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
* Values shown are placeholder values. Please replace with actual data.