Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the UOM schedule properties can be referenced.

Where Clause Columns

...

Column Name

...

????

Example Request

Code Block
<NSRequest>
  <RequestName>NorthPacificUOMScheduleMaster</RequestName>
  <RequestContent>
    <DataEntityCompanySK>1</DataEntityCompanySK>
  </RequestContent>
</NSRequest>

...

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the site properties can be referenced.

Where Clause Columns

...

Column Name

...

SiteSK

...

SiteID

...

SiteName

...

CompanyID

...

DataEntityCompanySK

...

AddressLine1

...

AddressLine2

...

City

...

...

Zip

...

Country

...

Phone1

...

Fax

Example Request

Code Block
languagexml
<NSRequest>
	<RequestName>ListSites</RequestName>
	<RequestContent>
		<DataEntityCompanySK>1</DataEntityCompanySK>
		<WhereClause>State = 'WA' OR SiteName LIKE '%a%'</WhereClause>
	</RequestContent>
</NSRequest>

...

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the sales order (not detail) properties can be referenced.

Where Clause Columns

...

Column Name

...

????

Example Request

ListItems

This request will retrieve a list of items.

Accepted Information

...

Parameter Name

...

Required

...

Comment

...

DataEntityCompanySK

...

Yes

...

The identifier for the company from which to pull sites.

...

WhereClause

...

No

...

Filtering parameter for returned data.

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the Item properties can be referenced.

Where Clause Columns

...

Column Name

...

????

Example Request

Example Request

Code Block
<NSRequest>
  <RequestName>NorthPacificSalesOrder</RequestName>
  <RequestContent>
    <DataEntityCompanySK>1</DataEntityCompanySK>
    <WhereClause>SiteID = '400'</WhereClause>
  </RequestContent>
</NSRequest>

Note: JSON is not supported for this request.

Example Response

Code Block
languagexml
<NSResponse>
    <Timestamp>2019-12-02T14:15:06.265</Timestamp>
    <Success>true</Success>
    <SalesOrders>
        <SalesOrder>
            <CompanyID>Acme</CompanyID>
            <SiteID>123</SiteID>
            <OrderID>PO500</OrderID>
            <CustomerID>BrownCo</CustomerID>
            <CustomerSK>889</CustomerSK>
            <AddressID>BrownCoPPT1</AddressID>
            <ScheduledShipDate>2019-11-20T00:00:00</ScheduledShipDate>
            <ScheduledDeliveryDate>2019-11-29T00:00:00</ScheduledDeliveryDate>
            <CarrierName>Good Old Shipping Company</CarrierName>
            <OrderDate>2019-11-13T00:00:00</OrderDate>
            <ShipAddressSK>7878</ShipAddressSK>
            <OrderHeaderSK>9090</OrderHeaderSK>
            <OrderStatusSK>2</OrderStatusSK>
            <OrderTypeSK>2</OrderTypeSK>
            <OrderDetails>
                <OrderDetail>
                    <OrderItemSK>400</OrderItemSK>
                    <OrderHeaderSK>9090</OrderHeaderSK>
                    <ItemID>8998</ItemID>
                    <ManageItemsByEN>3</ManageItemsByEN>
                    <WeightUOMID>Lbs</WeightUOMID>
                    <UnitUOMID>Each</UnitUOMID>
                    <ItemDescription>Pudding 6-10 Lbs. Fresh</ItemDescription>
                    <OrderedUnits>22</OrderedUnits>
                    <OrderedWeight>220</OrderedWeight>
                    <ItemSort>2</ItemSort>
                </OrderDetail>
                <OrderDetail>
                    <OrderItemSK>900</OrderItemSK>
                    <OrderHeaderSK>9090</OrderHeaderSK>
                    <ItemID>2359</ItemID>
                    <ManageItemsByEN>3</ManageItemsByEN>
                    <WeightUOMID>Lbs</WeightUOMID>
                    <UnitUOMID>Case</UnitUOMID>
                    <ItemDescription>Flakes Cereal #2</ItemDescription>
                    <OrderedUnits>15.00000</OrderedUnits>
                    <OrderedWeight>150.00000</OrderedWeight>
                    <ItemSort>1</ItemSort>
                </OrderDetail>
            </OrderDetails>
        </SalesOrder>
    </SalesOrders>
</NSResponse>

ListItems

This request will retrieve a list of items.

Accepted Information

Parameter Name

Required

Comment

DataEntityCompanySK

Yes

The identifier for the company from which to pull sites.

WhereClause

No

Filtering parameter for returned data.

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the Item properties can be referenced.

Example Request

Code Block
<NSRequest>
  <RequestName>NorthPacificItemMaster</RequestName>
  <RequestContent>
    <DataEntityCompanySK>1</DataEntityCompanySK>
  </RequestContent>
</NSRequest>  

Note: JSON is not supported for this command.

Example Response

Code Block
languagexml
<NSResponse>
    <Timestamp>2019-12-02T14:15:04.574</Timestamp>
    <Success>true</Success>
    <ItemList>
        <Item>
            <ItemID>4010</ItemID>
            <ItemSK>1</ItemSK>
            <ItemDescription>A do-dad</ItemDescription>
            <CompanyID>Acme</CompanyID>
            <TrackMethodEN>3</TrackMethodEN>
            <ManageItemsByEN>3</ManageItemsByEN>
            <IsItemVariableWeight>1</IsItemVariableWeight>
            <ClassID>Wholesale</ClassID>
            <UnitsUOMID>Each</UnitsUOMID>
            <WeightUOMID>Lbs</WeightUOMID>
            <BaseUOMID>Lbs</BaseUOMID>
            <ExpirationDays>999</ExpirationDays>
            <ScheduleSK>58</ScheduleSK>
            <ShippingWeight>1</ShippingWeight>
        </Item>
        <Item>
            <ItemID>5050</ItemID>
            <ItemSK>2</ItemSK>
            <ItemDescription>A thingamajig</ItemDescription>
            <CompanyID>Acme</CompanyID>
            <TrackMethodEN>3</TrackMethodEN>
            <ManageItemsByEN>3</ManageItemsByEN>
            <IsItemVariableWeight>1</IsItemVariableWeight>
            <ClassID>Wholesale</ClassID>
            <UnitsUOMID>Each</UnitsUOMID>
            <WeightUOMID>Lbs</WeightUOMID>
            <BaseUOMID>Lbs</BaseUOMID>
            <ExpirationDays>999</ExpirationDays>
            <ScheduleSK>57</ScheduleSK>
            <ShippingWeight>0</ShippingWeight>
        </Item>
    </ItemList>
</NSResponse>

ListCustomerAddresses

This request will retrieve a list of customer addresses.

...

The WhereClause parameter enables only a selection of data to be sent back in the reply, based on filter criteria written with SQL syntax. Any of the customer address properties can be referenced.

Where Clause Columns

...

Column Name

...

Example Request

Code Block
languagexml
<NSRequest>
  <RequestName>NorthPacificCustomer</RequestName>
  <RequestContent>
    <DataEntityCompanySK>1</DataEntityCompanySK>
  </RequestContent>
</NSRequest>

Note: JSON is not supported for this web request.

Example Response

Code Block
languagexml
<NSResponse>
    <Timestamp>2019-12-02T14:15:07.058</Timestamp>
    <Success>true</Success>
    <CustomerShipToList>
        <CustomerShipTo>
            <CustomerSK>8001</CustomerSK>
            <CustomerID>CustomerID1</CustomerID>
            <CustomerName>Acme Company</CustomerName>
            <AddressID>ACMEADDR1</AddressID>
            <AddressName>Acme Building A</AddressName>
            <AddressLine1>1234 SE StreetName BLD A</AddressLine1>
            <AddressLine2 />
            <City>Seattle</City>
            <State>WA</State>
            <Zip>98125</Zip>
            <Country>USA</Country>
            <AddressTypeEN>3</AddressTypeEN>
            <CompanyID>CompanyID</CompanyID>
        </CustomerShipTo>
        <CustomerShipTo>
            <CustomerSK>8001</CustomerSK>
            <CustomerID>CustomerID1</CustomerID>
            <CustomerName>Acme Company</CustomerName>
            <AddressID>ACMEADDR2</AddressID>
            <AddressName>Acme Building B</AddressName>
            <AddressLine1>1234 SE StreetName BLD A</AddressLine1>
            <AddressLine2 />
            <City>Seattle</City>
            <State>WA</State>
            <Zip>98125</Zip>
            <Country>USA</Country>
            <AddressTypeEN>4</AddressTypeEN>
            <CompanyID>CompanyID</CompanyID>
        </CustomerShipTo>
    </CustomerShipToList>
</NSResponse>