Get signed url

POST

/merchants/{merchantCode}/imports/{importRef}/urls

const url = 'https://import.shopgate.io/v1/merchants/example/imports/example/urls';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"catalogCode":"example","entity":"product","importStrategy":"full","locationCodes":["example"],"operation":"upload"}'
};

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

curl --request POST \
  --url https://import.shopgate.io/v1/merchants/example/imports/example/urls \
  --header 'Content-Type: application/json' \
  --data '{ "catalogCode": "example", "entity": "product", "importStrategy": "full", "locationCodes": [ "example" ], "operation": "upload" }'

Get a signed URL for file

Parameters

Path Parameters

merchantCode

required

string

importRef

required

string

Request Body

application/json

object

catalogCode

Required for product and category entity as they are sub entities of a catalog

string

entity

required

string

Allowed values: product category attribute inventory customer segment segmentMember

importStrategy

string

default: full

Allowed values: full partial

locationCodes

Optional for an inventory import with strategy ‘full’. It performs a full import only for the given locations.

Array<string>

operation

string

default: upload

Allowed values: upload download

Responses

201

New URL created

application/json

object

url

string

Example

{
  "url": "https://some.url"
}

403

Forbidden error

application/json

object

code

required

string

message

required

string

Example

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