POST api/CancelPickupRequest_V1
C pickup Request
Request Information
URI Parameters
None.
Body Parameters
Cancel Pickup Request request
WS_Repository.Models.Requests.Pickup.CancelPickupRequestName | Description | Type | Additional information |
---|---|---|---|
WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
CancelPickupRequestType |
(Mandatory) Cancel Pickup Type |
WS_Repository.Models.Requests.Pickup.CancelPickupRequestType |
None. |
PickupId |
(Mandatory if CancelPickupRequestType = ByPickupId) Internal 2Ship Pickup Id returned when you create the pickup |
integer |
None. |
CarrierId |
(Mandatory if CancelPickupRequestType = ByCarrierAndPickupNumber) Carrier Id |
integer |
None. |
PickupCarrierNumber |
(Mandatory if CancelPickupRequestType = ByCarrierAndPickupNumber) Pickup Carrier Number returned when you create the pickup |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "WS_Key": "sample string 1", "CancelPickupRequestType": 0, "PickupId": 2, "CarrierId": 3, "PickupCarrierNumber": "sample string 4" }
application/xml, text/xml
Sample:
<CancelPickupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Pickup"> <CancelPickupRequestType>ByPickupId</CancelPickupRequestType> <CarrierId>3</CarrierId> <PickupCarrierNumber>sample string 4</PickupCarrierNumber> <PickupId>2</PickupId> <WS_Key>sample string 1</WS_Key> </CancelPickupRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
void
None.