POST api/AddInternalPickupScan_V1

Add Internal Pickup Scan

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.OPS.InternalPickupScan

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
OrderNo	(Mandatory) The order # or ship request #	integer	None.
InternalPickupStatus	(Mandatory) The internal pikcup status	WS_Repository.Models.Requests.OPS.InternalPickupStatus	None.
ScanDateTime	(Optional) Date and time when the scan was made	date	None.
ScanTime	(Optional) Time when the scan was made	string	None.
ScanUserName	(Optional) The user name that processed the scan	string	None.
Description	(Optional) Description for the event	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "OrderNo": 2,
  "InternalPickupStatus": 0,
  "ScanDateTime": "2024-04-19T07:07:35.6316465-04:00",
  "ScanTime": "sample string 4",
  "ScanUserName": "sample string 5",
  "Description": "sample string 6"
}

application/xml, text/xml

Sample:

<InternalPickupScan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.OPS">
  <Description>sample string 6</Description>
  <InternalPickupStatus>Created</InternalPickupStatus>
  <OrderNo>2</OrderNo>
  <ScanDateTime>2024-04-19T07:07:35.6316465-04:00</ScanDateTime>
  <ScanTime>sample string 4</ScanTime>
  <ScanUserName>sample string 5</ScanUserName>
  <WS_Key>sample string 1</WS_Key>
</InternalPickupScan>

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.OPS.InternalPickupScan'.

Response Information

Resource Description

WS_Repository.Models.Responses.OPS.InternalPickupScanResponse

Name	Description	Type	Additional information
OrderNo	Order Number ( )	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderNo": 1
}

application/xml, text/xml

Sample:

<InternalPickupScanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.OPS">
  <OrderNo>1</OrderNo>
</InternalPickupScanResponse>