POST api/AddInboundShipment_V1

Add a shipment in 2ship inbound history

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Inbound.AddInboundRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
Sender	(Optional) The sender of your shipment	WS_Repository.Models.Requests.Inbound.Contact	None.
ReceivingLocationId	(Mandatory) Location to use for Recipient info	integer	None.
CarrierId	(Mandatory) The Carrier Id of your shipment (if the shipment was made with a carrier that you don't have in 2ship then use My Carrier with id 999)	integer	None.
ServiceCode	(Mandatory) The Service of your shipment	string	None.
TrackingNumber	(Mandatory) The Service of your shipment	string	None.
CarrierName	(Optional) The carrier name (default: Other Carrier)	string	None.
ServiceName	(Optional) The service name (default: Other Service)	string	None.
ShipDate	(Optional) The date of the shipment	date	None.
CarrierType	(Optional) The Carrier Type (default: Small Package Type)	WS_Repository.Models.Requests.Inbound.CarrierType	None.
MarkAsReceived	(Optional) Mark the shipment as received	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "Sender": {
    "PersonName": "sample string 1",
    "CompanyName": "sample string 2",
    "Country": "sample string 3",
    "State": "sample string 4",
    "City": "sample string 5",
    "PostalCode": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "Telephone": "sample string 9",
    "Email": "sample string 10"
  },
  "ReceivingLocationId": 2,
  "CarrierId": 3,
  "ServiceCode": "sample string 4",
  "TrackingNumber": "sample string 5",
  "CarrierName": "sample string 6",
  "ServiceName": "sample string 7",
  "ShipDate": "2024-04-25T16:44:46.075572-04:00",
  "CarrierType": 0,
  "MarkAsReceived": true
}

application/xml, text/xml

Sample:

<AddInboundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Inbound">
  <CarrierId>3</CarrierId>
  <CarrierName>sample string 6</CarrierName>
  <CarrierType>SP</CarrierType>
  <MarkAsReceived>true</MarkAsReceived>
  <ReceivingLocationId>2</ReceivingLocationId>
  <Sender>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <City>sample string 5</City>
    <CompanyName>sample string 2</CompanyName>
    <Country>sample string 3</Country>
    <Email>sample string 10</Email>
    <PersonName>sample string 1</PersonName>
    <PostalCode>sample string 6</PostalCode>
    <State>sample string 4</State>
    <Telephone>sample string 9</Telephone>
  </Sender>
  <ServiceCode>sample string 4</ServiceCode>
  <ServiceName>sample string 7</ServiceName>
  <ShipDate>2024-04-25T16:44:46.075572-04:00</ShipDate>
  <TrackingNumber>sample string 5</TrackingNumber>
  <WS_Key>sample string 1</WS_Key>
</AddInboundRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.Inbound.AddInboundRequest'.

Response Information

Resource Description

None.