Introduction

This document describes the Sellside API to place ads.

The API is designed as a RESTful API supporting JSON as data formats. Authentication is provided va OAuth2 to allow simple integration with existing client libraries.

Help / Feedback

If you have questions or would like to provide feedback, you can do so via our Slack channel. Please talk to your contact at the tenant (local marketplace) to get access, this is an invite-only chat channel. This channel is highly interactive, and contains several of our developers as well so deeper technical support can also be found here. Notifications about maintenance will also go through this channel.

Contents

• Overview
  • Authentication
  • Media Types
  • Content-Type and Accept Headers
  • Image Downloads
  • Feed Downloads
  • Customize response body
  • Dates and Times
  • Prices and Currencies
  • HTTP Response Codes and Error Handling
  • Dry-Run Request Validation
  • Vendor Ids
  • Page tokens
• Authentication
  • What is OAuth 2.0
  • OAuth 2.0 Roles
  • OAuth 2.0 Endpoints
  • Getting an Access Token
  • Using an Access Token
  • Getting another Access Token
  • Refresh Tokens and Token Expiration
  • Scopes
• Advertisements
  • Fields
  • Images
• Campaigns
  • Fields
• Categories
  • Category Ids
  • Category Levels
  • Category Status
  • Category Configuration
  • Intervals
  • Locales
  • Price Types
  • Data Model
  • Non-Leaf Categories
  • Leaf Categories
  • Attribute Groups
  • Attributes
  • Attribute Rendering
• Attributes
  • Category Attributes
  • User-Defined Attributes
• Regions
  • Region Ids
  • Region Levels
  • Region label
  • Region center
  • Data Model
  • Non-Leaf Regions
  • Leaf Regions
• Feeds
  • File Format
  • Errors
  • Frequently Asked Questions
• Feed Fields
  • vendor id
  • external id
  • seller name
  • title
  • description
  • category id
  • status
  • url
  • vanity url
  • price type
  • price
  • original price
  • item images
  • attributes
  • budget details
  • shipping & pick-up
  • phone number
  • email advertiser
  • region id
  • micro tip
  • MPN
  • google product category
  • product type
  • brand
  • GTIN
  • item group id
  • condition
  • material
  • energy efficiency class
  • min energy efficiency class
  • max energy efficiency class
  • color
  • gender
  • age group
  • size
  • unit pricing base measure
  • unit pricing measure
• Reporting
  • Dimensions and Metrics
  • Time Ranges
  • Time Aggregation
  • Filters
  • Sorting
  • Pagination with offset and limit
  • Enrichment
  • Query and Response
  • Examples
  • Errors
• Error Handling
• OpenAPI reference
• Release Notes
  • September 2024: ‘Deprecated handler clean up’
  • Feb 2023: ‘Campaigns & Micros’
• Migration Guide
  • Key changes and benefits of migrating
  • Step by step guide
  • Campaigns
  • FAQ
• References
  • Ad Status
  • Campaign Status
  • Error Codes
  • Price Types

History

• v.0.129 - 6 Nov 2023 - tw

  • added GET /ad/count and GET /ad/histogram to openApi docs

• v.0.128 - 17 Oct 2023 - tw

  • added multi-campaign documentation, only available for Kleinanzeigen now though.

  • extra explanation on the ‘vendorId’ concept

  • extra explanation on _include and _exclude

  • fixes on some examples

  • added vendorId, title and isDefault to campaign V5 struct

  • more explanation on usage of pageToken

  • added some error codes

• v.0.127 - 9 May 2023 - pm

  • improved Feeds docs

  • added separate Feed Fields page

  • added collapse feature to docs engine

  • added campaignID to supported dimension in reporting Reporting

  • added error too many ads in the category to PUT /ad/{id} v5

• v.0.126 - 26 Apr 2023 - tw

  • improved GET /ad docs

  • added explanation about nextPageToken

  • added information about small difference in workings of _include and _exclude

• v 0.126 - 2 Mar 2023 - pm

  • Improved XML feed description. Added “Fields” section with currently supported, and newly introduced (industry-accepted) fields in Feeds section.

• v 0.125 - 26 Feb 2023 - dr

  • Added empty XML file generator API that guarantees a unique file name per download. This avoid the clash of previously pointing to a single hosted empty file. The download button has also been added in the Feeds section.

• v.0.124 - 3 Jan 2023 - tw

  • Added ad V5 related endpoints

  • Added campaign related endpoints

  • removed GET /ad/ids docs as it’s already gone

  • moved deprecation plan into Release Notes

Indices and tables

• Index

• Search Page