Get imports

GET

/merchants/{merchantCode}/imports

curl --request GET \
  --url 'https://import.shopgate.io/v1/merchants/example/imports?limit=100&offset=0'

Get all imports

Parameters

Path Parameters

merchantCode

required

string

Query Parameters

filters

string

Filter string. Supported filters: ref, status

limit

integer

default: 100

The limit of entries of one page

offset

integer

0

The offset where to start the page

sort

string

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

Responses

200

List of imports

Media typeapplication/json

object

imports

Array<object>

object

createDate

string

endDate

string

entityFiles

Array<object>

object

context

string | null

created

required

object

dispatched

integer

failed

integer

succeeded

integer

deleted

required

object

dispatched

integer

failed

integer

succeeded

integer

entity

required

string

importStrategy

string

default: full

Allowed values: full partial

scopes

string

skipped

integer

total

integer

updated

required

object

dispatched

integer

failed

integer

succeeded

integer

ref

string

scriptFinishDate

string

source

string

startDate

string

status

string

Allowed values: new started processing finished aborted

meta

object

limit

number

offset

number

totalItemCount

number

Example

{
  "imports": [
    {
      "createDate": "2021-02-09T17:59:37.803Z",
      "endDate": "2021-02-09T17:59:37.803Z",
      "entityFiles": [
        {
          "context": "catalog1",
          "created": {
            "dispatched": 3,
            "failed": 3,
            "succeeded": 3
          },
          "deleted": {
            "dispatched": 3,
            "failed": 3,
            "succeeded": 3
          },
          "entity": "product",
          "importStrategy": "full",
          "scopes": null,
          "skipped": 1,
          "total": 10,
          "updated": {
            "dispatched": 3,
            "failed": 3,
            "succeeded": 3
          }
        }
      ],
      "ref": "87eff434-4f89-4d83-a8c6-117e10817034",
      "scriptFinishDate": "2021-02-09T17:59:37.803Z",
      "source": "aName",
      "startDate": "2021-02-09T17:59:37.803Z",
      "status": "finished"
    }
  ],
  "meta": {
    "limit": 10,
    "offset": 0,
    "totalItemCount": 1
  }
}

400

Validation error

Media typeapplication/json

object

code

string

error

object

code

Machine readable error code

string

Allowed values: SCHEMA_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 UNKNOWN_FORMAT PATTERN

message

required

Human readable error code

string

paramName

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

string

paramValue

The value, that was sent, like “xxx”

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 UNKNOWN_FORMAT PATTERN

description

string

message

Human readable error code

string

path

Array<string>

warnings

array

message

string

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "ENUM_MISMATCH",
          "description": "human readable error code"
        }
      ]
    }
  }
}

403

Forbidden error

Media typeapplication/json

object

code

required

string

message

required

string

Example

{
  "code": "Forbidden",
  "message": "No access to merchant 1"
}