@spree/storefront-api-v2-sdk
Version:
Node module to easily integrate your JavaScript or TypeScript application with Spree API V2. You can create an entirely custom Storefront in JS/TS with this package including one page checkout, Single Page Apps, PWAs and so on
54 lines (53 loc) • 1.64 kB
TypeScript
import { JsonApiDocument, JsonApiListResponse, JsonApiSingleResponse } from './JsonApi';
import { IRelationships } from './Relationships';
import { ResultResponse } from './ResultResponse';
import { WithCommonOptions } from './WithCommonOptions';
export interface OrderAttr extends JsonApiDocument {
type: string;
id: string;
attributes: {
number: string;
item_total: string;
total: string;
ship_total: string;
adjustment_total: string;
included_tax_total: string;
additional_tax_total: string;
display_additional_tax_total: string;
display_included_tax_total: string;
tax_total: string;
currency: string;
state: string;
token: string;
email: string;
display_item_total: string;
display_ship_total: string;
display_adjustment_total: string;
display_tax_total: string;
promo_total: string;
display_promo_total: string;
item_count: number;
special_instructions: string;
display_total: string;
created_at: Date;
updated_at: Date;
completed_at: Date;
};
relationships: IRelationships;
}
export interface IOrder extends JsonApiSingleResponse {
data: OrderAttr;
}
export interface IOrders extends JsonApiListResponse {
data: OrderAttr[];
}
export interface IOrderResult extends ResultResponse<IOrder> {
}
export interface IOrdersResult extends ResultResponse<IOrders> {
}
export declare type StatusOptions = WithCommonOptions<{
suggestToken: true;
suggestQuery: true;
}, {
order_number: string;
}>;