POST v1/sales-orders/search

Search for sales orders using the search filters.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Number		string	None.
Name		string	None.
CustomerId		integer	None.
StatusChangedTo		integer	None.
StatusChangedDateRange	The date and time (in company time zone) when the sales order status was changed.	DateRange	None.
DateCreatedRange	The date and time (in company time zone) when the sales order was created.	DateRange	None.
LastUpdatedDateRange	The date and time (in company time zone) when the sales order was last updated.	DateRange	None.
PageIndex	zero-based page number	integer	None.
PageSize	Default value is 100	integer	Range: inclusive between 1 and 1000
SortExpression	Specify the field name to sort the result set by. It can be one of the fields returned by the search.	string	None.
SortOrder	Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending)	integer	Range: inclusive between 1 and 2

Request Formats

application/json, text/json

Sample:

{
  "number": "sample string 1",
  "name": "sample string 2",
  "customerId": 1,
  "statusChangedTo": 1,
  "statusChangedDateRange": null,
  "dateCreatedRange": null,
  "lastUpdatedDateRange": null,
  "pageIndex": 3,
  "pageSize": 4,
  "sortExpression": "sample string 5",
  "sortOrder": 6
}

application/xml, text/xml

Sample:

<SalesOrderSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.SO">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">4</PageSize>
  <SortExpression xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">sample string 5</SortExpression>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">6</SortOrder>
  <CustomerId>1</CustomerId>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Name>sample string 2</Name>
  <Number>sample string 1</Number>
  <StatusChangedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <StatusChangedTo>1</StatusChangedTo>
</SalesOrderSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfSalesOrderSearchResult

Name	Description	Type	Additional information
TotalCount		integer	None.
Data		Collection of SalesOrderSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "number": "sample string 2",
      "name": "sample string 3",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2024-04-20T03:25:41.877363-04:00",
      "lastUpdatedDate": "2024-04-20T03:25:41.877363-04:00"
    },
    {
      "id": 1,
      "number": "sample string 2",
      "name": "sample string 3",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "dateCreated": "2024-04-20T03:25:41.877363-04:00",
      "lastUpdatedDate": "2024-04-20T03:25:41.877363-04:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResultOfSalesOrderSearchResult_S17SLpEL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.SO">
    <d2p1:SalesOrderSearchResult>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Customer>
      <d2p1:DateCreated>2024-04-20T03:25:41.877363-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-20T03:25:41.877363-04:00</d2p1:LastUpdatedDate>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Status>
    </d2p1:SalesOrderSearchResult>
    <d2p1:SalesOrderSearchResult>
      <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Customer>
      <d2p1:DateCreated>2024-04-20T03:25:41.877363-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-20T03:25:41.877363-04:00</d2p1:LastUpdatedDate>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:Status>
    </d2p1:SalesOrderSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfSalesOrderSearchResult_S17SLpEL>