Export entities as csv

POST

/merchants/{merchantCode}/exportCsv

curl --request POST \
  --url https://catalog.shopgate.io/v1/merchants/example/exportCsv \
  --header 'Content-Type: application/json' \
  --data '{ "entity": "product", "withHeader": true, "delimiter": ",", "enclosure": "\"", "escape": "\"" }'

Export entities as csv

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Query Parameters

catalogCode

string

<= 255 characters

Request Body

Media typeapplication/json

object

entity

required

string

Allowed values: product category

Example

product

withHeader

Whether the CSV file contains a header line with column headers. Defaults to true.

boolean

Example

true

delimiter

The delimiter between columns in the file. Defaults to “,”.

string

Example

,

enclosure

The enclosure around values in the CSV file. Defaults to double-quotes (“”“).

string

Example

"

escape

The escape character within values. Defaults to double-quotes (“”“).

string

Example

"

Example

{
  "entity": "product",
  "withHeader": true,
  "delimiter": ",",
  "enclosure": "\"",
  "escape": "\""
}

Responses

202

Export request accepted.

Media typeapplication/json

400

Bad request (mostly missing or invalid parameters/values)

Media typeapplication/json

object

statusCode

number

message

string

code

string

additionalInfo

object

validationErrors

Array<object>

object

code

number

reason

string

entity

string

entityId

string

subentityPath

Array<string | number>

error

object

paramName

The parameter-field, that failed to validate, like “userId”

string

paramValue

The value, that was sent, like “xxx”

null | string | number | array | object

code

Machine readable error code

string

Allowed values: SCHEMA_VALIDATION_FAILED VALIDATION_FAILED ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

required

Human readable error code

string

results

object

errors

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_CREDENTIALS INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

warnings

array

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "MAX_LENGTH",
          "message": "Name too long",
          "description": "Property Name is too long",
          "path": [
            "name"
          ]
        }
      ]
    }
  }
}

404

Merchant not found

Media typeapplication/json

object

statusCode

number

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}