Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Get List of Jobs
- Get List of Files
- Download Files
- POSTCancel background jobs using job IDs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
- Webhook Events
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
- Customer Profile
- Customer Address
- Customer Self
Search jobs
Get a paginated list of jobs related to products and collections by specifying the request body. You need to specify the criteria for the search such as job id
, type
, status
, collectionId
, inputFileId
.
S2S access token (JWT) from fabric Identity service (during login)
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Request for a job search.
Sorting criteria. Sorting is supported on id
, type
, status
, completedAt
and createdAt
. -
refers to descending while +
refers to ascending order.
Search criteria to match jobs.
job id search
Operations that can be performed on a string
type
Search based on input file ID
Operations that can be performed on a string
type
Search based on job name
Operations that can be performed on a string
type
Search based on either job name or job ID
Search operation that can be performed on a string
type
Sample string schema
Search based on job type
Operations that can be performed on a string
type
Search based on job status
Operations that can be performed on a string
type
Search based on job creation time
Search operation performed on a date range
Starting range (UTC)
Ending range (UTC)
Search based on job completion Time
Search operation performed on a date range
Starting range (UTC)
Ending range (UTC)
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Authorizations
S2S access token (JWT) from fabric Identity service (during login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Body
Request for a job search.
Search criteria to match jobs.
Search based on job type
Operations that can be performed on a string
type
IN
ITEM_VARIANT_EXPORT
, ITEM_VARIANT_IMPORT
, BUNDLE_EXPORT
, BUNDLE_IMPORT
, ATTRIBUTE_IMPORT
, ATTRIBUTE_EXPORT
, CATEGORY_IMPORT
, CATEGORY_EXPORT
, COLLECTION_IMPORT
, COLLECTION_EXPORT
, ATTRIBUTE_JOB
, PRODUCT_JOB
, CATEGORY_JOB
, COLLECTION_JOB
, PRODUCT_BULK_CATEGORY_UPDATE
, PRODUCT_DENORM_JOB
Search based on job status
Sorting criteria. Sorting is supported on id
, type
, status
, completedAt
and createdAt
. -
refers to descending while +
refers to ascending order.
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Response
Details of jobs
24-character system-generated job ID
Supported job types
ITEM_VARIANT_EXPORT
, ITEM_VARIANT_IMPORT
, BUNDLE_EXPORT
, BUNDLE_IMPORT
, ATTRIBUTE_IMPORT
, ATTRIBUTE_EXPORT
, CATEGORY_IMPORT
, CATEGORY_EXPORT
, COLLECTION_IMPORT
, COLLECTION_EXPORT
, ATTRIBUTE_JOB
, PRODUCT_JOB
, CATEGORY_JOB
, COLLECTION_JOB
, PRODUCT_BULK_CATEGORY_UPDATE
, PRODUCT_DENORM_JOB
File ID that needs to be processed through the job
Time of last update to tracker (UTC)
Total number of records to be processed through the job
Total number of records to be processed
Total number of errors
Job status
SCHEDULED
, COMPLETED_PARTIALLY
, IN_PROGRESS
, COMPLETED
, FAILED
, UPDATING_SEARCH_INDEX
, CANCELLATION_IN_PROGRESS
, CANCELLED
User-friendly message corresponding to the current job status
Number of items created. Only applicable when the job type
is ITEM_VARIANT_IMPORT
.
Number of items updated. Only applicable when the job type
is ITEM_VARIANT_IMPORT
.
Number of variants created. Only applicable when the job type
is ITEM_VARIANT_IMPORT
.
Number of variants updated. Only applicable when the job type
is ITEM_VARIANT_IMPORT
.
Number of bundles created. Only applicable when the job type
is BUNDLE_IMPORT
.
Number of bundles updated. Only applicable when the job type
is BUNDLE_IMPORT
.
Number of attributes created. Only applicable when the job type
is ATTRIBUTE_IMPORT
.
Number of attributes updated. Only applicable when the job type
is ATTRIBUTE_IMPORT
.
Number of categories created. Only applicable when the job type
- CATEGORY_IMPORT
.
Number of categories updated. Only applicable when the job type
is CATEGORY_IMPORT
.
Number of collections created. Only applicable when the job type
is COLLECTION_IMPORT
.
Number of collections updated. Only applicable when the job type
is COLLECTION_IMPORT
.
Time of job creation (UTC)
Time of job completion (UTC)
Email of the user who last updated the job
Time of last update to job (UTC)
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Total number of records
Was this page helpful?