POST api/Centers/CreateShipEngineShippingLabel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OverrideShippingMethodId	integer	None.
OverrideWeight	integer	None.
OverrideLength	integer	None.
OverrideWidth	integer	None.
OverrideHeight	integer	None.
Unit	string	None.
ShippingLabelItemIDs	Collection of integer	None.
ShippingLabelWarehouseCount	integer	None.
ShippingLabelOrderNumber	string	None.
ShippingLabelFormat	string	None.
ShippingLabelPluginId	integer	None.
UserName	string	None.
LocaleId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OverrideShippingMethodId": 1,
  "OverrideWeight": 2,
  "OverrideLength": 3,
  "OverrideWidth": 4,
  "OverrideHeight": 5,
  "Unit": "sample string 6",
  "ShippingLabelItemIDs": [
    1,
    2
  ],
  "ShippingLabelWarehouseCount": 1,
  "ShippingLabelOrderNumber": "sample string 7",
  "ShippingLabelFormat": "sample string 8",
  "ShippingLabelPluginId": 9,
  "UserName": "sample string 10",
  "LocaleId": 11
}

application/xml, text/xml

Sample:

<CreateShippingLabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API.Centers">
  <LocaleId>11</LocaleId>
  <OverrideHeight>5</OverrideHeight>
  <OverrideLength>3</OverrideLength>
  <OverrideShippingMethodId>1</OverrideShippingMethodId>
  <OverrideWeight>2</OverrideWeight>
  <OverrideWidth>4</OverrideWidth>
  <ShippingLabelFormat>sample string 8</ShippingLabelFormat>
  <ShippingLabelItemIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ShippingLabelItemIDs>
  <ShippingLabelOrderNumber>sample string 7</ShippingLabelOrderNumber>
  <ShippingLabelPluginId>9</ShippingLabelPluginId>
  <ShippingLabelWarehouseCount>1</ShippingLabelWarehouseCount>
  <Unit>sample string 6</Unit>
  <UserName>sample string 10</UserName>
</CreateShippingLabelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateShippingLabelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
IsSuccess	boolean	None.
ShippingLabelUrl	string	None.
ErrorMessage	string	None.
SuccessMessage	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "IsSuccess": true,
  "ShippingLabelUrl": "sample string 3",
  "ErrorMessage": "sample string 4",
  "SuccessMessage": "sample string 5",
  "CorrelationId": "sample string 6"
}

application/xml, text/xml

Sample:

<CreateShippingLabelResponse 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 6</CorrelationId>
  <ErrorMessage>sample string 4</ErrorMessage>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
  <ShippingLabelUrl>sample string 3</ShippingLabelUrl>
  <SuccessMessage>sample string 5</SuccessMessage>
</CreateShippingLabelResponse>