GET salesorder/list/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&poNumber={poNumber}&endUserPO={endUserPO}&shippingCity={shippingCity}&referenceNumber={referenceNumber}&status={status}&docType={docType}&includeScheduleLines={includeScheduleLines}&fromDate={fromDate}&toDate={toDate}&fromLastChangeDate={fromLastChangeDate}&toLastChangeDate={toLastChangeDate}

Get Order List allows customers to get a paged list of sales orders with details.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerNumber	Your Customer Number	string	Required
page	Page Number	integer	Default value is 1
pageSize	Number of results per page	integer	Default value is 100
salesOrderNumber	Sales Order Number	string	None.
poNumber	Purchase Order Number	string	None.
endUserPO	End User PO Number	string	None.
shippingCity	Shipping City	string	None.
referenceNumber		string	None.
status	Order status: Cancelled, Completely Shipped, On Hold, Open, Partially Shipped, Quotation/Sales	string	None.
docType		string	None.
includeScheduleLines	flag indicating if response should include schedule lines	boolean	Default value is False
fromDate	Start date range Format: YYYY-MM-DD	string	None.
toDate	End date range Format: YYYY-MM-DD	string	None.
fromLastChangeDate	Start last changed date range Format: YYYY-MM-DD	string	None.
toLastChangeDate	End last changed date range Format: YYYY-MM-DD	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SalesOrderList

