ApexERPHost

<back to all web services

GetCrmOrderExternals

Requires Authentication
The following routes are available for this service:
GET/Crm/Orders/External/{OrderId}
GET/Crm/Orders/External
GetCrmOrderExternals Parameters:
NameParameterData TypeRequiredDescription
order_datequeryDateTime[]No
delivery_datequeryDateTime[]No
Statusqueryint[]No
OrderTypequeryint[]No
SupplierBranchIdqueryint?No
RecipientBranchIdqueryint?No
Idqueryint?No
GetCrmOrderExternalsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<GetExtRequestInfoResponse>No
GetExtRequestInfoResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RequestIdformintNo
RequestTypeformintNo
RequestStatusformintNo
RequestDataformList<ExternalOrderReference>No
OrderIdformintNo
ExternalOrderReference Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
StatusformintNo
ReceiveDocIdformstringNo
ReceiveWarehouseAccformstringNo
VanWarehouseAccformstringNo
ExtSupplierBranchIdformint?No
SubOrderIdformint?No
LocalSubOrderIdformint?No

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 /Crm/Orders/External/{OrderId} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCrmOrderExternalsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Warehousing.Orders.External">
  <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>
  <Result>
    <GetExtRequestInfoResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <RequestId>0</RequestId>
      <RequestType>0</RequestType>
      <RequestStatus>0</RequestStatus>
      <RequestData>
        <ExternalOrderReference>
          <OrderId>0</OrderId>
          <Status>0</Status>
          <ReceiveDocId>String</ReceiveDocId>
          <ReceiveWarehouseAcc>String</ReceiveWarehouseAcc>
          <VanWarehouseAcc>String</VanWarehouseAcc>
          <ExtSupplierBranchId>0</ExtSupplierBranchId>
          <SubOrderId>0</SubOrderId>
          <LocalSubOrderId>0</LocalSubOrderId>
        </ExternalOrderReference>
      </RequestData>
      <OrderId>0</OrderId>
    </GetExtRequestInfoResponse>
  </Result>
</GetCrmOrderExternalsResponse>