NAV

<back to all web services

NAVOpenOrderGetList

The following routes are available for this service:
GET/pendingOrders/{BeeNumber}/{Days}
GET/pendingOrders/{BeeNumber}/{Days}/{Status}
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 NAVOpenOrderViewModel:
    order_number: Optional[str] = None
    order_id: Optional[int] = None
    order_status_id: Optional[int] = None
    order_status: Optional[str] = None
    created: Optional[datetime.datetime] = None
    order_type: Optional[str] = None
    subtotal: Optional[Decimal] = None
    shipping_cost: Optional[Decimal] = None
    final_tax: Optional[Decimal] = None
    commissionable_value_earned: Optional[Decimal] = None
    qualifying_value_earned: Optional[Decimal] = None
    campaign_of_order: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOpenOrderGetListResponse(GetListResponse[NAVOpenOrderViewModel]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVOpenOrderGetList(IGet):
    bee_number: Optional[Decimal] = None
    days: Optional[int] = None
    status: Optional[str] = None


TEntity = TypeVar('TEntity')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetListResponse(Generic[TEntity]):
    items: Optional[List[TEntity]] = None
    response_status: Optional[ResponseStatus] = None

Python NAVOpenOrderGetList DTOs

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

HTTP + XML

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

GET /pendingOrders/{BeeNumber}/{Days} HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NAVOpenOrderGetListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <Items>
    <NAVOpenOrderViewModel>
      <CampaignOfOrder>String</CampaignOfOrder>
      <CommissionableValueEarned>0</CommissionableValueEarned>
      <Created>0001-01-01T00:00:00</Created>
      <FinalTax>0</FinalTax>
      <OrderId>0</OrderId>
      <OrderNumber>String</OrderNumber>
      <OrderStatus>String</OrderStatus>
      <OrderStatusId>0</OrderStatusId>
      <OrderType>String</OrderType>
      <QualifyingValueEarned>0</QualifyingValueEarned>
      <ShippingCost>0</ShippingCost>
      <Subtotal>0</Subtotal>
    </NAVOpenOrderViewModel>
  </Items>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NAVOpenOrderGetListResponse>