Breadcrumbs

How to build a Shopping API or Reporting API request?

Request builders :

It makes your life as an integrator easier.

It helps you test the API within your browser without developing any code.

The request builder is built with Swagger and OpenAPI specification (more details).

Usage

The Request Builder lists all available APIs with their URI, parameters and response types.

And it lets you play with the API by filling the different parameters in a form and building the request for you.

Authentication

You can set up your credentials:

  • either by clicking the padlock icon at the right of an operation title: if the padlock is closed it means the credentials are already set

padlock_button
  • or by clicking on the Authorize button in the top right corner of the page,

authorize_button

JWT

In the appearing dialog, if the operation you want to try needs JWT authentication, you need to fill the JWT that you have generated by yourself on the Publisher Center.

credentials_forms

See details on JWT

Building a request

Open the endpoint you need, click on Try it out and fill the required fields.

parameters_form

Then click on Execute. The query is built, authenticated and executed for you.

You can see the response just below (or in your browser downloads menu in case of offers feeds).

parameters_form