POST api/Shipment/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Recipient	UserModel	None.
Price	decimal number	None.
Title	string	Required
MerchantOrderId	string	Required
IsCashOnDelivery	boolean	Required
ShippingPaymentType	PaymentType	Required

Request Formats

application/json, text/json

Sample:

{
  "Recipient": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "PhoneNumber": "sample string 3",
    "Address": "sample string 4",
    "TargetLocationId": 5
  },
  "Price": 1.0,
  "Title": "sample string 1",
  "MerchantOrderId": "sample string 2",
  "IsCashOnDelivery": true,
  "ShippingPaymentType": 1
}

application/xml, text/xml

Sample:

<CreateShipmentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Boomex.WebService.Models.Booking">
  <IsCashOnDelivery>true</IsCashOnDelivery>
  <MerchantOrderId>sample string 2</MerchantOrderId>
  <Price>1</Price>
  <Recipient>
    <Address>sample string 4</Address>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <PhoneNumber>sample string 3</PhoneNumber>
    <TargetLocationId>5</TargetLocationId>
  </Recipient>
  <ShippingPaymentType>ConsignerPayment</ShippingPaymentType>
  <Title>sample string 1</Title>
</CreateShipmentRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.