GET api/ArgusAPI/GetOrderMaster

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Login	string	None.
Password	string	None.
Region	string	None.
ApplicationName	string	None.
SessionId	string	None.
OrderMasterKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Login": "sample string 1",
  "Password": "sample string 2",
  "Region": "sample string 3",
  "ApplicationName": "sample string 4",
  "SessionId": "sample string 5",
  "OrderMasterKey": "sample string 6"
}

application/xml, text/xml

Sample:

<GetOrderMasterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <ApplicationName>sample string 4</ApplicationName>
  <Login>sample string 1</Login>
  <OrderMasterKey>sample string 6</OrderMasterKey>
  <Password>sample string 2</Password>
  <Region>sample string 3</Region>
  <SessionId>sample string 5</SessionId>
</GetOrderMasterRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetOrderMasterResponse

Name	Type	Additional information
OM	WS_OM	None.
StatusCode	string	None.
StatusDescription	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OM": {
    "OMKey": "sample string 1",
    "Active": true,
    "AppliedDeposits": [
      1.0,
      2.0
    ],
    "BusinessPhone": "sample string 3",
    "CancellationCode": "sample string 4",
    "ChangeOfDeliveryNotification": "sample string 5",
    "CMKey": "sample string 6",
    "Commission": 7,
    "CreatedByLogin": "sample string 8",
    "CreatedByTerminalID": "sample string 9",
    "DeliveryCharge": 10.0,
    "DeliveryDate": "sample string 11",
    "DeliveryDateModified": "sample string 12",
    "DeliveryMonthEstimated": "sample string 13",
    "DeliveryTruckNumber": "sample string 14",
    "DeliveryType": "sample string 15",
    "DepositItems": [
      {
        "Amount": 1.0,
        "CashCode": "sample string 2",
        "Date": "sample string 3",
        "Reference": "sample string 4"
      },
      {
        "Amount": 1.0,
        "CashCode": "sample string 2",
        "Date": "sample string 3",
        "Reference": "sample string 4"
      }
    ],
    "expDeliveryZone": "sample string 16",
    "FinanceAccount": "sample string 17",
    "FinanceAuthorization": "sample string 18",
    "FinanceFlag": "sample string 19",
    "FinancePlan": "sample string 20",
    "LastAccessStamp": "sample string 21",
    "LineNumbers": [
      "sample string 1",
      "sample string 2"
    ],
    "MediaType": "sample string 22",
    "NewHomeClosingDate": "sample string 23",
    "OrderTotal": 24.0,
    "OrderType": "sample string 25",
    "OriginalOrder": "sample string 26",
    "PackageIndicator": [
      "sample string 1",
      "sample string 2"
    ],
    "PackageNumbers": [
      "sample string 1",
      "sample string 2"
    ],
    "PreviousDeliveryDate": "sample string 27",
    "PreviousDeliveryDates": [
      "sample string 1",
      "sample string 2"
    ],
    "PrimaryPhone": "sample string 28",
    "Printed": 29,
    "RemoteDeliveryDate": "sample string 30",
    "RemoteTimeFrame": "sample string 31",
    "RepInitials": "sample string 32",
    "ReturnCodeOrAffiliateData": "sample string 33",
    "Route": "sample string 34",
    "SalespersonNumber": "sample string 35",
    "ShippingLog": "sample string 36",
    "SpecialInstructions": "sample string 37",
    "StagingLock": "sample string 38",
    "Status": "sample string 39",
    "Stop": "sample string 40",
    "StoreNumber": "sample string 41",
    "TaxExemptCertificate": "sample string 42",
    "TimeFrame": "sample string 43",
    "WrittenDateTime": "sample string 44",
    "MainCashCode": [
      "sample string 1",
      "sample string 2"
    ],
    "OrderStatus": "sample string 45",
    "Notes": [
      "sample string 1",
      "sample string 2"
    ],
    "isI95": true,
    "Invoices": [
      {
        "Amount": 1.0,
        "Date": "sample string 2",
        "InvoiceNumber": "sample string 3"
      },
      {
        "Amount": 1.0,
        "Date": "sample string 2",
        "InvoiceNumber": "sample string 3"
      }
    ]
  },
  "StatusCode": "sample string 1",
  "StatusDescription": "sample string 2"
}

application/xml, text/xml

Sample:

<GetOrderMasterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <OM>
    <Active>true</Active>
    <AppliedDeposits xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:decimal>1</d3p1:decimal>
      <d3p1:decimal>2</d3p1:decimal>
    </AppliedDeposits>
    <BusinessPhone>sample string 3</BusinessPhone>
    <CMKey>sample string 6</CMKey>
    <CancellationCode>sample string 4</CancellationCode>
    <ChangeOfDeliveryNotification>sample string 5</ChangeOfDeliveryNotification>
    <Commission>7</Commission>
    <CreatedByLogin>sample string 8</CreatedByLogin>
    <CreatedByTerminalID>sample string 9</CreatedByTerminalID>
    <DeliveryCharge>10</DeliveryCharge>
    <DeliveryDate>sample string 11</DeliveryDate>
    <DeliveryDateModified>sample string 12</DeliveryDateModified>
    <DeliveryMonthEstimated>sample string 13</DeliveryMonthEstimated>
    <DeliveryTruckNumber>sample string 14</DeliveryTruckNumber>
    <DeliveryType>sample string 15</DeliveryType>
    <DepositItems>
      <SalesOrderDepositItem>
        <Amount>1</Amount>
        <CashCode>sample string 2</CashCode>
        <Date>sample string 3</Date>
        <Reference>sample string 4</Reference>
      </SalesOrderDepositItem>
      <SalesOrderDepositItem>
        <Amount>1</Amount>
        <CashCode>sample string 2</CashCode>
        <Date>sample string 3</Date>
        <Reference>sample string 4</Reference>
      </SalesOrderDepositItem>
    </DepositItems>
    <FinanceAccount>sample string 17</FinanceAccount>
    <FinanceAuthorization>sample string 18</FinanceAuthorization>
    <FinanceFlag>sample string 19</FinanceFlag>
    <FinancePlan>sample string 20</FinancePlan>
    <Invoices>
      <WS_SalesOrderInvoiceItem>
        <Amount>1</Amount>
        <Date>sample string 2</Date>
        <InvoiceNumber>sample string 3</InvoiceNumber>
      </WS_SalesOrderInvoiceItem>
      <WS_SalesOrderInvoiceItem>
        <Amount>1</Amount>
        <Date>sample string 2</Date>
        <InvoiceNumber>sample string 3</InvoiceNumber>
      </WS_SalesOrderInvoiceItem>
    </Invoices>
    <LastAccessStamp>sample string 21</LastAccessStamp>
    <LineNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LineNumbers>
    <MainCashCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MainCashCode>
    <MediaType>sample string 22</MediaType>
    <NewHomeClosingDate>sample string 23</NewHomeClosingDate>
    <Notes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Notes>
    <OMKey>sample string 1</OMKey>
    <OrderStatus>sample string 45</OrderStatus>
    <OrderTotal>24</OrderTotal>
    <OrderType>sample string 25</OrderType>
    <OriginalOrder>sample string 26</OriginalOrder>
    <PackageIndicator xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PackageIndicator>
    <PackageNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PackageNumbers>
    <PreviousDeliveryDate>sample string 27</PreviousDeliveryDate>
    <PreviousDeliveryDates xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PreviousDeliveryDates>
    <PrimaryPhone>sample string 28</PrimaryPhone>
    <Printed>29</Printed>
    <RemoteDeliveryDate>sample string 30</RemoteDeliveryDate>
    <RemoteTimeFrame>sample string 31</RemoteTimeFrame>
    <RepInitials>sample string 32</RepInitials>
    <ReturnCodeOrAffiliateData>sample string 33</ReturnCodeOrAffiliateData>
    <Route>sample string 34</Route>
    <SalespersonNumber>sample string 35</SalespersonNumber>
    <ShippingLog>sample string 36</ShippingLog>
    <SpecialInstructions>sample string 37</SpecialInstructions>
    <StagingLock>sample string 38</StagingLock>
    <Status>sample string 39</Status>
    <Stop>sample string 40</Stop>
    <StoreNumber>sample string 41</StoreNumber>
    <TaxExemptCertificate>sample string 42</TaxExemptCertificate>
    <TimeFrame>sample string 43</TimeFrame>
    <WrittenDateTime>sample string 44</WrittenDateTime>
    <expDeliveryZone>sample string 16</expDeliveryZone>
    <isI95>true</isI95>
  </OM>
  <StatusCode>sample string 1</StatusCode>
  <StatusDescription>sample string 2</StatusDescription>
</GetOrderMasterResponse>