KEkevel

Create Ingest URL

post/v1/itemdb/ingest-url

Request

  • Base URL
    https://api.kevel.co
  • URL
    https://api.kevel.co/v1/itemdb/ingest-url
  • Auth
    API key in header X-Adzerk-ApiKey

Request body

folderstring required

The folder the file is uploaded to. Use the folder your Kevel account team set up for your network. When using with Kevel Catalog, this is generally products or categories, and can end in the table ID, such as products-103. The maximum length is 50 characters, and spaces and / are replaced with hyphens.

filenamestring required

The name of the file that will be uploaded to the returned URL. This must include a file type extension (eg products.ndjson.gz). Use a .gz extension only when your Kevel account team has enabled compression for your network. The maximum length is 50 characters, and spaces and / are replaced with hyphens. Note: Kevel will automatically prepend a datetime string to the provided file name.

Response

200

urlstring

The signed URL to upload your file to with an HTTP PUT. It expires after 1 hour.

statusstring

The URL to request the status of this upload. See Ingest Status.

Example response

{
  "url": "https://kevel-prod-itemdb-ingest-default.s3.amazonaws.com/99999/products/incoming/2024-04-12T20%3A02%3A18.425674978-products.ndjson?x-amz-security-token=xxx&AWSAccessKeyId=xxx&Expires=1712955738&Signature=xxx",
  "status": "https://api.kevel.co/v1/itemdb/ingest-status?folder=products&file=2024-04-12T20%3A02%3A18.425674978-products.ndjson"
}

Changes

No recorded changes to this operation across all 1 revision of this API.