POST api/OmsNodeInformation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
NodeSiteCode	string	None.
NodeCode	string	None.
NodeID	integer	None.
OnlyActive	boolean	None.
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
ResponseCallbackUri	string	None.
APIUsername	string	None.
IDToken	string	None.
UserAccount	Account	None.
UserdID	integer	None.
IsValidJwtToken	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "NodeSiteCode": "sample string 1",
  "NodeCode": "sample string 2",
  "NodeID": 3,
  "OnlyActive": true,
  "SiteCode": "sample string 5",
  "VerificationKey": "sample string 6",
  "TimestampUTC": "sample string 7",
  "ResponseCallbackUri": "sample string 8",
  "APIUsername": "sample string 9",
  "IDToken": "sample string 10",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T21:18:05.0243543+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T21:18:05.0243543+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T21:18:05.0243543+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T21:18:05.0243543+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T21:18:05.0243543+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T21:18:05.0243543+00:00",
    "ApiKey": "sample string 21",
    "FederatedID": "sample string 22",
    "FirstName": "sample string 23",
    "LastName": "sample string 24",
    "FullName": "sample string 23sample string 24"
  },
  "UserdID": 11,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<OmsNodeInformationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 9</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 10</IDToken>
  <IsValidJwtToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">true</IsValidJwtToken>
  <ResponseCallbackUri xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 8</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 5</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 7</TimestampUTC>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Membership.Models" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">
    <d2p1:ApiKey>sample string 21</d2p1:ApiKey>
    <d2p1:ConfirmationToken>sample string 4</d2p1:ConfirmationToken>
    <d2p1:CreateDate>2025-12-20T21:18:05.0243543+00:00</d2p1:CreateDate>
    <d2p1:FederatedID>sample string 22</d2p1:FederatedID>
    <d2p1:FirstName>sample string 23</d2p1:FirstName>
    <d2p1:IsArchived>true</d2p1:IsArchived>
    <d2p1:IsAuthorized>true</d2p1:IsAuthorized>
    <d2p1:IsConfirmed>true</d2p1:IsConfirmed>
    <d2p1:LastName>sample string 24</d2p1:LastName>
    <d2p1:LastPasswordFailureDate>2025-12-20T21:18:05.0243543+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T21:18:05.0243543+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T21:18:05.0243543+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T21:18:05.0243543+00:00</d2p1:PasswordChangedDate>
    <d2p1:PasswordFailuresSinceLastSuccess>7</d2p1:PasswordFailuresSinceLastSuccess>
    <d2p1:PasswordSalt>sample string 10</d2p1:PasswordSalt>
    <d2p1:PasswordVerificationToken>sample string 11</d2p1:PasswordVerificationToken>
    <d2p1:PasswordVerificationTokenExpirationDate>2025-12-20T21:18:05.0243543+00:00</d2p1:PasswordVerificationTokenExpirationDate>
    <d2p1:SecurityAnswer>sample string 14</d2p1:SecurityAnswer>
    <d2p1:SecurityFailuresSinceLastSuccess>15</d2p1:SecurityFailuresSinceLastSuccess>
    <d2p1:SecurityQuestion>sample string 13</d2p1:SecurityQuestion>
    <d2p1:UserID>1</d2p1:UserID>
    <d2p1:Username>sample string 2</d2p1:Username>
  </UserAccount>
  <UserdID xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">11</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 6</VerificationKey>
  <NodeCode>sample string 2</NodeCode>
  <NodeID>3</NodeID>
  <NodeSiteCode>sample string 1</NodeSiteCode>
  <OnlyActive>true</OnlyActive>
</OmsNodeInformationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OmsNodeInformationResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
Nodes	Collection of NodeExportDetails	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "Nodes": [
    {
      "NodeID": 1,
      "Location": "sample string 2",
      "ZipCode": "sample string 3",
      "NodeCode": "sample string 4",
      "SiteCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "ShippingPlugin": "sample string 5",
      "ShippingHeaderPlugin": "sample string 6",
      "ShippingItemPlugin": "sample string 7",
      "ShippingErrorPlugin": "sample string 8",
      "CutoffHourToShipToday": 9,
      "ProcessingDelayHours": 10,
      "ClosedDates": "sample string 11",
      "WorkingDays": "sample string 12",
      "NodeShip": true,
      "OmniPickup": true,
      "OmniShip": true,
      "Address1": "sample string 16",
      "Address2": "sample string 17",
      "City": "sample string 18",
      "Province": "sample string 19",
      "Email": "sample string 20",
      "Phone": "sample string 21",
      "ParentNodeID": 1,
      "GeoLatitude": 1.0,
      "GeoLongitude": 1.0,
      "Country": "sample string 22",
      "NodeType": 1,
      "NodeTypeString": "sample string 23",
      "Priority": 24,
      "OpenShipOrderCapacity": 1,
      "OpenPickupOrderCapacity": 25,
      "Status": 0,
      "StatusString": "sample string 26",
      "InventoryListName": "sample string 27",
      "Region": "sample string 28",
      "Custom1": "sample string 29",
      "Custom2": "sample string 30",
      "Custom3": "sample string 31",
      "Custom4": "sample string 32",
      "Custom5": "sample string 33",
      "OmniPickupCurbside": true,
      "SmsContactNumber": "sample string 35",
      "SiteSmsNumber": {
        "SiteSmsNumberID": 1,
        "SiteID": 2,
        "ProvisionedNumber": "sample string 3",
        "Deleted": true
      }
    },
    {
      "NodeID": 1,
      "Location": "sample string 2",
      "ZipCode": "sample string 3",
      "NodeCode": "sample string 4",
      "SiteCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "ShippingPlugin": "sample string 5",
      "ShippingHeaderPlugin": "sample string 6",
      "ShippingItemPlugin": "sample string 7",
      "ShippingErrorPlugin": "sample string 8",
      "CutoffHourToShipToday": 9,
      "ProcessingDelayHours": 10,
      "ClosedDates": "sample string 11",
      "WorkingDays": "sample string 12",
      "NodeShip": true,
      "OmniPickup": true,
      "OmniShip": true,
      "Address1": "sample string 16",
      "Address2": "sample string 17",
      "City": "sample string 18",
      "Province": "sample string 19",
      "Email": "sample string 20",
      "Phone": "sample string 21",
      "ParentNodeID": 1,
      "GeoLatitude": 1.0,
      "GeoLongitude": 1.0,
      "Country": "sample string 22",
      "NodeType": 1,
      "NodeTypeString": "sample string 23",
      "Priority": 24,
      "OpenShipOrderCapacity": 1,
      "OpenPickupOrderCapacity": 25,
      "Status": 0,
      "StatusString": "sample string 26",
      "InventoryListName": "sample string 27",
      "Region": "sample string 28",
      "Custom1": "sample string 29",
      "Custom2": "sample string 30",
      "Custom3": "sample string 31",
      "Custom4": "sample string 32",
      "Custom5": "sample string 33",
      "OmniPickupCurbside": true,
      "SmsContactNumber": "sample string 35",
      "SiteSmsNumber": {
        "SiteSmsNumberID": 1,
        "SiteID": 2,
        "ProvisionedNumber": "sample string 3",
        "Deleted": true
      }
    }
  ],
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<OmsNodeInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <Nodes>
    <NodeExportDetails>
      <Address1>sample string 16</Address1>
      <Address2>sample string 17</Address2>
      <City>sample string 18</City>
      <ClosedDates>sample string 11</ClosedDates>
      <Country>sample string 22</Country>
      <Custom1>sample string 29</Custom1>
      <Custom2>sample string 30</Custom2>
      <Custom3>sample string 31</Custom3>
      <Custom4>sample string 32</Custom4>
      <Custom5>sample string 33</Custom5>
      <CutoffHourToShipToday>9</CutoffHourToShipToday>
      <Email>sample string 20</Email>
      <GeoLatitude>1</GeoLatitude>
      <GeoLongitude>1</GeoLongitude>
      <InventoryListName>sample string 27</InventoryListName>
      <Location>sample string 2</Location>
      <NodeCode>sample string 4</NodeCode>
      <NodeID>1</NodeID>
      <NodeShip>true</NodeShip>
      <NodeType>DistributionCenter</NodeType>
      <NodeTypeString>sample string 23</NodeTypeString>
      <OmniPickup>true</OmniPickup>
      <OmniPickupCurbside>true</OmniPickupCurbside>
      <OmniShip>true</OmniShip>
      <OpenPickupOrderCapacity>25</OpenPickupOrderCapacity>
      <OpenShipOrderCapacity>1</OpenShipOrderCapacity>
      <ParentNodeID>1</ParentNodeID>
      <Phone>sample string 21</Phone>
      <Priority>24</Priority>
      <ProcessingDelayHours>10</ProcessingDelayHours>
      <Province>sample string 19</Province>
      <Region>sample string 28</Region>
      <ShippingErrorPlugin>sample string 8</ShippingErrorPlugin>
      <ShippingHeaderPlugin>sample string 6</ShippingHeaderPlugin>
      <ShippingItemPlugin>sample string 7</ShippingItemPlugin>
      <ShippingPlugin>sample string 5</ShippingPlugin>
      <SiteCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SiteCodes>
      <SiteSmsNumber>
        <Deleted>true</Deleted>
        <ProvisionedNumber>sample string 3</ProvisionedNumber>
        <SiteID>2</SiteID>
        <SiteSmsNumberID>1</SiteSmsNumberID>
      </SiteSmsNumber>
      <SmsContactNumber>sample string 35</SmsContactNumber>
      <Status>Open</Status>
      <StatusString>sample string 26</StatusString>
      <WorkingDays>sample string 12</WorkingDays>
      <ZipCode>sample string 3</ZipCode>
    </NodeExportDetails>
    <NodeExportDetails>
      <Address1>sample string 16</Address1>
      <Address2>sample string 17</Address2>
      <City>sample string 18</City>
      <ClosedDates>sample string 11</ClosedDates>
      <Country>sample string 22</Country>
      <Custom1>sample string 29</Custom1>
      <Custom2>sample string 30</Custom2>
      <Custom3>sample string 31</Custom3>
      <Custom4>sample string 32</Custom4>
      <Custom5>sample string 33</Custom5>
      <CutoffHourToShipToday>9</CutoffHourToShipToday>
      <Email>sample string 20</Email>
      <GeoLatitude>1</GeoLatitude>
      <GeoLongitude>1</GeoLongitude>
      <InventoryListName>sample string 27</InventoryListName>
      <Location>sample string 2</Location>
      <NodeCode>sample string 4</NodeCode>
      <NodeID>1</NodeID>
      <NodeShip>true</NodeShip>
      <NodeType>DistributionCenter</NodeType>
      <NodeTypeString>sample string 23</NodeTypeString>
      <OmniPickup>true</OmniPickup>
      <OmniPickupCurbside>true</OmniPickupCurbside>
      <OmniShip>true</OmniShip>
      <OpenPickupOrderCapacity>25</OpenPickupOrderCapacity>
      <OpenShipOrderCapacity>1</OpenShipOrderCapacity>
      <ParentNodeID>1</ParentNodeID>
      <Phone>sample string 21</Phone>
      <Priority>24</Priority>
      <ProcessingDelayHours>10</ProcessingDelayHours>
      <Province>sample string 19</Province>
      <Region>sample string 28</Region>
      <ShippingErrorPlugin>sample string 8</ShippingErrorPlugin>
      <ShippingHeaderPlugin>sample string 6</ShippingHeaderPlugin>
      <ShippingItemPlugin>sample string 7</ShippingItemPlugin>
      <ShippingPlugin>sample string 5</ShippingPlugin>
      <SiteCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SiteCodes>
      <SiteSmsNumber>
        <Deleted>true</Deleted>
        <ProvisionedNumber>sample string 3</ProvisionedNumber>
        <SiteID>2</SiteID>
        <SiteSmsNumberID>1</SiteSmsNumberID>
      </SiteSmsNumber>
      <SmsContactNumber>sample string 35</SmsContactNumber>
      <Status>Open</Status>
      <StatusString>sample string 26</StatusString>
      <WorkingDays>sample string 12</WorkingDays>
      <ZipCode>sample string 3</ZipCode>
    </NodeExportDetails>
  </Nodes>
  <ResponseCode>Success</ResponseCode>
</OmsNodeInformationResponse>