POST api/Centers/GetShipmentsForFolder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
WarehouseId	integer	None.
FolderId	integer	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:

{
  "WarehouseId": 1,
  "FolderId": 2,
  "SiteCode": "sample string 3",
  "VerificationKey": "sample string 4",
  "TimestampUTC": "sample string 5",
  "ResponseCallbackUri": "sample string 6",
  "APIUsername": "sample string 7",
  "IDToken": "sample string 8",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T21:19:34.445921+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T21:19:34.445921+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T21:19:34.445921+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T21:19:34.445921+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T21:19:34.445921+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T21:19:34.445921+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": 9,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<GetOmniFolderDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 7</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 8</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 6</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 3</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 5</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:19:34.445921+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:19:34.445921+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T21:19:34.445921+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T21:19:34.445921+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T21:19:34.445921+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:19:34.445921+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">9</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 4</VerificationKey>
  <FolderId>2</FolderId>
  <WarehouseId>1</WarehouseId>
</GetOmniFolderDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetOmsFolderDetailResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
Folder	IFolder	None.
OrderCount	integer	None.
OrdersGrossTotal	string	None.
OrderItemPricePlusOrMinusAdjustments	string	None.
OrderItemStatusNames	Collection of string	None.
Sites	Collection of IValueTextModel	None.
FolderDetails	Collection of OmsFolderDetailsModel	None.
CorrelationId	string	None.
ErrorMessage	string	None.
SqlTimeout	boolean	None.
InvalidOrderFound	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "Folder": null,
  "OrderCount": 2,
  "OrdersGrossTotal": "sample string 3",
  "OrderItemPricePlusOrMinusAdjustments": "sample string 4",
  "OrderItemStatusNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Sites": null,
  "FolderDetails": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3",
      "OrderShipmentID": 4,
      "WarehouseCountNumber": 5,
      "Location": "sample string 6",
      "OrderNumber": "sample string 7",
      "OrderDateUTC": "2025-12-20T21:19:34.445921+00:00",
      "TimeZone": "sample string 9",
      "ShippingMethodDescription": "sample string 10",
      "FolderID": 11,
      "WarehouseID": 12,
      "SiteID": 13,
      "LastOrderNote": "sample string 14",
      "PickupWarehouseID": 15,
      "AdjustedMerchandiseGrossTotal": 16.0,
      "EstimatedDeliveryDateUTC": "2025-12-20T21:19:34.445921+00:00",
      "ItemTotal": 18,
      "Items": [
        {
          "DeckSku": "sample string 1",
          "UPC": "sample string 2",
          "StyleNumber": "sample string 3",
          "Attribute": "sample string 4",
          "ProductSize": "sample string 5",
          "ImageURL": "sample string 6",
          "Count": 7,
          "OrderItemTypeId": 8,
          "OrderItemStatusChangeDateUTC": "2025-12-20T21:19:34.445921+00:00",
          "Description": "sample string 10"
        },
        {
          "DeckSku": "sample string 1",
          "UPC": "sample string 2",
          "StyleNumber": "sample string 3",
          "Attribute": "sample string 4",
          "ProductSize": "sample string 5",
          "ImageURL": "sample string 6",
          "Count": 7,
          "OrderItemTypeId": 8,
          "OrderItemStatusChangeDateUTC": "2025-12-20T21:19:34.445921+00:00",
          "Description": "sample string 10"
        }
      ],
      "RowColor": "sample string 19",
      "ShipToNodeID": 20,
      "OrderValueDictionary": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "Email": "sample string 3",
      "OrderShipmentID": 4,
      "WarehouseCountNumber": 5,
      "Location": "sample string 6",
      "OrderNumber": "sample string 7",
      "OrderDateUTC": "2025-12-20T21:19:34.445921+00:00",
      "TimeZone": "sample string 9",
      "ShippingMethodDescription": "sample string 10",
      "FolderID": 11,
      "WarehouseID": 12,
      "SiteID": 13,
      "LastOrderNote": "sample string 14",
      "PickupWarehouseID": 15,
      "AdjustedMerchandiseGrossTotal": 16.0,
      "EstimatedDeliveryDateUTC": "2025-12-20T21:19:34.445921+00:00",
      "ItemTotal": 18,
      "Items": [
        {
          "DeckSku": "sample string 1",
          "UPC": "sample string 2",
          "StyleNumber": "sample string 3",
          "Attribute": "sample string 4",
          "ProductSize": "sample string 5",
          "ImageURL": "sample string 6",
          "Count": 7,
          "OrderItemTypeId": 8,
          "OrderItemStatusChangeDateUTC": "2025-12-20T21:19:34.445921+00:00",
          "Description": "sample string 10"
        },
        {
          "DeckSku": "sample string 1",
          "UPC": "sample string 2",
          "StyleNumber": "sample string 3",
          "Attribute": "sample string 4",
          "ProductSize": "sample string 5",
          "ImageURL": "sample string 6",
          "Count": 7,
          "OrderItemTypeId": 8,
          "OrderItemStatusChangeDateUTC": "2025-12-20T21:19:34.445921+00:00",
          "Description": "sample string 10"
        }
      ],
      "RowColor": "sample string 19",
      "ShipToNodeID": 20,
      "OrderValueDictionary": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "CorrelationId": "sample string 5",
  "ErrorMessage": "sample string 6",
  "SqlTimeout": true,
  "InvalidOrderFound": true
}

