@shipengine/connect-order-source-api/lib/responses/inventory-fetch-response.d.ts

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

import { InventoryItemError } from '../models/inventory-item-error';
import { InventoryFetchItem } from '../models/inventory-fetch-item';
interface BaseInventoryFetchResponse {
    /** Any messages associated with the results inclosed */
    message?: string;
    /** Any errros associated with the results included */
    errors?: InventoryItemError[];
}
export interface InventoryFetchResponsePaging extends BaseInventoryFetchResponse {
    /** The next cursor to use for the next page of inventory */
    cursor: string;
    /** The inventory items being returned for the current page */
    items: InventoryFetchItem[];
}
export interface InventoryFetchResponseDone extends BaseInventoryFetchResponse {
    /** The inventory items being returned */
    items: InventoryFetchItem[];
}
export interface InventoryFetchResponseProcessing extends BaseInventoryFetchResponse {
    /** This is an optional cursor for the currently processing page */
    cursor?: string;
    /** The number of milliseconds to wait before making another request */
    poll_after_ms: number;
}
/**
 * The response for a fetch inventory request.
 * For synchronous operations, the response will be either `InventoryFetchResponsePaging` or `InventoryFetchResponseDone`.
 * For asynchronous operations, the response type can include `InventoryFetchResponseProcessing` or `InventoryFetchResponseReady`.
 */
export type InventoryFetchResponse = InventoryFetchResponsePaging | InventoryFetchResponseDone | InventoryFetchResponseProcessing;
export {};