Get exports

GET

/merchants/{merchantCode}/exports

const url = 'https://catalog.shopgate.io/v1/merchants/example/exports?limit=1000&offset=0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://catalog.shopgate.io/v1/merchants/example/exports?limit=1000&offset=0'

Returns a list of Google exports

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Query Parameters

catalogCode

string

<= 255 characters

filters

string format: json

Filter string. Supported filters:

id
feed
status

limit

integer

default: 1000 >= 1 <= 1000

The limit of entries of one page

offset

integer

The offset where to start the page

sort

string

Sorting of the products (sequenceId only works with filter catalogCode)

Responses

200

Export created.

application/json

object

meta

object

limit

number

offset

number

totalItemCount

number

exports

Array

object

feed

string

Allowed values: product inventory pickupLinkSubfeed

status

string

Allowed values: processing succeeded failed

entityCount

number

errorMessage

null | string

startDate

string format: date-time

endDate

null | string format: date-time

Example

{
  "meta": {
    "limit": 10,
    "offset": 0,
    "totalItemCount": 2
  },
  "exports": [
    {
      "endDate": "2018-12-15T00:00:26.114Z",
      "entityCount": 74327,
      "errorMessage": null,
      "feed": "product",
      "startDate": "2018-12-15T00:00:25.114Z",
      "status": "succeded"
    },
    {
      "endDate": "2018-12-15T00:00:24.114Z",
      "entityCount": 10,
      "errorMessage": "Upload failed",
      "feed": "product",
      "startDate": "2018-12-15T00:00:23.114Z",
      "status": "failed"
    }
  ]
}

400

Bad request (mostly missing or invalid parameters/values)

application/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 or segment not found

application/json