Create bulk product import job
curl --request POST \
--url https://apix.us.amity.co/api/v1/products/bulk/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fileId": "file-abc123xyz"
}
'import requests
url = "https://apix.us.amity.co/api/v1/products/bulk/jobs"
payload = { "fileId": "file-abc123xyz" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fileId: 'file-abc123xyz'})
};
fetch('https://apix.us.amity.co/api/v1/products/bulk/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v1/products/bulk/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fileId' => 'file-abc123xyz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/products/bulk/jobs"
payload := strings.NewReader("{\n \"fileId\": \"file-abc123xyz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v1/products/bulk/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fileId\": \"file-abc123xyz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/products/bulk/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileId\": \"file-abc123xyz\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"_id": "64a1b2c3d4e5f6g7h8i9j0k1",
"jobId": "64a1b2c3d4e5f6g7h8i9j0k1",
"networkId": "network-abc123",
"userId": "user-xyz789",
"fileId": "file-123456",
"status": "pending",
"entityType": "product",
"operation": "insert",
"summary": {
"totalRows": 100,
"processedRows": 100,
"successfulRows": 95,
"failedRows": 5,
"errorReportFileId": "file-error-report-123",
"metadata": {},
"processingStartedAt": "2024-01-15T10:30:30.000Z",
"processingCompletedAt": "2024-01-15T10:35:30.000Z",
"processingDurationMs": 300000
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z",
"expiredAt": "2024-01-18T10:30:00.000Z"
}
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Product
Create bulk product import job
Create a new bulk job to import products from a CSV file.
Access Control:
- Requires admin permissions with ManageProducts flag
Important Notes:
- CSV file must be uploaded first using the file upload API
- Job will be created in ‘pending’ status
- Use the start endpoint to begin processing
- Job expires in 3 days if not started
- Product feature must be enabled in network settings
POST
/
api
/
v1
/
products
/
bulk
/
jobs
Create bulk product import job
curl --request POST \
--url https://apix.us.amity.co/api/v1/products/bulk/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fileId": "file-abc123xyz"
}
'import requests
url = "https://apix.us.amity.co/api/v1/products/bulk/jobs"
payload = { "fileId": "file-abc123xyz" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fileId: 'file-abc123xyz'})
};
fetch('https://apix.us.amity.co/api/v1/products/bulk/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v1/products/bulk/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fileId' => 'file-abc123xyz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/products/bulk/jobs"
payload := strings.NewReader("{\n \"fileId\": \"file-abc123xyz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v1/products/bulk/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fileId\": \"file-abc123xyz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/products/bulk/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fileId\": \"file-abc123xyz\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"_id": "64a1b2c3d4e5f6g7h8i9j0k1",
"jobId": "64a1b2c3d4e5f6g7h8i9j0k1",
"networkId": "network-abc123",
"userId": "user-xyz789",
"fileId": "file-123456",
"status": "pending",
"entityType": "product",
"operation": "insert",
"summary": {
"totalRows": 100,
"processedRows": 100,
"successfulRows": 95,
"failedRows": 5,
"errorReportFileId": "file-error-report-123",
"metadata": {},
"processingStartedAt": "2024-01-15T10:30:30.000Z",
"processingCompletedAt": "2024-01-15T10:35:30.000Z",
"processingDurationMs": 300000
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z",
"expiredAt": "2024-01-18T10:30:00.000Z"
}
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
ID of the uploaded CSV file containing product data
Maximum string length:
100Example:
"file-abc123xyz"
⌘I