xclade
Admin APIProducts

Create Product Import

Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/imports` API route.

POST
/admin/products/imports
AuthorizationBearer <token>

In: header

Request Body

application/json

file_key*string

The name of the file as stored in the configured File Module Provider.

originalname*string

The file's original name.

extension*string

The file's extension.

size*number

The file's size in bytes.

mime_type*string

The file's mime type.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X POST "https://{tenant}.api.myxclade.com/admin/products/imports" \  -H "Content-Type: application/json" \  -d '{    "file_key": "string",    "originalname": "string",    "extension": "csv",    "size": 0,    "mime_type": "text/csv"  }'
{
  "transaction_id": "string",
  "summary": {
    "toCreate": 0,
    "toUpdate": 0
  }
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}