UNPKG

@shipengine/connect-order-source-api

Version:

This is the typescript/javascript definitions for the order source api

23 lines (22 loc) 1.02 kB
/** * This represents an error that is actionable within the inventory platform. * @option not_found - The inventory item was not found in the 3rd party system. */ export type InventoryActionableErrorCategoryType = 'not_found' | 'resource_locked'; /** This represents and error while syncing inventory for a given product * to the order source. */ export interface InventoryItemError { /** * Unique identifier for the inventory record in the 3rd party integration system (i.e. marketplace, 3PL, WMS, etc). * This may be the same as `sku`, or be a JSON encoded string containing all the identifiers required to uniquely * specify and update the item. */ integration_inventory_item_id: string; /** The SKU associated with the error */ sku?: string; /** The error message while syncing inventory to the order source */ message: string; /** An optional error category used in the inventory platform to take action */ category?: InventoryActionableErrorCategoryType; }