OSZZ API

<back to all web services

SearchOrder

The following routes are available for this service:
POST, GET/searchOrder
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrderResponse:
    response_status: Optional[ResponseStatus] = None
    total_results_count: Optional[int] = None
    result: Optional[List[OrderItemModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrder:
    comment: Optional[str] = None
    from_global_id: Optional[int] = None
    to_global_id: Optional[int] = None
    page: Optional[int] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    token_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderItemModel:
    order_item_id: Optional[str] = None
    global_id: Optional[int] = None
    date: Optional[datetime.datetime] = None
    last_update: Optional[datetime.datetime] = None
    product_id: Optional[str] = None
    product_number: Optional[str] = None
    product_title: Optional[str] = None
    manufacturer_title: Optional[str] = None
    replacement_product_id: Optional[str] = None
    replacement_product_number: Optional[str] = None
    replacement_product_title: Optional[str] = None
    replacement_manufacturer_title: Optional[str] = None
    quantity: Optional[int] = None
    price: Optional[Decimal] = None
    initial_price: Optional[Decimal] = None
    comment: Optional[str] = None
    expected_delivery_days: Optional[int] = None
    guaranteed_delivery_days: Optional[int] = None
    guaranteed_delivery_time: Optional[datetime.datetime] = None
    expected_delivery_time: Optional[datetime.datetime] = None
    price_list_logo: Optional[str] = None
    delivery: Optional[str] = None
    is_cash: Optional[bool] = None
    delivery_date: Optional[datetime.datetime] = None
    price_list_use_schedule: Optional[bool] = None
    supplier_alias_id: Optional[str] = None
    subcustomer_id: Optional[str] = None
    is_cash_subcustomer: Optional[bool] = None
    subcustomer_logo: Optional[str] = None
    initial_subcustomer_price: Optional[Decimal] = None
    subcustomer_price: Optional[Decimal] = None
    motions: Optional[List[OrderItemMotionModel]] = None


class OrderItemState(str, Enum):
    UNDEFINED = 'Undefined'
    SOLD = 'Sold'
    REFUSED = 'Refused'
    IN_ORDER = 'InOrder'
    IN_SUPPLIER_CART = 'InSupplierCart'
    PURCHASED = 'Purchased'
    NOT_DISTRIBUTED = 'NotDistributed'
    IN_CART = 'InCart'
    READY = 'Ready'
    DISTRIBUTED = 'Distributed'
    SUPPLIER_REFUSED = 'SupplierRefused'
    ARCHIVED = 'Archived'
    GIVING_OUT_SCAN = 'GivingOutScan'
    IN_PROCESSING = 'InProcessing'
    RETURN_ = 'Return'
    RETURNED = 'Returned'
    REFUSED_BY_CLIENT = 'RefusedByClient'
    PURCHASED_BY_SUPPLIER = 'PurchasedBySupplier'
    IN_PARENT_CART = 'InParentCart'
    IN_SUPPLIER_WEB_CART = 'InSupplierWebCart'
    WORK_IN_SUPPLIER_WEB_CART = 'WorkInSupplierWebCart'
    DEFICIT = 'Deficit'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderItemMotionModel:
    motion_id: Optional[str] = None
    parent_id: Optional[str] = None
    state: Optional[OrderItemState] = None
    state_title: Optional[str] = None
    date: Optional[datetime.datetime] = None
    initial_quantity: Optional[int] = None
    quantity: Optional[int] = None
    planned_delivery_date: Optional[datetime.datetime] = None

Python SearchOrder DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"comment":"String","fromGlobalId":0,"toGlobalId":0,"page":0,"fromDate":"0001-01-01 00:00:00","toDate":"0001-01-01 00:00:00","tokenId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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 00:00:00","lastUpdate":"0001-01-01 00:00:00","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 00:00:00","expectedDeliveryTime":"0001-01-01 00:00:00","priceListLogo":"String","delivery":"String","isCash":false,"deliveryDate":"0001-01-01 00:00:00","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 00:00:00","initialQuantity":0,"quantity":0,"plannedDeliveryDate":"0001-01-01 00:00:00"}]}]}