Canada Post Pickup Request Virtual Sandbox
Manage Canada Post parcel pickup requests via SOAP operations.
The PickupRequestService provides a SOAP interface for managing parcel pickup workflows. Developers can use this service to create, update, cancel, and retrieve pickup requests, as well as calculate pricing and manage the hold or resume status of scheduled pickups.
Use this hosted sandbox to simulate Canada Post Pickup Request APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready.
This keeps your integration code consistent across local development, QA, demos, and production.
Use cases:
Use this service to validate pickup request XML payloads, verify pricing calculation logic, test state transitions for pickup scheduling, and handle SOAP fault responses for invalid pickup details or scheduling conflicts.
Canada Post Pickup Request virtual sandbox is up and running!
Use this sandbox URL as the API base in your code to simulate Canada Post Pickup Request responses instantly.
https://canada-pickup-request.mock.beeceptor.com
Operations:(8)
CancelPickupRequest
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/CancelPickupRequest
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><cancel-pickup-request-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'string.numeric' '{"length":10}'}}</customer-number><locale>{{oneOf 'Fr' 'En'}}</locale><platform-id>{{faker 'string.numeric' '{"length":8}'}}</platform-id><request-id>{{faker 'string.alphanumeric' '{"length":8}'}}</request-id></cancel-pickup-request-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><cancel-pickup-request-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><cancel-pickup-success>{{oneOf 'true' 'false'}}</cancel-pickup-success></cancel-pickup-request-response></soap12:Body></soap12:Envelope>CreatePickupRequest
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/CreatePickupRequest
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><create-pickup-request-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>5478733</customer-number><locale>{{oneOf 'EN' 'FR'}}</locale><platform-id>84799010</platform-id><pickup-request-details><customer-request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</customer-request-id><pickup-type>OnDemand</pickup-type><pickup-location><business-address-flag>{{oneOf 'true' 'false'}}</business-address-flag><alternate-address><company>{{faker 'company.name'}}</company><address-line-1>{{faker 'location.streetAddress'}}</address-line-1><city>{{faker 'location.city'}}</city><province>{{faker 'location.state' '{"abbreviated":true}'}}</province><postal-code>{{faker 'string.alphanumeric' '{"length":6,"casing":"upper"}'}}</postal-code></alternate-address></pickup-location><contact-info><contact-name>{{faker 'person.fullName'}}</contact-name><email>{{faker 'internet.email'}}</email><contact-phone>{{faker 'phone.number' '{"style":"national"}'}}</contact-phone><telephone-ext>{{faker 'string.numeric' '{"length":4}'}}</telephone-ext><receive-email-updates-flag>{{oneOf 'true' 'false'}}</receive-email-updates-flag></contact-info><location-details><five-ton-flag>{{oneOf 'true' 'false'}}</five-ton-flag><loading-dock-flag>{{oneOf 'true' 'false'}}</loading-dock-flag><pickup-instructions>{{faker 'commerce.productDescription'}}</pickup-instructions></location-details><items-characteristics><pww-flag>{{oneOf 'true' 'false'}}</pww-flag><priority-flag>{{oneOf 'true' 'false'}}</priority-flag><returns-flag>{{oneOf 'true' 'false'}}</returns-flag><heavy-item-flag>{{oneOf 'true' 'false'}}</heavy-item-flag></items-characteristics><pickup-volume>{{faker 'number.int' '{"min":1,"max":100}'}}</pickup-volume><pickup-times><on-demand-pickup-time><date>{{now 'iso'}}</date><preferred-time>17:45</preferred-time><closing-time>17:15</closing-time></on-demand-pickup-time></pickup-times><payment-info><contract-id>680104</contract-id><method-of-payment>CreditCard</method-of-payment><pre-authorized-payment><account-number>{{faker 'finance.accountNumber' '{"length":10}'}}</account-number><auth-code>{{faker 'string.alphanumeric' '{"length":6}'}}</auth-code><auth-timestamp>{{now 'iso'}}</auth-timestamp><charge-amount>{{faker 'finance.amount' '{"min":10,"max":500}'}}</charge-amount></pre-authorized-payment></payment-info></pickup-request-details></create-pickup-request-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><create-pickup-request-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><pickup-request-info><pickup-request-header><request-id>{{faker 'string.uuid'}}</request-id><request-status>Active</request-status><pickup-type>OnDemand</pickup-type><request-date>{{now 'iso'}}</request-date><next-pickup-date>{{now '{days:1}' 'iso'}}</next-pickup-date></pickup-request-header><pickup-request-price><pre-tax-amount>{{faker 'finance.amount' '{"min":10,"max":100}'}}</pre-tax-amount><gst-amount>{{faker 'finance.amount' '{"min":1,"max":10}'}}</gst-amount><pst-amount>{{faker 'finance.amount' '{"min":1,"max":10}'}}</pst-amount><hst-amount>{{faker 'finance.amount' '{"min":1,"max":10}'}}</hst-amount><due-amount>{{faker 'finance.amount' '{"min":20,"max":150}'}}</due-amount><cc-receipt-details><merchant-name>{{faker 'company.name'}}</merchant-name><merchant-url>{{faker 'internet.url'}}</merchant-url><name-on-card>{{faker 'person.fullName'}}</name-on-card><auth-code>{{faker 'string.alphanumeric' '{"length":6}'}}</auth-code><auth-timestamp>{{now 'iso'}}</auth-timestamp><card-type>{{oneOf 'Visa' 'MasterCard' 'Amex'}}</card-type><charge-amount>{{faker 'finance.amount' '{"min":20,"max":150}'}}</charge-amount><currency>CAD</currency><transaction-type>Sale</transaction-type></cc-receipt-details><supplier-account-receipt-details><merchant-name>{{faker 'company.name'}}</merchant-name><merchant-url>{{faker 'internet.url'}}</merchant-url><auth-code>{{faker 'string.alphanumeric' '{"length":6}'}}</auth-code><auth-timestamp>{{now 'iso'}}</auth-timestamp><supplier-id>{{faker 'string.numeric' '{"length":8}'}}</supplier-id><charge-amount>{{faker 'finance.amount' '{"min":20,"max":150}'}}</charge-amount><currency>CAD</currency><transaction-type>Sale</transaction-type></supplier-account-receipt-details></pickup-request-price></pickup-request-info></create-pickup-request-response></soap12:Body></soap12:Envelope>GetPickupPrice
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/GetPickupPrice
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-price-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'string.numeric' '{"length":10}'}}</customer-number><locale>{{oneOf 'eN' 'fR'}}</locale><platform-id>{{faker 'string.numeric' '{"length":8}'}}</platform-id><pickup-details><date>{{now 'iso'}}</date><contract-id>{{faker 'string.numeric' '{"length":5}'}}</contract-id><pww-flag>{{oneOf 'true' 'false'}}</pww-flag><priority-flag>{{oneOf 'true' 'false'}}</priority-flag><alternate-address-province>{{faker 'location.state' '{"abbreviated":true}'}}</alternate-address-province><alternate-address-postal-code>{{faker 'location.zipCode'}}</alternate-address-postal-code></pickup-details></get-pickup-price-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-price-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><pickup-request-price><pre-tax-amount>{{faker 'finance.amount' '{"min":10,"max":500,"dec":2}'}}</pre-tax-amount><gst-amount>{{faker 'finance.amount' '{"min":1,"max":50,"dec":2}'}}</gst-amount><pst-amount>{{faker 'finance.amount' '{"min":1,"max":50,"dec":2}'}}</pst-amount><hst-amount>{{faker 'finance.amount' '{"min":1,"max":50,"dec":2}'}}</hst-amount><due-amount>{{faker 'finance.amount' '{"min":12,"max":600,"dec":2}'}}</due-amount></pickup-request-price></get-pickup-price-response></soap12:Body></soap12:Envelope>GetPickupRequestDetails
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/GetPickupRequestDetails
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-request-details-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'number.int' '{"min":1000000,"max":9999999}'}}</customer-number><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'number.int' '{"min":10000000,"max":99999999}'}}</platform-id><request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</request-id></get-pickup-request-details-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-request-details-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><pickup-request-detailed-info><pickup-request-header><request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</request-id><request-status>{{oneOf 'Active' 'Cancelled' 'Completed'}}</request-status><pickup-type>{{oneOf 'OnDemand' 'Scheduled'}}</pickup-type><request-date>{{now 'iso'}}</request-date><next-pickup-date>{{now '{days:1}' 'iso'}}</next-pickup-date></pickup-request-header><pickup-request-details><pickup-location><business-address-flag>{{oneOf 'true' 'false'}}</business-address-flag><alternate-address><company>{{faker 'company.name'}}</company><address-line-1>{{faker 'location.streetAddress'}}</address-line-1><city>{{faker 'location.city'}}</city><province>{{faker 'location.state' '{"abbreviated":true}'}}</province><postal-code>{{faker 'location.zipCode'}}</postal-code></alternate-address></pickup-location><contact-info><contact-name>{{faker 'person.fullName'}}</contact-name><email>{{faker 'internet.email'}}</email><contact-phone>{{faker 'phone.number' '{"style":"national"}'}}</contact-phone><telephone-ext>{{faker 'string.numeric' '{"length":5}'}}</telephone-ext><receive-email-updates-flag>{{oneOf 'true' 'false'}}</receive-email-updates-flag></contact-info><location-details><five-ton-flag>{{oneOf 'true' 'false'}}</five-ton-flag><loading-dock-flag>{{oneOf 'true' 'false'}}</loading-dock-flag><pickup-instructions>{{faker 'company.catchPhrase'}}</pickup-instructions></location-details><items-characteristics><pww-flag>{{oneOf 'true' 'false'}}</pww-flag><priority-flag>{{oneOf 'true' 'false'}}</priority-flag><returns-flag>{{oneOf 'true' 'false'}}</returns-flag><heavy-item-flag>{{oneOf 'true' 'false'}}</heavy-item-flag></items-characteristics><pickup-volume>{{oneOf 'Small' 'Medium' 'Large'}}</pickup-volume><pickup-times><on-demand-pickup-time><date>{{now 'iso'}}</date><preferred-time>14:00</preferred-time><closing-time>17:00</closing-time></on-demand-pickup-time></pickup-times></pickup-request-details></pickup-request-detailed-info></get-pickup-request-details-response></soap12:Body></soap12:Envelope>GetPickupRequests
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/GetPickupRequests
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-requests-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'string.numeric' '{"length":9}'}}</customer-number><locale>{{oneOf 'EN' 'FR'}}</locale><platform-id>{{faker 'string.numeric' '{"length":8}'}}</platform-id></get-pickup-requests-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><get-pickup-requests-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><pickup-requests>{{#repeat (faker 'number.int' '{"min":1,"max":3}') comma=false}}<pickup-request><pickup-request-header><request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</request-id><request-status>{{oneOf 'Active' 'Cancelled' 'Completed' 'Pending'}}</request-status><pickup-type>{{oneOf 'OnDemand' 'Scheduled'}}</pickup-type><request-date>{{now 'iso'}}</request-date><next-pickup-date>{{now '{days:1}' 'iso'}}</next-pickup-date></pickup-request-header></pickup-request>{{/repeat}}</pickup-requests></get-pickup-requests-response></soap12:Body></soap12:Envelope>HoldPickups
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/HoldPickups
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><hold-pickups-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'string.numeric' '{"length":8}'}}</customer-number><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":5}'}}</platform-id><request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</request-id><effective-date>{{now 'iso'}}</effective-date></hold-pickups-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><hold-pickups-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><hold-pickups-success>{{oneOf 'true' 'false'}}</hold-pickups-success></hold-pickups-response></soap12:Body></soap12:Envelope>ResumePickups
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/ResumePickups
Request Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><resume-pickups-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'string.numeric' '{"length":10}'}}</customer-number><locale>{{oneOf 'En' 'Fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":10}'}}</platform-id><request-id>{{faker 'string.alphanumeric' '{"length":8}'}}</request-id><effective-date>{{now 'iso'}}</effective-date></resume-pickups-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="utf-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><resume-pickups-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><resume-pickups-success>{{oneOf 'true' 'false'}}</resume-pickups-success></resume-pickups-response></soap12:Body></soap12:Envelope>UpdatePickupRequest
View
SOAP Action: http://www.canadapost.ca/ws/soap/pickuprequest/UpdatePickupRequest
Request Envelope
<?xml version="1.0" encoding="UTF-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><update-pickup-request-request xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><customer-number>{{faker 'number.int' '{"min":10000,"max":99999}'}}</customer-number><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":8}'}}</platform-id><request-id>{{faker 'string.alphanumeric' '{"length":10}'}}</request-id><pickup-request-update><contact-info><contact-name>{{faker 'person.fullName'}}</contact-name><email>{{faker 'internet.email'}}</email><contact-phone>{{faker 'phone.number' '{"style":"national"}'}}</contact-phone><telephone-ext>{{faker 'string.numeric' '{"length":5}'}}</telephone-ext><receive-email-updates-flag>{{faker 'datatype.boolean'}}</receive-email-updates-flag></contact-info><location-details><five-ton-flag>{{faker 'datatype.boolean'}}</five-ton-flag><loading-dock-flag>{{faker 'datatype.boolean'}}</loading-dock-flag><pickup-instructions>{{faker 'person.bio'}}</pickup-instructions></location-details><items-characteristics><heavy-item-flag>{{faker 'datatype.boolean'}}</heavy-item-flag></items-characteristics><pickup-volume>{{faker 'number.int' '{"min":1,"max":100}'}}</pickup-volume><pickup-times><on-demand-pickup-time><date>{{now 'iso'}}</date><preferred-time>14:15</preferred-time><closing-time>14:00</closing-time></on-demand-pickup-time></pickup-times></pickup-request-update></update-pickup-request-request></soap12:Body></soap12:Envelope>Response Envelope
<?xml version="1.0" encoding="UTF-8"?><soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"><soap12:Body><update-pickup-request-response xmlns="http://www.canadapost.ca/ws/soap/pickuprequest"><update-pickup-request-success>true</update-pickup-request-success></update-pickup-request-response></soap12:Body></soap12:Envelope>canada-postshippinglogisticssoapwsdl