UNPKG

@shipengine/connect-order-source-api

Version:

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

33 lines (32 loc) 1.49 kB
import { InventoryItemError } from '../models/inventory-item-error'; import { InventoryPushItem } from '../models/inventory-push-item'; interface BaseInventoryPushResponse { /** Any messages associated with the results inclosed */ message?: string; /** Any errros associated with the results included */ errors?: InventoryItemError[]; } export interface InventoryPushResponsePaging extends BaseInventoryPushResponse { /** The next cursor to use for the next page of inventory */ cursor: string; /** * The inventory items being returned for the current page * @deprecated It is no longer necessary to return successful updates, the lack of an error will indicate success. */ items?: InventoryPushItem[]; } export interface InventoryPushResponseDone extends BaseInventoryPushResponse { /** * The inventory items being returned for the current page * @deprecated It is no longer necessary to return successful updates, the lack of an error will indicate success. */ items?: InventoryPushItem[]; } export interface InventoryPushResponseProcessing extends BaseInventoryPushResponse { /** 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; } export type InventoryPushResponse = InventoryPushResponsePaging | InventoryPushResponseDone | InventoryPushResponseProcessing; export {};