OSZZ API

<back to all web services

SearchOrder

The following routes are available for this service:
POST, GET/searchOrder

// @DataContract
export class SearchOrderResponse
{
    // @DataMember
    public responseStatus?: ResponseStatus;

    // @DataMember
    public totalResultsCount?: number;

    // @DataMember
    public result?: OrderItemModel[];

    public constructor(init?: Partial<SearchOrderResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SearchOrder
{
    // @DataMember
    public comment?: string;

    // @DataMember
    public fromGlobalId?: number;

    // @DataMember
    public toGlobalId?: number;

    // @DataMember
    public page?: number;

    // @DataMember
    public fromDate?: string;

    // @DataMember
    public toDate?: string;

    // @DataMember
    public tokenId?: string;

    public constructor(init?: Partial<SearchOrder>) { (Object as any).assign(this, init); }
}

// @DataContract
export class OrderItemModel
{
    // @DataMember
    public orderItemId?: string;

    // @DataMember
    public globalId?: number;

    // @DataMember
    public date?: string;

    // @DataMember
    public lastUpdate?: string;

    // @DataMember
    public productId?: string;

    // @DataMember
    public productNumber?: string;

    // @DataMember
    public productTitle?: string;

    // @DataMember
    public manufacturerTitle?: string;

    // @DataMember
    public replacementProductId?: string;

    // @DataMember
    public replacementProductNumber?: string;

    // @DataMember
    public replacementProductTitle?: string;

    // @DataMember
    public replacementManufacturerTitle?: string;

    // @DataMember
    public quantity?: number;

    // @DataMember
    public price?: number;

    // @DataMember
    public initialPrice?: number;

    // @DataMember
    public comment?: string;

    // @DataMember
    public expectedDeliveryDays?: number;

    // @DataMember
    public guaranteedDeliveryDays?: number;

    // @DataMember
    public guaranteedDeliveryTime?: string;

    // @DataMember
    public expectedDeliveryTime?: string;

    // @DataMember
    public priceListLogo?: string;

    // @DataMember
    public delivery?: string;

    // @DataMember
    public isCash?: boolean;

    // @DataMember
    public deliveryDate?: string;

    // @DataMember
    public priceListUseSchedule?: boolean;

    // @DataMember
    public supplierAliasId?: string;

    // @DataMember
    public subcustomerId?: string;

    // @DataMember
    public isCashSubcustomer?: boolean;

    // @DataMember
    public subcustomerLogo?: string;

    // @DataMember
    public initialSubcustomerPrice?: number;

    // @DataMember
    public subcustomerPrice?: number;

    // @DataMember
    public motions?: OrderItemMotionModel[];

    public constructor(init?: Partial<OrderItemModel>) { (Object as any).assign(this, init); }
}

export enum OrderItemState
{
    Undefined = 'Undefined',
    Sold = 'Sold',
    Refused = 'Refused',
    InOrder = 'InOrder',
    InSupplierCart = 'InSupplierCart',
    Purchased = 'Purchased',
    NotDistributed = 'NotDistributed',
    InCart = 'InCart',
    Ready = 'Ready',
    Distributed = 'Distributed',
    SupplierRefused = 'SupplierRefused',
    Archived = 'Archived',
    GivingOutScan = 'GivingOutScan',
    InProcessing = 'InProcessing',
    Return = 'Return',
    Returned = 'Returned',
    RefusedByClient = 'RefusedByClient',
    PurchasedBySupplier = 'PurchasedBySupplier',
    InParentCart = 'InParentCart',
    InSupplierWebCart = 'InSupplierWebCart',
    WorkInSupplierWebCart = 'WorkInSupplierWebCart',
    Deficit = 'Deficit',
}

// @DataContract
export class OrderItemMotionModel
{
    // @DataMember
    public motionId?: string;

    // @DataMember
    public parentId?: string;

    // @DataMember
    public state?: OrderItemState;

    // @DataMember
    public stateTitle?: string;

    // @DataMember
    public date?: string;

    // @DataMember
    public initialQuantity?: number;

    // @DataMember
    public quantity?: number;

    // @DataMember
    public plannedDeliveryDate?: string;

    public constructor(init?: Partial<OrderItemMotionModel>) { (Object as any).assign(this, init); }
}

TypeScript SearchOrder DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /searchOrder HTTP/1.1 
Host: api.oszz.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	comment: String,
	fromGlobalId: 0,
	toGlobalId: 0,
	page: 0,
	fromDate: 0001-01-01,
	toDate: 0001-01-01,
	tokenId: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	totalResultsCount: 0,
	result: 
	[
		{
			orderItemId: 00000000000000000000000000000000,
			globalId: 0,
			date: 0001-01-01,
			lastUpdate: 0001-01-01,
			productId: 00000000000000000000000000000000,
			productNumber: String,
			productTitle: String,
			manufacturerTitle: String,
			replacementProductId: 00000000000000000000000000000000,
			replacementProductNumber: String,
			replacementProductTitle: String,
			replacementManufacturerTitle: String,
			quantity: 0,
			price: 0,
			initialPrice: 0,
			comment: String,
			expectedDeliveryDays: 0,
			guaranteedDeliveryDays: 0,
			guaranteedDeliveryTime: 0001-01-01,
			expectedDeliveryTime: 0001-01-01,
			priceListLogo: String,
			delivery: String,
			isCash: False,
			deliveryDate: 0001-01-01,
			priceListUseSchedule: False,
			supplierAliasId: 00000000000000000000000000000000,
			subcustomerId: 00000000000000000000000000000000,
			isCashSubcustomer: False,
			subcustomerLogo: String,
			initialSubcustomerPrice: 0,
			subcustomerPrice: 0,
			motions: 
			[
				{
					motionId: 00000000000000000000000000000000,
					parentId: 00000000000000000000000000000000,
					state: Undefined,
					stateTitle: String,
					date: 0001-01-01,
					initialQuantity: 0,
					quantity: 0,
					plannedDeliveryDate: 0001-01-01
				}
			]
		}
	]
}