Create Catalog Export via Plugin

Updated 2 months ago ​by nussi

Overview

In order to perform a catalog data export via plugin, you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call to the server.

Endpoint

Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/Catalog/ViaPlugin

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json

Request Model

Field Name

Type

Description

PluginProfileKey

string

The value of "Key" field from the response model after obtaining the list of available plugins for export.

PluginProfileDisplayName

string

The value of "DisplayName" field from the response model after obtaining the list of available plugins for export.

FileFormat

string

Specify file format for the exported data.

ProductIds

Array of strings

An array of product SKUs.

Response

  • If user is authenticated then response will be Status Code 200 => OK.
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error


How did we do?