Sub-resources of campaing-products

All available sub-resources of the resource campaign-products.

Get a campaign product store records

Get information about all campaign products store records.
[badge-blue GET] /campaign-products/{campaign_product_id}/campaign-product-store-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
campaign_product_id string The unique id of the Campaign product Yes

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
campaign_product_store_records CampaignProductStoreRecord[] List of the campaign product store records
total_items integer Count of all found campaign product store records


Add a store to the campaign product

Add one of the stores to a campaign product
[badge-green POST] /campaign-products/{campaign_product_id}/campaign-product-store-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
campaign_product_id string The unique id of the campaign product Yes

Request

Parameter name Type Description Mandatory (Yes/No)
campaign_product_store_record CamapignProductStoreRecord Campaign product store record Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
campaing_product_store_record_id string The unique id of the campaign product store record