Get bulk product import job by ID
curl --request GET \
--url https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}', 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/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 400400,
"message": "Resource Not Found."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Product
Get bulk product import job by ID
Retrieve details of a specific bulk import job.
Access Control:
- Requires admin permissions
Important Notes:
- Returns complete job details including processing summary
- Check summary.errorReportFileId for error details if job had failures
- Product feature must be enabled in network settings
GET
/
api
/
v1
/
products
/
bulk
/
jobs
/
{jobId}
Get bulk product import job by ID
curl --request GET \
--url https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}', 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/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 400400,
"message": "Resource Not Found."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the bulk job
Required string length:
24Pattern:
^[0-9a-fA-F]{24}$⌘I