PUT api/OmsShipmentMethodRule/{identifier}

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
identifier

string

Required

Body Parameters

UpdateShipmentMethodRuleRequest

NameDescriptionTypeAdditional Information
Identifier

string

None.

Name

string

None.

IncomingShippingMethodMappingId

integer

None.

TargetShippingMethodMappingId

integer

None.

MinShipWeight

decimal number

None.

MaxShipWeight

decimal number

None.

UnitOfMeasure

WeightUOM

None.

IsActive

boolean

None.

Note

string

None.

UserName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Identifier": "sample string 1",
  "Name": "sample string 2",
  "IncomingShippingMethodMappingId": 3,
  "TargetShippingMethodMappingId": 4,
  "MinShipWeight": 5.0,
  "MaxShipWeight": 6.0,
  "UnitOfMeasure": 0,
  "IsActive": true,
  "Note": "sample string 7",
  "UserName": "sample string 8"
}

application/xml, text/xml

Sample:
<UpdateShipmentMethodRuleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <Identifier>sample string 1</Identifier>
  <IncomingShippingMethodMappingId>3</IncomingShippingMethodMappingId>
  <IsActive>true</IsActive>
  <MaxShipWeight>6</MaxShipWeight>
  <MinShipWeight>5</MinShipWeight>
  <Name>sample string 2</Name>
  <Note>sample string 7</Note>
  <ShipmentMethodRuleUnitOfMeasureId>undefined</ShipmentMethodRuleUnitOfMeasureId>
  <TargetShippingMethodMappingId>4</TargetShippingMethodMappingId>
  <UserName>sample string 8</UserName>
</UpdateShipmentMethodRuleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentMethodRuleResponse

NameDescriptionTypeAdditional Information
Rules

Collection of IShipmentMethodRule

None.

ValidationErrors

Dictionary of string [key] and string [value]

None.

DeletedRecords

integer

None.

ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ValidationErrors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "DeletedRecords": 1,
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:
<ShipmentMethodRuleResponse 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>
  <DeletedRecords>1</DeletedRecords>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
  <Rules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ValidationErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ValidationErrors>
</ShipmentMethodRuleResponse>