GET api/OmsInboundOrderAppeasement/v2/financials?orderNumber={orderNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| orderNumber | string |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderAppeasementV2FinancialsResponse
| Name | Description | Type | Additional Information |
|---|---|---|---|
| Financials | OrderAppeasementV2FinancialData |
None. |
|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| CorrelationId | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Financials": {
"OrderNumber": "sample string 1",
"Taxation": "sample string 2",
"Currency": "sample string 3",
"CurrencyPrecision": 4,
"Totals": null,
"OrderAdjustments": null,
"OrderTaxes": null,
"OrderShipping": null,
"Returns": null,
"OrderPayments": null,
"ItemGroups": [
{
"SKU": "sample string 1",
"Quantity": 2,
"MaxAvailableCreditAmount": 3.0,
"Items": [
{
"MaxAvailableCreditAmount": 1.0,
"OrderItemID": 2,
"ExternalItemId": "sample string 3",
"GTIN": "sample string 4",
"SKU": "sample string 5",
"Description": "sample string 6",
"GrossPrice": 7.0,
"NetPrice": 8.0,
"AdjustedNetPrice": 9.0,
"AdjustedGrossPrice": 10.0,
"ItemType": "sample string 11",
"ItemStatus": "sample string 12",
"DiscountTotal": 13.0,
"OrderItemAdjustments": null,
"OrderItemTaxes": null
},
{
"MaxAvailableCreditAmount": 1.0,
"OrderItemID": 2,
"ExternalItemId": "sample string 3",
"GTIN": "sample string 4",
"SKU": "sample string 5",
"Description": "sample string 6",
"GrossPrice": 7.0,
"NetPrice": 8.0,
"AdjustedNetPrice": 9.0,
"AdjustedGrossPrice": 10.0,
"ItemType": "sample string 11",
"ItemStatus": "sample string 12",
"DiscountTotal": 13.0,
"OrderItemAdjustments": null,
"OrderItemTaxes": null
}
]
},
{
"SKU": "sample string 1",
"Quantity": 2,
"MaxAvailableCreditAmount": 3.0,
"Items": [
{
"MaxAvailableCreditAmount": 1.0,
"OrderItemID": 2,
"ExternalItemId": "sample string 3",
"GTIN": "sample string 4",
"SKU": "sample string 5",
"Description": "sample string 6",
"GrossPrice": 7.0,
"NetPrice": 8.0,
"AdjustedNetPrice": 9.0,
"AdjustedGrossPrice": 10.0,
"ItemType": "sample string 11",
"ItemStatus": "sample string 12",
"DiscountTotal": 13.0,
"OrderItemAdjustments": null,
"OrderItemTaxes": null
},
{
"MaxAvailableCreditAmount": 1.0,
"OrderItemID": 2,
"ExternalItemId": "sample string 3",
"GTIN": "sample string 4",
"SKU": "sample string 5",
"Description": "sample string 6",
"GrossPrice": 7.0,
"NetPrice": 8.0,
"AdjustedNetPrice": 9.0,
"AdjustedGrossPrice": 10.0,
"ItemType": "sample string 11",
"ItemStatus": "sample string 12",
"DiscountTotal": 13.0,
"OrderItemAdjustments": null,
"OrderItemTaxes": null
}
]
}
],
"MaxAvailableShippingCreditAmount": 5.0,
"MaxAvailableRestockingFeeCreditAmount": 6.0,
"MaxAvailableOrderTaxCreditAmount": 7.0,
"MaxAvailableOrderItemCreditAmount": 8.0,
"MaxAvailableWholeOrderChargeAmount": 9.0,
"MaxAvailableWholeOrderCreditAmount": 10.0,
"NonRefundableOrderTax": 11.0,
"AdjustmentClassifications": null
},
"ResponseCode": 0,
"Message": "sample string 1",
"CorrelationId": "sample string 2"
}
application/xml, text/xml
Sample:
<OrderAppeasementV2FinancialsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
<CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</CorrelationId>
<Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 1</Message>
<ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
<Financials xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
<d2p1:AdjustmentClassifications i:nil="true" />
<d2p1:Currency>sample string 3</d2p1:Currency>
<d2p1:ItemGroups>
<d2p1:OrderAppeasementItemGroup>
<d2p1:Items>
<d2p1:OrderAppeasementItem>
<d2p1:AdjustedGrossPrice>10</d2p1:AdjustedGrossPrice>
<d2p1:AdjustedNetPrice>9</d2p1:AdjustedNetPrice>
<d2p1:Description>sample string 6</d2p1:Description>
<d2p1:DiscountTotal>13</d2p1:DiscountTotal>
<d2p1:ExternalItemId>sample string 3</d2p1:ExternalItemId>
<d2p1:GTIN>sample string 4</d2p1:GTIN>
<d2p1:GrossPrice>7</d2p1:GrossPrice>
<d2p1:ItemStatus>sample string 12</d2p1:ItemStatus>
<d2p1:ItemType>sample string 11</d2p1:ItemType>
<d2p1:MaxAvailableCreditAmount>1</d2p1:MaxAvailableCreditAmount>
<d2p1:NetPrice>8</d2p1:NetPrice>
<d2p1:OrderItemAdjustments i:nil="true" />
<d2p1:OrderItemID>2</d2p1:OrderItemID>
<d2p1:OrderItemTaxes i:nil="true" />
<d2p1:SKU>sample string 5</d2p1:SKU>
</d2p1:OrderAppeasementItem>
<d2p1:OrderAppeasementItem>
<d2p1:AdjustedGrossPrice>10</d2p1:AdjustedGrossPrice>
<d2p1:AdjustedNetPrice>9</d2p1:AdjustedNetPrice>
<d2p1:Description>sample string 6</d2p1:Description>
<d2p1:DiscountTotal>13</d2p1:DiscountTotal>
<d2p1:ExternalItemId>sample string 3</d2p1:ExternalItemId>
<d2p1:GTIN>sample string 4</d2p1:GTIN>
<d2p1:GrossPrice>7</d2p1:GrossPrice>
<d2p1:ItemStatus>sample string 12</d2p1:ItemStatus>
<d2p1:ItemType>sample string 11</d2p1:ItemType>
<d2p1:MaxAvailableCreditAmount>1</d2p1:MaxAvailableCreditAmount>
<d2p1:NetPrice>8</d2p1:NetPrice>
<d2p1:OrderItemAdjustments i:nil="true" />
<d2p1:OrderItemID>2</d2p1:OrderItemID>
<d2p1:OrderItemTaxes i:nil="true" />
<d2p1:SKU>sample string 5</d2p1:SKU>
</d2p1:OrderAppeasementItem>
</d2p1:Items>
<d2p1:MaxAvailableCreditAmount>3</d2p1:MaxAvailableCreditAmount>
<d2p1:Quantity>2</d2p1:Quantity>
<d2p1:SKU>sample string 1</d2p1:SKU>
</d2p1:OrderAppeasementItemGroup>
<d2p1:OrderAppeasementItemGroup>
<d2p1:Items>
<d2p1:OrderAppeasementItem>
<d2p1:AdjustedGrossPrice>10</d2p1:AdjustedGrossPrice>
<d2p1:AdjustedNetPrice>9</d2p1:AdjustedNetPrice>
<d2p1:Description>sample string 6</d2p1:Description>
<d2p1:DiscountTotal>13</d2p1:DiscountTotal>
<d2p1:ExternalItemId>sample string 3</d2p1:ExternalItemId>
<d2p1:GTIN>sample string 4</d2p1:GTIN>
<d2p1:GrossPrice>7</d2p1:GrossPrice>
<d2p1:ItemStatus>sample string 12</d2p1:ItemStatus>
<d2p1:ItemType>sample string 11</d2p1:ItemType>
<d2p1:MaxAvailableCreditAmount>1</d2p1:MaxAvailableCreditAmount>
<d2p1:NetPrice>8</d2p1:NetPrice>
<d2p1:OrderItemAdjustments i:nil="true" />
<d2p1:OrderItemID>2</d2p1:OrderItemID>
<d2p1:OrderItemTaxes i:nil="true" />
<d2p1:SKU>sample string 5</d2p1:SKU>
</d2p1:OrderAppeasementItem>
<d2p1:OrderAppeasementItem>
<d2p1:AdjustedGrossPrice>10</d2p1:AdjustedGrossPrice>
<d2p1:AdjustedNetPrice>9</d2p1:AdjustedNetPrice>
<d2p1:Description>sample string 6</d2p1:Description>
<d2p1:DiscountTotal>13</d2p1:DiscountTotal>
<d2p1:ExternalItemId>sample string 3</d2p1:ExternalItemId>
<d2p1:GTIN>sample string 4</d2p1:GTIN>
<d2p1:GrossPrice>7</d2p1:GrossPrice>
<d2p1:ItemStatus>sample string 12</d2p1:ItemStatus>
<d2p1:ItemType>sample string 11</d2p1:ItemType>
<d2p1:MaxAvailableCreditAmount>1</d2p1:MaxAvailableCreditAmount>
<d2p1:NetPrice>8</d2p1:NetPrice>
<d2p1:OrderItemAdjustments i:nil="true" />
<d2p1:OrderItemID>2</d2p1:OrderItemID>
<d2p1:OrderItemTaxes i:nil="true" />
<d2p1:SKU>sample string 5</d2p1:SKU>
</d2p1:OrderAppeasementItem>
</d2p1:Items>
<d2p1:MaxAvailableCreditAmount>3</d2p1:MaxAvailableCreditAmount>
<d2p1:Quantity>2</d2p1:Quantity>
<d2p1:SKU>sample string 1</d2p1:SKU>
</d2p1:OrderAppeasementItemGroup>
</d2p1:ItemGroups>
<d2p1:MaxAvailableOrderItemCreditAmount>8</d2p1:MaxAvailableOrderItemCreditAmount>
<d2p1:MaxAvailableOrderTaxCreditAmount>7</d2p1:MaxAvailableOrderTaxCreditAmount>
<d2p1:MaxAvailableRestockingFeeCreditAmount>6</d2p1:MaxAvailableRestockingFeeCreditAmount>
<d2p1:MaxAvailableShippingCreditAmount>5</d2p1:MaxAvailableShippingCreditAmount>
<d2p1:MaxAvailableWholeOrderChargeAmount>9</d2p1:MaxAvailableWholeOrderChargeAmount>
<d2p1:MaxAvailableWholeOrderCreditAmount>10</d2p1:MaxAvailableWholeOrderCreditAmount>
<d2p1:NonRefundableOrderTax>11</d2p1:NonRefundableOrderTax>
<d2p1:OrderAdjustments i:nil="true" />
<d2p1:OrderNumber>sample string 1</d2p1:OrderNumber>
<d2p1:OrderPayments i:nil="true" />
<d2p1:OrderShipping i:nil="true" />
<d2p1:OrderTaxes i:nil="true" />
<d2p1:Returns i:nil="true" />
<d2p1:Taxation>sample string 2</d2p1:Taxation>
<d2p1:Totals i:nil="true" />
</Financials>
</OrderAppeasementV2FinancialsResponse>