Create import

POST

/merchants/{merchantCode}/imports

curl --request POST \
  --url https://import.shopgate.io/v1/merchants/example/imports \
  --header 'Content-Type: application/json' \
  --data '{ "source": "example" }'

Create a new import

Parameters

Path Parameters

merchantCode

required

string

Request Body

Media typeapplication/json

object

source

string

<= 255 characters

Example^generated

{
  "source": "example"
}

Responses

201

Import created

Media typeapplication/json

object

ref

string

Example

{
  "ref": "87eff434-4f89-4d83-a8c6-117e10817034"
}

400

Validation error

Media typeapplication/json

object

errors

Array<object>

object

code

required

Machine readable error code

string

Allowed values: INVALID_TOKEN ALREADY_CONNECTED

field

required

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

string

message

required

Human readable error code

string

value

The value, that was sent, like “xxx”

string

Example

{
  "errors": [
    {
      "code": "INVALID_TOKEN"
    }
  ]
}

403

Forbidden error

Media typeapplication/json

object

code

required

string

message

required

string

Example

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