POST api/OmsInboundItemStatusUpdate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderNumber	string	None.
StatusCode	string	None.
StatusDescription	string	None.
InvoiceDate	date	None.
InvoiceNumber	string	None.
InvoiceAmount	decimal number	None.
InvoiceBillToAccount	string	None.
PODate	date	None.
PONumber	string	None.
InternalSalesNumber	string	None.
InternalStatusCode	string	None.
DontValidateStatusTransition	boolean	None.
GtinsToUpdate	Collection of GtinDetails	None.
TotalItemTransitionCount	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:

{
  "OrderNumber": "sample string 1",
  "StatusCode": "sample string 2",
  "StatusDescription": "sample string 3",
  "InvoiceDate": "2025-12-20T20:46:36.583755+00:00",
  "InvoiceNumber": "sample string 5",
  "InvoiceAmount": 6.0,
  "InvoiceBillToAccount": "sample string 7",
  "PODate": "2025-12-20T20:46:36.583755+00:00",
  "PONumber": "sample string 9",
  "InternalSalesNumber": "sample string 10",
  "InternalStatusCode": "sample string 11",
  "DontValidateStatusTransition": true,
  "GtinsToUpdate": [
    {
      "Gtin": "sample string 1",
      "ExternalId": "sample string 2",
      "Id": 3,
      "Sku": "sample string 4",
      "Quantity": 1,
      "EstimatedShippingDate": "2025-12-20T20:46:36.583755+00:00",
      "OverwriteEstimatedShipDate": true,
      "InternalItemStatusCode": "sample string 6",
      "Custom1": "sample string 7",
      "Custom2": "sample string 8",
      "Custom3": "sample string 9",
      "Custom4": "sample string 10",
      "Custom5": "sample string 11",
      "DeliveredDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "CancelReasonCode": "sample string 12",
      "EstimatedDeliveryDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "EndEstimatedDeliveryDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "ShippedDateUTC": "2025-12-20T20:46:36.583755+00:00"
    },
    {
      "Gtin": "sample string 1",
      "ExternalId": "sample string 2",
      "Id": 3,
      "Sku": "sample string 4",
      "Quantity": 1,
      "EstimatedShippingDate": "2025-12-20T20:46:36.583755+00:00",
      "OverwriteEstimatedShipDate": true,
      "InternalItemStatusCode": "sample string 6",
      "Custom1": "sample string 7",
      "Custom2": "sample string 8",
      "Custom3": "sample string 9",
      "Custom4": "sample string 10",
      "Custom5": "sample string 11",
      "DeliveredDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "CancelReasonCode": "sample string 12",
      "EstimatedDeliveryDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "EndEstimatedDeliveryDateUTC": "2025-12-20T20:46:36.583755+00:00",
      "ShippedDateUTC": "2025-12-20T20:46:36.583755+00:00"
    }
  ],
  "TotalItemTransitionCount": 13,
  "SiteCode": "sample string 14",
  "VerificationKey": "sample string 15",
  "TimestampUTC": "sample string 16",
  "ResponseCallbackUri": "sample string 17",
  "APIUsername": "sample string 18",
  "IDToken": "sample string 19",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-20T20:46:36.583755+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-20T20:46:36.583755+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-20T20:46:36.583755+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-20T20:46:36.583755+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-20T20:46:36.583755+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-20T20:46:36.583755+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": 20,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<ItemStatusUpdate 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 18</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 19</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 17</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 14</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 16</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-20T20:46:36.583755+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-20T20:46:36.583755+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-20T20:46:36.583755+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-20T20:46:36.583755+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-20T20:46:36.583755+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-20T20:46:36.583755+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">20</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 15</VerificationKey>
  <DontValidateStatusTransition>true</DontValidateStatusTransition>
  <GtinsToUpdate xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
    <d2p1:GtinDetails>
      <d2p1:CancelReasonCode>sample string 12</d2p1:CancelReasonCode>
      <d2p1:Custom1>sample string 7</d2p1:Custom1>
      <d2p1:Custom2>sample string 8</d2p1:Custom2>
      <d2p1:Custom3>sample string 9</d2p1:Custom3>
      <d2p1:Custom4>sample string 10</d2p1:Custom4>
      <d2p1:Custom5>sample string 11</d2p1:Custom5>
      <d2p1:DeliveredDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:DeliveredDateUTC>
      <d2p1:EndEstimatedDeliveryDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:EndEstimatedDeliveryDateUTC>
      <d2p1:EstimatedDeliveryDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:EstimatedDeliveryDateUTC>
      <d2p1:EstimatedShippingDate>2025-12-20T20:46:36.583755+00:00</d2p1:EstimatedShippingDate>
      <d2p1:ExternalId>sample string 2</d2p1:ExternalId>
      <d2p1:Gtin>sample string 1</d2p1:Gtin>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:InternalItemStatusCode>sample string 6</d2p1:InternalItemStatusCode>
      <d2p1:OverwriteEstimatedShipDate>true</d2p1:OverwriteEstimatedShipDate>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:ShippedDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:ShippedDateUTC>
      <d2p1:Sku>sample string 4</d2p1:Sku>
    </d2p1:GtinDetails>
    <d2p1:GtinDetails>
      <d2p1:CancelReasonCode>sample string 12</d2p1:CancelReasonCode>
      <d2p1:Custom1>sample string 7</d2p1:Custom1>
      <d2p1:Custom2>sample string 8</d2p1:Custom2>
      <d2p1:Custom3>sample string 9</d2p1:Custom3>
      <d2p1:Custom4>sample string 10</d2p1:Custom4>
      <d2p1:Custom5>sample string 11</d2p1:Custom5>
      <d2p1:DeliveredDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:DeliveredDateUTC>
      <d2p1:EndEstimatedDeliveryDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:EndEstimatedDeliveryDateUTC>
      <d2p1:EstimatedDeliveryDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:EstimatedDeliveryDateUTC>
      <d2p1:EstimatedShippingDate>2025-12-20T20:46:36.583755+00:00</d2p1:EstimatedShippingDate>
      <d2p1:ExternalId>sample string 2</d2p1:ExternalId>
      <d2p1:Gtin>sample string 1</d2p1:Gtin>
      <d2p1:Id>3</d2p1:Id>
      <d2p1:InternalItemStatusCode>sample string 6</d2p1:InternalItemStatusCode>
      <d2p1:OverwriteEstimatedShipDate>true</d2p1:OverwriteEstimatedShipDate>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:ShippedDateUTC>2025-12-20T20:46:36.583755+00:00</d2p1:ShippedDateUTC>
      <d2p1:Sku>sample string 4</d2p1:Sku>
    </d2p1:GtinDetails>
  </GtinsToUpdate>
  <InternalSalesNumber>sample string 10</InternalSalesNumber>
  <InternalStatusCode>sample string 11</InternalStatusCode>
  <InvoiceAmount>6</InvoiceAmount>
  <InvoiceBillToAccount>sample string 7</InvoiceBillToAccount>
  <InvoiceDate>2025-12-20T20:46:36.583755+00:00</InvoiceDate>
  <InvoiceNumber>sample string 5</InvoiceNumber>
  <OrderNumber>sample string 1</OrderNumber>
  <PODate>2025-12-20T20:46:36.583755+00:00</PODate>
  <PONumber>sample string 9</PONumber>
  <StatusCode>sample string 2</StatusCode>
  <StatusDescription>sample string 3</StatusDescription>
  <TotalItemTransitionCount>13</TotalItemTransitionCount>
</ItemStatusUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>