Name	Description	Type	Additional information
OrderNumber	Sales Order Number	string	None.
PONumber	Your Purchase Order Number	string	None.
EndUserPO	End User Purchase Order Number	string	None.
ReferenceNumber	ReferenceNumber	string	None.
DocType	Document Type	string	None.
SalesRepCode	SalesRepCode	string	None.
Status	Order Status	string	None.
BillingAddress	Billing Address	Address	None.
ShippingAddress	Shipping Address	Address	None.
ShippingOptionDescription	Shipping option description	string	None.
FreightAmount	Freight amount	decimal number	Data type: Currency
EnteredByEmail	email address of user that create order if specified	string	None.
Total	Total order amount	decimal number	None.
Currency	Currency code for amounts. USD – US Dollars, CAD- Canadian Dollars, EUR- Euro, GBP- British Pound	string	None.
SalesOrderLines	List of lines	Collection of SalesOrderListLine	None.
DateEntered	Date stamp when order was created	string	None.
LastChanged	Date stamp for when order was last updated	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderNumber": "sample string 1",
    "PONumber": "sample string 2",
    "EndUserPO": "sample string 3",
    "ReferenceNumber": "sample string 4",
    "DocType": "sample string 5",
    "SalesRepCode": "sample string 6",
    "Status": "sample string 7",
    "BillingAddress": {
      "Name": "sample string 1",
      "Attn": "sample string 2",
      "Street1": "sample string 3",
      "Street2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "PostalCode": "sample string 7",
      "Country": "sample string 8"
    },
    "ShippingAddress": {
      "Name": "sample string 1",
      "Attn": "sample string 2",
      "Street1": "sample string 3",
      "Street2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "PostalCode": "sample string 7",
      "Country": "sample string 8"
    },
    "ShippingOptionDescription": "sample string 8",
    "FreightAmount": 9.0,
    "EnteredByEmail": "sample string 10",
    "Total": 11.0,
    "Currency": "sample string 12",
    "SalesOrderLines": [
      {
        "LineNumber": 1.0,
        "POLineNumber": 2.0,
        "ItemNumber": "sample string 3",
        "ProductMfrPart": "sample string 4",
        "Ordered": 5.0,
        "Committed": 6.0,
        "BackOrdered": 7.0,
        "Shipped": 8.0,
        "Canceled": 9,
        "Price": 10.0,
        "Currency": "sample string 11",
        "ScheduleLines": [
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          },
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          }
        ]
      },
      {
        "LineNumber": 1.0,
        "POLineNumber": 2.0,
        "ItemNumber": "sample string 3",
        "ProductMfrPart": "sample string 4",
        "Ordered": 5.0,
        "Committed": 6.0,
        "BackOrdered": 7.0,
        "Shipped": 8.0,
        "Canceled": 9,
        "Price": 10.0,
        "Currency": "sample string 11",
        "ScheduleLines": [
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          },
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          }
        ]
      }
    ],
    "DateEntered": "sample string 13",
    "LastChanged": "sample string 14"
  },
  {
    "OrderNumber": "sample string 1",
    "PONumber": "sample string 2",
    "EndUserPO": "sample string 3",
    "ReferenceNumber": "sample string 4",
    "DocType": "sample string 5",
    "SalesRepCode": "sample string 6",
    "Status": "sample string 7",
    "BillingAddress": {
      "Name": "sample string 1",
      "Attn": "sample string 2",
      "Street1": "sample string 3",
      "Street2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "PostalCode": "sample string 7",
      "Country": "sample string 8"
    },
    "ShippingAddress": {
      "Name": "sample string 1",
      "Attn": "sample string 2",
      "Street1": "sample string 3",
      "Street2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "PostalCode": "sample string 7",
      "Country": "sample string 8"
    },
    "ShippingOptionDescription": "sample string 8",
    "FreightAmount": 9.0,
    "EnteredByEmail": "sample string 10",
    "Total": 11.0,
    "Currency": "sample string 12",
    "SalesOrderLines": [
      {
        "LineNumber": 1.0,
        "POLineNumber": 2.0,
        "ItemNumber": "sample string 3",
        "ProductMfrPart": "sample string 4",
        "Ordered": 5.0,
        "Committed": 6.0,
        "BackOrdered": 7.0,
        "Shipped": 8.0,
        "Canceled": 9,
        "Price": 10.0,
        "Currency": "sample string 11",
        "ScheduleLines": [
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          },
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          }
        ]
      },
      {
        "LineNumber": 1.0,
        "POLineNumber": 2.0,
        "ItemNumber": "sample string 3",
        "ProductMfrPart": "sample string 4",
        "Ordered": 5.0,
        "Committed": 6.0,
        "BackOrdered": 7.0,
        "Shipped": 8.0,
        "Canceled": 9,
        "Price": 10.0,
        "Currency": "sample string 11",
        "ScheduleLines": [
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          },
          {
            "EstimatedShipDate": "2024-05-03T06:10:19.96348-04:00",
            "Confirmed": 2
          }
        ]
      }
    ],
    "DateEntered": "sample string 13",
    "LastChanged": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSalesOrderList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SalesOrderList>
    <OrderNumber>sample string 1</OrderNumber>
    <PONumber>sample string 2</PONumber>
    <EndUserPO>sample string 3</EndUserPO>
    <ReferenceNumber>sample string 4</ReferenceNumber>
    <DocType>sample string 5</DocType>
    <SalesRepCode>sample string 6</SalesRepCode>
    <Status>sample string 7</Status>
    <BillingAddress>
      <Name>sample string 1</Name>
      <Attn>sample string 2</Attn>
      <Street1>sample string 3</Street1>
      <Street2>sample string 4</Street2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <PostalCode>sample string 7</PostalCode>
      <Country>sample string 8</Country>
    </BillingAddress>
    <ShippingAddress>
      <Name>sample string 1</Name>
      <Attn>sample string 2</Attn>
      <Street1>sample string 3</Street1>
      <Street2>sample string 4</Street2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <PostalCode>sample string 7</PostalCode>
      <Country>sample string 8</Country>
    </ShippingAddress>
    <ShippingOptionDescription>sample string 8</ShippingOptionDescription>
    <FreightAmount>9</FreightAmount>
    <EnteredByEmail>sample string 10</EnteredByEmail>
    <Total>11</Total>
    <Currency>sample string 12</Currency>
    <SalesOrderLines>
      <SalesOrderListLine>
        <LineNumber>1</LineNumber>
        <POLineNumber>2</POLineNumber>
        <ItemNumber>sample string 3</ItemNumber>
        <ProductMfrPart>sample string 4</ProductMfrPart>
        <Ordered>5</Ordered>
        <Committed>6</Committed>
        <BackOrdered>7</BackOrdered>
        <Shipped>8</Shipped>
        <Canceled>9</Canceled>
        <Price>10</Price>
        <Currency>sample string 11</Currency>
        <ScheduleLines>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
        </ScheduleLines>
      </SalesOrderListLine>
      <SalesOrderListLine>
        <LineNumber>1</LineNumber>
        <POLineNumber>2</POLineNumber>
        <ItemNumber>sample string 3</ItemNumber>
        <ProductMfrPart>sample string 4</ProductMfrPart>
        <Ordered>5</Ordered>
        <Committed>6</Committed>
        <BackOrdered>7</BackOrdered>
        <Shipped>8</Shipped>
        <Canceled>9</Canceled>
        <Price>10</Price>
        <Currency>sample string 11</Currency>
        <ScheduleLines>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
        </ScheduleLines>
      </SalesOrderListLine>
    </SalesOrderLines>
    <DateEntered>sample string 13</DateEntered>
    <LastChanged>sample string 14</LastChanged>
  </SalesOrderList>
  <SalesOrderList>
    <OrderNumber>sample string 1</OrderNumber>
    <PONumber>sample string 2</PONumber>
    <EndUserPO>sample string 3</EndUserPO>
    <ReferenceNumber>sample string 4</ReferenceNumber>
    <DocType>sample string 5</DocType>
    <SalesRepCode>sample string 6</SalesRepCode>
    <Status>sample string 7</Status>
    <BillingAddress>
      <Name>sample string 1</Name>
      <Attn>sample string 2</Attn>
      <Street1>sample string 3</Street1>
      <Street2>sample string 4</Street2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <PostalCode>sample string 7</PostalCode>
      <Country>sample string 8</Country>
    </BillingAddress>
    <ShippingAddress>
      <Name>sample string 1</Name>
      <Attn>sample string 2</Attn>
      <Street1>sample string 3</Street1>
      <Street2>sample string 4</Street2>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <PostalCode>sample string 7</PostalCode>
      <Country>sample string 8</Country>
    </ShippingAddress>
    <ShippingOptionDescription>sample string 8</ShippingOptionDescription>
    <FreightAmount>9</FreightAmount>
    <EnteredByEmail>sample string 10</EnteredByEmail>
    <Total>11</Total>
    <Currency>sample string 12</Currency>
    <SalesOrderLines>
      <SalesOrderListLine>
        <LineNumber>1</LineNumber>
        <POLineNumber>2</POLineNumber>
        <ItemNumber>sample string 3</ItemNumber>
        <ProductMfrPart>sample string 4</ProductMfrPart>
        <Ordered>5</Ordered>
        <Committed>6</Committed>
        <BackOrdered>7</BackOrdered>
        <Shipped>8</Shipped>
        <Canceled>9</Canceled>
        <Price>10</Price>
        <Currency>sample string 11</Currency>
        <ScheduleLines>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
        </ScheduleLines>
      </SalesOrderListLine>
      <SalesOrderListLine>
        <LineNumber>1</LineNumber>
        <POLineNumber>2</POLineNumber>
        <ItemNumber>sample string 3</ItemNumber>
        <ProductMfrPart>sample string 4</ProductMfrPart>
        <Ordered>5</Ordered>
        <Committed>6</Committed>
        <BackOrdered>7</BackOrdered>
        <Shipped>8</Shipped>
        <Canceled>9</Canceled>
        <Price>10</Price>
        <Currency>sample string 11</Currency>
        <ScheduleLines>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
          <ScheduleLine>
            <EstimatedShipDate>2024-05-03T06:10:19.96348-04:00</EstimatedShipDate>
            <Confirmed>2</Confirmed>
          </ScheduleLine>
        </ScheduleLines>
      </SalesOrderListLine>
    </SalesOrderLines>
    <DateEntered>sample string 13</DateEntered>
    <LastChanged>sample string 14</LastChanged>
  </SalesOrderList>
</ArrayOfSalesOrderList>