application/xml, text/xml

Sample:

<GetOmsFolderDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <CorrelationId>sample string 5</CorrelationId>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Folder i:nil="true" />
  <FolderDetails>
    <OmsFolderDetailsModel>
      <AdjustedMerchandiseGrossTotal>16</AdjustedMerchandiseGrossTotal>
      <Email>sample string 3</Email>
      <EstimatedDeliveryDateUTC>2025-12-20T21:19:34.445921+00:00</EstimatedDeliveryDateUTC>
      <FirstName>sample string 1</FirstName>
      <FolderID>11</FolderID>
      <ItemTotal>18</ItemTotal>
      <Items>
        <OmsFolderItemLevelDetail>
          <Attribute>sample string 4</Attribute>
          <Count>7</Count>
          <DeckSku>sample string 1</DeckSku>
          <Description>sample string 10</Description>
          <ImageURL>sample string 6</ImageURL>
          <OrderItemStatusChangeDateUTC>2025-12-20T21:19:34.445921+00:00</OrderItemStatusChangeDateUTC>
          <OrderItemTypeId>8</OrderItemTypeId>
          <ProductSize>sample string 5</ProductSize>
          <StyleNumber>sample string 3</StyleNumber>
          <UPC>sample string 2</UPC>
        </OmsFolderItemLevelDetail>
        <OmsFolderItemLevelDetail>
          <Attribute>sample string 4</Attribute>
          <Count>7</Count>
          <DeckSku>sample string 1</DeckSku>
          <Description>sample string 10</Description>
          <ImageURL>sample string 6</ImageURL>
          <OrderItemStatusChangeDateUTC>2025-12-20T21:19:34.445921+00:00</OrderItemStatusChangeDateUTC>
          <OrderItemTypeId>8</OrderItemTypeId>
          <ProductSize>sample string 5</ProductSize>
          <StyleNumber>sample string 3</StyleNumber>
          <UPC>sample string 2</UPC>
        </OmsFolderItemLevelDetail>
      </Items>
      <LastName>sample string 2</LastName>
      <LastOrderNote>sample string 14</LastOrderNote>
      <Location>sample string 6</Location>
      <OrderDateUTC>2025-12-20T21:19:34.445921+00:00</OrderDateUTC>
      <OrderNumber>sample string 7</OrderNumber>
      <OrderShipmentID>4</OrderShipmentID>
      <OrderValueDictionary xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </OrderValueDictionary>
      <PickupWarehouseID>15</PickupWarehouseID>
      <RowColor>sample string 19</RowColor>
      <ShipToNodeID>20</ShipToNodeID>
      <ShippingMethodDescription>sample string 10</ShippingMethodDescription>
      <SiteID>13</SiteID>
      <TimeZone>sample string 9</TimeZone>
      <WarehouseCountNumber>5</WarehouseCountNumber>
      <WarehouseID>12</WarehouseID>
    </OmsFolderDetailsModel>
    <OmsFolderDetailsModel>
      <AdjustedMerchandiseGrossTotal>16</AdjustedMerchandiseGrossTotal>
      <Email>sample string 3</Email>
      <EstimatedDeliveryDateUTC>2025-12-20T21:19:34.445921+00:00</EstimatedDeliveryDateUTC>
      <FirstName>sample string 1</FirstName>
      <FolderID>11</FolderID>
      <ItemTotal>18</ItemTotal>
      <Items>
        <OmsFolderItemLevelDetail>
          <Attribute>sample string 4</Attribute>
          <Count>7</Count>
          <DeckSku>sample string 1</DeckSku>
          <Description>sample string 10</Description>
          <ImageURL>sample string 6</ImageURL>
          <OrderItemStatusChangeDateUTC>2025-12-20T21:19:34.445921+00:00</OrderItemStatusChangeDateUTC>
          <OrderItemTypeId>8</OrderItemTypeId>
          <ProductSize>sample string 5</ProductSize>
          <StyleNumber>sample string 3</StyleNumber>
          <UPC>sample string 2</UPC>
        </OmsFolderItemLevelDetail>
        <OmsFolderItemLevelDetail>
          <Attribute>sample string 4</Attribute>
          <Count>7</Count>
          <DeckSku>sample string 1</DeckSku>
          <Description>sample string 10</Description>
          <ImageURL>sample string 6</ImageURL>
          <OrderItemStatusChangeDateUTC>2025-12-20T21:19:34.445921+00:00</OrderItemStatusChangeDateUTC>
          <OrderItemTypeId>8</OrderItemTypeId>
          <ProductSize>sample string 5</ProductSize>
          <StyleNumber>sample string 3</StyleNumber>
          <UPC>sample string 2</UPC>
        </OmsFolderItemLevelDetail>
      </Items>
      <LastName>sample string 2</LastName>
      <LastOrderNote>sample string 14</LastOrderNote>
      <Location>sample string 6</Location>
      <OrderDateUTC>2025-12-20T21:19:34.445921+00:00</OrderDateUTC>
      <OrderNumber>sample string 7</OrderNumber>
      <OrderShipmentID>4</OrderShipmentID>
      <OrderValueDictionary xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </OrderValueDictionary>
      <PickupWarehouseID>15</PickupWarehouseID>
      <RowColor>sample string 19</RowColor>
      <ShipToNodeID>20</ShipToNodeID>
      <ShippingMethodDescription>sample string 10</ShippingMethodDescription>
      <SiteID>13</SiteID>
      <TimeZone>sample string 9</TimeZone>
      <WarehouseCountNumber>5</WarehouseCountNumber>
      <WarehouseID>12</WarehouseID>
    </OmsFolderDetailsModel>
  </FolderDetails>
  <InvalidOrderFound>true</InvalidOrderFound>
  <Message>sample string 1</Message>
  <OrderCount>2</OrderCount>
  <OrderItemPricePlusOrMinusAdjustments>sample string 4</OrderItemPricePlusOrMinusAdjustments>
  <OrderItemStatusNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OrderItemStatusNames>
  <OrdersGrossTotal>sample string 3</OrdersGrossTotal>
  <ResponseCode>Success</ResponseCode>
  <Sites xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <SqlTimeout>true</SqlTimeout>
</GetOmsFolderDetailResponse>