@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
35 lines (34 loc) • 988 B
TypeScript
import { RequestBase } from './request-base';
/**
* The criteria to use when fetching inventory from an order source.
*/
export interface InventoryFetchCriteria {
/**
* If provided, only fetch inventory for the specified SKUs.
*/
skus?: string[];
/**
* If provided, only fetch inventory that has been updated since
* the specified date and time.
*/
from_date_time?: string;
}
/**
* The shape of a request to fetch inventory from an order source.
*/
export interface InventoryFetchRequest extends RequestBase {
/**
* The cursor is provided in the InventoryFetchResponse.
* If provided, the cursor is used to fetch the next page of inventory.
*/
cursor?: string;
/**
* Criteria to use for fetching specific inventory.
*/
criteria?: InventoryFetchCriteria;
/**
* If provided, only fetch inventory that has been updated since
* the specified date and time.
*/
since_date?: string;
}