GET api/SalesOrderStatus?companyCode={companyCode}

Get all Sales Order Items in status Planning, PendingPayment, BackOrder, New of InProcess. Sales Order Items in status Completed, Cancelled or Destroyed will not be returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required

Body Parameters

None.

Response Information

Resource Description

Response message with SO items. HttpStatusCode.Conflict when user isn't connected to Company

GetSalesOrderStatusListMessageResponse

Name	Description	Type	Additional information
Header	Header item	MessageHeader	None.
SalesOrders	List of Sales Orders with statuses	Collection of SalesOrderStatusResult	None.
Footer	Footer item	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "SalesOrders": [
    {
      "CompanyIdentifier": "string 1",
      "SalesOrderIdentifier": "string 2",
      "SalesOrderLineStatusResults": [
        {
          "LineIdentifier": 1,
          "SequenceIdentifier": 1,
          "SequenceIdentifierSpecified": true,
          "ProductIdentifier": "string 3",
          "QuantityOrdered": 4,
          "Status": "New",
          "HoldStatuses": [
            "Unknown",
            "Unknown"
          ]
        },
        {
          "LineIdentifier": 1,
          "SequenceIdentifier": 1,
          "SequenceIdentifierSpecified": true,
          "ProductIdentifier": "string 3",
          "QuantityOrdered": 4,
          "Status": "New",
          "HoldStatuses": [
            "Unknown",
            "Unknown"
          ]
        }
      ]
    },
    {
      "CompanyIdentifier": "string 1",
      "SalesOrderIdentifier": "string 2",
      "SalesOrderLineStatusResults": [
        {
          "LineIdentifier": 1,
          "SequenceIdentifier": 1,
          "SequenceIdentifierSpecified": true,
          "ProductIdentifier": "string 3",
          "QuantityOrdered": 4,
          "Status": "New",
          "HoldStatuses": [
            "Unknown",
            "Unknown"
          ]
        },
        {
          "LineIdentifier": 1,
          "SequenceIdentifier": 1,
          "SequenceIdentifierSpecified": true,
          "ProductIdentifier": "string 3",
          "QuantityOrdered": 4,
          "Status": "New",
          "HoldStatuses": [
            "Unknown",
            "Unknown"
          ]
        }
      ]
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<GetSalesOrderStatusListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <SalesOrders>
    <SalesOrderStatusResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <SalesOrderLineStatusResults>
        <SalesOrderLineStatusResult>
          <LineIdentifier>1</LineIdentifier>
          <SequenceIdentifier>1</SequenceIdentifier>
          <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
          <ProductIdentifier>string 3</ProductIdentifier>
          <QuantityOrdered>4</QuantityOrdered>
          <Status>New</Status>
          <HoldStatuses>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
          </HoldStatuses>
        </SalesOrderLineStatusResult>
        <SalesOrderLineStatusResult>
          <LineIdentifier>1</LineIdentifier>
          <SequenceIdentifier>1</SequenceIdentifier>
          <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
          <ProductIdentifier>string 3</ProductIdentifier>
          <QuantityOrdered>4</QuantityOrdered>
          <Status>New</Status>
          <HoldStatuses>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
          </HoldStatuses>
        </SalesOrderLineStatusResult>
      </SalesOrderLineStatusResults>
    </SalesOrderStatusResult>
    <SalesOrderStatusResult>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <SalesOrderIdentifier>string 2</SalesOrderIdentifier>
      <SalesOrderLineStatusResults>
        <SalesOrderLineStatusResult>
          <LineIdentifier>1</LineIdentifier>
          <SequenceIdentifier>1</SequenceIdentifier>
          <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
          <ProductIdentifier>string 3</ProductIdentifier>
          <QuantityOrdered>4</QuantityOrdered>
          <Status>New</Status>
          <HoldStatuses>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
          </HoldStatuses>
        </SalesOrderLineStatusResult>
        <SalesOrderLineStatusResult>
          <LineIdentifier>1</LineIdentifier>
          <SequenceIdentifier>1</SequenceIdentifier>
          <SequenceIdentifierSpecified>true</SequenceIdentifierSpecified>
          <ProductIdentifier>string 3</ProductIdentifier>
          <QuantityOrdered>4</QuantityOrdered>
          <Status>New</Status>
          <HoldStatuses>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
            <SalesOrderLineHoldStatus>Unknown</SalesOrderLineHoldStatus>
          </HoldStatuses>
        </SalesOrderLineStatusResult>
      </SalesOrderLineStatusResults>
    </SalesOrderStatusResult>
  </SalesOrders>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetSalesOrderStatusListMessageResponse>