PickupRequestService
Click here for a complete list of operations.
CreatePickupRequest
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /sandbox/PickupRequestService.asmx HTTP/1.1 Host: api.rlcarriers.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.rlcarriers.com/CreatePickupRequest" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreatePickupRequest xmlns="http://www.rlcarriers.com/"> <APIKey>string</APIKey> <request> <Pickup> <Shipper> <Name>string</Name> <AddressLine1>string</AddressLine1> <AddressLine2>string</AddressLine2> <ISO3Country>string</ISO3Country> <ZipCode>string</ZipCode> <City>string</City> <State>string</State> <PhoneNumber>string</PhoneNumber> <PhoneExtension>string</PhoneExtension> <ContactName>string</ContactName> <ContactEmailAddress>string</ContactEmailAddress> </Shipper> <Contact> <Name>string</Name> <CompanyName>string</CompanyName> <PhoneNumber>string</PhoneNumber> <PhoneExtension>string</PhoneExtension> <EmailAddress>string</EmailAddress> </Contact> <Destinations> <Destination xsi:nil="true" /> <Destination xsi:nil="true" /> </Destinations> <PickupInformation> <PickupDate>string</PickupDate> <ReadyTime>string</ReadyTime> <CloseTime>string</CloseTime> <AdditionalInstructions>string</AdditionalInstructions> <LoadAttributes xsi:nil="true" /> </PickupInformation> <ServiceOptions> <PURAccessorial>LiftGate or NoRollup</PURAccessorial> <PURAccessorial>LiftGate or NoRollup</PURAccessorial> </ServiceOptions> <ServiceLevel>StandardService or GuaranteedService or GuaranteedByNoon or GuaranteedHourlyWindow or ExpeditedService or WeekendExpress</ServiceLevel> <HourlyWindow> <Start>string</Start> <End>string</End> </HourlyWindow> <ExpeditedQuoteNumber>string</ExpeditedQuoteNumber> <LinkedBolId>int</LinkedBolId> </Pickup> <IncludeBol>boolean</IncludeBol> <IncludeBolPdf>boolean</IncludeBolPdf> </request> </CreatePickupRequest> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreatePickupRequestResponse xmlns="http://www.rlcarriers.com/"> <CreatePickupRequestResult> <PickupRequestID>string</PickupRequestID> <Pickup> <Id xmlns="http://gorlc.com/">string</Id> <WasSuccess xmlns="http://gorlc.com/">boolean</WasSuccess> <Message xmlns="http://gorlc.com/">string</Message> <Result xmlns="http://gorlc.com/"> <ExtensionData xsi:nil="true" /> <BOL xsi:nil="true" /> <BOLAvailableFlag>boolean</BOLAvailableFlag> <Channel xsi:nil="true" /> <CloseTime>string</CloseTime> <Comment>string</Comment> <CommunicationStatus xsi:nil="true" /> <Constraints xsi:nil="true" /> <ContactEmail>string</ContactEmail> <ContactExtension>string</ContactExtension> <ContactName>string</ContactName> <ContactPhone>string</ContactPhone> <CustomsDocumentRequirementsFlag>boolean</CustomsDocumentRequirementsFlag> <Id>int</Id> <LatePickupFlag>boolean</LatePickupFlag> <LoadDetails xsi:nil="true" /> <ParentId>int</ParentId> <PickupDate>string</PickupDate> <ReadyTime>string</ReadyTime> <References xsi:nil="true" /> <Requestor xsi:nil="true" /> <RequestorType xsi:nil="true" /> <Shipper xsi:nil="true" /> <TaskStatus xsi:nil="true" /> <TerminalCode>string</TerminalCode> <TerminalLocalDateTime>dateTime</TerminalLocalDateTime> <VersionNumber>int</VersionNumber> </Result> </Pickup> <BolPdf>base64Binary</BolPdf> </CreatePickupRequestResult> </CreatePickupRequestResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /sandbox/PickupRequestService.asmx HTTP/1.1 Host: api.rlcarriers.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CreatePickupRequest xmlns="http://www.rlcarriers.com/"> <APIKey>string</APIKey> <request> <Pickup> <Shipper> <Name>string</Name> <AddressLine1>string</AddressLine1> <AddressLine2>string</AddressLine2> <ISO3Country>string</ISO3Country> <ZipCode>string</ZipCode> <City>string</City> <State>string</State> <PhoneNumber>string</PhoneNumber> <PhoneExtension>string</PhoneExtension> <ContactName>string</ContactName> <ContactEmailAddress>string</ContactEmailAddress> </Shipper> <Contact> <Name>string</Name> <CompanyName>string</CompanyName> <PhoneNumber>string</PhoneNumber> <PhoneExtension>string</PhoneExtension> <EmailAddress>string</EmailAddress> </Contact> <Destinations> <Destination xsi:nil="true" /> <Destination xsi:nil="true" /> </Destinations> <PickupInformation> <PickupDate>string</PickupDate> <ReadyTime>string</ReadyTime> <CloseTime>string</CloseTime> <AdditionalInstructions>string</AdditionalInstructions> <LoadAttributes xsi:nil="true" /> </PickupInformation> <ServiceOptions> <PURAccessorial>LiftGate or NoRollup</PURAccessorial> <PURAccessorial>LiftGate or NoRollup</PURAccessorial> </ServiceOptions> <ServiceLevel>StandardService or GuaranteedService or GuaranteedByNoon or GuaranteedHourlyWindow or ExpeditedService or WeekendExpress</ServiceLevel> <HourlyWindow> <Start>string</Start> <End>string</End> </HourlyWindow> <ExpeditedQuoteNumber>string</ExpeditedQuoteNumber> <LinkedBolId>int</LinkedBolId> </Pickup> <IncludeBol>boolean</IncludeBol> <IncludeBolPdf>boolean</IncludeBolPdf> </request> </CreatePickupRequest> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <CreatePickupRequestResponse xmlns="http://www.rlcarriers.com/"> <CreatePickupRequestResult> <PickupRequestID>string</PickupRequestID> <Pickup> <Id xmlns="http://gorlc.com/">string</Id> <WasSuccess xmlns="http://gorlc.com/">boolean</WasSuccess> <Message xmlns="http://gorlc.com/">string</Message> <Result xmlns="http://gorlc.com/"> <ExtensionData xsi:nil="true" /> <BOL xsi:nil="true" /> <BOLAvailableFlag>boolean</BOLAvailableFlag> <Channel xsi:nil="true" /> <CloseTime>string</CloseTime> <Comment>string</Comment> <CommunicationStatus xsi:nil="true" /> <Constraints xsi:nil="true" /> <ContactEmail>string</ContactEmail> <ContactExtension>string</ContactExtension> <ContactName>string</ContactName> <ContactPhone>string</ContactPhone> <CustomsDocumentRequirementsFlag>boolean</CustomsDocumentRequirementsFlag> <Id>int</Id> <LatePickupFlag>boolean</LatePickupFlag> <LoadDetails xsi:nil="true" /> <ParentId>int</ParentId> <PickupDate>string</PickupDate> <ReadyTime>string</ReadyTime> <References xsi:nil="true" /> <Requestor xsi:nil="true" /> <RequestorType xsi:nil="true" /> <Shipper xsi:nil="true" /> <TaskStatus xsi:nil="true" /> <TerminalCode>string</TerminalCode> <TerminalLocalDateTime>dateTime</TerminalLocalDateTime> <VersionNumber>int</VersionNumber> </Result> </Pickup> <BolPdf>base64Binary</BolPdf> </CreatePickupRequestResult> </CreatePickupRequestResponse> </soap12:Body> </soap12:Envelope>