Canada Post OpenReturnService Virtual Sandbox

Virtual endpoint for managing Canada Post OpenReturn templates and artifacts.

The OpenReturnService provides operations for managing return templates, including creation, retrieval, detail inspection, and deletion. This virtual service allows developers to simulate SOAP-based interactions for return workflows, validating XML request structures and response handling for return template lifecycle management.

Use this hosted sandbox to simulate Canada Post OpenReturnService 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 sandbox to validate return template creation, verify artifact retrieval logic, test template detail parsing, and simulate error handling for template deletion workflows before integrating with Canada Post production systems.

Canada Post OpenReturnService virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate Canada Post OpenReturnService responses instantly.

`https://canada-openreturn.mock.beeceptor.com`

Operations:(6)

CreateOpenReturnTemplate

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><create-open-return-template-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>8599590</mailed-by><mobo>867746518</mobo><locale>EN</locale><platform-id>60</platform-id><open-return><max-number-of-artifacts>{{faker 'number.int' '{"min":1,"max":100}'}}</max-number-of-artifacts><service-code>{{faker 'string.alphanumeric' '{"length":5}'}}</service-code><receiver><name>{{faker 'person.fullName'}}</name><company>{{faker 'company.name'}}</company><domestic-address><address-line-1>{{faker 'location.streetAddress'}}</address-line-1><address-line-2>{{faker 'location.streetAddress'}}</address-line-2><city>{{faker 'location.city'}}</city><province>{{faker 'location.state' '{"abbreviated":true}'}}</province><postal-code>{{faker 'location.zipCode'}}</postal-code></domestic-address></receiver><print-preferences><output-format>{{oneOf '8.5x11' '4x6'}}</output-format><customer-input-type>{{faker 'string.alphanumeric' '{"length":10}'}}</customer-input-type><encoding>{{oneOf 'PDF' 'ZPL'}}</encoding><show-packing-instructions>{{faker 'datatype.boolean'}}</show-packing-instructions></print-preferences><settlement-info><contract-id>{{faker 'string.numeric' '{"length":8}'}}</contract-id></settlement-info></open-return></create-open-return-template-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><create-open-return-template-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><open-return-info><artifacts-remaining>{{faker 'number.int' '{"min":0,"max":100}'}}</artifacts-remaining><template-id>{{faker 'string.uuid'}}</template-id></open-return-info></create-open-return-template-response></soap:Body></soap:Envelope>

RetrieveNextOpenReturnArtifact

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><retrieve-next-open-return-artifact-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>{{faker 'string.numeric' '{"length":7}'}}</mailed-by><mobo>{{faker 'string.numeric' '{"length":5}'}}</mobo><locale>{{oneOf 'eN' 'fR'}}</locale><platform-id>{{faker 'string.numeric' '{"length":3}'}}</platform-id><template-id>{{faker 'string.alphanumeric' '{"length":1}'}}</template-id></retrieve-next-open-return-artifact-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><retrieve-next-open-return-artifact-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><artifact-data><image>{{faker 'string.alphanumeric' '{"length":50}'}}</image><mime-type>{{oneOf 'application/pdf' 'image/png' 'image/jpeg'}}</mime-type></artifact-data></retrieve-next-open-return-artifact-response></soap:Body></soap:Envelope>

GetOpenReturnTemplate

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-template-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>{{faker 'string.numeric' '{"length":4}'}}</mailed-by><mobo>{{faker 'string.numeric' '{"length":2}'}}</mobo><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":8}'}}</platform-id><template-id>{{faker 'string.alphanumeric' '{"length":5}'}}</template-id></get-open-return-template-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-template-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><open-return-info><artifacts-remaining>{{faker 'number.int' '{"min":0,"max":50}'}}</artifacts-remaining><template-id>{{faker 'string.alphanumeric' '{"length":5}'}}</template-id></open-return-info></get-open-return-template-response></soap:Body></soap:Envelope>

GetOpenReturnTemplateDetails

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-template-details-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>{{faker 'string.numeric' '{"length":7}'}}</mailed-by><mobo>{{faker 'string.numeric' '{"length":6}'}}</mobo><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":6}'}}</platform-id><template-id>{{faker 'string.alphanumeric' '{"length":5}'}}</template-id></get-open-return-template-details-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-template-details-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><open-return-details><artifacts-remaining>{{faker 'number.int' '{"min":0,"max":100}'}}</artifacts-remaining><open-return><max-number-of-artifacts>{{faker 'number.int' '{"min":100,"max":500}'}}</max-number-of-artifacts><service-code>{{faker 'string.alphanumeric' '{"length":4}'}}</service-code><receiver><name>{{faker 'person.fullName'}}</name><company>{{faker 'company.name'}}</company><domestic-address><address-line-1>{{faker 'location.streetAddress'}}</address-line-1><address-line-2>{{faker 'location.streetAddress'}}</address-line-2><city>{{faker 'location.city'}}</city><province>{{faker 'location.state' '{"abbreviated":true}'}}</province><postal-code>{{faker 'location.zipCode'}}</postal-code></domestic-address></receiver><print-preferences><output-format>{{oneOf '8.5x11' '4x6'}}</output-format><customer-input-type>{{oneOf 'label' 'custom'}}</customer-input-type><encoding>{{oneOf 'PDF' 'ZPL'}}</encoding><show-packing-instructions>{{oneOf 'true' 'false'}}</show-packing-instructions></print-preferences><settlement-info><contract-id>{{faker 'string.numeric' '{"length":6}'}}</contract-id></settlement-info></open-return></open-return-details></get-open-return-template-details-response></soap:Body></soap:Envelope>

DeleteOpenReturnTemplate

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><delete-open-return-template-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>{{faker 'string.numeric' '{"length":9}'}}</mailed-by><mobo>{{faker 'string.numeric' '{"length":3}'}}</mobo><locale>{{oneOf 'Fr' 'En'}}</locale><platform-id>{{faker 'string.numeric' '{"length":10}'}}</platform-id><template-id>{{faker 'string.alphanumeric' '{"length":5}'}}</template-id></delete-open-return-template-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><delete-open-return-template-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><delete-template-success>{{oneOf 'true' 'false'}}</delete-template-success></delete-open-return-template-response></soap:Body></soap:Envelope>

GetOpenReturnTemplates

View

Request Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-templates-request xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><mailed-by>{{faker 'string.numeric' '{"length":6}'}}</mailed-by><mobo>{{faker 'number.int' '{"min":1,"max":9}'}}</mobo><locale>{{oneOf 'en' 'fr'}}</locale><platform-id>{{faker 'string.numeric' '{"length":3}'}}</platform-id><from>{{now 'iso'}}</from><to>{{now '{days:7}' 'iso'}}</to></get-open-return-templates-request></soap:Body></soap:Envelope>

Response Envelope

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><get-open-return-templates-response xmlns="http://www.canadapost.ca/ws/soap/openreturn/v2"><templates>{{#repeat (faker 'number.int' '{"min":1,"max":5}') comma=false}}<template-id>{{faker 'string.alphanumeric' '{"length":10}'}}</template-id>{{/repeat}}</templates></get-open-return-templates-response></soap:Body></soap:Envelope>

canada-postsoapwsdlshippingreturns