ApexERPHost

<back to all web services

ECommerceOrdersQuery

Requires Authentication
The following routes are available for this service:
GET/eCommerce/Orders/View
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CrmOrderView Parameters:
NameParameterData TypeRequiredDescription
order_idformintNo
currency_idformstringNo
rateformdecimalNo
order_typeformintNo
order_statusformintNo
order_dateformDateTimeNo
pay_dateformDateTime?No
recipient_idformint?No
supplier_idformintNo
contract_idformint?No
vat_typeformbyteNo
noteformstringNo
presaler_idformint?No
unidformGuidNo
cuserformstringNo
crtimeformDateTimeNo
prod_amountformdecimalNo
service_amountformdecimalNo
payed_amountformdecimalNo
total_amountformdecimal?No
total_rem_amountformdecimal?No
document_numbersformstringNo
supplier_snformstringNo
supplier_company_nameformstringNo
supplier_branch_nameformstringNo
recipient_snformstringNo
recipient_company_nameformstringNo
recipient_branch_nameformstringNo
delivery_typeformint?No
delivery_dateformDateTime?No
transport_numberformstringNo
transport_descriptionformstringNo
delivery_recipient_snformstringNo
delivery_recipientformstringNo
from_addressformstringNo
to_addressformstringNo
prepare_list_numberformstringNo
is_giftformboolNo
sub_order_idformint?No
forwarder_user_idformint?No
booked_prod_amountformdecimal?No
booked_service_amountformdecimal?No
market_part_idformstringNo
market_part_nameformstringNo
loyalty_card_idformstringNo
loyalty_card_owner_pernumformstringNo
loyalty_card_owner_nameformstringNo
driver_snformstringNo
driver_nameformstringNo
forwarder_nameformstringNo
transit_docs_idformstringNo
transit_statusformintNo
delivery_idformint?No
transit_wbidformint?No
transit_tdidformlong?No
ECommerceOrderView Parameters:
NameParameterData TypeRequiredDescription
order_status_nameformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /eCommerce/Orders/View HTTP/1.1 
Host: 10.10.0.107 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfECommerceOrderViewW3lrUHR0 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apex.Services.ECommerce">
    <d2p1:ECommerceOrderView>
      <order_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</order_id>
      <currency_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</currency_id>
      <rate xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</rate>
      <order_type xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</order_type>
      <order_status xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</order_status>
      <order_date xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0001-01-01T00:00:00</order_date>
      <pay_date xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0001-01-01T00:00:00</pay_date>
      <recipient_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</recipient_id>
      <supplier_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</supplier_id>
      <contract_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</contract_id>
      <vat_type xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</vat_type>
      <note xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</note>
      <presaler_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</presaler_id>
      <unid xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">00000000-0000-0000-0000-000000000000</unid>
      <cuser xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</cuser>
      <crtime xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0001-01-01T00:00:00</crtime>
      <prod_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</prod_amount>
      <service_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</service_amount>
      <payed_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</payed_amount>
      <total_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</total_amount>
      <total_rem_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</total_rem_amount>
      <document_numbers xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</document_numbers>
      <supplier_sn xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</supplier_sn>
      <supplier_company_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</supplier_company_name>
      <supplier_branch_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</supplier_branch_name>
      <recipient_sn xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</recipient_sn>
      <recipient_company_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</recipient_company_name>
      <recipient_branch_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</recipient_branch_name>
      <delivery_type xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</delivery_type>
      <delivery_date xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0001-01-01T00:00:00</delivery_date>
      <transport_number xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</transport_number>
      <transport_description xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</transport_description>
      <delivery_recipient_sn xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</delivery_recipient_sn>
      <delivery_recipient xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</delivery_recipient>
      <from_address xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</from_address>
      <to_address xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</to_address>
      <prepare_list_number xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</prepare_list_number>
      <is_gift xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">false</is_gift>
      <sub_order_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</sub_order_id>
      <forwarder_user_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</forwarder_user_id>
      <booked_prod_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</booked_prod_amount>
      <booked_service_amount xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</booked_service_amount>
      <market_part_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</market_part_id>
      <market_part_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</market_part_name>
      <loyalty_card_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</loyalty_card_id>
      <loyalty_card_owner_pernum xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</loyalty_card_owner_pernum>
      <loyalty_card_owner_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</loyalty_card_owner_name>
      <driver_sn xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</driver_sn>
      <driver_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</driver_name>
      <forwarder_name xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</forwarder_name>
      <transit_docs_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">String</transit_docs_id>
      <transit_status xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</transit_status>
      <delivery_id xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</delivery_id>
      <transit_wbid xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</transit_wbid>
      <transit_tdid xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Crm.Orders">0</transit_tdid>
      <d2p1:order_status_name>String</d2p1:order_status_name>
    </d2p1:ECommerceOrderView>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</QueryResponseOfECommerceOrderViewW3lrUHR0>