POST api/Centers/GetShippingLabelWeightCheck

Request Information

URI Parameters

None.

Body Parameters

ShipmentWeightModel

NameDescriptionTypeAdditional Information
OrderID

integer

None.

ShipmentNumber

integer

None.

PackagingID

integer

None.

Unit

string

None.

ShippingMethodID

integer

None.

ShippingLabelPluginID

integer

None.

SelectedItems

Collection of integer

None.

OverrideItemWeights

boolean

None.

ShipmentWeight

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderID": 1,
  "ShipmentNumber": 2,
  "PackagingID": 3,
  "Unit": "sample string 4",
  "ShippingMethodID": 5,
  "ShippingLabelPluginID": 6,
  "SelectedItems": [
    1,
    2
  ],
  "OverrideItemWeights": true,
  "ShipmentWeight": 8.0
}

application/xml, text/xml

Sample:
<ShipmentWeightModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <OrderID>1</OrderID>
  <OverrideItemWeights>true</OverrideItemWeights>
  <PackagingID>3</PackagingID>
  <SelectedItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SelectedItems>
  <ShipmentNumber>2</ShipmentNumber>
  <ShipmentWeight>8</ShipmentWeight>
  <ShippingLabelPluginID>6</ShippingLabelPluginID>
  <ShippingMethodID>5</ShippingMethodID>
  <Unit>sample string 4</Unit>
</ShipmentWeightModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShippingLabelWeightCheckResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

ShippingLabelWeightCheck

IShippingLabelWeightCheck

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<ShippingLabelWeightCheckResponse 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 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
  <ShippingLabelWeightCheck i:nil="true" />
</ShippingLabelWeightCheckResponse>