Total: 473
Tasks/Crons: 117
Private: 289
Public: 67
Tasks/Crons/Deferred (117)
BackupAdjustmentRecords
TASK
/tasks/backup/adjustment-records
POST
Backup AdjustmentRecord entities to GCS with cursor-based pagination
Parameters
UUID: Unique identifier for grouping temp files (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
BackupInventoryAuditResults
TASK
/tasks/backup/inventory-audit-results
POST
Backup InventoryAuditResult entities to GCS with cursor-based pagination
Parameters
UUID: Unique identifier for grouping temp files (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
BackupInventoryStatusBlocks
TASK
/tasks/backup/inventory-status-blocks
POST
Coordinator task that spawns backup tasks for each active SKU
Parameters
UUID: Unique identifier for this backup run (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
BackupInventoryStatusBlocksBySku
TASK
/tasks/backup/inventory-status-blocks/sku
POST
Backup inventory status blocks for a specific SKU to GCS
Parameters
* SkuKey: Urlsafe NDB key of ProductSku (query parameter, not JSON)
BackupProductAttributeOptions
TASK
/tasks/backup/product-attribute-options
POST
Backup ProductAttributeOption entities to GCS
BackupProductAttributes
TASK
/tasks/backup/product-attributes
POST
Backup ProductAttribute entities to GCS
BackupProductListings
TASK
/tasks/backup/product-listings
POST
Backup ProductListing entities to GCS with cursor-based pagination
Parameters
UUID: Unique identifier for grouping temp files (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
BackupProductSkus
TASK
/tasks/backup/product-skus
POST
Backup ProductSku entities to GCS with cursor-based pagination
Parameters
UUID: Unique identifier for grouping temp files (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
BackupStorageLocations
TASK
/tasks/backup/storage-locations
POST
Backup StorageLocation entities to GCS
BackupSuppliers
TASK
/tasks/backup/suppliers
POST
Backup Supplier entities to GCS
BackupWarehouseLocations
TASK
/tasks/backup/warehouse-locations
POST
Backup WareHouseLocation entities to GCS with cursor-based pagination
Parameters
UUID: Unique identifier for grouping temp files (generated if not provided)
Cursor: NDB cursor for pagination (urlsafe string)
Counter: Current batch number (default 0)
CombineAutocompleteFilesHandler
TASK
/tasks/autocomplete/combine-files
POST
Internal endpoint to combine temp autocomplete files into final destinations
Parameters
* UUID: UUID for grouping temp files
* Counter: Total number of batches (temp files to combine)
* Type: Type of autocomplete file (sku or listing)
* FinalPaths: List of final destination paths
* FileDirectory: Environment file directory (test or prod)
Metadata: GCS metadata to apply to final files
CronBackup
TASK
/cron/backup
GET
Trigger backups of all important entities
CronCalculateInventoryMismatchReport
TASK
/cron/calculate-inventory-mismatch-report
GET
[DEPRECATED] Trigger inventory mismatch report generation
CronCombineSupplierAvailabilityJSONFiles
TASK
/cron/combine-supplier-availability-json-files
GET
[DEPRECATED] Trigger combining of supplier availability JSON files
CronCombineSupplierJSONFiles
TASK
/cron/combine-supplier-json-files
GET
Trigger combining of supplier JSON files
CronCreateOutOfStockReport
TASK
/cron/create-out-of-stock-report
GET
Trigger out of stock report generation
CronCreateSupplierAvailabilityJSONFiles
TASK
/cron/create-supplier-availability-json-files
GETPOST
[DEPRECATED] Trigger supplier availability JSON file creation for all active SKUs
CronCreateSupplierJSONFiles
TASK
/cron/create-supplier-json-files
GET
Trigger supplier JSON file creation for all suppliers
CronDropExpiredCounts
TASK
/cron/drop-expired-counts
GET
Trigger dropping of expired inventory counts
CronGenerateAutocompleteFiles
TASK
/cron/generate-autocomplete-files
GET
Trigger autocomplete file generation for SKUs and Listings
CronGenerateDailyInventoryBlocks
TASK
/cron/generate-daily-inventory-blocks
GETPOST
Trigger daily inventory block generation for all active SKUs
CronGenerateInventoryRMAAssignedToRestockReport
TASK
/cron/get-rma-assigned-to-restock-report
GETPOST
[DEPRECATED] Cron trigger for RMA restock report
CronGenerateInventoryReports
TASK
/cron/generate-inventory-reports
POST
Cron handler to trigger daily inventory report generation
CronGenerateListingDataFile
TASK
/cron/generate-listing-data-file
GET
Trigger listing data file generation
CronGenerateProductFeeds
TASK
/cron/generate-product-feeds
GETPOST
Trigger product feed generation (in-stock and out-of-stock)
CronGenerateSkuDataFile
TASK
/cron/generate-sku-data-file
GET
Trigger SKU data file generation (with throttling for non-daily runs)
CronGenerateSupplierDataFile
TASK
/cron/generate-supplier-data-file
GET
Trigger supplier data file generation
CronKickoffAdjustmentRecordValidations
TASK
/cron/kickoff-adjustment-record-validations
GET
Trigger adjustment record validations
CronProcessInventoryAuditEmails
TASK
/cron/process-inventory-audit-emails
GET
Trigger sending of physical audit batch emails
CronProductEventsSummary
TASK
/cron/product-events-summary
GET
Trigger product events summary email
CronResetOnSaleFlagRetiredSkus
TASK
/cron/reset-on-sale-flag-retired-skus
GET
Reset IsOnSale flag on retired SKUs with no inventory
CronSetSkuSalesIndex
TASK
/cron/set-sku-sales-index
GET
Fetch and set sales index data for all SKUs
CronSweepInventoryAuditResults
TASK
/cron/sweep-inventory-audit-results
GET
Trigger inventory audit results sweep
CronSyncAllProducts
TASK
/cron/sync-all-products
GET
[DEPRECATED] Trigger product sync from external CMS
CronTestHandler
TASK
/cron/test
GETPOST
Test cron job endpoint
CronTransferRmaAssignedToRestock
TASK
/cron/transfer-rma-assigned-to-restock
GET
[DEPRECATED] Transfer RMA inventory to available status
CronUpdateIsOnClearanceSkus
TASK
/cron/update-is-on-clearance-skus
GET
Decrement prices for clearance SKUs
CronValidateAllInventoryBlocks
TASK
/cron/validate-all-blocks
GET
Trigger inventory block validation for all active SKUs
CronValidateAllSkusAndListings
TASK
/cron/validate-all-skus-and-listings
GET
Trigger validation of all SKUs and Listings
CronValidateAllSuppliers
TASK
/cron/validate-all-suppliers
GET
Trigger validation of all Suppliers
FailedAddonConversionReport
TASK
/tasks/2019-10-18/failed-addon-conversion-report
POST
Report on failed addon conversions from listing to SKU level
FinalizeAsyncReport
TASK
/tasks/asynchronous-report/finalize
POST
Combine report parts and send to requester
Parameters
* ComposedFilepath: Path for final composed file
* ComposedFilename: Name for final composed file
* AllFilenames: List of part filenames to combine
* ContentType: Content type of report
* RecipientEmail: Email address to send report to
* ReportTitle: Title of the report
GenerateAutocompleteFileCompat
TASK
/tasks/generate-autocomplete-file
POST
Legacy autocomplete file generation (compatibility shim - DEPRECATED)
Parameters
* Model: Model type: "Sku" or "Listing"
Returns
Status: success
Model: The model type that was processed
GenerateListingAutocompleteHandler
TASK
/tasks/autocomplete/listings
POST
Internal endpoint to generate Listing autocomplete file
Parameters
Cursor: Pagination cursor for continuing from previous batch
Counter: Batch counter for tracking progress
UUID: UUID for grouping temp files
GenerateSkuAdjustmentFile
TASK
/tasks/generate-sku-adjustments-file
POST
Generate paginated CSV file of SKU adjustment transactions
Parameters
* StartDate: Start date in MM/DD/YYYY format
EndDate: End date in MM/DD/YYYY format (defaults to StartDate + 30 days)
RequesterEmail: Email address for completion notification
SkuCursor: Pagination cursor for continued execution
PageCounter: Current page number for file naming (defaults to 1)
Returns
status: success
message: Page generated, chained to next task
GenerateSkuAutocompleteHandler
TASK
/tasks/autocomplete/skus
POST
Internal endpoint to generate SKU autocomplete file
Parameters
Cursor: Pagination cursor for continuing from previous batch
Counter: Batch counter for tracking progress
UUID: UUID for grouping temp files
GetBlocksForCreatingAdjustments
TASK
/tasks/get-blocks-for-creating-adjustments
POST
Paginate through all inventory blocks and queue adjustment creation tasks
Parameters
Cursor: Pagination cursor (urlsafe) for continuing from previous batch
Returns
status: success
blocks_processed: Number of block keys processed in this batch
chunks_queued: Number of sync tasks queued
has_more: Whether more blocks remain to process
IndexListingBatchHandler
TASK
/tasks/index-listing-batch
POST
Internal endpoint to process a batch of Listings for search indexing
Parameters
start_cursor: Cursor for pagination (empty string for first batch)
batch_size: Number of Listings to process in this batch (default 100)
IndexSkuBatchHandler
TASK
/tasks/index-sku-batch
POST
Internal endpoint to process a batch of SKUs for search indexing
Parameters
start_cursor: Cursor for pagination (empty string for first batch)
batch_size: Number of SKUs to process in this batch (default 100)
RebuildListingSearchIndex
TASK
/tasks/rebuild-listing-search-index
POST
Trigger a full rebuild of the ProductListing search index
RebuildSkuSearchIndex
TASK
/tasks/rebuild-sku-search-index
POST
Trigger a full rebuild of the ProductSku search index
RetiredSkuDatafix
TASK
/tasks/2020-9-30/retired-sku-datafix
POST
Paginate through retired SKUs and queue datetime update tasks
Parameters
Cursor: Pagination cursor for continuing from previous batch
Returns
status: success
batch_size: Number of SKUs processed in this batch
has_more: Whether more batches need processing
TaskBatchOutOfStockReport
TASK
/tasks/batch-out-of-stock-report
POST
Batch coordinator for out-of-stock report generation
Parameters
cursor: Pagination cursor for continuing from previous batch
BatchCounter: Batch number tracker (starts at 1)
TaskBuildSalesDataForAllSkus
TASK
/tasks/kickoff-build-sales-data-for-all-skus
POST
Internal task to build sales data for all SKUs
TaskBuildSalesDataForSku
TASK
/tasks/kickoff-build-sales-data-for-sku
POST
Internal task to build sales data for a specific SKU
Parameters
ProductSkuKey: ProductSku urlsafe key (string)
ProductSkuID: ProductSku ID (string)
TaskBuildSalesDataForSupplier
TASK
/tasks/kickoff-build-sales-data-for-supplier
POST
Internal task to build sales data for all SKUs from a supplier
Parameters
SupplierKey: Supplier urlsafe key (string)
SupplierID: Supplier ID (integer or string)
TaskCalculateInventoryMismatchReport
TASK
/tasks/calculate-inventory-mismatch-report
POST
[DEPRECATED] Calculate inventory mismatch report
TaskClearAllProductListingSearchIndex
TASK
/tasks/all-product-listing-name-index/data-fix
POST
Clear all product listing search index and rebuild from scratch
Returns
status: success
message: Collection cleared and rebuild queued
TaskClearAllProductSkuSearchIndex
TASK
/tasks/all-product-sku-name-index/data-fix
POST
Clear all product SKU search index and rebuild from scratch
Returns
status: success
message: Collection cleared and rebuild queued
TaskCombineGcsJsonFiles
TASK
/tasks/combine-gcs-json-files
POST
Internal task to combine GCS JSON files
Parameters
* files_to_combine: List of file paths or path to JSON file containing list
* file_output_names: List of output file paths
include_newline_delimited_file: Whether to create newline-delimited version (boolean)
delete_files_after_combining: Whether to delete source files after combining (boolean)
concatenate: Concatenation mode: "extend" or "append" (string)
silently_fail: Whether to silently fail on errors (boolean)
loop_counter: Current batch iteration (integer)
public_files: List of files that should be public (list)
TaskCombineOutOfStockFiles
TASK
/tasks/combine-out-of-stock-files
POST
Combine out-of-stock part files into final report
Parameters
* files_to_combine: List of GCS file paths to combine
* output_file: Output file path for combined result
TaskCombineSupplierAvailabilityJsonFiles
TASK
/tasks/combine-supplier-availability-json-files
POST
Internal task to combine supplier availability JSON files
TaskCombineSupplierJsonFiles
TASK
/tasks/supplier/combine-supplier-json-files
POST
Internal task to combine supplier JSON files
TaskComposeSkuAdjustmentFiles
TASK
/tasks/compose-sku-adjustment-files
POST
Compose paginated SKU adjustment CSV files into final report
Parameters
* StartDate: Start date in MM/DD/YYYY format
* EndDate: End date in MM/DD/YYYY format
* PageCounter: Number of page files to merge
RequesterEmail: Email address for completion notification
TaskCreateHandler
TASK
/tasks/create
POST
Create a new Cloud Task
Parameters
task_name: Name for the task
payload: Task payload data
TaskCreateSkuBlockForToday
TASK
/tasks/inventory/create-sku-block-for-today
POST
Create daily inventory block for a SKU and validate chain
Parameters
* ProductSkuKey: Urlsafe key of ProductSku to create block for
TaskCreateSupplierAvailabilityJsonFiles
TASK
/tasks/create-supplier-availability-json-files
POST
Internal task to create supplier availability JSON for a SKU
Parameters
ProductSkuKey: ProductSku urlsafe key (string)
TaskCreateSupplierJsonFiles
TASK
/tasks/supplier/create-supplier-json-files
POST
Internal task to create JSON file for a supplier
Parameters
SupplierKey: Supplier urlsafe key (string)
TaskDeleteInventoryLocations
TASK
/tasks/delete-inventory-locations
POST
Deletes all existing inventory locations (DEPRECATED - DISABLED)
TaskDeleteInventoryStatusBlock
TASK
/tasks/delete-inventory-status-blocks
POST
Deletes all existing inventory status blocks (DEPRECATED - DISABLED)
TaskDropExpiredCounts
TASK
/tasks/drop-expired-counts
POST
Drop expired inventory counts (older than 14 days) and send expiration warnings
Returns
status: success|error
dropped_count: Number of audit results dropped
expiring_count: Number of audit results expiring tomorrow
warning_email_sent: Whether warning email was sent
TaskGenerateActiveAuditsFile
TASK
/tasks/generate-active-audits-file
GETPOST
Generate CSV files listing all audits with non-zero adjustments
Parameters
AuditCursor: Cursor tracking where we are in the audit query
PageCounter: Counter of what page we are on (used to create unique files to be merged at end)
UUID: Unique ID to prevent multi runs from deleting each others files
Returns
status: success
message: Page generated or task completed
TaskGenerateInventoryRMAAssignedToRestockReport
TASK
/tasks/get-rma-assigned-to-restock-report
POST
[DEPRECATED] Generate RMA assigned to restock inventory report
TaskGenerateInventoryReports
TASK
/tasks/generate-inventory-reports
POST
Generate and email daily inventory out-of-stock report
TaskGenerateListingDataFile
TASK
/tasks/generate-listing-data-file
POST
Generate listing data JSON file for all active ProductListings
Parameters
daily_archive: Boolean - if true, creates date-stamped backup file
include_skus: Boolean - if true, includes SKU data in listing dictionaries
Returns
status: success
total_rows: Number of listings written to file
file_path: GCS path of generated file
TaskGenerateProductFeed
TASK
/tasks/2019-10-09/generate-product-feed
POST
Queries product skus for product feeds (Google/Bing/FB/GSA) and returns results
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
TaskGenerateProductSkuSupplierData
TASK
/tasks/generate-product-sku-supplier-data
POST
Internal task to generate supplier data for a specific SKU
Parameters
* ProductSkuKey: ProductSku urlsafe key (string)
Returns
Status: completed
Files: List of generated files (always empty)
TaskGenerateProductSkus
TASK
/tasks/2019-03-26/generate-product-skus
POST
Generates ProductSkus from ProductListings
Parameters
* ProductListingKey: NDB key of the product listing that product skus will be generated from
IncludeNameDescriptions: Description of attribute to be added
TaskGenerateSkuDataFile
TASK
/tasks/generate-sku-data-file
POST
Generate SKU data JSON file for all active ProductSkus with pagination
Parameters
daily_archive: Boolean - if true, creates date-stamped backup file
include_inventory: Boolean - if true, includes inventory location data in SKU dictionaries
cursor: Pagination cursor (urlsafe string)
uuid: File grouping UUID for batch file management
page_counter: Current page number for batch processing
Returns
status: success
message: Batch processed or final file generated
page_counter: Current page number
has_more: Boolean - true if more batches to process
TaskGenerateSupplierDataFile
TASK
/tasks/generate-supplier-data-file
POST
Internal task to generate supplier data files
TaskGenerateSupplierFileForSku
TASK
/tasks/generate-supplier-file-for-sku
POST
Internal task to generate supplier data file for a specific SKU
Parameters
ProductSkuKey: ProductSku urlsafe key (string)
ProductSID: ProductSku ID/SID (string)
TaskHandlerEndpoint
TASK
/tasks/handler
POST
Internal task handler endpoint
TaskKickoffAdjustmentRecordValidations
TASK
/tasks/kickoff-adjustment-record-validations
POST
Re-validate CHECK_IN adjustment records created today
Returns
status: success
adjustments_found: Number of adjustment records found
unique_skus: Number of unique SKUs to validate
TaskKickoffProductListingValidations
TASK
/tasks/validate-all-listings
POST
Kickoff validation tasks for all ProductListings
Parameters
Cursor: Pagination cursor (urlsafe) for continuing from previous batch
Returns
status: success
listings_queued: Number of validation tasks queued in this batch
has_more: Whether more listings remain to process
TaskKickoffProductSkuValidations
TASK
/tasks/validate-all-skus
POST
Kickoff validation tasks for all ProductSkus
Parameters
Cursor: Pagination cursor (urlsafe) for continuing from previous batch
Returns
status: success
skus_queued: Number of validation tasks queued in this batch
has_more: Whether more SKUs remain to process
TaskKickoffSetSkuSalesIndex
TASK
/tasks/kickoff/set-sku-sales-index
POST
Fetch sales index data from LARS and queue SKU update tasks
TaskOutOfStockSkus
TASK
/tasks/out-of-stock-report-worker
POST
Worker task that processes SKU batch for out-of-stock report
Parameters
* SIDs: List of SKU IDs to process
* BatchCounter: Batch number for file naming
TaskProductEventsSummary
TASK
/tasks/product-events/send-summary-email
POST
Generate and send product events summary email for the last 24 hours
Parameters
* StartDate: ISO format datetime string for the end of the reporting period
Returns
status: success|error
events_count: Number of product events included in the email
email_sent: Whether email was successfully sent
TaskPublishDraft
TASK
/tasks/publish-draft
POST
Update SKU metadata after publishing a product listing draft
Parameters
* ProductListingKey: NDB urlsafe key of the published ProductListing
TaskPublishMultiSkuListings
TASK
/tasks/publish-multi-sku-listings
POST
Publish draft versions for all multi-SKU product listings
Parameters
ProductListingCursor: Pagination cursor (urlsafe string) for batch processing
batch_size: Number of listings to process per batch (default 100)
Returns
status: success
message: Batch processed or complete
processed_count: Number of listings processed in this batch
published_count: Number of multi-SKU listings published in this batch
has_more: Boolean - true if more batches to process
TaskRecalculateSkuActiveStatus
TASK
/tasks/recalculate-sku-active-status
POST
Recalculate active status for ProductSkus based on listing ActiveSkus array
Parameters
ProductSkuCursor: Pagination cursor (urlsafe string) for batch processing
Returns
status: success
message: Batch processed or complete
modified_count: Number of SKUs marked inactive in this batch
has_more: Boolean - true if more batches to process
TaskReplaceAllProductContentRelativeUrls
TASK
/tasks/replace-all-product-content-relative-urls-with-absolutes
POST
Replace relative URLs in product listing content with absolute URLs
Parameters
ProductListingCursor: Cursor for pagination (for continuation)
batch_size: Number of listings to process in batch (default 50)
TaskResetOnSaleFlagRetiredSkus
TASK
/tasks/reset-on-sale-flag-retired-skus
POST
Reset IsOnSale flag on retired SKUs and retire clearance SKUs
TaskSendPhysicalAuditEmails
TASK
/tasks/inventory/send-physical-audit-emails
POST
Send physical count summary email notifications
Returns
status: success|error
counts_sent: Number of audit results included in email
TaskSetAllProductPublishStatus
TASK
/tasks/set-all-product-published-status
POST
Background task to set HasBeenPublished boolean for all ProductListing entities
TaskSetFeaturedImage
TASK
/tasks/set-featured-image
POST
Background task to set featured images for listings with images but no featured image
TaskSetRetiredSKUDateTime
TASK
/tasks/2020-9-30/set-retired-datetime
POST
Set RetiredDateTime for retired SKUs (data fix task)
Parameters
* SKUKeys: List of urlsafe SKU keys to update
Returns
Status: success|error
updated: Number of SKUs updated
TaskSetSkuNameAndImage
TASK
/tasks/set-sku-name-and-image
POST
Update SKU names and featured images from their parent product listings
Parameters
ProductListingCursor: Pagination cursor (urlsafe string) for batch processing
batch_size: Number of listings to process per batch (default 200)
Returns
status: success
message: Batch processed or complete
processed_listings: Number of listings processed in this batch
updated_skus: Number of SKUs updated in this batch
has_more: Boolean - true if more batches to process
TaskSetSkuSalesIndex
TASK
/tasks/set-sku-sales-index
POST
Update SKU sales index and success rating data
Parameters
ProductSID: SKU ID (e.g., ABCD1234)
ProductSkuKey: SKU key urlsafe (alternative to ProductSID)
SalesIndex: Sales index data dict with SalesIndexDollars, SalesIndexUnits, SuccessRating, SuccessCount
TaskSweepInventoryAuditResults
TASK
/tasks/inventory/sweep-inventory-audit-results
POST
Process daily inventory audit results for zero-quantity counts
Returns
status: success|error
processed_audits: Number of audit results processed
deleted_audits: Number of audits marked as deleted/closed
moved_to_eod: Number of audits moved to end of day
skus_validated: Number of SKUs queued for validation
TaskSyncSkuSearchIndex
TASK
/tasks/sync-sku-search-index/data-fix
POST
Sync SKU names with listing titles for single-SKU listings (data fix)
Parameters
ProductListingCursor: Pagination cursor for batch processing
OverrideSkuName: Boolean - whether to update SKU names (default: False)
TaskTransferRMAAssignedToRestock
TASK
/tasks/transfer-rma-assigned-to-restock
POST
[DEPRECATED] Transfer RMA inventory to correct BIN (disabled by design)
TaskUpdateClearanceSkuPrice
TASK
/tasks/update-clearance-sku-price
POST
Process individual SKU price reduction for clearance items
Parameters
* ProductSkuKey: SKU key urlsafe
WeekOfYear: Week of year (for tracking)
TaskUpdateIsOnClearanceSkus
TASK
/tasks/update-is-on-clearance-skus
POST
Query clearance SKUs and queue individual price reduction tasks
TaskValidateAllBlocks
TASK
/tasks/inventory/validate-all-blocks
POST
Validate inventory chain for a single SKU
Parameters
* ProductSkuKey: Urlsafe key of ProductSku to validate
TaskValidateAllSuppliers
TASK
/tasks/validate-all-suppliers
POST
Internal task to validate all suppliers
Parameters
Cursor: Pagination cursor (string)
TaskValidateAndCreateSku
TASK
/tasks/2019-03-26/validate-and-create-sku
POST
Validates and creates SKUs from attribute combinations
Parameters
* ProductListingKey: NDB key of the product listing
* ListingsSkuKeys: List of urlsafe sku keys associated with the listing
* AttributeCombinations: List of attribute combinations used to generate SKUs
IncludeNameDescriptions: Description of attribute to be added
TaskValidateInventoryChain
TASK
/tasks/inventory/validate-chain
POST
Validate inventory chain for a SKU starting from a specific date
Parameters
* SkuKey: Urlsafe key of ProductSku to validate
StartDate: ISO format date to start validation (YYYY-MM-DD), defaults to today
Returns
status: success|error
sku_key: SKU key that was validated
start_date: Start date used for validation
TaskValidateProductListing
TASK
/tasks/product-listing/validate
POST
Validate a single ProductListing entity
Parameters
* ProductListingKey: Urlsafe key of ProductListing to validate
Returns
status: success|error
has_errors: Whether validation errors were found
TaskValidateProductSku
TASK
/tasks/product-sku/validate
POST
Validate a single ProductSku entity
Parameters
* ProductSkuKey: Urlsafe key of ProductSku to validate
RetryAttempts: Current retry attempt number (1-5, default 1)
Returns
status: success|error
has_errors: Whether validation errors were found
retry_queued: Whether a retry task was queued (transient errors)
TaskValidateSupplier
TASK
/tasks/supplier/validate
POST
Validate a single Supplier entity
Parameters
* SupplierKey: Urlsafe key of Supplier to validate
Returns
status: success|error
has_errors: Whether validation errors were found
UpdateComponentsSkuCacheHandler
TASK
/tasks/update-components-sku-cache
POST
Internal endpoint to update cached values for parent SKUs that use this SKU as a component
Parameters
* sku_key: SKU key urlsafe string
UpdateListingCacheHandler
TASK
/tasks/update-listing-cache
POST
Internal endpoint to update cached listing values (price range)
Parameters
* listing_key: Listing key urlsafe string
UpdateListingSearchIndexHandler
TASK
/tasks/update-listing-search-index
POST
Internal endpoint to update search index for a single listing
Parameters
* listing_key: Listing key urlsafe string
UpdateSkuCacheHandler
TASK
/tasks/update-sku-cache
POST
Internal endpoint to update cached SKU values (component calculations)
Parameters
* sku_key: SKU key urlsafe string
UpdateSkuSearchIndexHandler
TASK
/tasks/update-sku-search-index
POST
Internal endpoint to update search index for a single SKU
Parameters
* sku_key: SKU key urlsafe string
Private Endpoints (289)
AcceptRecordAdjustment
PRIVATE
/api/1/inventory/transaction/accept-physical-audit
Accept a Physical Audit
Parameters
* SkuAuditKey: Key for a Sku Audit
UserEmail: Email address of user creating audit
AcknowledgeInventoryAudit
PRIVATE
/api/1/inventory/transaction/acknowledge-inventory-audit
Acknowledge an inventory audit result by updating its status to ACKNOWLEDGED
Parameters
* AuditKey: ID of Physical count (inventory audit result)
* UserEmail: Email address of user creating audit
AddAddOnToProductSku
PRIVATE
/api/2019-02-14/product-sku/addon-add
POST
Assign an addon to a product sku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of ProductSku to receive addon
* AddOnPrice: Price of the addon
* AddOnSkuKey: Key of the ProductSku to be associated with addon
Returns
Status: success|error
ProductAddon: Dictionary of created addon
AddAddonToProductListingDraft
PRIVATE
/api/1/product-listing/draft/add-addon
POST
Adds a product addon to a product listing
Parameters
* ProductListingKey: NDB key of Product Listing to add addon
* AddOnListingKey: Key for the Listing to be associated with new addon
* AddOnPrice: Price of addon
:
Returns
Status: success|error
ProductListingKey: Return Listing Key of Listing that gained an addon
AddOnListingKey: Return Listing key associated with new addon
AddAttributeProductListingDraft
PRIVATE
/api/2019-03-20/product-listing/draft/add-attribute
POST
Adds an attribute to a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* AttributeOptionKeys: List of NDB urlsage keys
* ProductAttributeKey: NDB key of attribute
DefaultAttributeOption: NDB Key of default attribute option to be applied to active skus.
Returns
Status: success|error
ProductListingKey: Pass listing key along for testing
AddComponentToSku
PRIVATE
/api/2022-05-05/product-sku/add-component
POST
Add a component to a sku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* SkuKey: SKU key
* ComponentKey: SKU key for a component
Quantity: Number of components to add (default: 1)
Returns
Status: success|error
ComponentKey: Key of added component
ProductSkuKey: Key of parent SKU
Quantity: Number of components added
AddContactToSupplier
PRIVATE
/api/1/supplier/add-contact
POST
Add email address to supplier vendor contact list. Either SupplierKey or SupplierID is required.
Parameters
* SupplierContactEmail: Email address of contact at supplier
SupplierKey: NDB urlsafe key of Supplier to edit (either this or SupplierID required)
SupplierID: Integer ID of Supplier to edit (either this or SupplierKey required)
AddDigitalItemToProductSku
PRIVATE
/api/1/product-sku/add-digital-item
POST
Adds a digital item to a ProductSku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: Key of the ProductSku that we are adding a digital item to
* LicenseCode: License Code of digital item being added to the ProductSku
Returns
Status: success|error
DigitalItemKey: Key of the added digital item
AddElementToProductListingDraft
PRIVATE
/api/1/product-listing/draft/add-element
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ElementType: Element Type (Image, Text, Html)
ElementCode: Six Digit alphanumeric unique code
ElementContent: Html content
ImageServingUrl: Serving Url of image to copy if type is image
ImageFileName: Name of image being edited if type is image
Returns
Status: success|error
ProductListingKey: NDB key of Product Listing pass along
ElementCode: Six Digit alphanumeric unique code
AddImageToAttributeOption
PRIVATE
/api/1/product-attribute-option/add-image
POST
Adds image tracking information for image associated with an attribute option
Parameters
* AttributeOptionKey: NDB key of the associated attribute option
ImageUrl: Serving url for image
ImageFileName: GCS filename
AddImageToProductAttribute
PRIVATE
/api/1/product-attribute/add-image
POST
Adds a new image associated with a product attribute (DEPRECATED)
Parameters
* AttributeKey: NDB key of the associated attribute
AddImageToProductListingDraft
PRIVATE
/api/1/product-listing/draft/add-image
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ImageServingUrl: file blob
Featured: Flag denoting if this image is the featured image
ImageFileName: Name of PLS file path. This will only exist when editing an image
Returns
Status: success|error
ProductListingKey: Pass listing key along for testing
ImageUrl: Pass along Serving Url for image
ImageFile: Pass along filename for image
AddImageToProductListingDraftElement
PRIVATE
/api/1/product-listing/draft/add-element-image
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* ElementCode: Six Digit alphanumeric unique code
* ImageUrl: Serving Url for image
* ImageFileName: GCS filename
Returns
Status: success|error
ProductListingKey: NDB key of created Product Listing pass along
ElementCode: Six Digit alphanumeric unique code pass along
ImageUrl: Serving Url for image pass along
AddImageToProductSku
PRIVATE
/api/1/product-sku/add-image
POST
Adds a new featured image to ProductSku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: Key of the ProductSku that we are adding an image to
* ImageFileName: Name of the Featured Image to be added
* ImageServingUrl: Url of the Featured Image to be added
AddMonitorUrl
PRIVATE
/api/1/price-data/add-monitor-url
POST
Add a URL to monitor for a specific SKU
Parameters
* ProductSkuKey: ndb Key for ProductSku
* MonitorUrl: Full URL to monitor for this SKU
Priority: Priority level (1=high, 2=medium, 3=low, default=1)
Notes: Optional notes about this URL
Returns
Status: success|error
MonitorUrlKey: Key of created SkuMonitorUrl record
PriceSourceKey: Key of PriceSource (created if new)
AddPickImageToProductSku
PRIVATE
/api/1/product-sku/add-pick-photo
POST
Add a pick photo to product sku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: Key of the ProductSku that we are adding an image to
* ImageFileName: Name of the Pick Image to be added
* ImageServingUrl: Url of the Pick Image to be added
AddPriceData
PRIVATE
/api/1/price-data/add
POST
Add external price data for a SKU with automatic source detection
Parameters
* ProductSkuKey: ndb Key for ProductSku
* SourceProductUrl: Full URL to product page (domain used for source detection)
* ScrapedPrice: Base price in cents
* IsAvailable: Boolean availability status
ScrapedListPrice: List price in cents
ShippingFees: Shipping and other fees in cents
DiscountAmount: Discount amount in cents
DiscountCode: Discount code used
VariantName: Product variant name for different configurations
StockLevel: Stock level indicator
SourceProductId: External product identifier
DataQuality: Data quality rating
Returns
Status: success|error
PriceDataKey: Key of created SkuPriceData record
PriceSourceKey: Key of PriceSource (created if new)
ModifiedTotalPrice: Calculated total price including fees and discounts
AddPricingRuleToProductSku
PRIVATE
/api/1/product-sku/add-pricing-rule
Adds Pricing Rule to Sku
Parameters
* ProductSkuKey: Key of the ProductSku that we are adding pricing rules to
* PricingRules: list of pricing rules in the form [{QualifyingQuantity:2, PercentOfPrice:9905},{QualifyingQuantity:2, PercentOfPrice:9500}]
AddPricingRulesToPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/add-rule
POST
Adds Pricing Rule to Template
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
PricingRules: List of pricing rules: [{QualifyingQuantity:2, PercentOfPrice:9905}]
AddProductKeywordsToProductListingDraft
PRIVATE
/api/1/product-listing/draft/add-product-keyword
POST
Adds MetaKeywords to Product Listing Draft
Parameters
* ProductListingKey: NDB key of created Product Listing
* MetaKeyword: NDB key of related Product Listing
AddProductListingDraft
PRIVATE
/api/2024-03-27/product-listing/draft/add
POST
Create a new Product Listing and associated Product Sku
Parameters
* Title: Title of the new product listing
* ReferenceUrl: Url reference string for product
Subtitle: Sub-title of new product listing
BasePrice: Base price for product, user for non price specific sku
ShortDescription: Description of Product Listing
PreOrderFlag: Flag denoting if product can be pre-ordered
ShowAddToCart: Flag denoting if the product can be added to cart for widgets
DisableAddToCart: Flag denoting if the product can be added to cart in general
ShowQuestionsFlag: Flag that allows users to leave and reference questions
ProductType: String denoting if the product is a physical or digital product
Returns
Status: success|error
ProductListingKey: NDB key of created Product Listing
AddProductListingDraftDeprecated
PRIVATE
/api/1/product-listing/draft/add
POST
Create a new Product Listing and associated Product Sku (DEPRECATED)
Parameters
* Title: Title of the new product listing
* ReferenceUrl: Url reference string for product
Subtitle: Sub-title of new product listing
BasePrice: Base price for product, user for non price specific sku
ShortDescription: Description of Product Listing
PreOrderFlag: Flag denoting if product can be pre-ordered
ShowAddToCart: Flag denoting if the product can be added to cart for widgets
DisableAddToCart: Flag denoting if the product can be added to cart in general
ShowQuestionsFlag: Flag that allows users to leave and reference questions
ProductType: String denoting if the product is a physical or digital product
Returns
Status: success|error
ProductListingKey: NDB key of created Product Listing
AddProductListingKeyword
PRIVATE
/api/1/product-listing/add-keyword
POST
Adds a keyword to the product listing (and product listing draft)
Parameters
* ProductListingKey: NDB key of Product Listing
* Keyword: Keyword to be included in meta tag and search
AddProductSKUListToPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/add-skus-by-list
POST
Adds a list of ProductSKUs to Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
* ProductSkuList: A list of SKU keys to add
AddProductSKUToPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/add-sku
POST
Adds a ProductSku to Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
* ProductSkuKey: Key of the SKU being added
AddProductSkuAddonToProductListingDraft
PRIVATE
/api/2019-08-23/product-listing/draft/product-sku-addon/add
POST
Adds a product addon to a product listing
Parameters
* ProductListingKey: NDB key of Product Listing to add addon
* AddOnSkuKey: Key of the product SKU to be associated with new addon
* AddOnPrice: Price of addon
:
Returns
Status: success|error
ProductListingKey: Return Listing Key of Listing that gained an addon
AddOnSkuKey: Return SKU key associated with new addon
AddRelatedProductToProductListingDraft
PRIVATE
/api/1/product-listing/draft/add-related-product
POST
Adds a related product to a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* RelatedProductKey: NDB key of related Product Listing
AddSkuToProductFeedBlacklist
PRIVATE
/api/2019-07-19/product-feed/blacklist/add-sku
POST
Adds a sku key to the product feed blacklist
Parameters
* ProductSkuKey: urlsafe key of product sku being added to the list
AddSkusToSupplier
PRIVATE
/api/1/supplier/add-skus
POST
Add SKUs to a supplier. Either SupplierKey or SupplierID is required. Accepts SKU SIDs (e.g., "6613571476652032") or urlsafe keys.
Parameters
SupplierKey: NDB urlsafe key of Supplier to edit (either this or SupplierID required)
SupplierID: Integer ID of Supplier to edit (either this or SupplierKey required)
SuppliedSkus: List of SKU SIDs (e.g., "6613571476652032") or urlsafe keys to add
Returns
Status: success|error
SkusAdded: Number of SKUs successfully added
AddToFilterList
PRIVATE
/api/1/filter-lists/add-value
POST
Adds string to filter list
Parameters
* ListName: String name of filter list
* FilterListValue: New value being added to filter list
AddWareHouseToProductSku
PRIVATE
/api/2022-03-31/warehouse/add
Assign a warehouse to a Product SKU
Parameters
* ProductSkuKey: NDB key of ProductSku to assign warehouse
* FulfillmentLocationKey: Which warehouse grouping
* Name: Name of the warehouse location
* UID: Unique ID assigned by warehouse scan
ProductSID: Can be used instead of ProductSkuKey
Returns
Status: success|error
ProductSkuKey: NDB key of ProductSku that received the addon.
AddressCreateOrUpdate
PRIVATE
/api/2022-04-18/address/create-or-update
POST
Create or update an address
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* AddressKey: NDB key of the address to be edited or "create" to create a new one
* Recipient: Recipient name
* AddressLineOne: Address line 1
* City: City
* Region: State/Region
* PostalCode: Postal/ZIP code
* CountryCode: Country code (e.g., US, CA, GB)
AddressLineTwo: Address line 2
PhoneNumber: Phone number
Returns
Status: success|error
Address: Dictionary of address data
AddressKey: URL-safe key of the address
ApplyPricingRuleTemplateToProductSkus
PRIVATE
/api/1/pricing-rule-template/apply-rules
POST
Apply Pricing Rules from Template to all SKUs
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
ArrangeImage
PRIVATE
/api/1/product-listing/draft/arrange-image
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ImageFileName: Name of file to set as featured image
Returns
Status: success|error
ProductListingKey: NDB key of Product Listing pass along
AuditParentDataFixLauncher
PRIVATE
/api/1/meta/audit-parent-data-fix
POST
Data fix for audit parent relationships (deprecated - one-time legacy migration)
BackupBlockRestoreDataFixLauncher
PRIVATE
/api/1/meta/backup-block-restore/datafix-launcher
POST
Data fix to restore inventory blocks from backup (deprecated - one-time legacy migration)
BuildSupplierSalesData
PRIVATE
/api/2025-08-26/supplier/kickoff-product-sku-supplier-data
POST
Kick off sales data build for all SKUs supplied by a specific supplier
Parameters
SupplierKey: Supplier urlsafe key (string)
SupplierID: Supplier ID (integer or string)
Returns
Status: success|error
Message: Task queued successfully or error message
BulkUploadMapping
PRIVATE
/api/2023-03-15/product-sku/bulk-upload-mapping
POST
Get mapping information for bulk upload operations
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
Returns
Status: success|error
Mapping: Array of field mappings with validation info
CancelDropShipRequest
PRIVATE
/api/1/inventory/transaction/reverse-drop-ship-order
Cancels a dropship request transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* UserEmail: Email of authorized user
* Note: Note related to adjustment
* ToLocationKey: Key of location where product was going to be shipped before drop-shipping
* PurchaseOrderKey: PO that has items being dropshipped
CleanUpAuditRecordAdjustments
PRIVATE
/api/1/meta/clean-audit-record-adjustments
POST
Data cleanup for audit record adjustments (deprecated - not migrated from legacy)
CompleteDropShip
PRIVATE
/api/1/inventory/transaction/complete-drop-ship-order
Records a dropship completion transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* UserEmail: Email of authorized user
* Note: Note related to adjustment
* PurchaseOrderKey: PO that has items being dropshipped
ContributionProfitProductSku
PRIVATE
/api/2025-03-11/product-sku/contribution-profit
Queries SKUs and generates the CP
Parameters
ProductSkuKeys: list of sku keys
ProductSkuKey: If a single SKU needs to be looked up
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
ConvertListingAddOnToSkuAddonLauncher
PRIVATE
/api/1/meta/addon-conversion/data-fix
POST
Data fix for listing addon conversion (deprecated - one-time 2019 migration)
CreateAdjustmentsForCheckinTransactions
PRIVATE
/api/1/meta/create-adjustments-for-checkin-transactions
POST
Launches task to create missing adjustment records for check-in transactions (deprecated)
Returns
Status: success|error
Message: Task queued successfully
CreateAttributeOption
PRIVATE
/api/2019-05-22/product-attribute-option/add
POST
Adds a new option to an attribute
Parameters
* ProductAttributeKey: NDB key of the product attribute
* AttributeOptionDescription: Description of attribute option to be added
AttributeOptionName: Name of attribute option
AttributeOptionData: Additional data for option
PriceModifier: Amount the attribute option varies the price (Default = 0)
HexColor: Hex color code for option
ProductListingKey: NDB key of the product listing
Returns
Status: success|error
AttributeOptionKey: NDB key of created attribute option
AttributeKey: NDB key of parent attribute
CreateAttributeOptionDeprecated
PRIVATE
/api/1/product-attribute-option/add
POST
Adds a new option to an attribute (DEPRECATED)
Parameters
* ProductAttributeKey: NDB key of the product listing to which attributes will be added
* AttributeOptionDescription: Name of attribute to be added
PriceModifier: Amount the attribute option varies the price (Default = 0)
ProductListingKey: NDB key of the product listing that has the attribute that this option will be added to
Returns
Status: success|error
AttributeOptionKey: NDB key of created attribute option
CreateOneTimeItemSku
PRIVATE
/api/2024-05-24/product-sku/create-one-time
POST
Create a one-time use ProductSku
Parameters
* SkuName: Name of one time ProductSku
* ProductPrice: The price of the one time ProductSKu
* ProductType: Type of product (service, physical-inventory, etc...)
* ProductWeight: Weight of product
ComponentKeys: Array of related component keys
Returns
Status: success|error
ProductSkuKey: NDB key of created sku
CreateOrUpdateSku
PRIVATE
/api/1/product-sku/create-or-update
POST
Create or update a product SKU by ID
Parameters
* SkuID: ID of Product
* SkuName: Name of Product
* ProductPrice: The price of the product
* ProductType: Type of product (service or physical-inventory)
* ProductWeight: Weight of product
QuantityOnHand: Number of sku on hand
IsOneTimeItem: Boolean for if this item is to be bought only once
Returns
Status: success|error
ProductSkuKey: NDB key of created sku
CreateProductAttribute
PRIVATE
/api/2019-03-13/product-attribute/create
POST
Create a new Attribute, local or global
Parameters
* AttributeName: Name of attribute to be added
AttributeDescription: Description of attribute to be added
AttributeFormat: Element type checbox, dropdown, color, text
IncludeInSearch: Set as 'True' if attribute should be included in search results
Returns
Status: success|error
ProductListingKey: Key of ProductListing the attribute is being added to
AttributesKey: NDB key of created attributes
CreateProductAttributeDeprecated
PRIVATE
/api/1/product-attribute/add
POST
Adds a new attribute to a product listing (DEPRECATED)
Parameters
* AttributeName: Name of attribute to be added
AttributeDescription: Description of attribute to be added
ProductListingKey: NDB key of the product listing to which attributes will be added
IncludeInSearch: Set as 'True' if attribute should be included in search results
Returns
Status: success|error
ProductListingKey: Key of ProductListing the attribute is being added to
AttributeKey: NDB key of created attribute
CreateProductVideo
PRIVATE
/api/2025-09-26/product-listing/draft/video/create
POST
Create a ProductVideo and add it to the Videos list for a given product listing page.
Parameters
* ProductListingKey: NDB key of Product Listing
* VideoPath: GCS file path/key
* VideoServingUrl: Public url for accessing video file
VideoId: UUID of Video if it has already been created
CreateSku
PRIVATE
/api/2023-03-13/product-sku/create
POST
Create a new product SKU
Parameters
* SkuName: Name of the Product
* ProductPrice: The price of the product
* ProductType: Type of product (service or physical-inventory)
* ProductWeight: Weight of product
Returns
Status: success|error
ProductSkuKey: NDB key of created sku
CreateStorageLocation
PRIVATE
/api/1/inventory/storage-location/create
POST
Create a new storage location
Parameters
* FulfillmentLocationKey: URL safe string of the FulfillmentLocation key
* Name: String name of the storage location
PhysicalLocation: Description of the physical location
Returns
Status: success|error
StorageLocationKey: Key of created storage location
CreateSupplier
PRIVATE
/api/1/supplier/create
POST
Create a new supplier
Parameters
* Name: Name of Supplier to create
Returns
Status: success|error
SupplierKey: NDB key of created supplier
DecrementProductQuantity
PRIVATE
/api/1/product-sku/decrement-quantities
POST
Decrements product quantity on hand (DEPRECATED - no longer used)
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuQuantityDict: Dictionary in form of {sku_key: quantity}
DeleteAdjustmentRecord
PRIVATE
/api/1/inventory/transaction/remove-adjustment-record
Mark an adjustment record as deleted and trigger validation chain
Parameters
* ProductSkuKey: ID of ProductSku
* AdjustmentRecordKey: ID of Physical count (inventory audit result)
* UserEmail: Email address of user creating audit
DeleteAllDBInventory
PRIVATE
/api/1/inventory/delete
POST
Records a customer order transaction (DEPRECATED - DISABLED)
DeletePricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/delete
POST
Delete Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of PricingRuleTemplate
DeleteProductListing
PRIVATE
/api/2019-09-10/product-listing/delete
POST
Permanently deletes product listing from the system
Parameters
* ProductListingKey: NDB key of Product Listing to delete.
:
DeleteProductListingDeprecated
PRIVATE
/api/1/product-listing/delete
POST
Permanently deletes product listing from the system (DEPRECATED)
Parameters
* ProductListingKey: NDB key of Product Listing to delete.
DeleteSkuAdjustmentsFile
PRIVATE
/api/1/meta/delete-sku-adjustments-file
POST
Delete SKU adjustment CSV files from cloud storage (deprecated - no longer functional)
Parameters
* StartDate: Start date in MM/DD/YYYY format
EndDate: End date in MM/DD/YYYY format (defaults to StartDate + 30 days)
Returns
Status: success|error
Message: Deprecation notice explaining endpoint is no longer functional
DeprecatedFailedAddonConversionReport
PRIVATE
/api/1/meta/failed-addon-conversion/report
POST
Generate report of failed addon conversion processes (deprecated)
DisableAttributeProductListingDraft
PRIVATE
/api/2019-03-20/product-listing/draft/disable-attribute
POST
Adds an attribute to a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ProductAttributeKey: NDB key of attribute
DefaultAttributeOption: NDB Key of default attribute option to be applied to active skus.
Returns
Status: success|error
ProductListingKey: Pass listing key along for testing
DuplicateProductListing
PRIVATE
/api/1/product-listing/duplicate
POST
Duplicates existing listing with exception of active sku list
Parameters
* ProductListingKey: NDB key of created Product Listing
EditElementInProductListingDraft
PRIVATE
/api/1/product-listing/draft/edit-element
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* ElementCode: Six Digit alphanumeric unique code
ElementContent: Html content
ElementType: Element Type (Image, Text, Html)
EditImageOnProductListingDraft
PRIVATE
/api/1/product-listing/draft/edit-image
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ImageServingUrl: file blob
* ImageFileName: Name of PLS file path. This will only exist when editing an image
Returns
Status: success|error
ProductListingKey: Pass listing key along for testing
ImageUrl: Pass along Serving Url for image
ImageFile: Pass along filename for image
EditProductListingDraft
PRIVATE
/api/1/product-listing/draft/edit
POST
Updates an existing product listing
Parameters
* ProductListingKey: NDB key of Product Listing
Title: Title of the new product listing
Subtitle: Sub-title of new product listing
ReferenceUrl: Url reference string for product
RedirectUrl: Product page redirect url for deprecated listings
BasePrice: Base price for product, user for non price specific sku
ShortDescription: Description of Product Listing
PreOrderFlag: Flag denoting if product can be pre-ordered
ShowAddToCart: Flag denoting if the product can be added to cart
DisableAddToCart: Flag denoting if the product can be added to cart
ShowQuestionsFlag: Flag that allows users to leave and reference questions
HideRewardsFlag: Flag that allows admin to remove rewords from why buy box
AlwaysInStockFlag: Flag that allows admin to ovveride qty on SKU
IsSearchable: Flag indicating whether or not a listing will appear in product search
TemplateKey: Key of product page template
IsActive: TBD
ProductType: String denoting if the product is a physical or digital product
EditProductSku
PRIVATE
/api/1/product-sku/edit
POST
For editing existing product sku properties (DEPRECATED - 12-17-2018)
Parameters
* ProductSkuKey: NDB key of ProductSku to edit
SkuName: Name of ProductSku to edit
ProductPrice: The price of the product being edited
AvailableDate: Date that ProductSku being edited will become available for purchase
QuantityOnHand: Total number of skus that are physically in stock
QuantityReserved: Total number of skus that are reserved from sale
Sku: String identifier of ProductSku being edited
ProductNumber: Numeric ID of product
AttributeOptionKey: Key of attribute option being added to AttributeOptions list
ProductUpc:
Weight: Weight of ProductSku being edited in milligrams
PackageHeight: Height of ProductSku being edited in inches
PackageWidth: Width of ProductSku being edited in inches
PackageDepth: Depth of ProductSku being edited in inches
PackagedToShip: Can be shipped in its packaging
IsOnSale: To Know the item is on sale
Returns
Status: success|error
ProductSkuKey: NDB key of edited SKU
Warning: Deprecation warning
EditProductSkuHandler
PRIVATE
/api/2019-02-14/product-sku/edit
POST
Edit existing product SKU properties
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of ProductSku to edit
SkuName: Update SkuName
Brand: Update Brand
DisplayPriceFlag: Update DisplayPriceFlag
ProductPrice: Update ProductPrice
ProductListPrice: Update ProductListPrice
LegacySku: Update LegacySku
LegacyPartNumber: Update LegacyPartNumber
AvailableDate: Update AvailableDate
LeadDays: Update LeadDays
ProductNumber: Update ProductNumber
ProductUpc: Update ProductUpc
Weight: Update Weight
PackageHeight: Update PackageHeight
PackageWidth: Update PackageWidth
PackageDepth: Update PackageDepth
PackagedToShip: Update PackagedToShip
AdminNote: Update AdminNote
ProductType: Update ProductType
IsSearchable: Update IsSearchable
IsActive: Update IsActive
IsRetired: Update IsRetired
BarCodeID: Update BarCodeID
ShipInBox: Update ShipInBox
IsOnSale: Update IsOnSale
IsOnClearance: Update IsOnClearance
IsRefurbished: Update IsRefurbished
AverageInboundTariff: Update AverageInboundTariff
AverageInboundFreight: Update AverageInboundFreight
HTSCode: Update HTSCode
DutiesPercentage: Update DutiesPercentage
CountryOrigin: Update CountryOrigin
WholesaleCost: Update WholesaleCost
WholesaleCostCurrency: Update WholesaleCostCurrency
RequireFulfillmentVerification: Update RequireFulfillmentVerification
Returns
Status: success|error
ProductSkuKey: NDB key of edited ProductSku
UpdatedFields: List of field names that were updated
EditProductSkuQuantity
PRIVATE
/api/2019-02-14/product-sku/change-quantity
POST
Edit existing product SKU quantity
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of ProductSku to edit
* QuantityChange: Amount the quantity will be changed by
Returns
Status: success|error
ProductSkuKey: NDB key of edited ProductSku
EditProductSkuSupportQuantityChange
PRIVATE
/api/2019-02-11/product-sku/edit
POST
For editing existing product sku properties (DEPRECATED - quantity change support)
Parameters
* ProductSkuKey: NDB key of ProductSku to edit
SkuName: Name of ProductSku to edit
ProductPrice: The price of the product being edited
AvailableDate: Date that ProductSku being edited will become available for purchase
QuantityOnHand: Total number of skus that are physically in stock
QuantityReserved: Total number of skus that are reserved from sale
Sku: String identifier of ProductSku being edited
ProductNumber: Numeric ID of product
AttributeOptionKey: Key of attribute option being added to AttributeOptions list
ProductUpc:
Weight: Weight of ProductSku being edited in milligrams
PackageHeight: Height of ProductSku being edited in inches
PackageWidth: Width of ProductSku being edited in inches
PackageDepth: Depth of ProductSku being edited in inches
PackagedToShip: Can be shipped in its packaging
AdminNote: Used by admin to facilitate information travel from vendor ops to sales
IsOnSale: To Know the item is on sale
Returns
Status: success|error
ProductSkuKey: NDB key of edited SKU
Warning: Deprecation warning
EditProductSkuWarningMessage
PRIVATE
/api/1/product-sku/edit-warning
POST
Edit product SKU warning messages
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of ProductSku to edit
* SkuWarningMessages: List of strings to add the type of error messages to the product
Returns
Status: success|error
ProductSkuKey: NDB key of edited ProductSku
EditSupplier
PRIVATE
/api/1/supplier/edit
POST
Update existing supplier properties. Either SupplierKey or SupplierID is required.
Parameters
SupplierKey: NDB urlsafe key of Supplier to edit (either this or SupplierID required)
SupplierID: Integer ID of Supplier to edit (either this or SupplierKey required)
IsActive: Indicates whether supplier is active
SuppliedSkus: List of SKUs supplied by supplier
AdminNote: Internal admin notes about the supplier
Returns
Status: success|error
SupplierKey: NDB key of edited supplier
FixNegativeAvailable
PRIVATE
/api/1/meta/fix-negative-available
POST
Transfer inventory from positive to negative locations (deprecated - no longer functional)
Parameters
ValidationID: Optional validation ID for tracking adjustments
Returns
Status: success|error
Message: Deprecation notice explaining endpoint is no longer functional
GenerateInventoryMismatchReport
PRIVATE
/api/2019-12-24/generate-inventory-mismatch-report
[DEPRECATED] Inventory mismatch report - no longer supported (not migrated to Python 3)
Returns
Status: error
Message: Endpoint deprecated
GenerateProductListingDraftSKUs
PRIVATE
/api/2019-03-26/product-listing/draft/generate-skus
POST
Generates sku for a product listing from associated attributes
Parameters
* ProductListingKey: NDB key of created Product Listing
IncludeNameDescriptions: Generate names using attribute option description
GenerateProductListingDraftSKUsDeprecated
PRIVATE
/api/1/product-listing/draft/generate-skus
POST
Generates sku for a product listing from associated attributes (DEPRECATED)
Parameters
* ProductListingKey: NDB key of created Product Listing
IncludeNameDescriptions: Generate names using attribute option description
GenerateProductListingSKUs
PRIVATE
/api/1/product-listing/generate-skus
POST
Generates sku for a product listing from associated attributes
Parameters
* ProductListingKey: NDB key of created Product Listing
IncludeNameDescriptions: Generate names using attribute option description
GenerateProfoundSkus
PRIVATE
/api/1/meta/data-fix/generate-profound-skus
POST
Generate profound SKUs from hardcoded CSV data (deprecated - no longer functional)
Returns
Status: success|error
Message: Deprecation notice explaining endpoint is no longer functional
GetActiveSkusOnClearance
PRIVATE
/api/2022-07-27/product-sku/query/is-on-clearance
Returns list of ProductSkus currently on clearance
Parameters
KeysOnly: Boolean to determine if we only return IDs
Returns
Status: success|error
SkuIDs: List of on-sale Sku identifiers
GetActiveSkusOnSale
PRIVATE
/api/2022-07-26/product-sku/query/is-on-sale
Returns list of ProductSkus IDs currently on sale
Parameters
KeysOnly: Boolean to determine if we only return IDs
Returns
Status: success|error
SkuIDs: List of on-sale Sku identifiers
GetActiveSkusRefurbished
PRIVATE
/api/2022-07-27/product-sku/query/is-refurbished
Returns list of ProductSkus currently set to refurbished
Parameters
KeysOnly: Boolean to determine if we only return IDs
Returns
Status: success|error
SkuIDs: List of on-sale Sku identifiers
GetAddress
PRIVATE
/api/2022-04-18/address/get
POST
Get an address from PLS
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* AddressKey: NDB key of the address to retrieve
Returns
Status: success|error
Address: Dictionary of address data
GetAllInventoryBlocksForASpecificDate
PRIVATE
/api/1/inventory/get-all-inventory-for-a-date
Get all inventory blocks for a specific date for Available and Reserved
Parameters
* StatusDate: Date of the sku blocks
TransactionStatusFilters: Filters to return - default available and reserved
IgnoreItemsWithComponents: BooleanDetermines if we want to filter out items with components
ProductTypeGroup: ['unlimited', 'physical-inventory', 'production']
Returns
Status: success|error
InventoryBlockList: SKUs for a specific date
GetAllMultiSkuListings
PRIVATE
/api/2019-09-16/product-listing/get-multi-sku
POST
Retrieve all multi sku listings in production
Returns
Status: success|error
ProductListingKeys: Returns list of multi-sku ProductListings
GetAllProductAttributeOption
PRIVATE
/api/1/product-attribute-option/get-all
POST
Gets a list of attribute options from keys
Parameters
* AttributeOptionKeys: List of NDB keys of ProductAttributeOptions
Returns
Status: success|error
AttributeOptions: List of attribute options
GetAllProductAttributeOptionDeprecated
PRIVATE
/api/1/product-attribute-option/get-all
POST
Gets a list of all attribute options (DEPRECATED)
Parameters
* AttributeOptionKey: NDB key of ProductAttribute
List: NDB key of the attribute key
Returns
Status: success|error
Attributes: List of attribute options
GetAllSuppliers
PRIVATE
/api/1/supplier/get-all
POST
Retrieve list of all suppliers, optionally including inactive suppliers
Parameters
IncludeInactive: Include inactive suppliers in list
Returns
Status: success|error
Suppliers: List of dictionaries containing Supplier data
GetAttributeProducts
PRIVATE
/api/1/product-attribute/get-associated-products
GETPOST
Gets a list of all products associated with an attribute (DEPRECATED)
Parameters
* AttributeKey: NDB key of ProductAttribute
Returns
Status: success|error
ProductListingKeys: List of product listing keys
GetAuditAdjustmentsDeprecated
PRIVATE
/api/1/inventory/get-audit_adjustments
POST
Gets a list of date and quantity for a storage location for a specific sku (DEPRECATED)
Parameters
* ProductSkuKey: NDB key of ProductSku to query
StartDate: Start Date for when to start getting audit adjustments
EndDate: End Date for when to stop getting audit adjustments
Returns
Status: success|error
AuditAdjustmentList: Audit adjustment information
Warning: Deprecation warning
GetAuditAdjustmentsQuery
PRIVATE
/api/1/inventory/get-audit-adjustments
Retrieve inventory audit results for a SKU within a date range, optionally including deleted records
Parameters
* ProductSkuKey: NDB key of ProductSku to query
StartDate: Start Date for when to start getting audit adjustments
EndDate: End Date for when to stop getting audit adjustments
Returns
Status: success|error
AuditAdjustmentList: Audit adjustment information
GetAvailabilityForSKU
PRIVATE
/api/2023-05-25/product-sku/availability
Calculate inventory statistics and availability metrics for a SKU over a date range
Parameters
* StartDate: Date to begin block query by
* EndDate: Date to end block query
* ProductSkuKey: NDB key of ProductSku to query
GetAvailabilityForSKUDeprecated
PRIVATE
/api/2023-02-27/product-sku/availability
POST
Returns each count for a location
Parameters
* Days: Integer of weeks to query
* ProductSkuKey: NDB key of ProductSku to query
GetAvailableComponentInventoryStatus
PRIVATE
/api/1/inventory/component-statuses-by-location
Retrieve inventory status for component SKUs, optionally filtered to physical inventory only
Parameters
ProductSkuKey: NDB key of ProductSku retrieve component details of
ComponentSkuKeys: NDB keys of ProductSkus to look up
PhysicalInventoryOnly: Only consider physical inventory when calculating counts
StatusDate: Date of status (returns today if omitted)
Returns
Status: success|error
InventoryStatuses: An array of lists of inventory status dictionaries for each component
GetAvailableInventoryByDateRange
PRIVATE
/api/1/inventory/by-date-range
Retrieve ending status quantities by date, location, and transaction status for a SKU over a date range
Parameters
* ProductSkuKey: NDB key of ProductSku to query
* StartDate: Start Date for when to start collecting totals
FilterStatusList: Starting Status Filters | default = available
Returns
Status: success|error
AvailableQty: Sku mapping with the available Qty and Location information
GetAvailableInventoryBySkuKeysDeprecated
PRIVATE
/api/2020-12-18/product-sku/get-available-inventory
POST
Gets a list of qty available for a SKU including its location info
Parameters
* ProductSkuKey: NDB keys of ProductSku to query
TransactionStatusFilters: Filters to return - default available and reserved
IncludeAll: Include all dicts
IncludeStorageLocations: Include storage locations
IncludeProductSku: Include sku.to_dict()
Returns
Status: success|error
SID: SID
SkuKey: SkuKey
QuantityOnHand: Quantity in physical locations
QuantityAvailable: Quantity available to sell (available - reserved)
StorageLocations: List of Storage Locations
FulfilmentLocations: List of Fulfillment Locations
ReservedSold: Number reserved
GetAvailableQtyBySkuKeys
PRIVATE
/api/2024-04-26/product-skus/inventory-by-date
Gets a list of qty available for a SKU including its location info
Parameters
* ProductSkuKey: NDB key of ProductSku to lookup
IncludeAll: Include all dicts
InventoryDate: Date: %Y-%m-%d
IncludeStorageLocations: Include storage locations
IncludeProductSku: Include sku.to_dict()
ProductSkuKeys: NDB keys of ProductSku to lookup
Returns
Status: success|error
SID: SID
SkuKey: SkuKey
QuantityOnHand: Quantity in physical locations
QuantityAvailable: Quantity available to sell (available - reserved)
StorageLocations: List of Storage Locations
FulfilmentLocations: List of Fulfillment Locations
ReservedSold: Number reserved
GetAvailableQtyBySkuKeysDeprecated
PRIVATE
/api/1/inventory/get-available-qty-by-sku-keys
POST
Gets a list of qty available for a SKU including its location info (DEPRECATED)
Parameters
* ProductSkuKeys: NDB keys of ProductSku to query
Returns
Status: success|error
AvailableQty: Sku mapping with the available Qty and Location information
GetAvailableQtyBySkuKeysV2Deprecated
PRIVATE
/api/2022-04-19/product-skus/get-available-inventory
POST
Gets a list of qty available for a SKU including its location info
Parameters
* ProductSkuKey: NDB key of ProductSku to lookup
IncludeAll: Include all dicts
IncludeStorageLocations: Include storage locations
IncludeProductSku: Include sku.to_dict()
ProductSkuKeys: NDB keys of ProductSku to lookup
Returns
Status: success|error
SID: SID
SkuKey: SkuKey
QuantityOnHand: Quantity in physical locations
QuantityAvailable: Quantity available to sell (available - reserved)
StorageLocations: List of Storage Locations
FulfilmentLocations: List of Fulfillment Locations
ReservedSold: Number reserved
GetBatchedBlocksByDateRange
PRIVATE
/api/1/get-block-batch-by-date-range
Gets a Batch of Blocks by date range
Parameters
* StartDate: Start Date
EndDate: End Date
Cursor: Cursor for the block query
BatchSize: Optional Batch Size for query defaults to 100
Returns
Status: success|error
BlockBatch: List of Block Dictionaries
Cursor: Cursor needed to continue batch process
More: Boolean determining if the query has more batches
GetBatchedInventoryByDate
PRIVATE
/api/1/inventory/get-batched-inventory-for-a-date
Get all inventory blocks for a specific date for Available and Reserved
Parameters
* StatusDate: Date of the sku blocks
TransactionStatusFilters: Filters to return - default available and reserved
IgnoreItemsWithComponents: BooleanDetermines if we want to filter out items with components
Cursor: Cursor for the current query
RecordLimit: Number Of items per query
Returns
Status: success|error
InventoryBlockBatch: SKUs for a specific date
Cursor: SKUs for a specific date
More: Boolean Denoting if there is more sku to get inventory for
GetCurrentApiVersion
PRIVATE
/api/1/meta/get-current-api-version
POST
Returns the current date and number for the api version
Returns
Status: success|error
CurrentApiNumber: An integer version of the api version
CurrentApiReleaseDate: A release date for the api version in isoformat
GetDetailedProductSku
PRIVATE
/api/1/product-sku/get
POST
Get everything about a ProductSku including inventory, suppliers, and related data
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
ProductSkuKey: A key to lookup (either this or ProductSID required)
ProductSID: Product SID to lookup (either this or ProductSkuKey required)
IncludeAll: Boolean whether to include all data (default: True)
Suppliers: Boolean whether to include Suppliers
ActiveBlock: Boolean whether to include active inventory block
Inventory: Boolean whether to include inventory summary
AdjustmentRecords: Boolean whether to include adjustment records
StorageLocations: Boolean whether to include storage locations
InventoryAudits: Boolean whether to include inventory audits
ParentComponentSkus: Boolean whether to include parent component SKUs
IncludeComponents: Boolean whether to include component details
KeysOnly: Boolean whether to return only keys for related entities
Returns
Status: success|error
ProductSku: Detailed product SKU dictionary with requested data
GetDisabledProductAttributeOptions
PRIVATE
/api/1/product-attribute/get-disabled-options
POST
Gets a list of all disabled attribute options for an attribute
Parameters
AttributeKey: NDB key of the attribute key
Returns
Status: success|error
DisabledAttributeOptions: List of disabled attribute options
GetElementByCode
PRIVATE
/api/1/product-listing/draft/get-element-by-code
POST
Adds a product addon to a product listing
Parameters
* ProductListingKey: NDB key of Product Listing to add addon
* ElementCode: Code for desired element content
:
Returns
Status: success|error
ElementContent: Content of the desired element
GetEntityByKey
PRIVATE
/api/1/entity/get-by-key
POST
Gets an entity by the Key and generates Python code to recreate it
Parameters
* Key: urlsafe() Key or SKU ID
Put: Boolean - whether to put the entity after retrieval
Returns
Status: success|error
Dictionary: Entity as dictionary
Modules: List of required imports
Python: Python code lines to recreate entity
CreatedKeys: List of created urlsafe keys
NextKeys: List of keys to process next
Key: Entity key
Entity: Entity as string
Build: Complete Python script to recreate entity
Kind: Entity kind
GetFilterListValues
PRIVATE
/api/1/filter-lists/get-list-values
POST
Retrieves string list for desired filter list
Parameters
* ListName: String name of filter list
Returns
Status: success|error
ListValues: List of string values representing the desired filter list
GetFirstTransactionBlock
PRIVATE
/api/1/inventory/inventory-status-block/get-rebuild-block
Get the first transaction block date for a SKU to determine rebuild starting point
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* TargetBlockDate: Target block date as YYYY-MM-DD
UserEmail: Email of authorized user
GetGlobalLeadDays
PRIVATE
/api/1/product-sku/get-global-lead-days
Get the global lead days for SKUs
Returns
Status: success|error
LeadDays: integer
GetInventoryAdjustmentsByDate
PRIVATE
/api/1/inventory/get-inventory-adjustments-by-date
Retrieve adjustment records for a specific date, optionally filtered by adjustment type
Parameters
TargetDate: Date to get Adjustments for
AdjustmentType: Desired singular adjustment type
Returns
Status: success|error
InventoryAdjustmentList: Audit adjustment information
GetInventoryAdjustmentsBySku
PRIVATE
/api/1/inventory/get-inventory-adjustments
Retrieve adjustment records for a SKU, optionally filtered by transaction type and adjustment type
Parameters
* ProductSkuKey: NDB key of ProductSku to query
* TransactionType: TransactionType to query
* AdjustmentType: AdjustmentType to query
Returns
Status: success|error
InventoryAdjustmentList: Audit adjustment information
GetInventoryBlock
PRIVATE
/api/2022-02-25/inventory/get-block
Retrieve a single inventory status block for a SKU on a specific date
Parameters
* ProductSkuKey: Product SKU Key
StatusDate: Date of Status to retrieve
IncludeAll: Defaults to False
Returns
Status: success|error
InventoryStatusBlock: List of possible Transaction Statuses
GetInventoryByDateRange
PRIVATE
/api/2019-10-16/inventory/by-date-range
Gets a list of date and quantity for a storage location for a specific sku
Parameters
* ProductSkuKey: NDB key of ProductSku to query
* StartDate: Start Date for when to start collecting totals
EndDate: End Date for when to stop collecting totals
Returns
Status: success|error
AvailableQty: Sku mapping with the available Qty and Location information
GetInventoryBySkuKeys
PRIVATE
/api/1/inventory/get-inventory-by-sku-keys
Gets a list of qty available for a SKU including its location info
Parameters
* ProductSkuKeys: NDB keys of ProductSku to query
* StatusDate: Date of the sku blocks
TransactionStatusFilters: Filters to return - default available and reserved
Returns
Status: success|error
AvailableQty: Sku mapping with the available Qty and Location information
GetMismatchSkuInventoryDetails
PRIVATE
/api/1/inventory/get-sku-inventory-mismatch
POST
Get details of inventory for SKUs where block and SKU inventory are mismatched
Returns
Status: success|error
MismatchSkuInventoryDetails: List of sku detail dictionary
GetOrInsertWareHouseByName
PRIVATE
/api/2022-05-13/warehouse/get-or-insert-by-name
Get or create a warehouse location by name
Parameters
* Name: WareHouse Location Name
* UID: Unique ID supplied from fulfillment
* FulfillmentLocationKey: FulfillmentLocation key
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
GetOutOfStockSkus
PRIVATE
/api/1/product-sku/get-out-of-stock
POST
Queries out of stock active skus and returns results
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
ReadFromCache: boolean indicating whether or not to retrieve skus from json file
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
GetPhysicalCountsByDateRange
PRIVATE
/api/1/get-physical-counts-by-date-range
Retrieve all inventory audit results (physical counts) within a specified date range
Parameters
* StartDate: Start Date
EndDate: End Date
GetPriceSources
PRIVATE
/api/1/price-data/sources
POST
Get list of available price sources
Parameters
ActiveOnly: Return only active sources (default true)
Returns
Status: success|error
PriceSources: List of price sources
GetPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/get
POST
Get Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of PricingRuleTemplate
Returns
Status: success|error
PricingRuleTemplate: JSON object containing all PricingRuleTemplateData
GetPricingRuleTemplates
PRIVATE
/api/1/pricing-rule-template/get-all-templates
POST
Retrieves all Pricing Rule Templates from PLS
Returns
Status: success|error
PricingRuleTemplateList: List of all pricing rule templates
GetProductAttributeList
PRIVATE
/api/2019-03-13/product-attribute/get-list
POST
Gets a list of all attributes based on specific/global flag
Parameters
AttributeType: specific|global
IncludeAll: Boolean
IncludeProductListing: Boolean
Returns
Status: success|error
Attributes: List of product attributes
GetProductAttributeOption
PRIVATE
/api/2019-09-05/product-attribute-option/get
POST
Gets a single attribute option by key
Parameters
* AttributeOptionKey: NDB key of ProductAttributeOption
Returns
Status: success|error
AttributeOption: Attribute option details
GetProductAttributeOptionDeprecated
PRIVATE
/api/1/product-attribute-option/get
POST
Gets a list of all attribute options (DEPRECATED)
Parameters
* AttributeOptionKey: NDB key of ProductAttribute
List: NDB key of the attribute key
Returns
Status: success|error
Attributes: List of attribute options
GetProductAttributeOptions
PRIVATE
/api/1/product-attribute/get-options
GETPOST
Gets a list of all attribute options (DEPRECATED)
Parameters
AttributeKey: NDB key of the attribute key
Returns
Status: success|error
AttributeOptions: List of product attribute options
GetProductAttributes
PRIVATE
/api/2019-03-13/product-attribute/get
POST
Gets a list of attributes from keys
Parameters
ProductAttributeKeys: NDB list of keys of the attribute key
IncludeAll: Boolean
IncludeProductListing: Boolean
Returns
Status: success|error
ProductAttributes: List of product attributes
GetProductAttributesByList
PRIVATE
/api/1/get-product-attributes-by-list
POST
Get Product Attribute JSON data (DEPRECATED)
Parameters
* ProductAttributeKeys: List of attributeKeys for which to retrieve data
IncludeOptionData: Boolean flag for also returning attribute option data
Returns
Status: success|error
ProductAttributes: List of dictionaries of Attribute data
GetProductAttributesDeprecated
PRIVATE
/api/1/product-attributes/get
GETPOST
Gets a list of all attributes (DEPRECATED)
Parameters
AttributeKey: NDB key of the attribute key
AttributeType: specific|global
Returns
Status: success|error
Attributes: List of product attributes
GetProductFeedBlacklist
PRIVATE
/api/2019-07-19/product-feed/blacklist/get
POST
Retrieves skus from product feed blacklist
Returns
Status: success|error
Blacklist: List of blacklisted SKUs
GetProductListingDraft
PRIVATE
/api/2019-06-19/product-listing/draft/get-draft
POST
Get the draft version of a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
IncludeSkuData: boolean flag for including sku data
IncludeDeprecatedSkus: boolean for including deprecated sku data
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
GetProductListingDraftDeprecated
PRIVATE
/api/1/product-listing/draft/get-draft
POST
Get the draft version of a product listing (DEPRECATED)
Parameters
* ProductListingKey: NDB key of Product Listing
IncludeSkuData: boolean flag for including sku data
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
GetProductListingDraftSKUs
PRIVATE
/api/1/product-listing/draft/get-skus
POST
Retrieves product sku data from product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
IncludeNameDescriptions: Generate names using attribute option description
GetProductListingSKUs
PRIVATE
/api/2025-08-20/product-listing/get-skus
POST
Retrieves all SKU Keys from the Product Listing
Parameters
* ProductListingKey: NDB key of created Product Listing
RecordLimit: Defaults to 500
Cursor: To continue the query
GetProductListingSKUsDeprecated
PRIVATE
/api/1/product-listing/get-skus
POST
Retrieves all SKU Keys from the Product Listing (DEPRECATED)
Parameters
* ProductListingKey: NDB key of created Product Listing
RecordLimit: Defaults to 100
Cursor: To continue the query
GetProductListingsFromTemplateKey
PRIVATE
/api/1/product-listing/get-by-template-key
POST
Retrieve product listings associated with a given template key
Parameters
* TemplateKey: CMS string key of template
Returns
Status: success|error
ProductListings: Returns list of ProductListings
GetProductListingsVersion
PRIVATE
/api/1/product-listing/draft/get-version
POST
Get a previous version of a product listing
Parameters
* ProductListingVersionKey: NDB key of Product Listing Version
IncludeSkuData: Include full SKU data
Returns
Status: success|error
ProductListingVersion: ProductListingVersion details
GetProductListingsVersions
PRIVATE
/api/1/product-listing/draft/get-versions
POST
Get all draft versions of a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingVersions: List of ProductListingVersions
GetProductListingsWithAddon
PRIVATE
/api/2025-07-29/product-listing/get-by-addon-key
POST
Retrieve product listing keys with an addon for the given listing key
Parameters
* AddonListingKey: Listing key for the Addon we want to find the "parent" listings of
Cache: Use cache (default: true)
Returns
Status: success|error
ProductListings: Returns list of ProductListings
GetProductListingsWithAddonDeprecated
PRIVATE
/api/1/product-listing/get-by-addon-key
POST
Retrieve product listing keys with an addon for the given listing key (DEPRECATED)
Parameters
* AddonListingKey: Listing key for the Addon we want to find the "parent" listings of
Cache: Use cached listings (default True)
Returns
Status: success|error
ProductListingKeys: Returns list of ProductListings
GetProductSkuByBarcodeID
PRIVATE
/api/05-10-2019/product-sku/get-by-barcode-id
POST
Retrieves Product SKU via Barcode ID
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* BarCodeID: Barcode ID of the ProductSku
Returns
Status: success|error
ProductSku: Product SKU dictionary
GetProductSkuByID
PRIVATE
/api/2024-03-07/product-sku/get-by-id
POST
Retrieves Product SKU via Identifier (Barcode, UPC, VendorItemID, etc.)
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ID: Identifier (Barcode, UPC, Key, SID, etc...)
Returns
Status: success|error
ProductSku: Product SKU dictionary
SID: String ID of the found SKU
ProductSkus: Array of matching keys
ProductSIDs: Array of matching SIDs
GetProductSkuInventory
PRIVATE
/api/2023-05-23/product-sku/inventory
Retrieve detailed inventory data including availability, sales metrics, and location-specific quantities for a SKU over a date range
Parameters
* ProductSkuKey: NDB key of ProductSku to query
* StartDate: Start date for inventory query
EndDate: End date for inventory query (defaults to today if omitted)
GetProductSkuInventoryDeprecated
PRIVATE
/api/2023-02-28/product-sku/inventory
POST
Returns each count for a location
Parameters
* Days: Integer of weeks to query
* ProductSkuKey: NDB key of ProductSku to query
GetProductSkuKeysBySID
PRIVATE
/api/1/product-sku/keys-by-sid
Get ProductSku keys from SIDs
Parameters
* SIDs: List of SIDs to return keys for
Returns
Status: success|error
SkuKeys: Remapped keys from SIDs
GetProductSkusByWareHouseKey
PRIVATE
/api/2022-05-13/warehouse/get-skus
Get ProductSkus assigned to a specific warehouse
Parameters
* WareHouseLocationKey: WareHouse Key
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
GetRetiredSKUSForDailySummary
PRIVATE
/api/1/product-sku/get-skus-for-retired-notice
Gets all SKUs retired within the past 30 days
Parameters
Cursor: index that previous query left off
RecordLimit: Requested batch size
Returns
Status: success|error
RetiredSKUs: List of SKU dictionaries
ProductSkus: List of SKU dictionaries
GetSKUsByProductType
PRIVATE
/api/1/product-sku/get-skus-by-product-type
Gets all skus with a given product type
Parameters
* ProductType: type of product
Returns
Status: success|error
RetiredSKUs: List of SKU dictionaries
GetSKUsForProductFeed
PRIVATE
/api/1/product-sku/query-product-feed
Queries valid products for the Product Feed
Returns
Status: success|error
RetiredSKUs: List of SKU dictionaries
GetSkuAvailableInventoryCount
PRIVATE
/api/1/inventory/available-for-sale
Retrieve the total available-for-sale quantity for a SKU
Parameters
* ProductSkuKey: NDB key of ProductSku to query
Returns
Status: success|error
AvailableForSale: An integer representing the quantity available for sale
GetSkuCurrentInventoryStatus
PRIVATE
/api/1/inventory/current-status-by-location
Queries detailed inventory status for given SKU and returns results
Parameters
* ProductSkuKey: NDB key of ProductSku to query
StatusDate: Date of status (returns today if omitted)
Returns
Status: success|error
InventoryStatus: An array of inventory status dictionaries
GetSkuCurrentPrices
PRIVATE
/api/1/price-data/sku-current
POST
Get current prices from all sources with totals
Parameters
* ProductSkuKey: ndb Key for ProductSku
Returns
Status: success|error
CurrentPrices: List of current prices from all sources
GetSkuDataForCartDiscountCalculations
PRIVATE
/api/1/product-sku/get-price
Get SKU pricing data for cart discount calculations
Parameters
* SkuKeys: list of sku keys
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
GetSkuInfoForDiscovery
PRIVATE
/api/1/price-data/sku-info
POST
Get essential SKU information needed for URL discovery
Parameters
* ProductSkuKey: ndb Key for ProductSku
Returns
Status: success|error
SkuInfo: SKU information for URL discovery
GetSkuInventoryCounts
PRIVATE
/api/1/inventory/sku-inventory-counts
Retrieve inventory count totals per location and transaction status for a SKU
Parameters
* ProductSkuKey: NDB key of ProductSku to query
Returns
Status: success|error
Counts: An dictionary of the count totals per location and type
GetSkuMonitorUrls
PRIVATE
/api/1/price-data/sku-monitor-urls
POST
Get all monitored URLs for a SKU
Parameters
* ProductSkuKey: ndb Key for ProductSku
ActiveOnly: Return only active URLs (default true)
IncludeSource: Include price source information (default true)
Returns
Status: success|error
MonitorUrls: [{'MonitorUrlKey': 'SkuMonitorUrl key', 'MonitorUrl': 'URL being monitored', 'Priority': 'Priority level', 'IsActive': 'Active status', 'SourceName': 'Price source name', 'CreatedOn': 'Creation timestamp', 'LastChecked': 'Last check timestamp', 'Notes': 'Optional notes', 'SuccessfulChecks': 'Count of successful monitoring checks', 'FailedChecks': 'Count of failed monitoring checks'}]
GetSkuPriceHistory
PRIVATE
/api/1/price-data/sku-history
POST
Get price history for a SKU with calculated totals
Parameters
* ProductSkuKey: ndb Key for ProductSku
PriceSourceKey: Filter by specific source
StartDate: Filter from date (YYYY-MM-DD)
EndDate: Filter to date (YYYY-MM-DD)
Limit: Maximum records to return (default 100)
Returns
Status: success|error
PriceHistory: List of price records with source information
GetSkusForPriceMonitoring
PRIVATE
/api/1/price-data/skus-for-monitoring
POST
Get list of active SKUs that should be monitored for price data
Parameters
Limit: Maximum number of SKUs to return (default 1000)
Offset: Offset for pagination (default 0)
OnlyWithoutMonitorUrls: Only return SKUs that have no active monitor URLs (default false)
SortBy: Sort field: sales_revenue, sales_units, or created_date (default created_date)
SortDirection: Sort direction: asc or desc
Returns
Status: success|error
SKUs: List of SKUs with monitoring information
TotalCount: Total number of SKUs available
HasMore: Whether there are more results available
GetSkusForProductFeed
PRIVATE
/api/2019-09-04/product-sku/get-skus-for-product-feed
Gets cached copy of product skus for product feeds (Google/Bing/FB/GSA) and returns results
Parameters
IncludeOutOfStockSkus: Boolean indicating whether or not to include out of stock skus in results
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
GetSkusForProductFeedDeprecated
PRIVATE
/api/1/product-sku/get-skus-for-product-feed
POST
Queries product skus for product feeds (Google/Bing/FB/GSA) and returns results (DEPRECATED)
Parameters
IncludeOutOfStockSkus: Boolean indicating whether or not to include out of stock skus in results
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
Warning: Deprecation warning
GetStorageLocation
PRIVATE
/api/1/inventory/get-storage-location
POST
Retrieve a single storage location by key or ID
Parameters
Key: Urlsafe Key for the StorageLocation
ID: Key ID for the StorageLocation
IsDeleted: Return storage location even if it may be deleted
Returns
Status: success|error
StorageLocation: Storage location details
GetStorageLocations
PRIVATE
/api/1/inventory/get-storage-locations
POST
Retrieve all storage locations, optionally filtered by fulfillment location
Parameters
FulfillmentLocationKey: URL safe string of the FulfillmentLocation key
DisplayDeleted: If true, then display deleted items
Returns
Status: success|error
StorageLocations: List of storage locations
GetSupplier
PRIVATE
/api/1/supplier/get
POST
Retrieve supplier data by key or ID. Either SupplierKey or SupplierID is required.
Parameters
SupplierKey: NDB urlsafe key of requested supplier (either this or SupplierID required)
SupplierID: Integer ID of requested supplier (either this or SupplierKey required)
IncludeSkuData: Returns the SKUs or not
Returns
Status: success|error
Supplier: Dictionary of Supplier data
GetSupplierData
PRIVATE
/api/2022-03-28/supplier/get-data
POST
Retrieve supplier data along with associated cached file data
Parameters
SupplierKey: NDB urlsafe key of requested supplier
SupplierID: Integer ID of requested supplier
Returns
Status: success|error
Data: Supplier file data
Supplier: Dictionary of Supplier data
GetSupplierFromFile
PRIVATE
/api/1/supplier/get-from-file
POST
Retrieve supplier data from cached file (deprecated)
Parameters
SupplierKey: NDB urlsafe key of requested supplier
SupplierID: Integer ID of requested supplier
Returns
Status: success|error
Supplier: Dictionary of Supplier data
GetSupplierProductSkuData
PRIVATE
/api/2025-08-26/product-sku/supplier-data
POST
Generate supplier JSON file for a specific SKU using SID or urlsafe key
Parameters
* ProductSkuKey: ProductSku urlsafe key (string)
HydrateLiveData: Boolean - Include live inventory and sales data (default: true)
Returns
Status: success|error
ProductSku: SupplierProductSku model data
Message: Success or error message
GetSuppliersForProductSku
PRIVATE
/api/1/supplier/product-sku
POST
Retrieve all suppliers associated with a product SKU
Parameters
* ProductSkuKey: Key of requested product SKU
IncludeDeleted: Include inactive suppliers
Returns
Status: success|error
Suppliers: List of Suppliers
GetTransactionStatuses
PRIVATE
/api/1/inventory/get-transaction-status-options
Gets a list of the possible transaction status options
Returns
Status: success|error
TransactionStatusOptions: List of possible Transaction Statuses
GetWareHousesByProductSkuKeys
PRIVATE
/api/2022-03-31/warehouse/get
Gets Warehouse data based on Sku Keys
Parameters
* ProductSkuKeyList: list of SKU Keys
Returns
Status: success|error
ProductSkus: A list of product sku dictionaries
IncrementProductQuantity
PRIVATE
/api/1/product-sku/increment-quantities
POST
Increment ProductSku quantities in bulk
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuQuantityDict: Dictionary in form of {sku_key: quantity}
InvalidateTransactionBlock
PRIVATE
/api/1/inventory/transaction/invalidate-transaction-block
Invalidate an inventory transaction block by clearing its checksum and triggering validation
Parameters
* ProductSkuKey: Key of queried SKU
StatusDate: Date as YYYY-MM-DD (current date if omitted)
InventoryAuditResultGet
PRIVATE
/api/2022-02-10/inventory/inventory-audit-result/get
Retrieve a single inventory audit result by key
Parameters
* InventoryAuditResultKey: Urlsafe key of the inventory audit result
InventoryAuditResultQueryActive
PRIVATE
/api/2022-02-10/inventory/inventory-audit-results/get-active
Query active Inventory Audit Results
Returns
Status: success|error
InventoryAuditResults: Keys of InventoryAuditResults
ItemsAvailableForInStore
PRIVATE
/api/1/inventory/are-items-available-for-in-store
Gets a boolean of if all the skus are available for pickup in-store
Parameters
* ProductSkuKeys: NDB keys of ProductSku to query
Returns
Status: success|error
AvailableInStore: Boolean of if the skus are all available in store
LaunchGenerateActiveAuditFile
PRIVATE
/api/1/meta/generate-active-audits-file
Launches the endpoint to generate a file of Audits that are currently making adjustments on the block
LaunchGenerateAdjustmentFile
PRIVATE
/api/1/meta/generate-sku-adjustments-file
POST
Launches the endpoint to generate the adjustment file
Parameters
* StartDate: Start date in MM/DD/YYYY format
EndDate: End date in MM/DD/YYYY format (defaults to StartDate + 30 days)
RequesterEmail: Email of user to send completed notification to
Returns
Status: success
Message: Adjustment file generation task queued
LoadListingVersionAsDraft
PRIVATE
/api/2019-06-12/product-listing/draft/publish-version
POST
Load a previous version of a product listing as the current draft
Parameters
* ProductListingVersionKey: NDB key of Product Listing Version to be loaded as draft
Returns
Status: success|error
ProductListingKey: NDB key of the Product Listing
LoadListingVersionAsDraftDeprecated
PRIVATE
/api/1/product-listing/draft/publish-version
POST
Get the draft version of a product listing (DEPRECATED)
Parameters
* ProductListingVersionKey: NDB key of Product Listing Version to be Published
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
MigrateProductSkuToListing
PRIVATE
/api/2019-04-01/product-listing/draft/swap-sku-details
POST
Migrates details of a legacy sku to a dynamically generated one.
Parameters
* KeyToCopy: NDB key of Product Sku
* KeyToUpdate: NDB key of Product Sku
PricingRuleTemplateSave
PRIVATE
/api/1/pricing-rule-template/save
POST
Create or update a Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of PricingRuleTemplate (use "new" to create)
* PricingRuleTemplateName: Name of PricingTemplate
Returns
Status: success|error
PricingRuleTemplateKey: NDB Key of pricing rule template
ProductAttributeDisableOption
PRIVATE
/api/2019-07-29/product-attribute/option/disable
POST
Disable an AttributeOption on ProductAttribute
Parameters
* AttributeKey: NDB key of the attribute to be edited
* AttributeOptionKey: NDB key of attribute option to flag as deleted
Returns
Status: success|error
AttributeKey: key
ProductAttributeEnableOption
PRIVATE
/api/2019-07-29/product-attribute/option/enable
POST
Enable an AttributeOption on ProductAttribute
Parameters
* AttributeKey: NDB key of the attribute to be edited
* AttributeOptionKey: NDB key of attribute option to flag as enabled
Returns
Status: success|error
AttributeKey: key
ProductAttributeSaveOptionOrder
PRIVATE
/api/2019-07-29/product-attribute/option/save-order
POST
Save the ordering of AttributeOption list on ProductAttribute
Parameters
* AttributeKey: NDB key of the attribute to be edited
* AttributeOptions: list of urlsafe attribute option keys
Returns
Status: success|error
AttributeKey: key
ProductEventsFeed
PRIVATE
/api/2022-10-26/product-events/feed
POST
Get a feed of product events with optional date filtering
Parameters
Cursor: NDB cursor for pagination
RecordLimit: Number of records to return (default 100)
StartDate: Start date for filtering (ISO format)
EndDate: End date for filtering (ISO format)
Order: Sort order: asc or desc (default desc)
Returns
Status: success|error
ProductEvents: List of Product Events
More: Whether more results available
Cursor: Cursor for next page
ProductListingDraftSaveAttributeOrder
PRIVATE
/api/2019-08-08/product-listing/draft/product-attribute/save-order
POST
Saves the ordering of product attribute list.
Parameters
* ProductListingKey: NDB key of Product Listing
* ProductAttributes: List of urlsafe product attribute keys
ProductListingDraftSetDefaultSKU
PRIVATE
/api/2019-06-06/product-listing/draft/set-default-sku
POST
Sets all listings and skus associated with a migration to their pre-migrated state.
Parameters
* ProductSkuKey: NDB key of Product SKU
* ProductListingKey: NDB key of Product Listing
PublicSkuInventoryByDateDeprecated
PRIVATE
/p/1/inventory/sku-status-by-date
POST
Get JSON data for current inventory block
Parameters
* ProductSkuKey: Key of queried SKU
StatusDate: Date as YYYY-MM-DD (current date if omitted)
Returns
Status: success|error
InventoryStatus: Block
PublishMultiSkuListingDataFix
PRIVATE
/api/1/meta/publish-multi-sku-listings
POST
Queues a datafix to publish the current draft state of multi-sku items
Returns
Status: success|error
Message: Task queued successfully
PublishProductListingDraft
PRIVATE
/api/2019-09-11/product-listing/draft/publish
POST
Publish the draft version of a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
PublishProductListingDraftDeprecated
PRIVATE
/api/2019-07-25/product-listing/draft/publish
POST
Get the draft version of a product listing (DEPRECATED)
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
QueryProductEvents
PRIVATE
/api/2022-10-17/product-events/query
POST
Query product events with filtering by SKU, type, action, etc.
Parameters
Cursor: NDB cursor for pagination
RecordLimit: Number of records to return (default 100)
EventType: Event type: sale, price, inventory, etc.
EventAction: Event action: create, update, delete
ProductSkuKey: NDB key of the SKU
Order: Sort order: asc or desc (default desc)
Returns
Status: success|error
ProductEvents: List of Product Events
More: Whether more results available
Cursor: Cursor for next page
QueryProductSkus
PRIVATE
/api/1/product-sku/get-all-skus-batched
Query SKUs as an endpoint
Parameters
Cursor: index that previous query left off
RecordLimit: Requested batch size
KeysOnly: Denotes if this query is key only
Returns
Status: success|error
ProductSkus: List of SKU dictionaries
QueryReportedInventoryAuditResults
PRIVATE
/api/2022-11-17/inventory-audit-results/query
Query inventory audit results with REPORTED status, optionally formatted as CSV data
Parameters
KeysOnly: Keys only response for quicker queries
ImitateCsvFile: Responds with CSV file
IncludeAll: Include all in the to_dict
QueryReportedInventoryAuditResultsQuery
PRIVATE
/api/2022-11-17/inventory-audit-results/query
Query inventory audit results with REPORTED status, optionally formatted as CSV data
Parameters
KeysOnly: Keys only response for quicker queries
ImitateCsvFile: Responds with CSV file
IncludeAll: Include all in the to_dict
RecentInventoryAudits
PRIVATE
/api/2024-12-30/inventory/inventory-audit-result/recent
Retrieve the most recent inventory audit result for each storage location for a SKU
Parameters
* ProductSkuKey: NDB key of ProductSku to query
FulfillmentLocationKey: FulfillmentLocationKey that queries the StorageLocationKey
RecordLimit: Maximum number of records to return (default: 10)
RecordAdjustment
PRIVATE
/api/1/inventory/transaction/adjustment
Records an adjustment transaction
Parameters
* Quantity: Quantity of stock in transaction (as integer)
ProductSkuKey: Urlsafe key of ProductSku
ProductSID: ID of ProductSku
UserEmail: Email of authorized user
Note: Note related to adjustment
ExternalTransactionNumber: Transaction Number for PO(Vendor or MH)
FromLocation: Location the inventory originated from
ToLocation: Where the inventory is ending up
LocationKey: Key of location where stock should be reserved
FromStatus: Status of the inventory at from location
ToStatus: Status of the inventory at to location
TargetDate: Date of specific block to target
BulkUploadID: Key of the Bulk upload this is associated with if applicable
RecordAdjustmentInBulk
PRIVATE
/api/1/inventory/transaction/adjustment-bulk
Records an adjustment transaction
Parameters
* ProductSkuKeyDict: Dictionary of Sku Keys To Bulk Update
* TargetDate: Date of specific block to target
UserEmail: Email of authorized user
Note: Note related to adjustment
FromLocation: Location the inventory originated from
ToLocation: Where the inventory is ending up
LocationKey: Key of location where stock should be reserved
FromStatus: Status of the inventory at
ToStatus: Status of the inventory at to location
RecordCustomerOrder
PRIVATE
/api/1/inventory/transaction/customer-order
Records a customer order transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location where stock should be reserved
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
HasComponents: skip save for parent of components
Note: note for the transaction
RecordCustomerReturnCancellation
PRIVATE
/api/1/inventory/transaction/return-cancel
Records a customer return transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location where stock is being returned to or disposed of
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
OrderNumber: purchase order number
ValidationID: used to prevent double submission
RecordCustomerReturnItemInspected
PRIVATE
/api/1/inventory/transaction/return-item-inspected
Records transaction when a return item is inspected
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of order
* AwaitingRestock: Flag whether or not item will be restocked
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordCustomerReturnItemReceived
PRIVATE
/api/1/inventory/transaction/return-item-received
Records transaction when a return item is received
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* ShipmentCreated: Whether or not shipment for rma exists
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordEventTransaction
PRIVATE
/api/1/inventory/transaction/record-fulfillment-transaction
Records a transaction from a fulfillment status event
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* FromLocationKey: Key of the location we are un-reserving stock from
* FromStatus: Status purchase item currently is being moved from
* ToStatus: Status purchase item is being moved to
* ToLocationKey: Key of new location where stock should be reserved
* StatusName: ItemFulfillmentStati defined on OFS
* OrderKey: Key of order
UserEmail: email of the user who created the customer transaction
ValidationID: used to prevent double submission
TargetDate: used to allow data-fix to generate these when relevant
RecordLocationTransfer
PRIVATE
/api/1/inventory/transaction/transfer-location
Records a location transfer transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* FromLocationKey: Key of the location we are unreserving stock from
* ToLocationKey: Key of new location where stock should be reserved
ExternalTransactionNumber: If we have a transactional number in the future we will want to support tracking this
IsAdjustmentTransfer: Boolean to determine if this is an adjustment or if we need to ship some to the other warehouse
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
Note: note for the transaction
BulkUploadID: Key of associated Bulk Upload if applicable
RecordRMACanceled
PRIVATE
/api/1/inventory/transaction/rma-canceled
Records RMA cancellation transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
* FromStatus: Status of the sku before cancellation
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordRMAFinalization
PRIVATE
/api/1/inventory/transaction/finalize-rma
Records finalization process complete
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
* LocationFrom: Location key of sold item
* LocationTo: Location key of sold item
* AwaitingRestock: Flag whether or not item will be restocked
* PreRAFulfillmentStatus: Status of purchase item prior to RMA
OriginalStorageLocation: Key of the original storage location.
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordRMAInitialization
PRIVATE
/api/1/inventory/transaction/initialize-rma
Records RMA initialization transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordRMAReturnShipmentRequested
PRIVATE
/api/1/inventory/transaction/rma-customer-shipment-requested
Records RMA return shipment requested transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordRMAStockTransfer
PRIVATE
/api/1/inventory/transaction/rma-stock-transfer
Records an RMA stock transfer
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* ToLocation: Urlsafe key of target location
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordReservationLocationChange
PRIVATE
/api/1/inventory/transaction/reserve-location-change
Records a reservation location change
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* FromLocationKey: Key of the location we are unreserving stock from
* ToLocationKey: Key of new location where stock should be reserved
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
TargetDate: used to allow data-fix to generate these when relevant
RecordShipmentScanned
PRIVATE
/api/1/inventory/transaction/shipment-scanned
Records a shipment sent transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location where stock is send out from
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
Note: additional note
ValidationID: used to prevent double submission
TargetDate: used to allow data-fix to generate these when relevant
RecordVendorOrder
PRIVATE
/api/2022-09-06/inventory/transaction/vendor-order
Records a vendor order transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location where stock is ordered for
* UserEmail: Email of authorized user
* Note: Note related to adjustment
TargetDate: Date where this should be inserted in
DirectToAvailable: Flag signifying if we should directly save to available
BulkUploadID: Key of associated Bulk Upload if applicable
RecordVendorOrderDeprecated
PRIVATE
/api/1/inventory/transaction/vendor-order
POST
Records a vendor order transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location where stock is ordered for
* UserEmail: Email of authorized user
* Note: Note related to adjustment
TargetDate: Date where this should be inserted in
DirectToAvailable: Flag signifying if we should directly save to available
BulkUploadID: Key of associated Bulk Upload if applicable
RecordVendorOrderReceived
PRIVATE
/api/2022-09-06/inventory/transaction/vendor-order/check-in
Records vendor order receipt transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* LocationKey: Key of location that is receiving stock
* OrderKey: Key of order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RecordVoidOrdered
PRIVATE
/api/1/inventory/transaction/void-order
Voided order
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Location: Urlsafe key of target location
* Quantity: Quantity of stock in transaction (as integer)
* OrderKey: Key of original order
CreatedBy: email of the user who created the customer transaction
ValidationID: used to prevent double submission
RelaunchSaveTransactionToBlock
PRIVATE
/api/1/relaunch-save-transactions-to-block
Starts save task for given transaction list if provided or all created before today
Parameters
TransactionWrapperKeys: List of transaction wrappers that need to be rerun
RemoveAddOnFromProductSku
PRIVATE
/api/2019-08-19/product-sku/remove-addon
POST
Removes an addon from a product sku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of Product Listing to remove addon from
* AddOnSkuKey: Key for the addon that is being removed
RemoveAddonFromProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove-addon
POST
Removes an addon from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing to add addon
* AddOnListingKey: Key for the addon that is being removed
:
Returns
Status: success|error
ProductListingKey: Return Listing Key of Listing that lost an addon
RemoveAllValWarehouseLocations
PRIVATE
/api/1/product-sku/remove-all-val-warehouse-locations
Removes all val warehouse locations by queuing deferred tasks
RemoveComponentFromSku
PRIVATE
/api/1/product-sku/remove-component
POST
Remove a component from a sku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* SkuKey: SKU key
* ComponentKey: SKU key for component to be removed
RemoveContactFromSupplier
PRIVATE
/api/1/supplier/remove-contact
POST
Remove email address from supplier vendor contact list. Either SupplierKey or SupplierID is required.
Parameters
* SupplierContactEmail: Email address of contact at supplier
SupplierKey: NDB urlsafe key of Supplier to edit (either this or SupplierID required)
SupplierID: Integer ID of Supplier to edit (either this or SupplierKey required)
RemoveDigitalItemFromProductSku
PRIVATE
/api/1/product-sku/remove-digital-item
POST
Removes a digital item from a ProductSku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: Key of the ProductSku that we are removing a digital item from
* DigitalItemKey: License Key of digital item being removed from the ProductSku
RemoveElementFromProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove-element
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* ElementCode: Six Digit alphanumeric unique code
RemoveFromFilterList
PRIVATE
/api/1/filter-lists/remove-value
POST
Removes string from filter list
Parameters
* ListName: String name of filter list
* FilterListValue: Value being removed from filter list
Returns
Status: success|error
ListValues: List of string values representing the desired filter list
RemoveImageFromAttributeOption
PRIVATE
/api/1/product-attribute-option/remove-image
POST
Removes the image associated with an attribute option
Parameters
* AttributeOptionKey: NDB key of the associated attribute option
RemoveImageFromAttributeOptionDeprecated
PRIVATE
/api/1/product-attribute-option/remove-image
POST
Removes the image associated with an attribute option (DEPRECATED)
Parameters
* AttributeKey: NDB key of the associated attribute
RemoveImageFromProductAttribute
PRIVATE
/api/1/product-attribute/remove-image
POST
Removes the image associated with a product attribute (DEPRECATED)
Parameters
* AttributeKey: NDB key of the associated attribute
RemoveImageFromProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove-image
POST
Removes an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ImageFileName: Name of file to be deleted
RemoveImageFromProductListingDraftElement
PRIVATE
/api/1/product-listing/draft/remove-element-image
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* ElementCode: Six Digit alphanumeric unique code
* ImageUrl: Serving Url for image
RemoveImageFromProductSku
PRIVATE
/api/1/product-sku/remove-image
POST
Removes a featured image from a ProductSku
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: Key of the ProductSku that we are removing the image from
RemoveInventoryAuditResultOnTransactionBlock
PRIVATE
/api/1/inventory/transaction/remove-physical-count
Remove an Inventory Audit for a specific time
Parameters
* PhysicalCountKey: ID of Physical count (inventory audit result)
* UserEmail: Email address of user creating audit
RemoveMonitorUrl
PRIVATE
/api/1/price-data/remove-monitor-url
POST
Remove/deactivate a monitored URL for a SKU
Parameters
* MonitorUrlKey: ndb Key for SkuMonitorUrl to remove
RemovePricingRuleFromPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/remove-rule
POST
Remove Pricing Rule from Template
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
* QualifyingQuantity: Qualifying Quantity of pricing rule to remove
RemovePricingRuleFromProductSku
PRIVATE
/api/1/product-sku/remove-pricing-rule
Removes a pricing rule from a ProductSku
Parameters
* ProductSkuKey: Key of the ProductSku that we are removing a pricing rule from
* QualifyingQuantity: Qualifying quantity value of rule desired to be removed
RemoveProductAttribute
PRIVATE
/api/1/product-attribute/remove
POST
Removes an attribute from a product (and all skus) (DEPRECATED)
Parameters
* AttributeKey: NDB key of the attribute to be removed
RemoveProductAttributeOption
PRIVATE
/api/1/product-attribute-option/remove
POST
Removes an attribute option from an attribute
Parameters
* AttributeOptionKey: NDB key of the attribute option to be removed
RemoveProductAttributeOptionDeprecated
PRIVATE
/api/1/product-attribute-option/remove
POST
Removes an attribute option from a attribute (DEPRECATED)
Parameters
* AttributeOptionKey: NDB key of the attribute to be removed
RemoveProductKeywordFromProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove-product-keyword
POST
Removes a MetaKeyword from a Product Listing Draft
Parameters
* ProductListingKey: NDB key of created Product Listing
* MetaKeyword: NDB key of related Product Listing
RemoveProductListing
PRIVATE
/api/1/product-listing/remove
POST
Deletes a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
RemoveProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove
POST
Deletes a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
RemoveProductSKUFromPricingRuleTemplate
PRIVATE
/api/1/pricing-rule-template/remove-sku
POST
Removes a ProductSku from Pricing Rule Template
Parameters
* PricingRuleTemplateKey: Key of the PricingRuleTemplate
* ProductSkuKey: Key of the SKU being removed
RemoveProductSku
PRIVATE
/api/1/product-sku/remove
POST
Removes a ProductSku from all active queries
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of Product Sku
EmailAddress: Email address of user removing the SKU
RemoveProductSkuAddonFromProductListingDraft
PRIVATE
/api/2019-08-19/product-listing/draft/remove-sku-addon
POST
Removes a sku addon from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing to add addon
* AddOnSkuKey: Key for the addon that is being removed.
:
Returns
Status: success|error
ProductListingKey: Return Listing Key of Listing that lost an addon
RemoveProductVideo
PRIVATE
/api/2025-09-26/product-listing/draft/video/remove
POST
Removes a ProductVideo from a given product listing page.
Parameters
* ProductListingKey: NDB key of Product Listing
* VideoId: Video UUID
RemoveRelatedProductFromProductListingDraft
PRIVATE
/api/1/product-listing/draft/remove-related-product
POST
Removes related product from product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* RelatedProductKey: NDB key of related product listing
RemoveSkuFromProductFeedBlacklist
PRIVATE
/api/2019-07-19/product-feed/blacklist/remove-sku
POST
Removes a sku key from the product feed blacklist
Parameters
* ProductSkuKey: urlsafe key of product sku being removed from the list
RemoveSkusFromSupplier
PRIVATE
/api/1/supplier/remove-skus
POST
Remove SKUs from a supplier. Either SupplierKey or SupplierID is required.
Parameters
SupplierKey: NDB urlsafe key of Supplier to edit (either this or SupplierID required)
SupplierID: Integer ID of Supplier to edit (either this or SupplierKey required)
SuppliedSkus: List of SKU urlsafe keys to remove
Returns
Status: success|error
PrimarySupplierRemoved: Number of SKUs where primary supplier was removed
RemoveWareHouseFromProductSku
PRIVATE
/api/2022-03-31/warehouse/remove
Removes a warehouse from a Product SKU
Parameters
* ProductSkuKey: Product SKU Key
* WarehouseLocationKey: Warehouse Key
Returns
Status: success|error
ProductSkuKey: NDB key of ProductSku that received the addon.
ReorderAddOnsInProductListingDraft
PRIVATE
/api/1/product-listing/draft/reorder-addons
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* AddOnKeyList: List urlsafe keys for add-ons
ReorderElementsInProductListingDraft
PRIVATE
/api/1/product-listing/draft/reorder-elements
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of created Product Listing
* ElementCodeList: List of element codes ordered in desired setup
ReorderProductSkuAddOns
PRIVATE
/api/2019-08-19/product-sku/reorder-addons
POST
Saves ordering of the product sku addons list
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: NDB key of Product SKU
* AddOnKeyList: List of urlsafe product sku add-on keys in desired order
Returns
Status: success|error
ProductSku: Updated product SKU dictionary
ReorderProductSkuAddOnsInProductListingDraft
PRIVATE
/api/2019-08-19/product-listing/draft/reorder-sku-addons
POST
Saves ordering of the product sku addons list
Parameters
* ProductListingKey: NDB key of created Product Listing
* SkuAddOnKeyList: List urlsafe keys for add-ons
ReorderRelatedProductsInProductListingDraft
PRIVATE
/api/2019-08-19/product-listing/draft/reorder-related-products
POST
Saves ordering of the related products list
Parameters
* ProductListingKey: NDB key of created Product Listing
* RelatedProductKeyList: List urlsafe keys for related products
ReplaceAllProductContentRelativeUrlsWithAbsolutes
PRIVATE
/api/1/meta/replace-all-product-content-relative-urls-with-absolutes
POST
Queues a task to replace relative URLs in product content with absolute URLs
Returns
Status: success|error
Message: Task queued successfully
ReplaceComponents
PRIVATE
/api/2023-08-18/product-sku/replace-components
POST
Replace all components on a SKU
Parameters
* RequestConsumer: API Consumer Key
* RequestSignature: Request signature
* ProductSkuKey: SKU key
ComponentKeys: SKU keys for components (can be empty to remove all)
RemoveComponentKeys: Boolean to explicitly remove all components
Returns
Status: success|error
ComponentKeys: List of component keys now on the SKU
ProductSkuKey: Key of parent SKU
ReplaceTransactionsOnBlock
PRIVATE
/api/1/inventory/inventory-status-block/replace-transactions
Records a list of transactions to overwrite for a day block. Validate will bring in the remainder of transactions
Parameters
* ProductSkuKey: Sku Key Of Transactions to overwrite
* TargetDate: Date of specific block to target
* TransactionDetailsList: List of transactions to be updated
UserEmail: Email of authorized user
RequestDropShip
PRIVATE
/api/1/inventory/transaction/request-drop-ship-order
Records a dropship request transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* UserEmail: Email of authorized user
* Note: Note related to adjustment
* PurchaseOrderKey: PO that has items being dropshipped
FromLocationKey: Key of location where product was going to be shipped before drop-shipping
ReverseReservation: Boolean to determine if there is a reservation already made that needs reversed
ResetDropShipSale
PRIVATE
/api/1/inventory/transaction/reset-drop-ship-sale
Resets a dropship request transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* UserEmail: Email of authorized user
* Note: Note related to adjustment
* PurchaseOrderKey: PO that has items being dropshipped
ResetProductListingDraft
PRIVATE
/api/1/product-listing/draft/reset
POST
Resets the current draft state back to live version
Parameters
* ProductListingKey: NDB key of Product Listing
ResetTransactionBlocks
PRIVATE
/api/1/inventory/inventory-status-block/reset-previous-blocks
Remove old blocks
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* StartDate: Start date for blocks to remove
EndDate: End date for blocks to remove
UserEmail: Email of authorized user
RestoreDeprecatedProductListing
PRIVATE
/api/1/meta/deprecated-listing/restore
POST
Restore deprecated product listings (deprecated - use modern draft management)
Parameters
* ProductListingKey: Listing key of the deprecated product listing to restore
Returns
Status: success|error
Message: Deprecation notice explaining modern alternatives
RetiredSkuDatafixLauncher
PRIVATE
/api/1/meta/retired-skus/datafix-launcher
POST
Launches data fix to set retired datetime
Returns
Status: success|error
Message: Data fix task queued successfully
RevertProductListingSkuMigration
PRIVATE
/api/2019-03-20/product-listing/draft/revert-migration
POST
Sets all listings and skus associated with a migration to their pre-migrated state.
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingKey: Key of the multi sku listing.
SetAllProductPublishedStatus
PRIVATE
/api/1/meta/set-all-product-published-status
POST
Queues a datafix for product_listings HasBeenPublished boolean
SetFeaturedImage
PRIVATE
/api/1/product-listing/draft/set-featuredImage
POST
Adds an image from a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
* ImageFileName: Name of file to set as featured image
Returns
Status: success|error
ProductListingKey: NDB key of Product Listing pass along
SetFeaturedImageDataFix
PRIVATE
/api/1/meta/set-featured-image
POST
Queues a datafix that sets a featured image for any listing with images but no featured image
Returns
Status: success|error
Message: Task queued successfully
SetGlobalLeadDays
PRIVATE
/api/1/product-sku/set-global-lead-days
Set the global lead days for SKUs
Parameters
* LeadDays: Set the lead days
Returns
Status: success|error
LeadDays: integer
SetPrimarySupplierOnSku
PRIVATE
/api/1/product-sku/set-primary-supplier
Set primary supplier on sku
Parameters
* ProductSkuKey: Key of the ProductSku that we are setting the primary supplier on
* SupplierKey: Key of Supplier that will be set as the primary supplier
SetProductListingDraftActive
PRIVATE
/api/2019-09-11/product-listing/draft/set-active
POST
Get the draft version of a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
SetProductListingDraftActiveDeprecated
PRIVATE
/api/2019-04-01/product-listing/draft/set-active
POST
Get the draft version of a product listing (DEPRECATED)
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
SetSkuNameAndImage
PRIVATE
/api/1/meta/set-sku-name-and-image
POST
Queues a datafix that sets SKU names and featured images from product listings
Returns
Status: success|error
Message: Task queued successfully
SkuDropInventoryBlocks
PRIVATE
/api/2021-03-01/product-sku/drop-inventory-blocks
Delete all inventory blocks for a SKU by queuing a background task
Parameters
* ProductSkuKey: NDB key of ProductSku to query
SmallTargetedDataFix
PRIVATE
/api/1/meta/small-targeted-data-fix
POST
Data fix for small PLS changes (deprecated)
SoupMessage
PRIVATE
/api/1/meta/soup-message
POST
Search for text strings within ProductListing element content
Parameters
* StringToLookup: String to lookup in ProductListing element content
UpdateSoup: Boolean flag to save Product Listing changes (not implemented)
Returns
Status: success|error
TargetedBlocks: [{'ElementValue': 'Content value from structured property', 'ProductName': 'Name of the product listing', 'ElementKey': 'LocalStructured Key of the element', 'ProductListingKey': 'Urlsafe key of the ProductListing'}]
TaskRecordAdjustmentInBulk
PRIVATE
/api/1/inventory/transaction/task-adjustment-bulk
Records an adjustment transaction
Parameters
* ProductSkuKeyDict: Dictionary of Sku Keys To Bulk Update
* TargetDate: Date of specific block to target
UserEmail: Email of authorized user
Note: Note related to adjustment
FromLocation: Location the inventory originated from
ToLocation: Where the inventory is ending up
LocationKey: Key of location where stock should be reserved
FromStatus: Status of the inventory at
ToStatus: Status of the inventory at to location
TransferReserveSoldToDropShipSold
PRIVATE
/api/1/inventory/transaction/transfer-reserve-sold-to-drop-ship-sold
Records a dropship transfer to sold request transaction
Parameters
* ProductSkuKey: Urlsafe key of ProductSku
* Quantity: Quantity of stock in transaction (as integer)
* UserEmail: Email of authorized user
* Note: Note related to adjustment
* PurchaseOrderKey: PO that has items being dropshipped
FromLocationKey: Key of location where product was going to be shipped before drop-shipping
UnpublishProductListing
PRIVATE
/api/2019-04-01/product-listing/draft/set-inactive
POST
Get the draft version of a product listing
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
UnpublishProductListingDeprecated
PRIVATE
/api/1/product-listing/draft/set-inactive
POST
Get the draft version of a product listing (DEPRECATED)
Parameters
* ProductListingKey: NDB key of Product Listing
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
UpdateInventoryAdjustmentRecords
PRIVATE
/api/1/meta/transaction/update-inventory-audit-result
POST
Records an adjustment transaction
Parameters
* Quantity: Quantity of stock in transaction (as integer)
* FromLocation: Location the inventory originated from
* ToLocation: Where the inventory is ending up
* FromStatus: Status of the inventory at from location
* ToStatus: Status of the inventory at to location
* TargetDate: Date of specific block to target
ProductSkuKey: Urlsafe key of ProductSku
ProductSID: ID of ProductSku
UserEmail: Email of authorized user
Note: Note related to adjustment
ExternalTransactionNumber: Transaction Number for PO (Vendor or MH)
ValidationID: Validation ID for adjustment record
Returns
Status: success|error
WarningMessages: ['List of warning messages if any']
UpdateInventoryAuditResultOnTransactionBlock
PRIVATE
/api/1/inventory/transaction/update-inventory-audit-result
Record an Inventory Audit amount for a specific date and location
Parameters
* ProductSkuKey: Id ofProductSku
* Quantity: Quantity of stock in transaction (as integer)
* Note: Note describing purpose of audit
* UserEmail: Email address of user creating audit
* LocationKey: Key of location where stock is to be updated
* AuditDate: Date of when inventory is to reflect update
* AuditTime: Time of when inventory is to reflect update
IncludesReserve: Boolean to determine if the amount sent includes the current reservation quantity
UpdateMonitorUrl
PRIVATE
/api/1/price-data/update-monitor-url
POST
Update monitoring settings for a URL
Parameters
* MonitorUrlKey: ndb Key for SkuMonitorUrl to update
Priority: New priority level (1=high, 2=medium, 3=low)
IsActive: Active status
Notes: Updated notes
LastChecked: Update last checked timestamp to now
UpdateProductAttribute
PRIVATE
/api/2019-09-10/product-attribute/update
POST
Updates an existing product attribute
Parameters
* AttributeKey: NDB key of the attribute to be edited
AttributeName: Revised name of attribute to be edited
AttributeDescription: Revised description of attribute to be edited
AttributeFormat: Revised description of attribute to be edited
IncludeInSearch: Set as 'True' if attribute should be included in search results
Returns
Status: success|error
AttributeKey: key
UpdateProductAttributeDeprecated
PRIVATE
/api/1/product-attribute/edit
POST
Edits an existing product attribute (DEPRECATED)
Parameters
* AttributeKey: NDB key of the attribute to be edited
AttributeName: Revised name of attribute to be edited
AttributeDescription: Revised description of attribute to be edited
AttributeFormat: Revised format of attribute to be edited
IncludeInSearch: Set as 'True' if attribute should be included in search results
Returns
Status: success|error
AttributeKey: key
UpdateProductAttributeOption
PRIVATE
/api/2019-09-10/product-attribute-option/update
POST
Updates an existing attribute option
Parameters
* AttributeOptionKey: NDB key of the attribute option to be edited
AttributeOptionDescription: Description of attribute option
AttributeOptionName: Name of attribute option
AttributeOptionData: Additional data for option
AttributeOptionImage: Image URL for option
PriceModifier: Amount the attribute option varies the price
HexColor: Hex color code for option
Returns
Status: success|error
AttributeOptionKey: key
AttributeOption: Updated option details
UpdateProductAttributeOptionDeprecated
PRIVATE
/api/2019-05-22/product-attribute-option/update
POST
Updates an existing attribute option (DEPRECATED)
Parameters
* AttributeOptionKey: NDB key of the attribute to be edited
AttributeOptionDescription: Description of attribute to be added
PriceModifier: Amount the attribute option varies the price (Default = 0)
UpdateProductVideo
PRIVATE
/api/2025-09-26/product-listing/draft/video/update
POST
Updates ProductVideo metadata.
Parameters
* ProductListingKey: NDB key of Product Listing
* VideoId: Video UUID
Title: Title of video
Description: Description of video
Width: Width of video
Height: Height of video
UpdateProductVideoPosterImage
PRIVATE
/api/2025-09-26/product-video/poster-image/add
POST
Updates the PosterImage for a ProductVideo on any given product listing page.
Parameters
* ProductListingKey: NDB key of Product Listing
* PosterImagePath: GSC file path/key
* PosterImageUrl: Serving url for the PosterImage
* VideoId: Video UUID
UpdateSkuAvgShippingCost
PRIVATE
/api/1/product-sku/update-calculated-fields
Update average shipping cost for a SKU
Parameters
* AverageShippingCost: Average Shipping Cost for SKU
UpdateStorageLocation
PRIVATE
/api/1/inventory/storage-location/update
POST
Update an existing storage location
Parameters
* StorageLocationKey: URL safe string of the Storage Location key
FulfillmentLocationKey: URL safe string of the FulfillmentLocation key
Name: The location name
IsDeleted: A flag indicating that the location is no longer used
Returns
Status: success|error
StorageLocation: Updated storage location dict
UpdateSupplierAdminNote
PRIVATE
/api/1/supplier/update-admin-note
POST
Update internal admin note for a supplier. Either SupplierKey or SupplierID is required.
Parameters
* AdminNote: Internal admin notes about the supplier
SupplierKey: NDB urlsafe key of Supplier to update (either this or SupplierID required)
SupplierID: Integer ID of Supplier to update (either this or SupplierKey required)
Returns
Status: success|error
SupplierKey: NDB key of updated supplier
ValidationTransactionBlock
PRIVATE
/api/1/inventory/transaction/validate-transaction-block
Validate the whole block of transactions
Parameters
* ProductSkuKeyList: List of Urlsafe key of ProductSku
Public Endpoints (67)
AdminSearchProductListings
PUBLIC
/p/2020-04-23/search/admin-product-listings
GETPOST
Accepts search terms and returns search results for related product listings
Parameters
* SearchQuery: Search term
Returns
Status: success|error
ProductListings: List of product listing identifiers
SearchQuery: Echo of provided search query
CacheInfoHandler
PUBLIC
/cache/info
GET
Cache connection information and stats
ConfigHandler
PUBLIC
/config
GET
Configuration and environment information
DashboardHandler
PUBLIC
/dash
GET
Dashboard of all API endpoints
DashboardJsonHandler
PUBLIC
/dash/json
GET
JSON formatted list of all API endpoints
DeferredTaskHandler
PUBLIC
/_ah/queue/deferred
POST
Execute deferred task from Cloud Tasks
Returns
Status: success|error
Message: Execution result message
EndpointCompareAPI
PUBLIC
/admin/api/compare-endpoint
POST
Test endpoint against all three environments (test server only)
Parameters
* endpoint: Endpoint URL to test
* method: HTTP method (GET/POST)
payload: Request payload for POST requests
useAuth: Whether to use authentication
Returns
local_response: Response from local server
gke_response: Response from GKE test server
appspot_response: Response from AppSpot server
matches: Boolean indicating if all responses match
EndpointTesterUI
PUBLIC
/admin/endpoint-tester
GET
Endpoint comparison testing tool (test server only)
GetAdminProductListingList
PUBLIC
/p/1/admin-product-listing-list
GETPOST
Returns list of ProductListing meta data for populating for admin product selection dropdowns
Returns
Status: success|error
ProductListings: List of product listing identifiers
GetAdminProductSkuList
PUBLIC
/p/1/admin-product-sku-list
GETPOST
Returns list of ProductSKu meta data for populating for admin product selection dropdowns (DEPRECATED)
Returns
Status: success|error
ProductListings: List of product listing identifiers
ListContent: JSON string of product options
Warning: Deprecation warning
GetAdminProductSkuListProductCollections
PUBLIC
/p/1/admin-product-sku-list-product-collections
GETPOST
Returns list of ProductSKu meta data for populating admin product collection SKU auto complete (filters out headless SKUs)
Returns
Status: success|error
ProductListings: List of product listing identifiers
GetAdminProductSkuList_2018
PUBLIC
/api/2018-12-17/admin-product-sku-list
GETPOST
Returns list of ProductSKU meta data for populating for admin product selection dropdowns
Parameters
ExcludeInactive: Boolean to toggle excluding of inactive skus
Returns
Status: success|error
ProductListings: List of product listing identifiers
GetAdminProductSkuList_2024
PUBLIC
/api/2024-03-12/admin-product-sku-list
GETPOST
Returns list of ProductSKU meta data for populating for admin product selection dropdowns
Parameters
ExcludeInactive: Boolean to toggle excluding of inactive skus
Returns
Status: success|error
ProductListings: List of product listing identifiers
GetAllActiveProductListings
PUBLIC
/p/1/product-listings/all-active
GET
Get JSON data for all active product listings
Returns
Status: success|error
ProductListings: NDB Key of all product listings
GetAllProductListings
PUBLIC
/p/1/product-listings/all
GET
Get JSON data for all product listings
Returns
Status: success|error
ProductListings: NDB Key of all product listings
GetAllProductSkus
PUBLIC
/p/1/product-skus/all
GET
Get JSON data for all product skus
Parameters
IncludeInactive: Flag to include inactive (defaults to false)
IgnoreItemsWithComponents: Boolean Determines if we want to filter out items with components
IgnoreOneTimeItems: Boolean determines if we should filter out one time items
ProductTypes: Either a string or a list
Returns
Status: success|error
ProductSkus: NDB Key of all product skus
GetAutoCompleteFile
PUBLIC
/api/2020-02-27/get-autocomplete-file
GETPOST
Gets the autocomplete file or rebuilds if its missing
Parameters
* Model: Value of "Listing" or "Sku"
Returns
Status: success|error
Autocomplete: Autocomplete data as JSON string
GetBackupFile
PUBLIC
/p/2023-02-21/get-backup-file
GET
Get Supplier JSON data
Parameters
* sk: Simple key required to auth get requests
Returns
Status: success|error
File: List of dictionaries of ProductSku data
GetBackupFileBlob
PUBLIC
/p/2024-03-12/get-backup-file
GET
Get backup file JSON data
Parameters
* sk: Simple key required to auth get requests
* file: File name to retrieve
Returns
Status: success|error
File: JSON file contents
GetBackupFileBlobStat
PUBLIC
/p/2025-03-14/get-backup-file/stats
GET
Get Supplier JSON data
Parameters
* sk: Simple key required to auth get requests
* file: File name to get metadata for
Returns
Status: success|error
Stats: Metadata about the file
GetConsumerAccountHandler
PUBLIC
/p/1/consumer-account/
GETPOST
Get Consumer Account information by key
Parameters
IncludeSecret: Include consumer secret in response (requires master token)
IncludeTransactions: Include recent transaction history
Returns
Status: success|error
Consumer: Dictionary of consumer account data
GetDetailsOfSkusInUnspecifiedLocation
PUBLIC
/p/1/inventory/sku-unspecified-location
Get JSON data for current inventory block
Returns
Status: success|error
UnspecifiedSkus: [{ keys = SkuKey,SID,SkuName,Quantity,ProductPrice,TotalDiscrepancyAmount,ListingKey},]
GetProductAddon
PUBLIC
GETPOST
Retrieve JSON data for Addon
Parameters
* AddonListingKey: Key for the listing of the sku used to create the addon
* AddonSku: SKU SID for sku used to create addon
Returns
Status: success|error
AddonSku: Dictionary of addon SKU data
AddonDetails: Dictionary of addon details
AddonListing: Dictionary of addon listing data
GetProductAddon2019
PUBLIC
/p/2019-23-09/product-addon/
GETPOST
Retrieve JSON data for Addon (2019 version)
Parameters
* AddonListingKey: Key for the listing of the sku used to create the addon
* AddonSku: SKU SID for sku used to create addon
Returns
Status: success|error
AddonSku: Dictionary of addon SKU data
AddonDetails: Dictionary of addon details
AddonListing: Dictionary of addon listing data
GetProductAddon2022
PUBLIC
/p/2022-12-30/product-addon/
GETPOST
Retrieve JSON data for Addon
Parameters
* AddonSku: SKU SID for sku used to create addon
Returns
Status: success|error
AddonSku: Dictionary of addon SKU data
AddonDetails: Dictionary of addon details
AddonListing: Dictionary of addon listing data (optional)
GetProductAddonDeprecated
PUBLIC
GETPOST
Retrieve JSON data for Addon
Parameters
* AddonListingKey: Key for the AddonListing
* AddonSku: Sku id for Addon
Returns
Status: success|error
AddonSku: Dictionary of addon SKU data
AddonDetails: Dictionary of addon details
AddonListing: Dictionary of addon listing data
GetProductListing
PUBLIC
/p/1/product-listing/
GETPOST
Get Product Listing JSON data
Parameters
IncludeSkuData: boolean flag for including sku data
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductListingAuditMultipleSkus
PUBLIC
/p/1/product-listings/audit/multiple-skus
GET
Get JSON data for aberrant product listings
Returns
Status: success|error
ProductListings: NDB Key of all product listings
GetProductListingByReferenceUrl
PUBLIC
/p/2019-05-29/product-listing/ref-url/
GETPOST
Get Product Listing JSON data
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductListingByReferenceUrlDeprecated
PUBLIC
/p/1/product-listing/ref-url/
GETPOST
Get Product Listing JSON data by reference URL
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductListingDraftJSON
PUBLIC
/p/1/product-listing/draft/
GETPOST
Get the draft version of a product listing
Parameters
IncludeSkuData: boolean flag for including sku data
IncludeDeprecatedSkus: boolean for including deprecated sku data
Returns
Status: success|error
ProductListingDraft: NDB key of created Product Listing
GetProductListingFromLegacyKey
PUBLIC
/p/1/product-listing/legacy-key/
GETPOST
Get Product Listing JSON data
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductListings
PUBLIC
/p/1/get-product-listings
GETPOST
Get Product Listing JSON data
Parameters
* ProductListingKeyList: list of product listing keys
IncludeSkuData: boolean flag for including sku data
Returns
Status: success|error
ProductListings: Dictionary of ProductListing data
GetProductListingsGetAll
PUBLIC
/p/1/product-listings/get-all
GET
Get Product Listing JSON data from remote environment (DEPRECATED)
Returns
Status: deprecated
Message: Deprecation notice
GetProductSku
PUBLIC
/p/1/product-sku/
GETPOST
Get Product SKU JSON data
Parameters
IncludeListingData: Include parent listing information
IncludeListingAsDraft: Include the parent listing draft instead of listing.
IncludeComponentDetails: If components return list of component details
IncludeWareHouseLocations: Include warehouse Location data
IncludeAttributes: Include attributes
Returns
Status: success|error
ProductSku: Dictionary of ProductSku data
GetProductSkuAuditMultipleSkus
PUBLIC
/p/1/product-skus/audit/multiple-skus
GET
Get JSON data for aberrant product listings
Parameters
FixData: Triggers fix of bad data
Returns
Status: success|error
ProductSkus: NDB Key of all product listings
GetProductSkuFeedList
PUBLIC
/p/1/product-skus/list/
/feedGETPOST
Retrieve Product Sku JSON data by FilterList ID
Returns
Status: success|error
ProductSkus: List of SKU to_dicts
InvalidSkus: List of invalid SKUs
GetProductSkuFromLegacyKey
PUBLIC
/p/1/product-sku/legacy-key/
GETPOST
Get Product Listing JSON data
Parameters
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductSku: Dictionary of ProductSku data
GetProductSkuFromLegacyPartNumber
PUBLIC
/p/1/product-sku/legacy-part-number/
GETPOST
Get Product Listing JSON data
Parameters
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductSkuFromProductNumber
PUBLIC
GETPOST
Retrieve Product Sku JSON data by legacy Product Number
Parameters
IncludeListingData: Include parent listing information
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductSkuFromVendorItemId
PUBLIC
/p/2021-02-21/product-sku/vendor-item-id/
GETPOST
Retrieve Product Sku JSON data by legacy Product Number
Parameters
IncludeListingData: Include parent listing information
Returns
Status: success|error
ProductListing: Dictionary of ProductListing data
GetProductSkuHandler
PUBLIC
/p/1/product-sku/
GETPOST
Get Product SKU JSON data
Parameters
IncludeListingData: Include parent listing information
IncludeListingAsDraft: Include the parent listing draft instead of listing
IncludeComponentDetails: If components return list of component details
IncludeWareHouseLocations: Include warehouse Location data
IncludeAttributes: Include attributes
Returns
Status: success|error
ProductSku: Dictionary of ProductSku data
GetProductSkuID
PUBLIC
/p/1/product-sid/
GETPOST
Get Product SKU JSON data by SID
Parameters
IncludeListingData: Include parent listing information
IncludeComponentDetails: Include Component Information
IncludeWareHouseLocations: Include WareHouse Location Information
Returns
Status: success|error
ProductSku: Dictionary of ProductSku data
GetProductSkusByList
PUBLIC
/p/1/product-skus-by-list
GETPOST
Get Product SKU JSON data
Parameters
ProductSkuKeyList: List of productKeys for which to retrieve data
ProductSIDList: List of SIDs for which to retrieve data
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductSkuList: List of dictionaries of ProductSku data
GetProductSkusData
PUBLIC
/p/1/product-sku-data
GET
Get Product SKU JSON data
Parameters
* sk: Simple key required to auth get requests
Returns
Status: success|error
ProductSkuData: List of dictionaries of ProductSku data
GetProductSkusDataWithLocation
PUBLIC
/p/2019-09-16/product-sku-data
GET
Get Product SKU JSON data
Parameters
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductSkuData: List of dictionaries of ProductSku data
GetProductSkusDataWithLocationBlob
PUBLIC
/p/2024-03-12/product-sku/get-data
GET
Get Product SKU JSON data with location information
Parameters
* sk: Simple key required to auth get requests
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductSkuData: List of dictionaries of ProductSku data
GetProductSkusDataWithLocation_20200212
PUBLIC
/p/2020-02-12/product-sku-data
GET
Get Product SKU JSON data with location information
Parameters
IncludeListingData: Boolean flag for also returning listing data
Returns
Status: success|error
ProductSkuData: List of dictionaries of ProductSku data
GetPublicSupplierData
PUBLIC
/p/1/supplier-data
GET
Get Supplier JSON data
Parameters
* sk: Simple key required to auth get requests
Returns
Status: success|error
SupplierData: List of dictionaries of Supplier data
GetSkuListSIDToNameMappings
PUBLIC
/p/1/product-skus/sid-to-name-mapping
GETPOST
Get Product SKU Mapping
Returns
Status: success|error
Mapping: Dictionary SID to ProductName mapping
GetSupplierAvailabilityData
PUBLIC
/p/2023-02-20/supplier/availability
GET
Get Supplier JSON data
Parameters
* sk: Simple key required to auth get requests
Returns
Status: success|error
Suppliers: Dictionary of supplier availability data
GetWorkflowDefinitionAPI
PUBLIC
/admin/api/workflow/
GET
Get workflow definition for client-side execution (localhost/test server only)
Returns
name: Workflow name
description: Workflow description
steps: Array of workflow step definitions
GetWorkflowsAPI
PUBLIC
/admin/api/workflows
GET
Get list of available test workflows (localhost/test server only)
Returns
workflows: List of workflow objects with name and description
HealthHandler
PUBLIC
/health
GET
Health check endpoint
IndexHandler
PUBLIC
/
GET
Redirect to API dashboard
LocalhostAutocompleteList
PUBLIC
/p/1/localhost/autocomplete-list
GET
Workaround for localhost cloudstorage
Parameters
* Model: Value of "Listing" or "Sku"
LocalhostInitialize
PUBLIC
/p/1/localhost/initialize
GET
Workaround for localhost cloudstorage
LocalhostSuppliers
PUBLIC
/p/1/localhost/suppliers
GET
Workaround for localhost cloudstorage
ProductListingUpdateAllDeprecated
PUBLIC
/p/1/product-listings/update-all
GETPOST
Sync product data from production to localhost (DEPRECATED)
Returns
Status: success|error
Message: Deprecation notice
ReadyHandler
PUBLIC
/ready
GET
Readiness check endpoint
RebuildAutoCompleteFile
PUBLIC
/api/2019-10-02/rebuild-autocomplete-file
GETPOST
Starts an async task to rebuild the given autocomplete file
Parameters
* Model: Value of "Listing" or "Sku"
RequestConsumerTokenHandler
PUBLIC
/p/1/consumer-token/request
GETPOST
Get a Request Consumer Token
Parameters
* RequestToken: Authorization token for consumer creation
* ConsumerName: Name for the new consumer
Returns
Status: success|error
ConsumerKey: Generated consumer key for API access
RunWorkflowAPI
PUBLIC
/admin/api/run-workflow
POST
Execute a test workflow (localhost/test server only)
Parameters
* workflow_name: Name of workflow to execute
Returns
success: Boolean indicating if workflow completed successfully
workflow_name: Name of executed workflow
steps: Array of step results
total_time_ms: Total execution time in milliseconds
SearchAllActive
PUBLIC
/p/1/search/all
GETPOST
Accepts search terms and returns search results for related product listings and skus
Parameters
* SearchQuery: Search term
SearchTitleOnly: Only search title
QueryLimit: Number of items to return from search query (defaults to 100)
UseCursor: Boolean to determine if we are using cursors for tracking multiple runs
ListingCursor: Ending Cursor From Listing Search
SkuCursor: Ending Cursor from Sku Search
IsRetired: Filter by retired status
IsOneTimeItem: Filter by one-time item status
Returns
Status: success|error
ProductListings: List of product listing identifiers
ProductSkus: List of product sku identifiers
SearchQuery: Echo of provided search query
QueryLimit: Number of items returned
ListingCursor: Ending Cursor From Listing Search
SkuCursor: Ending Cursor from Sku Search
SearchHealthHandler
PUBLIC
/search/health
GET
Search service health check
SearchProductListings
PUBLIC
/p/1/search/product-listings
GETPOST
Accepts search terms and returns search results for related product listings
Parameters
* SearchQuery: Search term
SearchTitleOnly: Only search title
Returns
Status: success|error
ProductListings: List of product listing identifiers
SearchQuery: Echo of provided search query
WorkflowTesterUI
PUBLIC
/admin/workflow-tester
GET
Workflow testing tool (localhost/test server only)