Managing Merchandising Sections

Campaign

GET api/v11/campaign

• Retrieves all campaigns

GET api/v11/campaign/{id}

• Retrieves a specific campaign by its id
• Parameters
  • id: Id of campaign to fetch (FromUri)

GET api/v11/campaign/{guid}

• Retrieves a specific campaign by its guid
• Parameters
  • guid: Id of campaign to fetch (FromUri)

POST api/v11/campaign

• Adds a valid campaign to the system
• Parameters
  • campaign: Campaign entity (FromBody)

PUT api/v11/campaign/{id}

• Updates a campaign
• Parameters
  • id: Id of the campaign to update (FromUri)
  • campaign: Campaign entity (FromBody)

PUT api/v11/campaign/{guid}

• Updates a campaign
• Parameters
  • guid: Id of the campaign to update (FromUri)
  • campaign: Campaign entity (FromBody)

DELETE api/v11/campaign/{id}

• Deletes a campaign
• Parameters
  • id: Id of campaign to delete (FromUri)

DELETE api/v11/campaign/{guid}

• Deletes a campaign
• Parameters
  • guid: Id of campaign to delete (FromUri)

Redirect

GET api/v11/redirect

• Gets all redirects in the system

GET api/v11/redirect/{id}

• Gets a single redirect by its id
• Parameters
  • id: Id of a redirect (FromUri)

POST api/v11/redirect

• Adds a redirect to the system
• Parameters
  • redirect: A redirect entity (FromBody)

PUT api/v11/redirect/{id}

• Updates a redirect
• Parameters
  • id: Id of a redirect to update (FromUri)
  • redirect: A redirect entity with updated properties (FromBody)

DELETE api/v11/redirect/{id}

• Deletes a redirect
• Parameters
  • id: Id of a redirect to delete (FromUri)

Sitemap

GET api/v11/sitemap/url

• Gets url to latest generated sitemap

Visitor Target

GET api/v11/visitortarget

• Gets all Visitor Targets

GET api/v11/visitortarget/{id}

• Gets a single Visitor Target by its id
• Parameters
  • id: Id of Visitor Target (FromUri)

GET api/v11/visitortarget/{guid}

• Gets a single Visitor Target by its guid
• Parameters
  • guid: Id of Visitor Target (FromUri)

POST api/v11/visitortarget

• Adds a new Visitor Target
• Parameters
  • target: A Visitor Target entity to add (FromBody)

PUT api/v11/visitortarget/{id}

• Updates a Visitor Target
• Parameters
  • id: Id of Visitor Target to update (FromUri)
  • target: Visitor target entity to update (FromBody)

PUT api/v11/visitortarget/{guid}

• Updates a Visitor Target
• Parameters
  • guid: Id of Visitor Target to update (FromUri)
  • target: Visitor target entity to update (FromBody)

DELETE api/v11/visitortarget/{id}

• Deletes a Visitor Target
• Parameters
  • id: Id of Visitor Target (FromUri)

DELETE api/v11/visitortarget/{guid}

• Deletes a Visitor Target
• Parameters
  • guid: Id of Visitor Target (FromUri)

Visibility Rules

GET api/v11/visibility

• Gets all visibility rules in the system

GET api/v11/visibility/{id}

• Gets a single visibility rule by its id
• Parameters
  • id: Id of a rule (FromUri)

GET api/v11/visibility/{guid}

• Gets a single visibility rule by its guid
• Parameters
  • guid: Id of a rule (FromUri)

POST api/v11/visibility

• Adds a visibility rule to the system
• Parameters
  • rule: A rule entity (FromBody)

PUT api/v11/visibility/{id}

• Updates a visibility rule
• Parameters
  • id: Id of a rule to update (FromUri)
  • rule: A visibility rule entity with updated properties (FromBody)

PUT api/v11/visibility/{guid}

• Updates a rule
• Parameters
  • guid: Id of a visibility rule to update (FromUri)
  • rule: A rule entity with updated properties (FromBody)

DELETE api/v11/visibility/{id}

• Deletes a visibility rule
• Parameters
  • id: Id of a rule to delete (FromUri)

DELETE api/v11/visibility/{guid}

• Deletes a visibility rule
• Parameters
  • guid: Id of a rule to delete (FromUri)