openapi: 3.0.0
info:
    title: Shipping
    description: Shipping
    x-ibm-languages:
        title:
            fr: Expédition
    version: 1.0.0
    x-ibm-name: shipping-service-v1
    x-pathalias: shipping-api-1.0.0
    x-ibm-summary: ''
servers:
    -
        url: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1'
paths:
    '/{mailedBy}/{mobo}/shipments':
        post:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/zonosAccountId'
                -
                    $ref: '#/components/parameters/language'
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/createShipmentRequest'
                        example:
                            groupId: APIC_DS
                            requestedShippingPoint: K1K1K1
                            expectedMailingDate: '2026-02-18'
                            createQrCode: true
                            deliverySpec:
                                serviceCode: DOM.XP
                                sender:
                                    name: 'Sam Sender'
                                    company: 'Happy Sendings'
                                    contactPhone: 613-325-7777
                                    addressDetails:
                                        addressLine1: '125 Main St'
                                        addressLine2: 'Apt 10'
                                        city: Ottawa
                                        provState: 'ON'
                                        countryCode: CA
                                        postalZipCode: K1K1K1
                                destination:
                                    name: 'Pete Pickup'
                                    company: GoodsGetter
                                    clientVoiceNumber: 613-123-4567
                                    addressDetails:
                                        addressLine1: '3 Elm St'
                                        city: Kanata
                                        provState: 'ON'
                                        countryCode: CA
                                        postalZipCode: K1K1K1
                                options:
                                    -
                                        optionCode: COV
                                        optionAmount: 123.45
                                    -
                                        optionCode: SO
                                parcelCharacteristics:
                                    weight: 0.02
                                    dimensions:
                                        length: 11
                                        width: 12
                                        height: 10
                                printPreferences:
                                    outputFormat: 8.5x11
                                preferences:
                                    showPackingInstructions: true
                                    showPostageRate: true
                                    showInsuredValue: true
                                settlementInfo:
                                    paidByCustomer: '0007271592'
                                    contractId: '0041596528'
                                    intendedMethodOfPayment: Account
                description: "<p><strong>Request &ndash; Fields</strong></p>\n<table>\n  <thead>\n    <tr>\n      <th>Field Name</th>\n      <th>Type</th>\n      <th>Required / Optional</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>createQrCode</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>This is an optional field, used to request the QR code image of the public label in base64 format, along with contains public key label URL, and expiry date.</p>\n        <p>If true, two new links are provided: publicLabel and publicKeyInfo.</p>\n        <p>Note: Only applicable to 8 1/2 X 11 paper encoded in pdf</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>createPublicKey</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>This is an optional field, used to request the public key label URL, and expiry date.</p>\n        <p>If true, two new links are provided: publicLabel and publicKeyInfo</p>\n        <p>Note: Only applicable to 8 1/2 X 11 paper encoded in pdf</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>&nbsp;customerRequestId</p>\n      </td>\n      <td>String</td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 35 characters)</p>\n        <p>A unique ID that you can define for this shipment. It must be unique or the request will be rejected.</p>\n        <p>Supplier Account vendors must use this field to provide a unique identifier for any shipment that is a pre-authorized payment request.</p>\n        <p>You can also use this ID recover shipment details, such as the label, without the need for the information provided in the Create Shipment response. Instead, just use this ID in a request to Get Shipments.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>groupId</p>\n      </td>\n      <td>String</td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - up to 32 characters)</p>\n        <p>This field represents the groupId number (or group name) in which to place the created shipment. The group will be created by the Canada Post service if it does not exist.</p>\n        <p>The groupId field is required unless transmitShipment is provided, in which case groupId must not be provided.</p>\n        <p>Do not create a unique group for each individual shipment. The purpose of a groupId is to group several shipments together to include on the same manifest. For example, grouping is useful in the following scenarios:</p>\n        <ul>\n          <li>You have multiple fulfillment locations.</li>\n          <li>You want all shipments in a group to be shipped on the same day.</li>\n          <li>You want to group shipments together for internal reference or billing purposes.</li>\n        </ul>\n        <p><strong>Note:</strong> domestic, U.S., and international shipments will be placed on separate manifests even if they contain the same groupId.</p>\n        <p><strong>Performance limitations</strong></p>\n        <p>To avoid a timeout of our servers, please follow these recommendations:</p>\n        <ul>\n          <li>Do not include more than 30 groups per manifest (i.e., maximum of 30 groupIds in one Transmit Shipments request.)</li>\n          <li>Do not put more than 5,000 shipments in one group.</li>\n        </ul>\n        <p><strong>System limitations</strong></p>\n        <p>To avoid an error, please do not exceed the following limits before performing a Transmit Shipments call:</p>\n        <ul>\n          <li>Maximum of 50 groups per manifest (error 9109 if exceeded).</li>\n          <li>Maximum of 10,000 shipments in one group (error 9110 if exceeded).</li>\n          <li>Maximum of 10,000 shipments across multiple groups (error 9108 if exceeded).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>transmitShipment</p>\n      </td>\n      <td>Boolean</td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true}</p>\n        <p>Contained within shipment.</p>\n        <p>This field identifies a shipment where no manifest is required for proof of payment.</p>\n        <p>This shipment will be transmitted immediately and a subsequent Transmit Shipments call is not required.</p>\n        <p>Use this field if you ship fewer than 50 parcels per day from multiple locations using one of these business models:</p>\n        <ul>\n          <li>Consumer-to-consumer shipping (e.g. online auction websites)</li>\n          <li>Distributed order management</li>\n          <li>Third-party direct fulfillment</li>\n        </ul>\n        <p>When this field is set to true, you will be charged immediately once your Create Shipment request is complete. Your shipment cannot be voided.</p>\n        <p><strong>Important:</strong> If you use traditional contract shipping and manifest processes (e.g. you ship more than 50 parcels per day from a central warehouse), this process is not for you. You must continue to use the regular manifest process. Failure to do so will result in refusal of your shipment until you produce the required manifests.</p>\n        <p>If you are a non-contract shipping customer who uses contract shipping web services, you must provide this field.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>quickshipLabelRequested</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>{true}</p>\n        <p>Use this field if you already have a domestic parcel with the recipient&rsquo;s name and address on it, but you want to create an additional label to affix to the parcel for tracking purposes.</p>\n        <p>Set this field to true, and, for billing purposes, provide the country code (must be CA) and the postal code, in the destination structure. A label that contains a tracking barcode and the words &ldquo;Quick Ship &ndash; Refer to Address Label/Exp&eacute;dition rapide &ndash; Reportez-vous &agrave; l&rsquo;&eacute;tiquette d&rsquo;adresse&rdquo; will be created.</p>\n        <p>Only provide this parameter when you want a Quick Ship label (i.e. do not provide when false).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>requestedShippingPoint</p>\n      </td>\n      <td>String</td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(6-character alphanumeric string)</p>\n        <p>Must be in valid Postal Code format.</p>\n        <p>e.g. A9A9A9</p>\n        <p>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d</p>\n        <p>Postal Code of the location where your shipments are picked up. The Postal Code you provide is used for pricing purposes.</p>\n        <p>If you deposit your shipments yourself, you have 2 choices:</p>\n        <ul>\n          <li>Omit this field and provide the site number of your deposit location in shippingPointId. (recommended), or</li>\n          <li>Provide the postal code of your deposit location here and omit shippingPointId.</li>\n        </ul>\n        <p><strong>Note:</strong> Using requestedShippingPoint to indicate your deposit location postal code will be discontinued in a future release. If you deposit your shipments yourself, we recommend using the shippingPointId field.</p>\n        <p>Mandatory when cpcPickupIndicator is provided.</p>\n        <p>Mutually exclusive with shippingPointId, but one of the two must be provided</p>\n        <p>You will be asked to provide the requestedShippingPoint again in your Transmit Shipments request. If you use a different Postal Code, it may result in a price adjustment depending on the difference in distance between the two locations.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>cpcPickupIndicator</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>(true)</p>\n        <p>Set this field to true if your shipments are picked up by Canada Post or a third party. Provide the Postal Code of your pickup location in requestedShippingPoint.</p>\n        <p>Omit this field if you deposit your shipments yourself.</p>\n        <p>Mutually exclusive with shippingPointId.</p>\n        <p>You must also set this field to true in your Transmit Shipments request.</p>\n        <p><strong>Note:</strong> In a future release it will become mandatory to explicitly identify whether your shipment is picked up by Canada Post (by providing both this indicator and requestedShippingPoint) or deposited at a Canada Post site (by providing shippingPointId).</p>\n        <p>We recommend preparing for this change by providing this indicator (and requestedShippingPoint) if your shipment is picked up by Canada Post.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>&nbsp;shippingPointId</p>\n      </td>\n      <td>String</td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(4-character alphanumeric string)</p>\n        <p>If you deposit your items at a Post Office or other Canada Post facility, provide the site number of the deposit location. Look up the site number using <a href=\"https://www.canadapost-postescanada.ca/information/app/fdl/business/findDepositLocation\">Find a Deposit Location</a>. This information is used for pricing.</p>\n        <p>You will also be asked to provide the shippingPointId in your Transmit Shipments request. Enter the same site number or pricing may be affected.</p>\n        <p>Mutually exclusive with requestedShippingPoint but one of the two must be provided.</p>\n        <p><strong>Note:</strong> If you deposit your items yourself, we recommend using this field rather than the requestedShippingPoint field to indicate your deposit location.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>expectedMailingDate</p>\n      </td>\n      <td>String</td>\n      <td>Optional</td>\n      <td>\n        <p>(YYYY-MM-DD - date format)</p>\n        <p><strong>Note:</strong> You can omit this field. It will be used in a future release.</p>\n        <p>All shipments are priced as per the current shipment date and are re-priced at time of transmit if transmitted at a later date.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>&nbsp;providePricingInfo</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>{true}</p>\n        <p>This field identifies that you want the shipmentPrice structure included in the response to this call. It will result in a larger payload but eliminates the need for a subsequent call to Get Shipment Price.</p>\n        <p>Only applicable to a shipment where transmitShipment=true.</p>\n        <p>Only provide this parameter if you want pricing details in the response (i.e., do not provide when false).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>&nbsp;provideReceiptInfo</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>{true}</p>\n        <p>This field identifies that you want the shipmentReceipt structure included in the response to this call. It will result in a larger payload but eliminates the need for a subsequent call to Get Shipment Receipt.</p>\n        <p>Only applicable to a shipment where transmitShipment=true that is paid by credit card or Supplier Account.</p>\n        <p>Only provide this parameter if you want receipt details in the response (i.e., do not provide when false).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>deliverySpec</p>\n      </td>\n      <td>Object</td>\n      <td>Required</td>\n      <td>\n        <p>Provides a description of the delivery request details, including recipient, serviceCode, sender, options, item specification, notificationInfo and referenceIds.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>serviceCode</p>\n      </td>\n      <td>String</td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 32 characters)</p>\n        <p>Must be a valid code representing the Canada Post delivery service used for shipping the item. The most frequently used codes are listed below.</p>\n        <table>\n          <thead>\n            <tr>\n              <th>Service Code</th>\n              <th>Description</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <td>DOM.RP</td>\n              <td>Regular Parcel</td>\n            </tr>\n            <tr>\n              <td>DOM.EP</td>\n              <td>Expedited Parcel</td>\n            </tr>\n            <tr>\n              <td>DOM.XP</td>\n              <td>Xpresspost</td>\n            </tr>\n            <tr>\n              <td>DOM.PC</td>\n              <td>Priority</td>\n            </tr>\n            <tr>\n              <td>DOM.LIB</td>\n              <td>Library Books</td>\n            </tr>\n            <tr>\n              <td>USA.EP</td>\n              <td>Expedited Parcel USA</td>\n            </tr>\n            <tr>\n              <td>USA.SP.AIR</td>\n              <td>Small Packet USA Air</td>\n            </tr>\n            <tr>\n              <td>USA.TP</td>\n              <td>Tracked Packet &ndash; USA</td>\n            </tr>\n            <tr>\n              <td>USA.TP.LVM</td>\n              <td>\n                <p>Tracked Packet &ndash; USA (LVM)<br>(large volume mailers)</p>\n                <p><strong>Note:</strong> To use this option, it must be specified in your contract.</p>\n              </td>\n            </tr>\n            <tr>\n              <td>USA.XP</td>\n              <td>Xpresspost USA</td>\n            </tr>\n            <tr>\n              <td>INT.XP</td>\n              <td>Xpresspost International</td>\n            </tr>\n            <tr>\n              <td>INT.IP.AIR</td>\n              <td>International Parcel Air</td>\n            </tr>\n            <tr>\n              <td>INT.IP.SURF</td>\n              <td>International Parcel Surface</td>\n            </tr>\n            <tr>\n              <td>INT.SP.AIR</td>\n              <td>Small Packet International Air</td>\n            </tr>\n            <tr>\n              <td>INT.SP.SURF</td>\n              <td>Small Packet International Surface</td>\n            </tr>\n            <tr>\n              <td>INT.TP</td>\n              <td>Tracked Packet &ndash; International</td>\n            </tr>\n          </tbody>\n        </table>\n        <p>(Note - These delivery services and their codes can be discovered by calling the Get Rates and Discover Services web services described in <a href=\"../../../api/overview/rating\">Rating</a>)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>sender</p>\n      </td>\n      <td>Object</td>\n      <td>Required</td>\n      <td>\n        <p>This structure contains data about the sender that will appear in the &ldquo;From&rdquo; address of the label. Blank fields will be removed for address formatting.</p>\n        <p><strong>Note:</strong> sender address must be domestic.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Contact name of the sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Company name of the sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>contactPhone</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 25 characters)</p>\n        <p>Contact phone number of the sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Contains the address data about the sender. Blank address fields will be removed for formatting the labels.</p>\n        <p><strong>Note:</strong> sender address must be domestic.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Address of the sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Address line 2 of the sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 40 characters)</p>\n        <p>City of sender.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 20 characters)</p>\n        <p>Province of sender.</p>\n        <p>Use standard Canadian province codes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(2-character valid country code)</p>\n        <p>Country code of sender. Must be CA.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(6-character alphanumeric)</p>\n        <p>Must be in valid postal code format</p>\n        <p>e.g. A9A9A9</p>\n        <p>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>destination</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>This field should always contain the address of the mail recipient, even if you are using the Deliver to Post Office option.</p>\n        <ul>\n          <li>For regular shipments, this data will appear in the \"To\" address of the label.</li>\n          <li>For Deliver to Post Office shipments, the system will substitute the Post Office address on the label.</li>\n          <li>For Quick Ship shipments (quickshipLabelRequested = true), this is only used for rating purposes and only the destination countryCode (CA) and postalCode fields must be provided.</li>\n        </ul>\n        <p>Blank fields will be removed in the address formatting.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 44 characters)</p>\n        <p>Contact name of the recipient at the destination.</p>\n        <p>If the Deliver to Post Office option is used, the name field must be present for the destination.</p>\n        <p>Not required when quickshipLabelRequested is true.</p>\n        <p>When shipping outside of Canada, at least one of name or company is required to comply with international customs regulations.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 44 characters)</p>\n        <p>Company name of the recipient at the destination.</p>\n        <p>When shipping outside of Canada, at least one of name or company is required to comply with international customs regulations.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>additionalAddressInfo</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String &ndash; up to 44 characters)</p>\n        <p>Additional address information for the destination.</p>\n        <p>This information is printed directly above address line 1 on the shipping label.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>clientVoiceNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 25 characters)</p>\n        <p>Phone number at the destination. Not required for domestic shipments unless the Deliver to Post Office option has been selected.</p>\n        <p><strong>Note:</strong> In addition to numbers, the following characters are also accepted in this field:</p>\n        <ul>\n          <li>A plus sign (+), but only as the first character in the string.</li>\n          <li>Period (.), hyphen (-), open and close brackets, space, and x or p to indicate an extension.</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Contains the address data the destination of the shipment. Blank fields will be removed for formatting the labels.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 44 characters)</p>\n        <p>Address at the destination.</p>\n        <p>Not required when quickshipLabelRequested is true; mandatory otherwise.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String &ndash; up to 44 characters)</p>\n        <p>Address line 2 for the destination.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 40 characters)</p>\n        <p>Destination city.</p>\n        <p>Optional for international shipments. Required for domestic and U.S.A. shipments.</p>\n        <p>Not required when quickshipLabelRequested is true.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String &ndash; up to 20 characters)</p>\n        <p>Province or state for the destination.</p>\n        <p>Use:</p>\n        <ul>\n          <li>Standard province code for provinces within Canada.</li>\n          <li>Standard state code for U.S. states.</li>\n          <li>Free form for states and provinces of other countries.</li>\n        </ul>\n        <p>Optional for international shipments. Required for domestic and U.S.A. shipments (except when quickshipLabelRequested is true).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(2-character valid country code)</p>\n        <p>Country code for the destination.</p>\n        <p>Must be CA when quickshipLabelRequested&nbsp;is true.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>Can be one of the following:</p>\n        <ul>\n          <li>(6-character alphanumeric for Canada (A9A9A9)<br>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d</li>\n          <li>(5-digit or 5-4 digit numeric code for US)<br>Pattern is \\d{5}(-\\d{4})?</li>\n          <li>Character String - up to 14 characters (free format) for other countries.</li>\n        </ul>\n        <p>Required for countries that require a Postal Code or zip code (e.g. Canada, U.S.A.)</p>\n        <p>Postal Code or zip code at the destination.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>options</p>\n      </td>\n      <td>\n        <p>Array of Objects</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains options for the delivery serviceCode such as insurance, COD, etc.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Alphanumeric String of up to 10 letters/digits)</p>\n        <p>Required if the corresponding parent field \"option\" exists.</p>\n        <p>This is the option code indicating which option applies to this shipment.</p>\n        <p>Valid option codes are as follows</p>\n        <p>SO - Signature<br>COV - Coverage<br>COD - Collect on delivery <br>PA18 - Proof of Age Required - 18<br>PA19 - Proof of Age Required - 19<br>PA21 - Proof of Age Required - 21<br>HFP - Card for pickup<br>DNS - Do not safe drop<br>LAD - Leave at door - do not card<br>D2PO - Deliver to Post Office</p>\n        <p><strong>Note:</strong> The D2PO option indicates that the parcel will be delivered directly to a nearby Post Office. For the D2PO option, the following fields are required:</p>\n        <ul>\n          <li>name (under destination)</li>\n          <li>clientVoiceNumber (under destination)</li>\n          <li>notification</li>\n          <li>optionQualifier2</li>\n        </ul>\n        <p><strong>Note:</strong> If you select Collect on Delivery (COD), specify Card for Pickup (HFP) or Deliver to Post Office (D2PO). This is to facilitate the collection of COD funds at a post office. If not specified, the system will default to HFP.</p>\n        <p><strong>Non-delivery handling codes</strong><br>(required for some U.S.A. and international shipments)<br>RASE - Return at Sender&rsquo;s Expense<br>RTS - Return to Sender<br>ABAN - Abandon</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionAmount</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 6.2 e.g. 999999.99)</p>\n        <p>Required if the corresponding parent field \"option\" exists and depending on the value of optionCode.</p>\n        <p>e.g., For COV option, this is the amount of insurance coverage to be purchased.</p>\n        <p>For COD option, this is the base amount to collect on delivery (shipping costs may also be added by the system as described below in optionQualifier1).</p>\n        <p>On U.S. and international shipments, do not provide if you want the system to calculate the maximum allowable coverage (see optionQualifier1 below).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionQualifier1</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>boolean &ndash; {true, false}</p>\n        <p>Can be used to provide a qualifier for the COD or COV options.</p>\n        <p>To indicate if the COD amount is to include the shipping cost or not:</p>\n        <ul>\n          <li>true = Shipping costs will be added to the COD amount you provided in&nbsp;optionAmount.</li>\n          <li>false = The COD amount to collect is specified in optionAmount (i.e. Shipping costs are not to be added).</li>\n        </ul>\n        <p>To use with the COV option on U.S. and international shipments to indicate that the system can apply the maximum allowable coverage amount, which would equal the total value of your goods, up to the allowable maximum for product and country:</p>\n        <ul>\n          <li>true = Use maximum allowable coverage; when used, there is no need to provide optionAmount.</li>\n          <li>false (the default) = Use the amount of coverage as provided in optionAmount.</li>\n        </ul>\n        <p>False is the default if the qualifier is not provided.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionQualifier2</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{Character String up to 12 characters}</p>\n        <p>Required if the corresponding parent field \"option\" exists <strong>and</strong> the optionCode is one that requires a 2nd qualifier.</p>\n        <p>Currently, the options requiring a 2nd qualifier are:</p>\n        <p><strong>Deliver to Post Office</strong><br>For the Deliver to Post Office option, this field must contain the office id of the destination Post Office.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>parcelCharacteristics</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Describes the characteristics of the parcel.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>weight</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Numeric field of pattern 3.3 e.g. 999.999)</p>\n        <p>Total package weight in kg.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>dimensions</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains the physical dimensions of the parcel, which can be used to make a more accurate determination of shipping cost.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>length</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 3.1 e.g. 999.9 pattern)</p>\n        <p>Length of parcel in cm.</p>\n        <p>Required if the corresponding parent field \"dimensions\" exists.</p>\n        <p>If specified, a more accurate price can be derived.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>width</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 3.1 e.g. 999.9 pattern)</p>\n        <p>Width of parcel in cm.</p>\n        <p>Required if the corresponding parent field \"dimensions\" exists.</p>\n        <p>If specified, a more accurate price may be derived.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>height</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 3.1 e.g. 999.9 pattern)</p>\n        <p>Height of parcel in cm.</p>\n        <p>Required if the corresponding parent field \"dimensions\" exists.</p>\n        <p>If specified, a more accurate price may be derived.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>unpackaged</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether a shipment is unpackaged or not. For example, auto tires may be an example of an unpackaged shipment.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>mailingTube</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether a shipment is contained in a mailing tube. e.g. a poster tube</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>oversized</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether the parcel is oversized or not.</p>\n        <p><strong>Note:</strong> If parcel dimensions have been provided, then this field will be automatically determined (as either true or false) based on the parcel dimensions (regardless of whether you include a value for the \"oversized\" field field). However, if no dimensions are provided, then you can specify that a parcel is oversized (or not) using this field.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>notification</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>Contains client references&nbsp;with respect to email notification for tracking events e.g. delivery.</p>\n        <p>This field is required if the Deliver to Post Office (D2PO) option has been selected. For Deliver to Post Office, the email indicated within notification will be used to notify the customer that their parcel is ready for pickup.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>email</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - up to 60 characters)</p>\n        <p>Must be a valid email address.</p>\n        <p>Pattern is (['_A-Za-z0-9\\-\\+])(\\.['_A-Za-z0-9\\-\\+])@([A-Za-z0-9-])(\\.[A-Za-z0-9-])(\\.[A-Za-z]{2,})</p>\n        <p>This field is required if the notification field exists.</p>\n        <p>Email address to receive automatic tracking updates.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onShipment</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>This field is required if the notification field exists.</p>\n        <p>Indicates whether you wish to receive an email notification upon shipment of the parcel.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onException</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>This field is required if the notification field exists.</p>\n        <p>Indicates whether you wish to receive an email notification on exceptions.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onDelivery</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>This field is required if the notification field exists.</p>\n        <p>Indicates whether you wish to receive an email notification upon delivery of the parcel.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>printPreferences</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains print preferences for the labels.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>outputFormat</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>{8.5x11, 4x6}</p>\n        <p>8.5x11 indicates paper and 4x6 indicates thermal.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>encoding</td>\n      <td>String</td>\n      <td>optional</td>\n      <td>\n        <p>{PDF, ZPL}</p>\n        <p>Use this field to specify the output format for your shipping label: PDF or ZPL II. If not provided, PDF will be selected by default.</p>\n        <p>If you choose ZPL, the response from a Get Artifact call will include a file containing ZPL II printer commands. You will then need to either code a solution or use an application to stream the commands directly to a thermal printer.</p>\n        <p>For ZPL II labels, your printer must support truncation. Use our <a href=\"../../../printing-labels\">sample code to test your printer&rsquo;s ability to truncate text.</a></p>\n        <p>ZPL is only available on thermal paper so&nbsp;outputFormat&nbsp;must be 4x6.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>preferences</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Contains a number of preferences with respect to printing labels, etc.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showPackingInstructions</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether packing instructions are to be rendered on the label.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showPostageRate</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether the postal rate is to be shown on the label.</p>\n        <p>This field is required only for U.S.A. and international shipments.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showInsuredValue</p>\n      </td>\n      <td>\n        <p>Boolean</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>{true, false}</p>\n        <p>Indicates whether the insured value is to be shown on the label.</p>\n        <p>This field is required only for insured U.S.A. and international shipments.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>references</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains reference fields that you assign. You can assign these alternate (possibly unique) identification numbers to the shipment for any purpose useful to you.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>costCentre</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 30 characters)</p>\n        <p>This is a value you assign for use by your applications. The value you enter here will appear on your invoice and in the PosteCS secure email that we use to send your invoice.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customerRef1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 35 characters)</p>\n        <p>This is a user-defined value available for use by your applications. (e.g. you could use this field as an internal \"order id\"). The value you enter here will appear on the shipping label, in Track and &ndash; for customers who subscribe to our Automated Parcel Tracking service &ndash; in your APT file.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customerRef1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 35 characters)</p>\n        <p>This is a user-defined value available for use by your applications. The value you enter here will appear on the shipping label, in Track and &ndash; for customers who subscribe to our Automated Parcel Tracking service &ndash; in your APT file.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customs</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains information to be printed on the label to facilitate passing through customs at international borders.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>usdeclarationid</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Alphanumeric String - up to 30 letters/digits)</p>\n        <p>A declaration ID is required when shipping items to the US if a Zonos account key is not included in the header. Please provide your Zonos declaration id here when it is being generated directly from their APIs. Each declaration ID is unique to a single shipment.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>currency</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - 3 alphabetic characters)</p>\n        <p>This is the currency of the receiving country. The currency code is converted to uppercase, if not already. Value must be:</p>\n        <ul>\n          <li>CAD for Canadian currency</li>\n          <li>USD for U.S. currency</li>\n          <li>Other valid ISO currency code</li>\n        </ul>\n        <p>Required if the corresponding parent field \"customs\" exists.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>conversionFromCad</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 3.3 i.e. 999.999)</p>\n        <p>The conversion rate from the Canadian dollar to the currency you entered in the currency field above; for example, if you used USD as the target currency and $1.00 CAD = $0.85 USD, the conversion rate is 0.85.</p>\n        <p>Required if the corresponding parent field \"customs\" exists and the currency is not CAD.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>reasonForExport</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(3 characters)</p>\n        <p>A code that represents the reason for export, which assists with border crossing.</p>\n        <p>The codes and their meanings are as follows:</p>\n        <p>DOC = document<br>SAM = commercial sample<br>REP = repair or warranty<br>SOG = sale of goods<br>OTH = other</p>\n        <p>Required if the corresponding parent field \"customs\" exists.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>otherReason</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - minimum 4 characters; maximum 44 characters)</p>\n        <p>Contains the reason for export.</p>\n        <p>Required if the field reasonForExport is \"other\".</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>dutiesAndTaxesPrepaid</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Reserved for future use.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>certificateNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String &ndash; up to 10 characters)</p>\n        <p>If required by customs at the destination, the number of the government/agency certificate or permit.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>licenseNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String &ndash; up to 10 characters)</p>\n        <p>If required by customs at the destination, the number of the government/agency import or export licence.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>invoiceNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String &ndash; up to 10 characters)</p>\n        <p>If required by customs at the destination, the commercial invoice number.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>iossId</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String up to 13 characters)</p>\n        <p>Optional field to enter Tax Registration Numbers or IDs (e.g. Tax ID, IRS No., VAT, IOSS number) for electronic transmission to the&nbsp;receiving post. Note: IOSS should be entered as IMxxxxxxxxxx.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>skuList</p>\n      </td>\n      <td>\n        <p>Array of Objects</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Required if the corresponding customs parent field exists.</p>\n        <p>Contains the list of unique types of items that are contained within this shipment, as well as information about them. Each item type may have a quantity of 1 or more. This information is printed on the manifest label to assist with processing of the parcel at customs.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsNumberOfUnits</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of four digits e.g. 9999)</p>\n        <p>Required if the corresponding parent field \"item\" exists.</p>\n        <p>The number of units in the parcel.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsUnitOfMeasure</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Three-character ISO code)</p>\n        <p>Identifies the unit of measure for the customsNumberOfUnits.</p>\n        <ul>\n          <li>PCE &ndash; Piece</li>\n          <li>NMB &ndash; Number</li>\n          <li>PAR &ndash; Pair</li>\n          <li>PKG &ndash; Package</li>\n          <li>ENV &ndash; Envelope</li>\n          <li>LTR &ndash; Litre</li>\n          <li>MLT &ndash; Millilitre</li>\n          <li>BOX &ndash; Box</li>\n          <li>BAG &ndash; Bag</li>\n          <li>MTR &ndash; Metre</li>\n          <li>MMT &ndash; Millimetre</li>\n          <li>DZN &ndash; Dozen</li>\n          <li>GRM &ndash; Gram</li>\n          <li>KGM &ndash; Kilogram</li>\n          <li>CTN &ndash; Carton</li>\n          <li>BIN &ndash; Bin</li>\n          <li>SET &ndash; Number of sets</li>\n          <li>BOT &ndash; Bottle</li>\n          <li>TBE &ndash; Tube</li>\n          <li>KIT &ndash; Kit</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsDescription</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - up to 45 characters)</p>\n        <p>Required if the corresponding parent field \"item\" exists.</p>\n        <p>A customs description of the item.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>sku</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 15 characters)</p>\n        <p>A customs sku number or sku name for the item</p>\n        <p><strong>Note:</strong> Version 6 only permits up to 15 characters. Previous versions allow up to 44 characters, but data will be truncated at 15 characters. The length limitations are necessary to comply with international customs regulations.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>hsTariffCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Numeric field of the general form 9999.99.99.99)</p>\n        <p>Pattern is \\d{4}(\\.\\d{2}(\\.\\d{2}(\\.\\d{2})?)?)?</p>\n        <p>The tariff code for the item.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>unitWeight</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 2.3 e.g. 99.999)</p>\n        <p>Required if the corresponding parent field \"item\" exists.</p>\n        <p>The unit weight of the item in kg.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsValuePerUnit</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Numeric field of pattern 5.2 e.g. 99999.99)</p>\n        <p>Required if the corresponding parent field \"item\" exists.</p>\n        <p>The value per unit in Canadian currency of the item.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryOfOrigin</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(2-character valid country code)</p>\n        <p>The country of origin of the corresponding item. Provide this if the corresponding parent field \"item\" exists (and if the country of origin is known).</p>\n        <p>If the country of origin is not known, the field can be omitted.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provinceOfOrigin</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(2-character valid province code)</p>\n        <p>Required if country of origin is Canada.</p>\n        <p>The province of origin of the goods.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>settlementInfo</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>This structure contains the customer details for settlement of payment.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>paidByCustomer</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(10-digit numeric)</p>\n        <p>paidByCustomer numbers are 10 digits. If the number you provide has fewer than 10 digits, the system will add leading zeros to increase the length to 10.</p>\n        <p>The customer number of the customer who will be billed for the shipment. This is typically the same as the \"mailed on behalf of\" customer unless a Central Payer relationship has been identified to Canada Post. If it is not supplied, it defaults to mailed-on-behalf-of.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>contractId</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(10-digit numeric)</p>\n        <p>contract ID numbers are 10 digits. If the number you provide has fewer than 10 digits, the system will add leading zeros to increase the length to 10.</p>\n        <p>Required to identify contract discounts if the intended method of payment is Account.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>cifShipment</td>\n      <td>Boolean</td>\n      <td>optional</td>\n      <td>\n        <p>{true}</p>\n        <p>If you have shipments that originate outside of Canada, but are being delivered directly to a Canada Post plant, use this field to identify these shipments as continuous inbound freight (CIF). This option allows you to be eligible for Canadian sales tax exemptions. You will need to provide Canada Post with documentation that shows proof of origin, such as a Canadian customs document or bill of lading.</p>\n        <p>Only provide this parameter when the shipment is CIF (i.e. do not provide when false).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>intendedMethodOfPayment</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>Character String &ndash; up to 15 characters</p>\n        <p>This field indicates the customer&rsquo;s method of payment for a shipment where no manifest is required (transmitShipments=true), or the intended method of payment otherwise (the actual method of payment being in the subsequent Transmit Shipments).</p>\n        <p>Valid values for intendedMethodOfPayment are:</p>\n        <ul>\n          <li>CreditCard = the payment will be by credit card. This must be saved and defaulted on your Canada Post profile.</li>\n          <li>Account = the payment will be by an existing contract with the paidByCustomer.</li>\n          <li>SupplierAccount = the payment will be through the Supplier Account specified in preAuthorizedPayment&nbsp;or identified as default in the customer profile (only available to Supplier Account providers).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>promoCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Character String &ndash; up to 10 characters.</p>\n        <p>Promotional discount code. Note that a promotion code is only valid for a certain period and product.</p>\n        <p>Your entry will be converted to uppercase (i.e, you can use lowercase or a mix of lower or upper case and will get the same result).</p>\n        <p><strong>Note:</strong> Promotion Code DEVPROTEST can be used to test this functionality in the sandbox environment. This promo code is only valid in the sandbox environment and for the following products:</p>\n        <ul>\n          <li>Xpresspost (DOM.XP)</li>\n          <li>Xpresspost International (INT.XP)</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnSpec</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Contains the return delivery request details, including return recipient, labelCount, serviceCode and referenceIds. If this field is absent, no return shipping label is required.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>serviceCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 32 characters)</p>\n        <p>Must be a valid code representing the Canada Post delivery service used for shipping the item. The most frequently used codes are listed below.</p>\n        <table>\n          <thead>\n            <tr>\n              <th>Service Code</th>\n              <th>Description</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <td>DOM.RP</td>\n              <td>Regular Parcel</td>\n            </tr>\n            <tr>\n              <td>DOM.EP</td>\n              <td>Expedited Parcel</td>\n            </tr>\n            <tr>\n              <td>DOM.XP</td>\n              <td>Xpresspost</td>\n            </tr>\n            <tr>\n              <td>DOM.PC</td>\n              <td>Priority</td>\n            </tr>\n            <tr>\n              <td>DOM.LIB</td>\n              <td>Library Books</td>\n            </tr>\n          </tbody>\n        </table>\n        <p>(Note - These delivery services and their codes can be discovered by calling the Get Rates and Discover Services web services described in <a href=\"../../../api/overview/rating\">Rating</a>)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnRecipient</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>Required if the corresponding parent field \"returnSpec&rdquo; exists.</p>\n        <p>The returnRecipient structure provides the shipping details (e.g. address) for the return delivery as it shows on the return label.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Contact name of the returnRecipient.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Company name of the returnRecipient.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>Required if the parent field returnRecipient exists (based on whether you have specified the need for a return address)</p>\n        <p>Contains the address data about returnRecipient.</p>\n        <p>Blank fields will be removed in address fields for formatting the labels.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Address line 1 of returnRecipient.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 44 characters)</p>\n        <p>Address line 2 of returnRecipient.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - up to 40 characters)</p>\n        <p>City of returnRecipient.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>(Character String - up to 20 characters)</p>\n        <p>Province of codRemittance.</p>\n        <p>Use standard Canadian province code.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Conditionally Required</td>\n      <td>\n        <p>6-character alphanumeric Canadian Postal Code for the returnRecipient address.</p>\n        <p>(A9A9A9)<br>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnNotification</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>(Character String - up to 60 characters)</p>\n        <p>Pattern is (['_A-Za-z0-9\\-\\+]+)(\\.['_A-Za-z0-9\\-\\+]+)*@([A-Za-z0-9-]+)(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,5})</p>\n        <p>The email address that an onDelivery notification will be sent to when the return shipment is delivered.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>preAuthorizedPayment</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>Optional</td>\n      <td>\n        <p>Supplier Account providers can pre-authorize payment using the Supplier Account of their customer.</p>\n        <p><strong>Important:</strong> This functionality can only be used by Canada Post approved Supplier Account providers, and only on a shipment where no manifest is required.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>accountNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character string &ndash; up to 16 characters)</p>\n        <p>The account number from which the amount will be withdrawn; will be used for reconciliation.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>authCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>(Character string &ndash; up to 16 characters)</p>\n        <p>The authorization code from the supplier; will be used for reconciliation.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>authTimestamp</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>The authorization date and time; will be used for reconciliation.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>chargeAmount</p>\n      </td>\n      <td>\n        <p>Number</p>\n      </td>\n      <td>Required</td>\n      <td>\n        <p>The amount authorized in Canadian dollars; must match the total charges that will be calculated.</p>\n        <p>Format 9999999.99 (leading zeroes not required).</p>\n      </td>\n    </tr>\n  </tbody>\n</table>"
                x-ibm-languages:
                    description:
                        fr: "<p><strong>Demande &ndash; Champs</strong></p>\n<table>\n  <thead>\n    <tr>\n      <th>Nom du champ</th>\n      <th>Type</th>\n      <th>Requis/Facultatif</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>createQrCode</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>Il s'agit d'un champ facultatif, utilis&eacute; pour demander l'image de code QR de l'&eacute;tiquette publique au format base64, ainsi que contient l'URL de l'&eacute;tiquette de cl&eacute; publique et la date d'expiration.</p>\n        <p>Si c'est vrai, deux nouveaux liens sont fournis : publicLabel et publicKeyInfo.</p>\n        <p>Remarque : Applicable uniquement &agrave; 8 1/2 X 11 papier cod&eacute; en pdf</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>createPublicKey</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>Il s'agit d&rsquo;un champ facultatif, utilis&eacute; pour demander l'URL de l'&eacute;tiquette de cl&eacute; publique et la date d'expiration.</p>\n        <p>Si c'est vrai, deux nouveaux liens sont fournis : publicLabel et publicKeyInfo</p>\n        <p>Remarque : Applicable uniquement &agrave; 8 1/2 X 11 papier cod&eacute; en pdf</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customerRequestId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu&rsquo;&agrave; 35 caract&egrave;res)</p>\n        <p>Un num&eacute;ro d&rsquo;identification unique que vous pouvez d&eacute;finir pour cet envoi. Il doit &ecirc;tre unique ou la demande sera rejet&eacute;e.</p>\n        <p>Les fournisseurs de compte de fournisseur doivent utiliser ce champ pour indiquer un num&eacute;ro d&rsquo;identification unique pour tout envoi associ&eacute; &agrave; une demande de paiement pr&eacute;autoris&eacute;.</p>\n        <p>Vous pouvez &eacute;galement utiliser ce num&eacute;ro d&rsquo;identification pour r&eacute;cup&eacute;rer les d&eacute;tails relatifs &agrave; l&rsquo;envoi, tels que l&rsquo;&eacute;tiquette, sans avoir &agrave; fournir d&rsquo;information dans la r&eacute;ponse &laquo; Cr&eacute;er l&rsquo;envoi &raquo;. Au lieu de cela, il suffit d&rsquo;utiliser ce num&eacute;ro d&rsquo;identification dans les demandes Obtenir l&rsquo;envoi.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>groupId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 32 caract&egrave;res)</p>\n        <p>Ce champ&nbsp;correspond au num&eacute;ro d'identification du groupe (ou au nom du groupe) dans lequel il faut placer l'envoi cr&eacute;&eacute;. Le groupe sera cr&eacute;&eacute; par le service de Postes Canada s'il n'existe pas.</p>\n        <p>Le champ groupId est requis, &agrave; moins que le champ transmitShipment soit fourni; dans un tel cas, le champ groupId ne doit par &ecirc;tre fourni.</p>\n        <p>Il ne faut pas cr&eacute;er un groupe unique pour chaque envoi individuel. Un groupId a pour but&nbsp;de regrouper plusieurs envois ensemble afin de les inclure sur le m&ecirc;me manifeste. Par exemple, le regroupement est utile dans les sc&eacute;narios suivants :</p>\n        <ul>\n          <li>Vous avez plusieurs emplacements de service.</li>\n          <li>Vous souhaitez que tous les envois dans un groupe soient exp&eacute;di&eacute;s le m&ecirc;me jour.</li>\n          <li>Vous voulez regrouper les envois ensemble aux fins de r&eacute;f&eacute;rence interne ou de facturation.</li>\n        </ul>\n        <p><strong>Remarque :</strong> Les envois du r&eacute;gime int&eacute;rieur, &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime international seront plac&eacute;s sur des manifestes s&eacute;par&eacute;s, m&ecirc;me s'ils contiennent le m&ecirc;me groupId.</p>\n        <p><strong>Limites du rendement</strong><br>Afin d'&eacute;viter un d&eacute;lai de temporisation de nos serveurs, veuillez suivre ces recommandations :</p>\n        <ul>\n          <li>Ne pas inclure plus de 30 groupes par manifeste (p. ex. un maximum de 30 groupIds dans une seule demande de service Transmettre les envois).</li>\n          <li>Ne pas placer plus de 5 000 envois dans un groupe.</li>\n        </ul>\n        <p><strong>Limites du syst&egrave;me</strong><br>Pour &eacute;viter une erreur, veuillez ne pas d&eacute;passer les limites suivantes avant d'effectuer une demande de service Transmettre les envois :</p>\n        <ul>\n          <li>Maximum de 50 groupes par manifeste (erreur 9109 si la limite est d&eacute;pass&eacute;e).</li>\n          <li>Maximum de 10 000 envois dans un groupe (erreur 9110 si la limite est d&eacute;pass&eacute;e).</li>\n          <li>Maximum de 10 000 envois dans l'ensemble de plusieurs groupes (erreur 9108 si la limite est d&eacute;pass&eacute;e).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>transmitShipment</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{true}</p>\n        <p>Fait partie de shipment.</p>\n        <p>Ce champ d&eacute;signe un envoi pour lequel un manifeste n'est pas requis &agrave; titre de preuve de paiement. Cet envoi sera transmis imm&eacute;diatement et une demande de service &laquo; Transmettre les envois &raquo; n'est pas requise.</p>\n        <p>Utilisez ce champ si vous exp&eacute;diez moins de 50 colis par jour &agrave; partir de diff&eacute;rents endroits &agrave; l'aide de l'un des mod&egrave;les op&eacute;rationnels ci-dessous.</p>\n        <ul>\n          <li>Exp&eacute;dition de consommateur &agrave; consommateur (p. ex. sites Web de vente aux ench&egrave;res en ligne)</li>\n          <li>Gestion de la distribution des commandes</li>\n          <li>Livraison directe par une tierce partie</li>\n        </ul>\n        <p>Lorsque ce champ est r&eacute;gl&eacute; &agrave; &laquo; Vrai &raquo;, la facturation sera effectu&eacute;e imm&eacute;diatement apr&egrave;s la pr&eacute;sentation d'une demande de cr&eacute;ation d'un envoi. Votre envoi ne peut pas &ecirc;tre annul&eacute;.</p>\n        <p><strong>Important :</strong> Si vous utilisez les proc&eacute;d&eacute;s traditionnels li&eacute;s &agrave; l'exp&eacute;dition avec convention et aux manifestes (p. ex. si vous exp&eacute;diez plus de 50 colis par jour &agrave; partir d'un entrep&ocirc;t central), ce proc&eacute;d&eacute; ne vous convient pas. Vous devez continuer &agrave; utiliser le proc&eacute;d&eacute; habituel li&eacute; aux manifestes. Le non-respect de cette consigne entra&icirc;nera le refus de votre envoi jusqu'&agrave; ce que vous produisiez les manifestes requis.</p>\n        <p>Si vous &ecirc;tes un client des services d&rsquo;exp&eacute;dition sans convention qui utilise des services Web d&rsquo;exp&eacute;dition avec convention, vous devez fournir ce champ.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>quickshipLabelRequested</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{true}</p>\n        <p>Utilisez ce champ si vous avez d&eacute;j&agrave; un colis du r&eacute;gime int&eacute;rieur indiquant le nom et l'adresse du destinataire, mais que vous voulez cr&eacute;er une &eacute;tiquette suppl&eacute;mentaire aux fins de suivi.</p>\n        <p>R&eacute;glez ce champ &agrave; &laquo; true &raquo; et, &agrave; des fins de facturation, fournissez le code du pays (doit &ecirc;tre CA) et le code postal dans la structure de destination. Une &eacute;tiquette comprenant un code &agrave; barres de rep&eacute;rage et la mention &laquo; Quick Ship &ndash; Refer to Address Label/Exp&eacute;dition rapide &ndash; Reportez-vous &agrave; l&rsquo;&eacute;tiquette d&rsquo;adresse &raquo; sera cr&eacute;&eacute;e.</p>\n        <p>Fournissez uniquement ce param&egrave;tre lorsque vous souhaitez cr&eacute;er une &eacute;tiquette d'exp&eacute;dition rapide (ne fournissez pas ce param&egrave;tre lorsque le champ est r&eacute;gl&eacute; &agrave; &laquo; false &raquo;).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>requestedShippingPoint</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de six caract&egrave;res alphanum&eacute;riques)</p>\n        <p>Doit &ecirc;tre dans un format de code postal valide.</p>\n        <p>Exemple : A9A9A9</p>\n        <p>Le format est &laquo; [A-Z]\\d[A-Z]\\d[A-Z]\\d &raquo;.</p>\n        <p>Il s'agit du code postal de l'emplacement o&ugrave; vos envois sont ramass&eacute;s. Le code postal fourni est utilis&eacute; aux fins de tarification.</p>\n        <p>Si vous d&eacute;posez vous-m&ecirc;me vos envois, vous avez deux choix :</p>\n        <ul>\n          <li>ne pas r&eacute;gler ce champ, et indiquer le num&eacute;ro d'identification de l'emplacement d'exp&eacute;dition dans shippingPointId (option recommand&eacute;e);</li>\n          <li>fournir le code postal de votre lieu d'exp&eacute;dition ici et ne pas r&eacute;gler le champ shippingPointId.</li>\n        </ul>\n        <p><strong>Nota :</strong> L'utilisation du champ requestedShippingPoint pour indiquer le code postal de votre lieu d'exp&eacute;dition ne sera plus possible dans une version future. Si vous d&eacute;posez vous-m&ecirc;me vos envois, nous vous recommandons d'utiliser le champ shippingPointId.</p>\n        <p>Ce champ est obligatoire lorsque l'indicateur de ramassage de la SCP (cpcPickupIndicator) est fourni.</p>\n        <p>Option s'excluant mutuellement avec le champ shippingPointId; cependant, l'une des deux doit &ecirc;tre saisie.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>cpcPickupIndicator</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(true)</p>\n        <p>R&eacute;glez ce champ &agrave; &laquo; true &raquo; si vos envois sont ramass&eacute;s par Postes Canada ou par une tierce partie. Fournissez le code postal de votre lieu de ramassage dans le champ requestedShippingPoint.</p>\n        <p>Ne fournissez pas ce renseignement si vous d&eacute;posez vous-m&ecirc;me vos envois.</p>\n        <p>Option s'excluant mutuellement avec le champ shippingPointId.</p>\n        <p>Vous devez aussi r&eacute;gler ce champ &agrave; &laquo; true &raquo; dans votre demande Transmettre les envois.</p>\n        <p><strong>Nota :</strong> Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramass&eacute; par Postes Canada (en fournissant &agrave; la fois cet indicateur et le champ requestedShippingPoint) ou d&eacute;pos&eacute; &agrave; un emplacement de Postes Canada (en fournissant le champ shippingPointId).</p>\n        <p>Nous vous recommandons de vous pr&eacute;parer &agrave; ce changement en offrant cet indicateur (et le champ requestedShippingPoint) si votre envoi est ramass&eacute; par Postes Canada.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>shippingPointId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de quatre caract&egrave;res alphanum&eacute;riques)</p>\n        <p>Si vous d&eacute;posez vos articles &agrave; un bureau de poste ou &agrave; une autre installation de Postes Canada, fournissez le num&eacute;ro d'emplacement de ce lieu de d&eacute;p&ocirc;t. Recherchez le num&eacute;ro d'emplacement en question &agrave; l'aide de la fonction <a href=\"https://www.canadapost-postescanada.ca/information/app/fdl/entreprise/trouverunlieudedepot\">Trouver un lieu de d&eacute;p&ocirc;t</a>. Cette information est utilis&eacute;e pour la tarification.</p>\n        <p>Vous devrez aussi fournir de nouveau le num&eacute;ro d'identification du lieu d'exp&eacute;dition (requestedShippingPoint)&nbsp;dans votre demande de service Transmettre les envois. Si vous n'entrez pas le m&ecirc;me num&eacute;ro d'emplacement, des ajustements tarifaires peuvent s'imposer.</p>\n        <p>Option s'excluant mutuellement avec l'option requestedShippingPoint; cependant, l'une des deux doit &ecirc;tre saisie.</p>\n        <p><strong>Nota :</strong> Si vous d&eacute;posez vous-m&ecirc;me vos envois, nous vous recommandons d'utiliser ce champ plut&ocirc;t que le champ requestedShippingPoint pour indiquer votre lieu d'exp&eacute;dition.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>expectedMailingDate</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Format de la date : AAAA-MM-JJ)</p>\n        <p><strong>Nota :</strong> Vous pouvez omettre ce champ. Il sera utilis&eacute; dans une version future.</p>\n        <p>Le tarif de tous les envois est &eacute;tabli en fonction de la date d'exp&eacute;dition actuelle, puis il est rajust&eacute; au moment de la transmission (si l'envoi est transmis &agrave; une date ult&eacute;rieure).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>providePricingInfo</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{true}</p>\n        <p>Ce champ indique que vous voulez que la structure tarifaire des envois soit incluse dans la r&eacute;ponse &agrave; cette demande. Cela entra&icirc;ne une plus grande charge, mais &eacute;limine la n&eacute;cessit&eacute; de soumettre une autre demande&nbsp;Obtenir le tarif de l&rsquo;envoi.</p>\n        <p>S&rsquo;applique uniquement aux envois o&ugrave; le champ &laquo; transmitShipment &raquo; est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;.</p>\n        <p>Fournir ce param&egrave;tre uniquement si vous voulez obtenir des d&eacute;tails sur la tarification dans la r&eacute;ponse (ne pas le fournir lorsque le champ est r&eacute;gl&eacute; &agrave; &laquo; false &raquo;).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provideReceiptInfo</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{true}</p>\n        <p>Ce champ indique que vous voulez que la structure &laquo; shipmentReceipt &raquo; soit incluse dans la r&eacute;ponse &agrave; cette demande. Il en r&eacute;sulte une plus grande charge, mais cela &eacute;limine la n&eacute;cessit&eacute; de soumettre une autre demande&nbsp;Obtenir le re&ccedil;u de l&rsquo;envoi.</p>\n        <p>Ne s&rsquo;applique qu&rsquo;&agrave; un envoi o&ugrave; le champ &laquo; transmitShipment=true &raquo; est pay&eacute; par carte de cr&eacute;dit ou par compte de fournisseur.</p>\n        <p>Fournir ce param&egrave;tre uniquement si vous voulez que les d&eacute;tails du re&ccedil;u soient indiqu&eacute;s dans la r&eacute;ponse (c.-&agrave;-d. qu&rsquo;il ne faut pas le fournir lorsque le champ est r&eacute;gl&eacute; &agrave; &laquo; false &raquo;).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>deliverySpec</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Fournit une description des d&eacute;tails de la demande de livraison, y compris le destinataire, le code de service, l'exp&eacute;diteur, les options, les sp&eacute;cifications de l'envoi, les renseignements li&eacute;s &agrave; l'avis et les num&eacute;ros d'identification de r&eacute;f&eacute;rence.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>serviceCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 32 caract&egrave;res)</p>\n        <p>Doit &ecirc;tre un code valide correspondant au service de livraison de Postes Canada utilis&eacute; pour exp&eacute;dier l'article. Les codes les plus fr&eacute;quemment utilis&eacute;s sont &eacute;num&eacute;r&eacute;s ci-dessous.</p>\n        <table summary=\"Code de service\" cellspacing=\"0\">\n          <thead>\n            <tr>\n              <th>Code de service</th>\n              <th>Description</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <td>DOM.RP</td>\n              <td>Colis standard</td>\n            </tr>\n            <tr>\n              <td>DOM.EP</td>\n              <td>Colis acc&eacute;l&eacute;r&eacute;s</td>\n            </tr>\n            <tr>\n              <td>DOM.XP</td>\n              <td>Xpresspost</td>\n            </tr>\n            <tr>\n              <td>DOM.PC</td>\n              <td>Priorit&eacute;</td>\n            </tr>\n            <tr>\n              <td>DOM.LIB</td>\n              <td>Livres de biblioth&egrave;que</td>\n            </tr>\n            <tr>\n              <td>USA.EP</td>\n              <td>Colis acc&eacute;l&eacute;r&eacute;s &Eacute;.-U.</td>\n            </tr>\n            <tr>\n              <td>USA.SP.AIR</td>\n              <td>Petits paquets-avion &agrave; destination des &Eacute;.-U.</td>\n            </tr>\n            <tr>\n              <td>USA.TP</td>\n              <td>Paquet rep&eacute;rable &ndash; &Eacute;.-U.</td>\n            </tr>\n            <tr>\n              <td>USA.TP.LVM</td>\n              <td>\n                <p>Paquet rep&eacute;rable &ndash; &Eacute;.-U. (GEC)<br>(gros exp&eacute;diteur de courrier)</p>\n                <p><strong>Nota :</strong> Cette option doit figurer dans votre convention pour pouvoir &ecirc;tre utilis&eacute;e.</p>\n              </td>\n            </tr>\n            <tr>\n              <td>USA.XP</td>\n              <td>Xpresspost &Eacute;.-U.</td>\n            </tr>\n            <tr>\n              <td>INT.XP</td>\n              <td>Xpresspost &ndash; International</td>\n            </tr>\n            <tr>\n              <td>INT.IP.AIR</td>\n              <td>Colis-avion du r&eacute;gime international</td>\n            </tr>\n            <tr>\n              <td>INT.IP.SURF</td>\n              <td>Colis de surface du r&eacute;gime international</td>\n            </tr>\n            <tr>\n              <td>INT.SP.AIR</td>\n              <td>Petits paquets-avion du r&eacute;gime international</td>\n            </tr>\n            <tr>\n              <td>INT.SP.SURF</td>\n              <td>Petits paquets de surface du r&eacute;gime international</td>\n            </tr>\n            <tr>\n              <td>INT.TP</td>\n              <td>Paquet rep&eacute;rable &ndash; International</td>\n            </tr>\n          </tbody>\n        </table>\n        <p>(Nota : Les services de livraison et leurs codes peuvent &ecirc;tre obtenus en faisant appel aux services &laquo; Obtenir les tarifs &raquo; et &laquo; D&eacute;couvrir les services &raquo; d&eacute;crits dans la section <a href=\"../../../api/overview/rating\">Tarification</a>.)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>sender</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Cette structure contient des donn&eacute;es sur l'exp&eacute;diteur correspondant &agrave; l'adresse de l'exp&eacute;diteur figurant sur l'&eacute;tiquette. Les champs vides seront retir&eacute;s pendant le formatage des adresses.</p>\n        <p><strong>Remarque :</strong> l&rsquo;adresse de l&rsquo;exp&eacute;diteur doit &ecirc;tre du r&eacute;gime int&eacute;rieur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom de l'exp&eacute;diteur avec qui il faut communiquer.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom de l'entreprise de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>contactPhone</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 25 caract&egrave;res)</p>\n        <p>Num&eacute;ro de t&eacute;l&eacute;phone de l'exp&eacute;diteur avec qui il faut communiquer.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Contient les donn&eacute;es d'adressage de l'exp&eacute;diteur. Les champs d'adresse vides seront retir&eacute;s pendant le formatage des &eacute;tiquettes.</p>\n        <p><strong>Remarque :</strong> l&rsquo;adresse de l&rsquo;exp&eacute;diteur doit &ecirc;tre du r&eacute;gime int&eacute;rieur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Adresse de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Ligne d'adresse 2 de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 40 caract&egrave;res)</p>\n        <p>Ville de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 20 caract&egrave;res)</p>\n        <p>Province de l'exp&eacute;diteur.</p>\n        <p>Utilisez les codes standards des provinces canadiennes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Code de pays valide &agrave; deux caract&egrave;res)</p>\n        <p>Code de pays de l'exp&eacute;diteur. Doit &ecirc;tre CA.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Six caract&egrave;res alphanum&eacute;riques)</p>\n        <p>Code postal de l'exp&eacute;diteur.</p>\n        <p>Format [A-Z]\\d[A-Z]\\d[A-Z]\\d</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>destination</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Ce champ doit toujours contenir l'adresse du destinataire du courrier, et ce, m&ecirc;me si vous utilisez l'option &laquo; Livrer au bureau de poste &raquo;.</p>\n        <ul>\n          <li>Pour les envois r&eacute;guliers, ces donn&eacute;es s'afficheront dans l'adresse de destination figurant sur l'&eacute;tiquette.</li>\n          <li>Pour les envois assortis de l'option &laquo; Livrer au bureau de poste &raquo;, le syst&egrave;me remplacera l'adresse du bureau de poste sur l'&eacute;tiquette.</li>\n          <li>Pour les envois d'exp&eacute;dition rapide (quickshipLabelRequested = true), le champ est seulement utilis&eacute; aux fins de tarification, et seuls les champs de destination countryCode (CA) et postalCode doivent &ecirc;tre fournis.</li>\n        </ul>\n        <p>Les champs&nbsp;vides seront retir&eacute;s pendant le formatage des adresses.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom du destinataire avec qui il faut communiquer.</p>\n        <p>Si l'option &laquo; Livrer au bureau de poste &raquo; est s&eacute;lectionn&eacute;e, le champ &laquo; name &raquo; doit &ecirc;tre pr&eacute;cis&eacute; pour la destination.</p>\n        <p>N'est pas requis lorsque quickshipLabelRequested est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;.</p>\n        <p>Si l'exp&eacute;dition se fait &agrave; l'ext&eacute;rieur du Canada, au moins un des champs &laquo; name &raquo; ou &laquo; company &raquo; est requis pour respecter les r&egrave;glements douaniers internationaux.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom de l'entreprise du destinataire.</p>\n        <p>Si l'exp&eacute;dition se fait &agrave; l'ext&eacute;rieur du Canada, au moins un des champs &laquo; name &raquo; ou &laquo; company &raquo; est requis pour respecter les r&egrave;glements douaniers internationaux.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>additionalAddressInfo</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Donn&eacute;es d'adressage suppl&eacute;mentaires pour la destination.</p>\n        <p>Ces renseignements sont imprim&eacute;s directement au-dessus de la ligne d'adresse 1 sur l'&eacute;tiquette d'exp&eacute;dition.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>clientVoiceNumber</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 25 caract&egrave;res)</p>\n        <p>Num&eacute;ro de t&eacute;l&eacute;phone du destinataire. Il n'est pas requis pour les envois du r&eacute;gime int&eacute;rieur, sauf si l'option &laquo; Livrer au bureau de poste &raquo; a &eacute;t&eacute; s&eacute;lectionn&eacute;e.</p>\n        <p><strong>Remarque :</strong> En plus des chiffres, les caract&egrave;res suivants sont accept&eacute;s dans ce champ :</p>\n        <ul>\n          <li>Un symbole d&rsquo;addition (+), mais seulement tout au d&eacute;but de la cha&icirc;ne de caract&egrave;res.</li>\n          <li>Un point (.), un tiret (-), des parenth&egrave;ses ou une espace suivie d&rsquo;un &laquo; x &raquo; ou d&rsquo;un &laquo; p &raquo; pour indiquer un num&eacute;ro de poste.</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Contient les donn&eacute;es d'adressage li&eacute;es &agrave; la destination de l'envoi. Les champs vides seront retir&eacute;s pendant le formatage des &eacute;tiquettes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Adresse de l'exp&eacute;diteur.</p>\n        <p>N'est pas requis lorsque quickshipLabelRequested est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;; obligatoire sinon.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Ligne d'adresse 2 de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 40 caract&egrave;res)</p>\n        <p>Ville de destination.</p>\n        <p>Optionnel pour les envois du r&eacute;gime international. Requis pour les envois &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime int&eacute;rieur.</p>\n        <p>N'est pas requis lorsque quickshipLabelRequested est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 20 caract&egrave;res)</p>\n        <p>Province ou &Eacute;tat de l'exp&eacute;diteur.</p>\n        <p>Il faut utiliser l'un des codes suivants :</p>\n        <ul>\n          <li>Code de province standard pour les provinces au Canada</li>\n          <li>Code d'&eacute;tat standard pour les &Eacute;tats am&eacute;ricains</li>\n          <li>Format non structur&eacute; pour les &Eacute;tats et les provinces des autres pays</li>\n        </ul>\n        <p>Optionnel pour les envois du r&eacute;gime international. Requis pour les envois &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime int&eacute;rieur. (Sauf lorsque quickshipLabelRequested est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;.)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Code de pays valide &agrave; deux caract&egrave;res)</p>\n        <p>Code&nbsp;de pays pour la destination.</p>\n        <p>Doit &ecirc;tre CA lorsque le champ quickshipLabelRequested est r&eacute;gl&eacute; &agrave; &laquo; true &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>Peut &ecirc;tre l'un des champs suivants :</p>\n        <ul>\n          <li>(Six caract&egrave;res alphanum&eacute;riques pour le Canada [A9A9A9]) &ndash; <br>Format [A-Z]\\d[A-Z]\\d[A-Z]\\d</li>\n          <li>(Code num&eacute;rique &agrave; cinq chiffres ou &agrave; neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les &Eacute;tats-Unis) &ndash; <br>Format \\d{5}(-\\d{4})?</li>\n          <li>Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 14 caract&egrave;res (tout format) pour les autres pays</li>\n        </ul>\n        <p>Requis pour les pays n&eacute;cessitant un code postal ou un code ZIP (p. ex. Canada, <br>&Eacute;tats-Unis).</p>\n        <p>Code postal ou code ZIP de l'exp&eacute;diteur.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>options</p>\n      </td>\n      <td>Tableau d'objets</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient les options li&eacute;es au code du service de livraison (p. ex. couverture, CR).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne alphanum&eacute;rique &ndash; Jusqu'&agrave; 10 lettres/chiffres)</p>\n        <p>Requis si le champ parent correspondant &laquo; option &raquo; existe.</p>\n        <p>Il s'agit du code d'option indiquant l'option qui s'applique &agrave; l'envoi.</p>\n        <p>Les codes d'option valides sont les suivants :</p>\n        <p>SO &ndash; Signature<br>COV &ndash; Couverture<br>COD &ndash; Contre remboursement <br>PA18 &ndash; Preuve d'&acirc;ge requise (18 ans)<br>PA19 &ndash; Preuve d'&acirc;ge requise (19 ans)<br>PA21 &ndash; Preuve d'&acirc;ge requise (21 ans)<br>HFP &ndash; Annoncer par carte<br>DNS &ndash; Ne pas laisser en lieu s&ucirc;r<br>LAD &ndash; Laisser &agrave; la porte &ndash; Pas d'avis<br>D2PO &ndash; Livrer au bureau de poste</p>\n        <p><strong>Nota :</strong> L'option &laquo; D2PO &raquo; indique que le colis sera livr&eacute; directement &agrave; un bureau de poste proche. Les champs&nbsp;suivants sont requis pour l'option &laquo; D2PO &raquo; :</p>\n        <ul>\n          <li>name (sous destination)</li>\n          <li>clientVoiceNumber (sous destination)</li>\n          <li>notification</li>\n          <li>optionQualifier2</li>\n        </ul>\n        <p><strong>Remarque :</strong> Si vous choisissez l'option de contre remboursement (COD), l'option Annoncer par carte (HFP) ou l'option Livrer au bureau de poste (D2PO). La perception de fonds pour des envois contre remboursement est ainsi facilit&eacute;e au bureau de poste. Si aucune option n'est choisie, le syst&egrave;me s&eacute;lectionnera par d&eacute;faut l'option HFP.</p>\n        <p><strong>Codes de traitement pour la non-livraison</strong><br>(requis pour certains envois &agrave; destination des &Eacute;.-U. et du r&eacute;gime international)<br>RASE &ndash; Retourner aux frais de l'exp&eacute;diteur<br>RTS &ndash; Renvoi &agrave; l'exp&eacute;diteur<br>ABAN &ndash; Abandon</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionAmount</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de six chiffres, suivis de deux d&eacute;cimales [p. ex., format 999999.99])</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; option &raquo; existe, selon la valeur du code d'option.</p>\n        <p>Exemple : Pour l'option &laquo; COV &raquo;, il s'agit du montant de la couverture &agrave; acheter.</p>\n        <p>Pour l'option &laquo; COD &raquo;, il s'agit du montant de base pour les envois contre remboursement (les frais d'exp&eacute;dition peuvent aussi &ecirc;tre ajout&eacute;s par le syst&egrave;me, tel qu'il est d&eacute;crit ci-dessous pour le champ &laquo; optionQualifier1 &raquo;).</p>\n        <p>Ne pas fournir dans le cas des envois &agrave; destination des &Eacute;tats-Unis ou du r&eacute;gime international si vous voulez que le syst&egrave;me calcule la couverture maximale permise (voir le champ optionQualifier1 ci-dessous).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionQualifier1</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>Attribut bool&eacute;en &ndash; {vrai, faux}</p>\n        <p>Peut &ecirc;tre utilis&eacute; pour fournir un qualificatif pour les options CR ou COV.</p>\n        <p>Pour indiquer si le montant du paiement CR comprend les frais d&rsquo;exp&eacute;dition ou non :</p>\n        <ul>\n          <li>Vrai = Les frais d&rsquo;exp&eacute;dition seront ajout&eacute;s au montant CR que vous avez indiqu&eacute; dans &laquo; optionAmount &raquo;.</li>\n          <li>Faux = Le montant CR &agrave; percevoir est indiqu&eacute; dans &laquo; optionAmount &raquo;&nbsp;(c.-&agrave;-d. que les frais d&rsquo;exp&eacute;dition ne seront pas ajout&eacute;s).</li>\n        </ul>\n        <p>&Agrave; utiliser avec l&rsquo;option COV pour les envois &agrave; destination des &Eacute;tats-Unis ou du r&eacute;gime international pour indiquer que le syst&egrave;me peut appliquer le montant de la couverture maximale permise, qui devrait correspondre &agrave; la valeur totale de vos articles, jusqu&rsquo;&agrave; la limite maximale permise pour le produit et le pays en question :</p>\n        <ul>\n          <li>Vrai = Utiliser la couverture maximale permise; lorsqu&rsquo;elle est utilis&eacute;e, il n&rsquo;est pas n&eacute;cessaire de fournir &laquo; optionAmount &raquo;.</li>\n          <li>Faux (par d&eacute;faut) = Utiliser le montant de la couverture indiqu&eacute;e dans &laquo; optionAmount &raquo;.</li>\n        </ul>\n        <p>Si le qualificatif n&rsquo;est pas fourni, l&rsquo;attribut &laquo; Faux &raquo; est s&eacute;lectionn&eacute; par d&eacute;faut.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>optionQualifier2</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 12 caract&egrave;res}</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; option &raquo; existe et qu'un deuxi&egrave;me qualificatif est n&eacute;cessaire pour le code d'option.</p>\n        <p>&Agrave; l'heure actuelle, les options n&eacute;cessitant un deuxi&egrave;me qualificatif sont les suivants :</p>\n        <p class=\"indent\"><strong>Livrer au bureau de poste</strong><br>Pour l'option &laquo; Livrer au bureau de poste &raquo;, ce champ doit contenir le num&eacute;ro d'identification du bureau de poste de destination.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>parcelCharacteristics</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>D&eacute;crit les caract&eacute;ristiques du colis.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>weight</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Champ num&eacute;rique de trois chiffres, suivis de trois d&eacute;cimales [p. ex. format 999.999])</p>\n        <p>Poids total du colis en kilogrammes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>dimensions</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient les dimensions physiques du colis qui peuvent &ecirc;tre utilis&eacute;es pour d&eacute;terminer les frais d'exp&eacute;dition de fa&ccedil;on plus pr&eacute;cise.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>length</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de trois chiffres, suivis d'une d&eacute;cimale [p. ex. format 999.9])</p>\n        <p>Longueur du colis en centim&egrave;tres.</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; dimensions &raquo; existe.</p>\n        <p>S'il est pr&eacute;cis&eacute;, un prix plus exact peut &ecirc;tre d&eacute;fini.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>width</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de trois chiffres, suivis d'une d&eacute;cimale [p. ex. format 999.9])</p>\n        <p>Largeur du colis en centim&egrave;tres.</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; dimensions &raquo; existe.</p>\n        <p>S'il est pr&eacute;cis&eacute;, un prix plus exact peut &ecirc;tre d&eacute;fini.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>height</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de trois chiffres, suivis d'une d&eacute;cimale [p. ex. format 999.9])</p>\n        <p>Hauteur du colis en centim&egrave;tres.</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; dimensions &raquo; existe.</p>\n        <p>S'il est pr&eacute;cis&eacute;, un prix plus exact peut &ecirc;tre d&eacute;fini.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>unpackaged</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si un envoi est emball&eacute; ou non. Par exemple, les pneus d'une voiture peuvent constituer un envoi non emball&eacute;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>mailingTube</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si un envoi est ins&eacute;r&eacute; dans un tube d'exp&eacute;dition (p. ex. tube contenant une affiche).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>oversized</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si le colis est surdimensionn&eacute; ou non.</p>\n        <p><strong>Nota :</strong> Si les dimensions du colis ont &eacute;t&eacute; fournies, ce champ sera donc automatiquement d&eacute;fini (comme &eacute;tant vrai ou faux) en fonction de ces dimensions (peu importe si vous ajoutez une valeur dans le champ du champ &laquo; oversized &raquo;). Toutefois, si aucune dimension n'est fournie, vous pouvez pr&eacute;ciser que le colis est surdimensionn&eacute; (ou non) &agrave; l'aide de ce champ.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>notification</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>Contient les pr&eacute;f&eacute;rences des clients quant &agrave; la fonction d'avis &eacute;lectronique pour les activit&eacute;s de suivi (p. ex. livraison).</p>\n        <p>Ce champ est requis si l'option &laquo; Livrer au bureau de poste &raquo; (D2PO) a &eacute;t&eacute; s&eacute;lectionn&eacute;e. Pour la livraison au bureau de poste, le courriel d&eacute;sign&eacute; dans le champ &laquo; notification &raquo; sera utilis&eacute; pour aviser le client qu'il peut ramasser son colis.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>email</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 60 caract&egrave;res)</p>\n        <p>Il doit s'agir d'une adresse &eacute;lectronique valide.</p>\n        <p>Le format est (['_A-Za-z0-9\\-\\+])(\\.['_A-Za-z0-9\\-\\+])@([A-Za-z0-9-])(\\.[A-Za-z0-9-])(\\.[A-Za-z]{2,}).</p>\n        <p>Ce champ est obligatoire si le champ notification existe.</p>\n        <p>Adresse &eacute;lectronique pour recevoir des mises &agrave; jour de suivi automatiques</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onShipment</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Ce champ est obligatoire si le champ notification existe.</p>\n        <p>Indique si vous souhaitez recevoir un avis &eacute;lectronique concernant l'exp&eacute;dition d'un envoi.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onException</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Ce champ est obligatoire si le champ notification existe.</p>\n        <p>Indique si vous souhaitez recevoir un avis &eacute;lectronique concernant l'exp&eacute;dition d'un envoi.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>onDelivery</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Ce champ est obligatoire si le champ notification existe.</p>\n        <p>Indique si vous souhaitez recevoir un avis &eacute;lectronique concernant l'exp&eacute;dition d'un envoi.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>printPreferences</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient les pr&eacute;f&eacute;rences d'impression pour les &eacute;tiquettes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>outputFormat</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{8.5x11, 4x6}</p>\n        <p>Le format du papier ordinaire est de 8 &frac12; po sur 11 po alors que celui du papier thermosensible est de 4 po sur 6 po.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>encoding</td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Facultatif</td>\n      <td>\n        <p>{PDF, ZPL}</p>\n        <p>Servez-vous de ce champ pour pr&eacute;ciser le format de sortie pour votre &eacute;tiquette d'exp&eacute;dition : PDF ou ZPL II. Si le champ est vide, le format PDF sera s&eacute;lectionn&eacute; par d&eacute;faut.</p>\n        <p>Si vous choisissez le format ZPL, la r&eacute;ponse du service &laquo; Obtenir l'artefact &raquo; inclura un fichier contenant des commandes d'impression ZPL II. Vous devrez ensuite coder une solution ou utiliser une application afin d'envoyer les commandes directement &agrave; une imprimante thermique.</p>\n        <p>Pour les &eacute;tiquettes de format ZPL II, votre imprimante doit permettre la troncature. Utilisez notre <a href=\"../../../printing-labels\">exemple de code pour tester la capacit&eacute; de votre imprimante &agrave; tronquer du texte.</a></p>\n        <p>Le format ZPL est uniquement disponible sur du papier thermosensible, alors le champ &laquo; outputFormat &raquo;&nbsp;doit &ecirc;tre de 4 po sur 6 po.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>preferences</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Contient un certain nombre de pr&eacute;f&eacute;rences en ce qui a trait &agrave; l'impression des &eacute;tiquettes, etc.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showPackingInstructions</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si les directives d'emballage doivent &ecirc;tre inscrites sur l'&eacute;tiquette.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showPostageRate</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si le tarif postal doit &ecirc;tre inscrit sur l'&eacute;tiquette.</p>\n        <p>Ce champ est seulement requis pour les envois &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime international.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>showInsuredValue</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>{vrai, faux}</p>\n        <p>Indique si la valeur assur&eacute;e doit &ecirc;tre inscrite sur l'&eacute;tiquette.</p>\n        <p>Ce champ est seulement requis pour les envois assur&eacute;s &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime international.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>references</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient des champs de r&eacute;f&eacute;rence que vous pouvez attribuer. Vous pouvez attribuer ces autres num&eacute;ros d'identification (pouvant &ecirc;tre uniques) &agrave; l'envoi pour une raison quelconque utile pour vous.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>costCentre</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 30 caract&egrave;res)</p>\n        <p>Il s'agit d'une valeur que vous pouvez attribuer pour vos applications. La valeur que vous saisissez ici appara&icirc;tra sur votre facture et dans le courriel s&eacute;curis&eacute; PosteCS que nous utilisons pour envoyer votre facture.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customerRef1</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 35 caract&egrave;res)</p>\n        <p>Il s'agit d'une valeur d&eacute;finie par l'utilisateur disponible pour vos applications (p. ex. vous pourriez utiliser ce champ pour le num&eacute;ro d'identification d'une commande interne). La valeur que vous saisissez ici appara&icirc;tra sur l'&eacute;tiquette d'exp&eacute;dition, dans l'outil Rep&eacute;rer et, pour les clients qui sont inscrits &agrave; notre service de suivi automatis&eacute; des colis, dans votre fichier SAC.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customerRef2</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 35 caract&egrave;res)</p>\n        <p>Il s'agit d'une valeur d&eacute;finie par l'utilisateur disponible pour vos applications. La valeur que vous saisissez ici appara&icirc;tra sur l'&eacute;tiquette d'exp&eacute;dition, dans l'outil Rep&eacute;rer et, pour les clients qui sont inscrits &agrave; notre service de suivi automatis&eacute; des colis, dans votre fichier SAC.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customs</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient des renseignements qui doivent &ecirc;tre imprim&eacute;s sur l'&eacute;tiquette pour faciliter le d&eacute;douanement transfrontalier.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>usdeclarationid</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne alphanum&eacute;rique &ndash; Jusqu'&agrave; 30 lettres/chiffres)</p>\n        <p>Un ID de déclaration est requis lors de l’expédition d’articles vers les États-Unis si une clé de compte Zonos n’est pas incluse dans l’en-tête. Veuillez saisir votre ID de déclaration Zonos ici lorsqu’il est généré directement à partir de leurs API. Chaque envoi doit avoir son propre ID de déclaration.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>currency</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Trois caract&egrave;res alphab&eacute;tiques)</p>\n        <p>Il s&rsquo;agit de la devise du pays de destination. Le code de devise est converti en majuscules, s&rsquo;il ne l&rsquo;est pas d&eacute;j&agrave;. La valeur doit &ecirc;tre :</p>\n        <ul>\n          <li>&laquo; CAD &raquo; pour une devise canadienne;</li>\n          <li>&laquo; USD &raquo; pour une devise am&eacute;ricaine;</li>\n          <li>Autre code de devise ISO valide</li>\n        </ul>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; customs &raquo; existe.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>conversionFromCad</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de trois chiffres, suivis de trois d&eacute;cimales [p. ex., format 999.999])</p>\n        <p>Le taux de conversion du dollar canadien &agrave; la devise que vous avez entr&eacute;e dans le champ de devise ci-dessus; par exemple, si vous entr&eacute; les dollars am&eacute;ricains comme devise cible et que 1,00 $ CAD = 0,85 $ US, le taux de conversion est de 0,85.</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; customs &raquo; existe et si la devise n'est pas canadienne.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>reasonForExport</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Trois caract&egrave;res)</p>\n        <p>Code repr&eacute;sentant la raison de l'exportation, lequel facilite le passage transfrontalier.</p>\n        <p>Voici les codes et leurs significations :</p>\n        <p>DOC = Document<br>SAM = &Eacute;chantillon commercial<br>REP = R&eacute;paration ou garantie<br>SOG = Vente de biens<br>OTH = Autre</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; customs &raquo; existe.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>otherReason</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Minimum de 4 caract&egrave;res; maximum de 44 caract&egrave;res)</p>\n        <p>Requis si le champ &laquo; reasonForExport &raquo; est &laquo; Autre &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>dutiesAndTaxesPrepaid</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>R&eacute;serv&eacute; aux fins d'utilisation ult&eacute;rieure.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>certificateNumber</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 10 caract&egrave;res)</p>\n        <p>Si requis par les douanes du pays de destination, le num&eacute;ro du certificat ou du permis du gouvernement ou de l'organisme.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>licenseNumber</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 10 caract&egrave;res)</p>\n        <p>Si requis par les douanes du pays de destination, le num&eacute;ro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>invoiceNumber</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 10 caract&egrave;res)</p>\n        <p>Si requis par les douanes du pays de destination, le num&eacute;ro de la facture commerciale.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>iossId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 13 caract&egrave;res)</p>\n        <p>Champ facultatif pour la saisie des num&eacute;ros ou ID d&rsquo;inscription &agrave; l&rsquo;imp&ocirc;t (p. ex., ID d&rsquo;inscription &agrave; l&rsquo;imp&ocirc;t, num&eacute;ro IRS, TVA, num&eacute;ro IOSS) aux fins de transmission &eacute;lectronique au poste de r&eacute;ception. Remarque : Le num&eacute;ro IOSS doit &ecirc;tre saisi selon le format &laquo; IMxxxxxxxxxx &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>skuList</p>\n      </td>\n      <td>Tableau d'objets</td>\n      <td>Requis</td>\n      <td>\n        <p>S'il existe un champ parent douanier correspondant, ce champ est obligatoire.</p>\n        <p>Contient la liste de types d'articles uniques inclus dans cet envoi ainsi que les renseignements connexes. Une quantit&eacute; de un ou plus peut &ecirc;tre associ&eacute;e &agrave; chaque type d'article. Ces renseignements sont imprim&eacute;s sur l'&eacute;tiquette du manifeste pour faciliter le traitement du colis aux douanes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsNumberOfUnits</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de quatre chiffres [p. ex. format 9999])</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; item &raquo; existe.</p>\n        <p>Nombre d'unit&eacute;s dans le colis.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsUnitOfMeasure</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Code de pays ISO &agrave; trois caract&egrave;res)</p>\n        <p>Indique l'unit&eacute; de mesure pour le champ customsNumberOfUnits.</p>\n        <ul>\n          <li>PCE &ndash; Article</li>\n          <li>NMB &ndash; Num&eacute;ro</li>\n          <li>PAR &ndash; Paire</li>\n          <li>PKG &ndash; Paquet</li>\n          <li>ENV &ndash; Enveloppe</li>\n          <li>LTR &ndash; Litre</li>\n          <li>MLT &ndash; Millilitre</li>\n          <li>BOX &ndash; Bo&icirc;te</li>\n          <li>BAG &ndash; Sac</li>\n          <li>MTR &ndash; M&egrave;tre</li>\n          <li>MMT &ndash; Millim&egrave;tre</li>\n          <li>DZN &ndash; Douzaine</li>\n          <li>GRM &ndash; Gramme</li>\n          <li>KGM &ndash; Kilogramme</li>\n          <li>CTN &ndash; Carton</li>\n          <li>BIN &ndash; Bac</li>\n          <li>SET &ndash; Nombre de s&eacute;ries</li>\n          <li>BOT &ndash; Bouteille</li>\n          <li>TBE &ndash; Tube</li>\n          <li>KIT &ndash; Trousse</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsDescription</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 45 caract&egrave;res)</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; item &raquo; existe.</p>\n        <p>Description pour douanes de l'article.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>sku</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 15 caract&egrave;res)</p>\n        <p>Nom ou num&eacute;ro de l'article aux fins de d&eacute;douanement</p>\n        <p><strong>Nota :</strong> La version 6 permet seulement un maximum de 15 caract&egrave;res. Les versions pr&eacute;c&eacute;dentes permettent un maximum de 44 caract&egrave;res, mais les donn&eacute;es seront tronqu&eacute;es en 15 caract&egrave;res. Les limites de longueur sont n&eacute;cessaires &agrave; des fins de conformit&eacute; aux r&egrave;glements douaniers internationaux.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>hsTariffCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Champ num&eacute;rique de format g&eacute;n&eacute;ral 9999.99.99.99)</p>\n        <p>Le format est \\d{4}(\\.\\d{2}(\\.\\d{2}(\\.\\d{2})?)?)?.</p>\n        <p>Code de tarification de l'article.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>unitWeight</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de deux chiffres, suivis de trois d&eacute;cimales [p. ex. format 99.999])</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; item &raquo; existe.</p>\n        <p>Poids unitaire de l'article en kilogrammes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>customsValuePerUnit</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Champ num&eacute;rique de cinq chiffres, suivis de deux d&eacute;cimales [p. ex. format 99999.99])</p>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; item &raquo; existe.</p>\n        <p>Valeur unitaire de l'article en devise canadienne.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryOfOrigin</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Code de pays valide &agrave; deux caract&egrave;res)</p>\n        <p>Pays d'origine de l'article correspondant. Il faut indiquer ce code si le champ&nbsp;parent correspondant &laquo; item &raquo; existe (et si le pays d'origine est connu).</p>\n        <p>Si le pays d'origine n'est pas connu, le champ peut &ecirc;tre omis.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provinceOfOrigin</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Code de province valide &agrave; deux caract&egrave;res)</p>\n        <p>Requis si le pays d'origine est le Canada.</p>\n        <p>Province d'origine des biens.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>settlementInfo</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Cette structure comprend les d&eacute;tails sur le client pour le r&egrave;glement des paiements, y compris le mode de paiement, le client et le client &laquo; Exp&eacute;di&eacute; au nom de &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>paidByCustomer</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(10 caract&egrave;res num&eacute;riques)</p>\n        <p>Les num&eacute;ros de client &laquo; Exp&eacute;di&eacute; par &raquo; comptent 10 chiffres. Si le num&eacute;ro fourni est inf&eacute;rieur &agrave; 10 chiffres, le syst&egrave;me ajoutera des z&eacute;ros au d&eacute;but jusqu'&agrave; ce qu'il y ait 10 chiffres.</p>\n        <p>Il s'agit du num&eacute;ro du client qui recevra la facture pour l'envoi. Il correspond habituellement au m&ecirc;me num&eacute;ro de client &laquo; Exp&eacute;di&eacute; au nom de &raquo;, &agrave; moins qu'une relation de payer central n'ait &eacute;t&eacute; signal&eacute;e &agrave; Postes Canada. S'il n'est pas fourni, le num&eacute;ro de client &laquo; Exp&eacute;di&eacute; au nom de &raquo; s'affiche par d&eacute;faut.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>contractId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(10 caract&egrave;res num&eacute;riques)</p>\n        <p>Les num&eacute;ros d'identification de convention comptent 10 chiffres. Si le num&eacute;ro fourni est inf&eacute;rieur &agrave; 10 chiffres, le syst&egrave;me ajoutera des z&eacute;ros au d&eacute;but jusqu'&agrave; ce qu'il y ait 10 chiffres.</p>\n        <p>Requis pour d&eacute;terminer les rabais consentis par convention si le mode de paiement voulu est &laquo; Compte &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>cifShipment</td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>{true}</p>\n        <p>Si vous avez des envois qui proviennent de l'ext&eacute;rieur du Canada, mais qui sont livr&eacute;s directement &agrave; un &eacute;tablissement de Postes Canada, servez-vous de ce champ pour indiquer que ces envois sont un acheminement continu de marchandises d'arriv&eacute;e (ACMA). Cette option vous permet d'&ecirc;tre admissible &agrave; une exemption de la taxe de vente du Canada. Vous devrez fournir &agrave; Postes Canada des documents comprenant une preuve d'origine, tels qu'un document &eacute;mis par les douanes canadiennes ou un connaissement.</p>\n        <p>Fournissez uniquement ce param&egrave;tre lorsque l'envoi est un ACMA (ne fournissez pas ce param&egrave;tre lorsque le champ est r&eacute;gl&eacute; &agrave; &laquo; false &raquo;).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>intendedMethodOfPayment</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 15 caract&egrave;res</p>\n        <p>Ce champ indique le mode de paiement du client pour un article n&rsquo;exigeant pas de manifeste (&laquo; transmitShipments=true &raquo;), ou lorsque la m&eacute;thode de paiement voulue est diff&eacute;rente (le mode de paiement est indiqu&eacute; dans la demande de service &laquo; Transmettre les envois &raquo; subs&eacute;quente).</p>\n        <p>Les valeurs valides pour le mode de paiement voulu sont les suivantes :</p>\n        <ul>\n          <li>CreditCard = Le paiement sera effectu&eacute; carte de cr&eacute;dit cela doit &ecirc;tre enregistr&eacute; et faites-en ma carte de cr&eacute;dit par d&eacute;faut.</li>\n          <li>Account = Le paiement se fera par l'entremise d'une convention en vigueur qui aura &eacute;t&eacute; conclue avec le payeur.</li>\n          <li>SupplierAccount = le paiement se fera par l&rsquo;interm&eacute;diaire du compte de fournisseur pr&eacute;cis&eacute; dans le champ &laquo; preAuthorizedPayment &raquo; ou sera d&eacute;sign&eacute; comme valeur par d&eacute;faut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>promoCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res &ndash; Jusqu&rsquo;&agrave; 10 caract&egrave;res.</p>\n        <p>Code de r&eacute;duction promotionnelle. Veuillez noter que les codes promotionnels sont uniquement valides pour une certaine p&eacute;riode et pour certains produits.</p>\n        <p>Votre bulletin de participation sera converti en majuscules (p. ex., vous pouvez utiliser des lettres minuscules ou un m&eacute;lange de minuscules et de majuscules et obtenir le m&ecirc;me r&eacute;sultat).</p>\n        <p><strong>Remarque :</strong> Le code promotionnel DEVPROTEST peut &ecirc;tre utilis&eacute; pour la mise &agrave; l&rsquo;essai des fonctions dans l&rsquo;environnement &laquo; bac &agrave; sable &raquo;. Ce code promotionnel est uniquement valide dans l&rsquo;environnement &laquo; bac &agrave; sable &raquo; et pour les produits suivants :</p>\n        <ul>\n          <li>Xpresspost (DOM.XP)</li>\n          <li>Xpresspost International (INT.XP)</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnSpec</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Contient les d&eacute;tails li&eacute;s &agrave; la demande de livraison d'un envoi retourn&eacute;, y compris le destinataire de l'envoi retourn&eacute;, le nombre d'&eacute;tiquettes, le code du service et les num&eacute;ros d'identification de r&eacute;f&eacute;rence. Si ce champ est absent, aucune &eacute;tiquette d'exp&eacute;dition du Service de retour n'est requise.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>serviceCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 32 caract&egrave;res)</p>\n        <p>Doit &ecirc;tre un code valide correspondant au service de livraison de Postes Canada utilis&eacute; pour exp&eacute;dier l'article. Les codes les plus fr&eacute;quemment utilis&eacute;s sont &eacute;num&eacute;r&eacute;s ci-dessous.</p>\n        <table summary=\"Code de service\" cellspacing=\"0\">\n          <thead>\n            <tr>\n              <th>Code de service</th>\n              <th>Description</th>\n            </tr>\n          </thead>\n          <tbody>\n            <tr>\n              <td>DOM.RP</td>\n              <td>Colis standard</td>\n            </tr>\n            <tr>\n              <td>DOM.EP</td>\n              <td>Colis acc&eacute;l&eacute;r&eacute;s</td>\n            </tr>\n            <tr>\n              <td>DOM.XP</td>\n              <td>Xpresspost</td>\n            </tr>\n            <tr>\n              <td>DOM.PC</td>\n              <td>Priorit&eacute;</td>\n            </tr>\n            <tr>\n              <td>DOM.LIB</td>\n              <td>Livres de biblioth&egrave;que</td>\n            </tr>\n          </tbody>\n        </table>\n        <p>(Nota : Les services de livraison et leurs codes peuvent &ecirc;tre obtenus en faisant appel aux services &laquo; Obtenir les tarifs &raquo; et &laquo; D&eacute;couvrir les services &raquo; d&eacute;crits dans la section <a href=\"../../../api/overview/rating\">Tarification</a>.)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnRecipient</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>Requis si le champ&nbsp;parent correspondant &laquo; returnSpec &raquo; existe.</p>\n        <p>La structure du champ &laquo; returnRecipient &raquo; fournit les d&eacute;tails d'exp&eacute;dition (p. ex. adresse) pour la livraison d'un envoi retourn&eacute;, tels qu'ils figurent sur l'&eacute;tiquette du Service de retour.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>name</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom du destinataire de l'envoi retourn&eacute; avec qui il faut communiquer.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>company</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom de l'entreprise du destinataire de l'envoi retourn&eacute;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>Requis si le champ parent &laquo; returnRecipient &raquo; existe (si vous avez pr&eacute;cis&eacute; que vous avez besoin d'une adresse de retour).</p>\n        <p>Contient les donn&eacute;es d'adressage du destinataire de l'envoi retourn&eacute;.</p>\n        <p>Les champs vides seront retir&eacute;s des champs relatifs &agrave; l'adresse aux fins de formatage des &eacute;tiquettes.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Ligne d'adresse 1 du destinataire de l'envoi retourn&eacute;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Ligne d'adresse 2 du destinataire de l'envoi retourn&eacute;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 40 caract&egrave;res)</p>\n        <p>Ville du destinataire de l'envoi retourn&eacute;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 20 caract&egrave;res)</p>\n        <p>Province pour le paiement CR.</p>\n        <p>Code de province standard pour les provinces au Canada.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>Code postal canadien comptant six caract&egrave;res alphanum&eacute;riques pour l'adresse du destinataire de l'envoi retourn&eacute;.</p>\n        <p>(A9A9A9)<br>Le format est &laquo; [A-Z]\\d[A-Z]\\d[A-Z]\\d &raquo;.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>returnNotification</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 60 caract&egrave;res)</p>\n        <p>Le format est (['_A-Za-z0-9\\-\\+]+)(\\.['_A-Za-z0-9\\-\\+]+)*@([A-Za-z0-9-]+)(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,5}).</p>\n        <p>Il s'agit de l'adresse &eacute;lectronique &agrave; laquelle un avis de livraison sera envoy&eacute; lorsque les envois retourn&eacute;s seront livr&eacute;s.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>preAuthorizedPayment</p>\n      </td>\n      <td>Objet</td>\n      <td>Facultatif</td>\n      <td>\n        <p>Les fournisseurs de comptes de fournisseur peuvent pr&eacute;autoriser les paiements &agrave; l&rsquo;aide du compte de fournisseur de leurs clients.</p>\n        <p><strong>Important :</strong> Cette fonction ne peut &ecirc;tre utilis&eacute;e que par les fournisseurs de comptes de fournisseur approuv&eacute;s par Postes Canada, et ce, uniquement pour les envois n&rsquo;exigeant pas de manifeste.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>accountNumber</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu&rsquo;&agrave; 16 caract&egrave;res)</p>\n        <p>Le num&eacute;ro de compte &agrave; partir duquel le montant sera retir&eacute;; sera utilis&eacute; aux fins de rapprochement.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>authCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu&rsquo;&agrave; 16 caract&egrave;res)</p>\n        <p>Le code d&rsquo;autorisation du fournisseur; sera utilis&eacute; aux fins de rapprochement.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>authTimestamp</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>La date et l&rsquo;heure d&rsquo;autorisation; seront utilis&eacute;s aux fins de rapprochement.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>chargeAmount</p>\n      </td>\n      <td>\n        <p>Nombre</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>Le montant autoris&eacute; en dollars canadiens; doit correspondre au total des frais qui seront calcul&eacute;s.</p>\n        <p>Format 9999999,99 (les z&eacute;ros indiqu&eacute;s au d&eacute;but ne sont pas requis).</p>\n      </td>\n    </tr>\n  </tbody>\n</table>"
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/createShipmentResponse'
                            example:
                                customerRequestId: 67234562365
                                shipmentId: 1
                                shipmentStatus: created
                                trackingPin: 222222222222
                                returnTrackingPin: 333333333333
                                shipmentPrice:
                                    serviceCode: DOM.RP
                                    baseAmount: 129.99
                                    pricedOptions:
                                        -
                                            optionCode: code1
                                            optionPrice: 1.99
                                        -
                                            optionCode: code2
                                            optionPrice: 0.59
                                        -
                                            optionCode: code3
                                            optionPrice: 0.89
                                    adjustments:
                                        -
                                            adjustmentCode: code4
                                            adjustmentAmount: 2.49
                                        -
                                            adjustmentCode: code5
                                            adjustmentAmount: 0.29
                                        -
                                            adjustmentCode: code6
                                            adjustmentAmount: 0.54
                                    preTaxAmount: 109.99
                                    gstAmount: 9.99
                                    pstAmount: 8.99
                                    hstAmount: 7.99
                                    dueAmount: 169.99
                                    serviceStandard:
                                        amDelivery: false
                                        guaranteedDelivery: true
                                        expectedTransitTime: 14
                                        expectedDeliveryDate: '2011-06-30T00:00:00.000Z'
                                    ratedWeight: 10.11
                                shipmentReceipt:
                                    ccReceiptDetails:
                                        merchantName: 'Canada Post'
                                        merchantUrl: www.canadapost.ca
                                        nameOnCard: 'Joe Cardholder'
                                        authCode: 266614
                                        authTimestamp: '2012-11-24T03:17:51.000Z'
                                        cardType: MC
                                        chargeAmount: 325.8
                                        currency: CAD
                                        transactionType: Sale
                                links:
                                    -
                                        rel: self
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments/1'
                                        mediaType: application/json
                                    -
                                        rel: details
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments/1/details'
                                        mediaType: application/json
                                    -
                                        rel: group
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipment?group-id=1'
                                        mediaType: application/json
                                    -
                                        rel: price
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments/1/price'
                                        mediaType: application/json
                                    -
                                        rel: receipt
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/shipments/243821768908893284/receipt'
                                        mediaType: application/json
                                    -
                                        rel: label
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/artifacts/12746/shipping/7634654/0'
                                        mediaType: application/pdf
                                        index: 0
                                    -
                                        rel: returnLabel
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/artifacts/12746/shipping/7624572645/0'
                                        mediaType: application/pdf
                                        index: 0
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '8048', message: 'Return address must be Canadian.' }
                                            - { errorCode: '7042', description: 'The USA zip code format must be 5 numeric digits or 5 numeric digits with a dash and 4 extra digits.' }
                                            - { errorCode: '1156', message: 'Address Line 1 is a mandatory field.' }
                                            - { errorCode: '1157', message: 'City is mandatory when shipping to Canada or USA.' }
                                            - { errorCode: '1159', message: 'Province is mandatory when shipping to Canada, and State is mandatory when shipping to USA.' }
                                            - { errorCode: '1459', message: 'The Reason for Export code value is not valid (Note: As of April 2016, gift is no longer valid).' }
                                            - { errorCode: '1702', message: 'The Contract Number is not associated to the Mailed on Behalf of Customer Number in the CPC accounting system on the mailing date.' }
                                            - { errorCode: '1711', message: 'Please select a different Method of Payment. Can only be creditcard or account.' }
                                            - { errorCode: '1719', message: 'The coverage amount cannot exceed the total value of your goods, up to the maximum allowable for the product and country.' }
                                            - { errorCode: '7230', message: 'The Deliver to Post Office option is not allowed in Quick Ship mode because it requires complete recipient name and address information.' }
                                            - { errorCode: '7282', message: 'At least one of Recipient Name or Company Name is required per Customs regulations.' }
                                            - { errorCode: '7285', message: 'As you must provide a manifest when you induct Continuous Inbound Freight (CIF) shipments, you cannot set transmit-shipment to true for these shipments.' }
                                            - { errorCode: '7289', message: 'The selected service is not valid for the specified customer and/or contract.' }
                                            - { errorCode: '7311', message: 'The pre-authorized amount does not match the calculated charges.' }
                                            - { errorCode: '7312', message: 'No default Supplier Account is specified in your Canada Post profile.' }
                                            - { errorCode: '7313', message: 'Supplier Account payment can only be submitted by the account provider or an authorized user.' }
                                            - { errorCode: '7314', message: 'Request ID already exists; it must be unique when provided.' }
                                            - { errorCode: '7315', message: 'customerRequestId is mandatory on a request with pre-authorized payment.' }
                                            - { errorCode: '7316', message: 'A pre-authorized payment is only valid with transmitShipment = true and methodOfPayment = SupplierAccount.' }
                                            - { errorCode: '7317', message: 'The issuer of the default Supplier Account in your Canada Post online profile does not match the platform you are using.' }
                                            - { errorCode: '7322', message: 'The currency code is not a valid 3-digit ISO currency code (such as USD).' }
                                            - { errorCode: '9186', message: 'Only one of shippingPointId or requestedShippingPoint can be provided.' }
                                            - { errorCode: '9187', message: 'requestedShippingPoint is mandatory when cpcPickupIndicator is provided.' }
                                            - { errorCode: '9188', message: 'shippingPointId is not valid.' }
                                            - { errorCode: '9189', message: 'requestedShippingPoint and shippingPointId are mutually exclusive.' }
                                            - { errorCode: '9191', message: 'ZPL is a language for thermal printers. You can therefore only use it with 4x6 thermal paper.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '8048', message: "L'adresse de retour doit être canadienne." }
                                            - { errorCode: '7042', description: "Le format du code postal américain doit comporter 5 chiffres ou 5 chiffres suivis d'un tiret et de 4 chiffres supplémentaires." }
                                            - { errorCode: '1156', message: "La ligne 1 de l'adresse est un champ obligatoire." }
                                            - { errorCode: '1157', message: 'La ville est obligatoire pour les envois au Canada ou aux États-Unis.' }
                                            - { errorCode: '1159', message: "La province est obligatoire pour les envois au Canada, et l'État est obligatoire pour les envois aux États-Unis." }
                                            - { errorCode: '1459', message: "La valeur du code Motif de l'exportation n'est pas valide (Remarque : depuis avril 2016, les cadeaux ne sont plus valides)." }
                                            - { errorCode: '1702', message: "Le numéro de contrat n'est pas associé au numéro d'envoi pour le compte du client dans le système comptable CPC à la date d'envoi." }
                                            - { errorCode: '1711', message: 'Veuillez sélectionner un autre mode de paiement. Seuls les paiements par carte bancaire ou par compte bancaire sont acceptés.' }
                                            - { errorCode: '1719', message: 'Le montant de la couverture ne peut excéder la valeur totale de vos marchandises, dans la limite maximale autorisée pour le produit et le pays.' }
                                            - { errorCode: '7230', message: "L'option « Livraison au bureau de poste » n'est pas autorisée en mode Expédition rapide car elle nécessite le nom et l'adresse complets du destinataire." }
                                            - { errorCode: '7282', message: "Conformément à la réglementation douanière, au moins l'un des deux éléments suivants est requis : le nom du destinataire ou le nom de l'entreprise." }
                                            - { errorCode: '7285', message: 'Étant donné que vous devez fournir un manifeste lorsque vous intégrez des expéditions de fret entrant continu (CIF), vous ne pouvez pas définir transmitShipment sur true pour ces expéditions.' }
                                            - { errorCode: '7289', message: "Le service sélectionné n'est pas valable pour le client et/ou le contrat spécifié." }
                                            - { errorCode: '7311', message: 'Le montant préautorisé ne correspond pas aux frais calculés.' }
                                            - { errorCode: '7312', message: "Aucun compte fournisseur par défaut n'est spécifié dans votre profil de Postes Canada." }
                                            - { errorCode: '7313', message: 'Le paiement du compte fournisseur ne peut être effectué que par le fournisseur du compte ou un utilisateur autorisé.' }
                                            - { errorCode: '7314', message: "L'identifiant de la requête existe déjà; il doit être unique lorsqu'il est fourni." }
                                            - { errorCode: '7315', message: "L'identifiant de requête client (customerRequestId) est obligatoire pour une demande avec paiement préautorisé." }
                                            - { errorCode: '7316', message: "Un paiement préautorisé n'est valable que si transmitShipment = true et methodOfPayment = SupplierAccount." }
                                            - { errorCode: '7317', message: 'L’émetteur du compte fournisseur par défaut de votre profil en ligne de Postes Canada ne correspond pas à la plateforme que vous utilisez.' }
                                            - { errorCode: '7322', message: "Le code de devise n'est pas un code de devise ISO à 3 chiffres valide (tel que USD)." }
                                            - { errorCode: '9186', message: "Seul l'un des deux, shippingPointId ou requestedShippingPoint, peut être fourni." }
                                            - { errorCode: '9187', message: "Le point d'expédition demandé est obligatoire lorsque l'indicateur de prise en charge CPC est fourni." }
                                            - { errorCode: '9188', message: "L'identifiant du point d'expédition n'est pas valide." }
                                            - { errorCode: '9189', message: 'Les champs requestedShippingPoint et shippingPointId sont mutuellement exclusifs.' }
                                            - { errorCode: '9191', message: "ZPL est un langage destiné aux imprimantes thermiques. Il ne peut donc être utilisé qu'avec du papier thermique 4x6." }
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                412:
                    $ref: '#/components/responses/412'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: PostShipment
            tags:
                - Shipping
            summary: 'Create Shipment'
            description: 'Creates a new shipment including the shipping label image, links and shipment details.'
            x-ibm-languages:
                summary:
                    fr: 'Créer un envoi'
                description:
                    fr: "Créer un nouvel envoi, y compris l'image de l'étiquette d'expédition, les liens et les détails associés."
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/language'
                -
                    name: no-manifest
                    in: query
                    description: 'Shipments where no manifest is required, which require you to pass a {no-manifest=true} parameter to identify this type of request.'
                    x-ibm-languages:
                        description:
                            fr: "Il s'agit d'envois pour lesquels un manifeste n'est pas requis, ce qui exige que vous passiez le paramètre {no-manifest=true} pour désigner ce type de requête."
                    schema:
                        type: boolean
                    example: true
                -
                    name: date
                    in: query
                    description: 'The date from which you want the search to start for shipments sent with no manifest required. Defaults to current date if not present. Format: YYYYMMDD'
                    x-ibm-languages:
                        description:
                            fr: "La date à partir de laquelle vous voulez que la recherche commence pour les envois pour lesquels un manifeste n'est pas requis. La date du jour s'affiche par défaut si l'élément n'est pas présent. Format : AAAAMMJJ"
                    schema:
                        type: string
                        pattern: '^\d{8}$'
                    example: 20231026
                -
                    name: limit
                    in: query
                    description: "The maximum number of links to include in response, from most recent to oldest. (e.g.; limit=1 would return only the most recent shipment).\n\nDefaults to 100 when parameter is not supplied. Limited to 99,999 if a number larger than that value is supplied."
                    x-ibm-languages:
                        description:
                            fr: "Le nombre maximal de liens à inclure dans la réponse, du plus récent au plus ancien. (p. ex. limit=1 affichera uniquement l'envoi le plus récent).\n\nLe nombre par défaut est « 100 » si le paramètre n'est pas fourni. Ce nombre est limité à 99 999 si un nombre plus grand que cette valeur est fourni."
                    schema:
                        type: integer
                        minimum: 1
                        maximum: 99999
                        default: 100
                    example: 10
                -
                    name: request-id
                    in: query
                    description: 'The customer-provided request ID of the shipment for which information is being requested.'
                    x-ibm-languages:
                        description:
                            fr: "Le numéro de demande du client associé à l'envoi pour lequel des renseignements sont demandés."
                    schema:
                        type: string
                        maxLength: 32
                    example: 412011698382821250
                -
                    name: tracking-pin
                    in: query
                    description: "The tracking ID of the existing shipment for which information is being requested.\n\n**Note:**\n\n- As Small Packet shipments do not have a tracking-pin, you must search for them using the other search parameters.</p>\n- In the sandbox (development) environment,the same tracking PIN is always returned (123456789012), so this query would not return representative results in that environment."
                    x-ibm-languages:
                        description:
                            fr: "NIP de repérage de l'envoi existant pour lequel les renseignements sont demandés.\n\n**Remarque :**\n\n- Comme les envois de Petits paquets n'ont pas de NIP de repérage, vous devez les chercher à l'aide des autres paramètres de recherche.\n- Dans l'environnement (de développement) « Bac à sable », le même NIP de repérage est toujours retourné (123456789012); alors, cette requête ne retournera pas des résultats représentatifs dans cet environnement."
                    schema:
                        minLength: 11
                        maxLength: 16
                        type: string
                    example: 123456789012
                -
                    name: group-id
                    in: query
                    description: "Shipments not yet transmitted in that group.\n\n**Note:** one of either group-id or manifest-id fields must be present, but never both."
                    x-ibm-languages:
                        description:
                            fr: "Envois pas encore transmis dans ce groupe.\n\n**Nota :** Un des deux champs (« group-id » ou « manifest-id ») doit être présent, mais jamais les deux."
                    schema:
                        type: string
                        maxLength: 32
                    example: 123456
                -
                    name: manifest-id
                    in: query
                    description: "Shipments in that manifest.\n\n**Note:** one of either group-id or manifest-id fields must be present, but never both."
                    x-ibm-languages:
                        description:
                            fr: "Envois sur ce manifeste.\n\n**Nota :** Un des deux champs (« group-id » ou « manifest-id ») doit être présent, mais jamais les deux."
                    schema:
                        type: string
                    example: 412011698382821250
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/shipments'
                            example:
                                -
                                    rel: shipment
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/shipments/123'
                                    mediaType: application/json
                                -
                                    rel: shipment
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/shipments/456'
                                    mediaType: application/json
                                -
                                    rel: shipment
                                    href: '"https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/shipments/789'
                                    mediaType: application/json
                202:
                    $ref: '#/components/responses/202'
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: getShipments
            summary: 'Get Shipments'
            description: 'Retrieves all shipments associated with a specific group or manifest.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir des envois'
                description:
                    fr: 'Récupérer toutes les expéditions associées à un groupe ou à un manifeste précis.'
            tags:
                - Shipping
    '/{mailedBy}/{mobo}/shipments/{id}':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/shipmentInfo'
                            example:
                                serviceCode: DOM.RP
                                baseAmount: 129.99
                                pricedOptions:
                                    -
                                        optionCode: code1
                                        optionPrice: 1.99
                                    -
                                        optionCode: code2
                                        optionPrice: 0.59
                                    -
                                        optionCode: code3
                                        optionPrice: 0.89
                                adjustments:
                                    -
                                        adjustmentCode: code4
                                        adjustmentAmount: 2.49
                                    -
                                        adjustmentCode: code5
                                        adjustmentAmount: 0.29
                                    -
                                        adjustmentCode: code6
                                        adjustmentAmount: 0.54
                                preTaxAmount: 109.99
                                gstAmount: 9.99
                                pstAmount: 8.99
                                hstAmount: 7.99
                                dueAmount: 169.99
                                serviceStandard:
                                    amDelivery: false
                                    guaranteedDelivery: true
                                    expectedTransitTime: 14
                                    expectedDeliveryDate: '2011-06-30T00:00:00.000Z'
                                ratedWeight: 10.11
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: getShipmentById
            tags:
                - Shipping
            summary: 'Get Shipment'
            description: 'Retrieves all IDs and PINs associated with a shipment allowing further calls to be made against them.'
            x-ibm-languages:
                summary:
                    fr: "Obtenir l'envoi"
                description:
                    fr: "Récupérer les liens créés lors d'un appel de création d'envoi précédent.  "
        delete:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                204:
                    $ref: '#/components/responses/204'
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '8064', message: 'A shipment can only be empty if it is in a PROCESSED or PRINTED state.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '8064', message: "Un envoi ne peut être vide que s'il est à l'état TRAITÉ ou IMPRIMÉ." }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: emptyShipment
            tags:
                - Shipping
            summary: 'Void Shipment'
            description: 'Indicates that a printed label for a manifested shipment was spoiled or cancelled by the customer and that it should not be transmitted and billed.'
            x-ibm-languages:
                summary:
                    fr: 'Envoi annulé'
                description:
                    fr: "Indique qu'une étiquette imprimée pour un envoi avec manifeste a été gâtée ou annulée par le client ou la cliente et qu'elle ne doit pas être transmise ni facturée. "
    '/artifacts/{consumerId}/shipping/{artifactId}/{index}':
        get:
            summary: 'Get Artifact'
            description: 'Retrieves the rendered label or manifest.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir un artéfact'
                description:
                    fr: "Récupère l'étiquette ou le manifeste rendu."
            parameters:
                -
                    $ref: '#/components/parameters/platformID'
                -
                    name: consumerId
                    in: path
                    description: 'A unique identifier for the mailed by customer using the API. This ID is automatically provided as part of the resource URLs in API responses.'
                    x-ibm-languages:
                        description:
                            fr: "Un numéro d'identification unique de l'envoi par le client à l'aide de l'API. Ce numéro d'identification est automatiquement fourni dans les adresses URL des ressources dans les réponses de l'API."
                    required: true
                    schema:
                        type: string
                    example: 021cdb9f5a4e0f3c
                -
                    name: artifactId
                    in: path
                    description: 'A unique identifier for the artifact (label or manifest) that was generated as part of a previous call. You can only retrieve artifacts for shipments, manifests or returns that you created.'
                    x-ibm-languages:
                        description:
                            fr: "Il s'agit du numéro d'identification unique de l'artefact (étiquette ou manifeste) généré dans le cadre d'une demande de service précédente. Vous pouvez seulement récupérer les artefacts pour les envois, les manifestes ou les envois retournés que vous avez créés."
                    required: true
                    schema:
                        type: string
                        maxLength: 18
                    example: '10005818570'
                -
                    name: index
                    in: path
                    description: 'To retrieve pdf documents, this parameter is not required or must be zero.'
                    x-ibm-languages:
                        description:
                            fr: "Ce paramètre n'est pas requis ou doit être à zéro pour récupérer les documents PDF."
                    required: true
                    schema:
                        type: string
                        enum:
                            - '0'
                    example: '0'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/pdf:
                            schema:
                                type: string
                                format: binary
                        application/zpl:
                            schema:
                                type: string
                                format: binary
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                404:
                    $ref: '#/components/responses/404'
                412:
                    $ref: '#/components/responses/412'
                500:
                    $ref: '#/components/responses/500'
                501:
                    $ref: '#/components/responses/501'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: shipmentArtifact
            tags:
                - Shipping
    '/{mailedBy}/{mobo}/shipments/{id}/price':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/shipmentPrice'
                            example:
                                serviceCode: DOM.RP
                                baseAmount: 129.99
                                pricedOptions:
                                    -
                                        optionCode: code1
                                        optionPrice: 1.99
                                    -
                                        optionCode: code2
                                        optionPrice: 0.59
                                    -
                                        optionCode: code3
                                        optionPrice: 0.89
                                adjustments:
                                    -
                                        adjustmentCode: code4
                                        adjustmentAmount: 2.49
                                    -
                                        adjustmentCode: code5
                                        adjustmentAmount: 0.29
                                    -
                                        adjustmentCode: code6
                                        adjustmentAmount: 0.54
                                preTaxAmount: 109.99
                                gstAmount: 9.99
                                pstAmount: 8.99
                                hstAmount: 7.99
                                dueAmount: 169.99
                                serviceStandard:
                                    amDelivery: false
                                    guaranteedDelivery: true
                                    expectedTransitTime: 14
                                    expectedDeliveryDate: '2011-06-30T00:00:00.000Z'
                                ratedWeight: 10.11
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: getShipmentPrice
            tags:
                - Shipping
            description: 'Retrieves pricing details for a shipment created by a prior Create Shipment call.'
            summary: 'Get Shipment Price'
            x-ibm-languages:
                summary:
                    fr: "Obtenir le prix de l'envoi"
                description:
                    fr: "Récupérer les détails de la tarification d'un envoi créé lors d'un précédent appel de création d'envoi. "
    '/{mailedBy}/{mobo}/shipments/{id}/receipt':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/shipmentReceipt'
                            example:
                                ccReceiptDetails:
                                    merchantName: 'Canada Post'
                                    merchantUrl: www.canadapost.ca
                                    nameOnCard: 'Joe Cardholder'
                                    authCode: 266614
                                    authTimestamp: '2012-11-24T03:17:51.000Z'
                                    cardType: MC
                                    chargeAmount: 325.8
                                    currency: CAD
                                    transactionType: Sale
                401:
                    $ref: '#/components/responses/401'
                403:
                    $ref: '#/components/responses/403'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: GetShipmentReceipt
            tags:
                - Shipping
            description: 'Retrieves payment information for a single shipment that was paid by credit card and did not require a manifest.'
            summary: 'Get Shipment Receipt'
            x-ibm-languages:
                summary:
                    fr: "Obtenir le reçu de l'envoi"
                description:
                    fr: "Récupérer les renseignements sur le paiement d'un envoi unique qui a été payé par carte de crédit et qui ne nécessite pas de manifeste.   "
    '/{mailedBy}/{mobo}/shipments/{id}/details':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/shipmentDetails'
                            example:
                                shipmentStatus: created
                                finalShippingPoint: A1A1A1
                                trackingPin: 222222222222
                                shipmentDetail:
                                    groupId: groupy
                                    expectedMailingDate: '2010-10-03T00:00:00.000Z'
                                    deliverySpec:
                                        serviceCode: DOM.RP
                                        sender:
                                            name: 'Sam Sender'
                                            company: 'Happy Sendings'
                                            contactPhone: 613-325-7777
                                            addressDetails: { addressLine1: '12 Main St', addressLine2: 'Ste 17', city: Ottawa, provState: 'ON', countryCode: CA, postalZipCode: K1K1K1 }
                                        destination:
                                            name: 'Pete Pickup'
                                            company: GoodsGetter
                                            additionalAddressInfo: 'side door'
                                            clientVoiceNumber: 613-123-4567
                                            addressDetails: { addressLine1: '43 Palm St', addressLine2: 'Apt 9', city: Ottawa, provState: Ont, countryCode: CA, postalZipCode: k1v8l5 }
                                        recipient:
                                            name: 'Pete Pickup'
                                            company: GoodsGetter
                                            additionalAddressInfo: 'side door'
                                            clientVoiceNumber: 613-123-4567
                                            addressDetails: { addressLine1: '43 Palm St', addressLine2: 'Apt 9', city: Flagstone, provState: CA, countryCode: US, postalZipCode: 90210 }
                                        options:
                                            - { optionCode: COV, optionAmount: 123.45, optionQualifier1: true, optionQualifier2: covqual2 }
                                            - { optionCode: REG, optionAmount: 67.89, optionQualifier1: true, optionQualifier2: regqual2 }
                                        parcelCharacteristics:
                                            weight: 123
                                            dimensions: { length: 11, width: 12, height: 10 }
                                            unpackaged: true
                                            mailingTube: true
                                            oversized: true
                                        notification:
                                            email: notif+test@icat.ion
                                            onShipment: true
                                            onException: true
                                            onDelivery: true
                                        printPreferences:
                                            outputFormat: 8.5x11
                                        preferences:
                                            showPackingInstructions: true
                                            showPostageRate: true
                                            showInsuredValue: true
                                        references:
                                            costCentre: ccent
                                            customerRef1: custref1
                                            customerRef2: custref2
                                        customs:
                                            currency: CAD
                                            conversionFromCad: 0.12
                                            reasonForExport: OTH
                                            otherReason: 'other r'
                                            skuList: [{ customsNumberOfUnits: 2, customsDescription: item1, sku: 12345, hsTariffCode: 1234.56, unitWeight: 0.5, customsValuePerUnit: 100, countryOfOrigin: CA, provinceOfOrigin: 'ON' }, { customsNumberOfUnits: 1, customsDescription: item2, sku: 67890, hsTariffCode: 1234, unitWeight: 0.25, customsValuePerUnit: 75, countryOfOrigin: US }]
                                            iossId: iossid
                                        settlementInfo:
                                            paidByCustomer: 1919191
                                            contractId: 78787878
                                            intendedMethodOfPayment: Account
                                    returnSpec:
                                        serviceCode: retcode
                                        returnRecipient:
                                            name: 'Ron Returns'
                                            company: Nokeepums
                                            addressDetails: { addressLine1: 'r.addr l1', addressLine2: 'r.addr l2', city: Gaggles, provState: 'ON', postalZipCode: K1K1K1 }
                                        returnNotification: retur+test@nspe.cif
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: GetShipmentIdDetails
            tags:
                - Shipping
            description: 'Retrieves shipment details for a shipment created by a prior Create Shipment call.'
            summary: 'Get Shipment Details'
            x-ibm-languages:
                description:
                    fr: "Récupérer les détails d'un envoi créé lors d'un précédent appel de création d'envoi."
                summary:
                    fr: "Obtenir les détails de l'envoi"
    '/{mailedBy}/{mobo}/shipments/{id}/qr-code':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/publicKeyInfo'
                            example:
                                expiryDate: '2020-05-18T00:00:00.000Z'
                                url: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/shipments/243821768995473359/qr-code'
                                qrCode: AAD6776dJHDF878687
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: getShipmentQRCode
            tags:
                - Shipping
            summary: 'Get Shipment Public Key Info'
            description: 'To retrieve the details on the public key including expiry date, QR code, public URL (un-authenticated URL).'
            x-ibm-languages:
                summary:
                    fr: "Obtenir les informations sur la clé publique de l'expédition"
                description:
                    fr: "Pour récupérer les détails de la clé publique, notamment la date d'expiration, le code QR, l'URL publique (URL non authentifiée).       "
    '/{mailedBy}/{mobo}/shipments/{id}/refund':
        post:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/shipmentId'
                -
                    $ref: '#/components/parameters/language'
            requestBody:
                required: true
                description: "<p><strong>Request &ndash; Fields</strong></p> <table>\n  <thead>\n    <tr>\n      <th>Field Name</th>\n      <th>Type</th>\n      <th>Required / Optional</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>email</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character string - up to 60 characters)</p>\n        <p>Must be a valid email address,&nbsp;i.e. pattern of (['_A-Za-z0-9\\-\\+])(\\.['_A-Za-z0-9\\-\\+])@([A-Za-z0-9-])(\\.[A-Za-z0-9-])(\\.[A-Za-z]{2,})</p>\n      </td>\n    </tr>\n  </tbody>\n</table>"
                x-ibm-languages:
                    description:
                        fr: "<p><strong>Demande &ndash; Champs</strong></p> <table>\n  <thead>\n    <tr>\n      <th>Nom du champ</th>\n      <th>Type</th>\n      <th>Requis/Facultatif</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>email</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>\n        <p>Requis</p>\n      </td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res jusqu'&agrave; 60 caract&egrave;res)</p>\n        <p>L'adresse &eacute;lectronique doit &ecirc;tre valide. Par exemple, elle doit respecter le format suivant : (['_A-Za-z0-9\\-\\+])(\\.['_A-Za-z0-9\\-\\+])@([A-Za-z0-9-])(\\.[A-Za-z0-9-])(\\.[A-Za-z]{2,})</p>\n      </td>\n    </tr>\n  </tbody>\n</table>"
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/refundRequest'
                        example:
                            email: joesmith@home.com
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/refundInfo'
                            example:
                                serviceTicketDate: '2014-10-10'
                                serviceTicketId: '0109648332'
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '7291', message: 'Shipment has not been transmitted; you must use Void Shipment.' }
                                            - { errorCode: '7292', message: 'A refund request has already been submitted for this shipment. Refunds take a few days to be processed.' }
                                            - { errorCode: '7296', message: 'The request could not be completed. You can try again later.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '7291', message: "L'envoi n'a pas été transmis ; vous devez annuler l'envoi." }
                                            - { errorCode: '7292', message: 'Une demande de remboursement a déjà été soumise pour cet envoi. Le traitement des remboursements prend quelques jours.' }
                                            - { errorCode: '7296', message: "La requête n'a pas pu être traitée. Vous pouvez réessayer plus tard." }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: RequestShipmentRefund
            tags:
                - Shipping
            summary: 'Request Shipment Refund'
            description: 'Sends a request to refund a transmitted shipment for which a label has been printed but subsequently spoiled.'
            x-ibm-languages:
                summary:
                    fr: "Demander le remboursement d'un envoi"
                description:
                    fr: 'Envoyer une demande de remboursement pour un envoi transmis pour lequel une étiquette a été imprimée, mais qui a par la suite été gâtée.  '
    '/{mailedBy}/{mobo}/groups':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/groups'
                            example:
                                -
                                    link:
                                        rel: group
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments?group-id=24242342'
                                        mediaType: application/json
                                    groupId: 24242342
                                -
                                    link:
                                        rel: group
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments?group-id=e33333'
                                        mediaType: application/json
                                    groupId: e33333
                                -
                                    link:
                                        rel: group
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/shipments?group-id=sdfsdfsd'
                                        mediaType: application/json
                                    groupId: sdfsdfsd
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: AA003, message: 'The customer number in the URL does not belong to the web service authorization provided in your request.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: AA003, message: "Le numéro de client figurant dans l'URL ne correspond pas à l'autorisation de service web fournie dans votre requête." }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: getShipmentGroups
            tags:
                - Shipping
            summary: 'Get Groups'
            description: 'Retrieves all group IDs associated with a customer (or mailed-on-behalf-of customer) for shipments that have been created.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir des groupes'
                description:
                    fr: "Récupérer tous les ID de groupe associés à un client ou une cliente (ou à une personne au nom de laquelle nous assurons l'expédition) pour les envois qui ont été créés."
    '/{mailedBy}/{mobo}/manifests':
        post:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/language'
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/transmitRequest'
                        example:
                            groupIds:
                                - APIC_DS
                            requestedShippingPoint: R3T4G4
                            detailedManifests: true
                            methodOfPayment: CreditCard
                            manifestAddress:
                                manifestCompany: MajorShop
                                manifestName: 'John Doe'
                                phoneNumber: 613-123-4567
                                addressDetails:
                                    addressLine1: '123 Eerie St'
                                    addressLine2: 'Ste 17'
                                    city: Ottawa
                                    provState: 'ON'
                                    countryCode: CA
                                    postalZipCode: K1L9G6
                            customerReference: custRef
                description: "<p><strong>Request &ndash; Top Level View of Fields</strong></p> <p>This section describes the top level (complex) fields that are part of the input to this service.</p> <table border=\"1\">\n  <thead>\n    <tr>\n      <th>Field Name</th>\n      <th>Type</th>\n      <th>Required / Optional</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>customerRequestId</p>\n      </td>\n      <td>String</td>\n      <td>Optional</td>\n      <td>For Future Use.</td>\n    </tr>\n    <tr>\n      <td>groupIds</td>\n      <td>Array of Strings</td>\n      <td>Required</td>\n      <td>\n        <p>This is a list of groupIds. The Transmit Shipments service will create a manifest for each group. The manifest will list the shipments included in the group (with the exception of shipments you exclude)</p>\n      </td>\n    </tr>\n    <tr>\n      <td>requestedShippingPoint</td>\n      <td>String</td>\n      <td>Conditionally</td>\n      <td>\n        <p>(6-character alphanumeric string)</p>\n        <p>Must be in valid Postal Code format</p>\n        <p>e.g. A9A9A9</p>\n        <p>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d</p>\n        <p>If you deposit your shipments yourself, you have 2 choices:</p>\n        <ul>\n          <li>Omit this field and provide the site number of your deposit location in shippingPointId. (recommended), or</li>\n          <li>Provide the postal code of your deposit location here and omit shippingPointId.</li>\n        </ul>\n        <p><strong>Note:</strong> Using requestedShippingPoint to indicate your deposit location postal code will be discontinued in a future release. If you deposit your shipments yourself, we recommend using the shippingPointId field.</p>\n        <p>Mandatory when&nbsp;cpcPickupIndicator is provided.</p>\n        <p>Mutually exclusive with shippingPointId, but one of the two must be provided.</p>\n        <p>If you provide the same Postal Code here that you used in your Create Shipment requests, then there will be no pricing adjustments related to the starting point for shipping. If you use a different Postal Code here than in Create Shipment, it may result in a pricing adjustment depending on the distance between the original shipping point (in the Create Shipment request) and the final shipping point (in the Transmit Shipments) request</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>cpcPickupIndicator</p>\n      </td>\n      <td>Boolean</td>\n      <td>Optional</td>\n      <td>\n        <p>(true)</p>\n        <p>Set this field to true if your shipments are picked up by Canada Post or a third party. Do not provide this field when false. Provide the Postal Code of your pickup location in requestedShippingPoint. If you use the same indicator and requestedShippingPoint as you did in Create Shipment, there will be no pricing adjustment; see details in requestedShippingPoint.</p>\n        <p>Omit this field if you deposit your shipments yourself.</p>\n        <p>Mutually exclusive with shippingPointId.</p>\n        <p><strong>Note:</strong> In a future release it will become mandatory to explicitly identify whether your shipment is picked up by Canada Post (by providing both this indicator and requestedShippingPoint) or deposited at a Canada Post site (by providing shippingPointId).</p>\n        <p>We recommend preparing for this change by providing this indicator (and requestedShippingPoint) if your shipment is picked up by Canada Post.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>shippingPointId</p>\n      </td>\n      <td>String</td>\n      <td>Conditionally required</td>\n      <td>\n        <p>(4-character alphanumeric string)</p>\n        <p>If you deposit your items at a Post Office or other Canada Post facility, provide the site number of the deposit location. Look up the site number using Find a Deposit Location. This information is used for pricing.</p>\n        <p>If you enter a different site number than you provided in your Create Shipment request, pricing may be affected.</p>\n        <p>Mutually exclusive with requestedShippingPoint but one of the two must be provided.</p>\n        <p><strong>Note:</strong> If you deposit your items yourself, we recommend using this field rather than the requestedShippingPoint field to indicate your deposit location.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>methodOfPayment</td>\n      <td>String</td>\n      <td>required</td>\n      <td>\n        <p>{15-character string}</p>\n        <p>This indicates what the method of payment is for the manifests that are to be generated.</p>\n        <p>Valid methods of payment are as follows:</p>\n        <ul>\n          <li>CreditCard = the payment will be by credit card.</li>\n          <li>Account = the payment will be via an existing contract with the paid-by-customer.</li>\n          <li>SupplierAccount = the payment will be through the Supplier Account identified as default in the customer profile (only available to Supplier Account providers).</li>\n        </ul>\n        <p><strong>Note:</strong> Different shipments may have different paid-by-customers. Separate manifests will be generated for shipments with different paid-by-customers.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>manifestAddress</td>\n      <td>Object</td>\n      <td>required</td>\n      <td>\n        <p>This structure contains the address that is printed on the manifest label.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>detailedManifests</td>\n      <td>Boolean</td>\n      <td>required</td>\n      <td>\n        <p>{true,false}</p>\n        <p>This indicates whether a full detailed manifest document will be rendered, or a summarized manifest document will be rendered.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>customerReference</td>\n      <td>String</td>\n      <td>Optional</td>\n      <td>\n        <p>(Alphanumeric String - up to 12 letters/digits)</p>\n        <p>A customer reference number may be provided to Canada Post which is placed on the manifest and returned in a Get Manifest Details request.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>excludedShipments</p>\n      </td>\n      <td>Array of Strings</td>\n      <td>Optional</td>\n      <td>\n        <p>The list of shipmentIds that are to be excluded from transmission. These shipments will remain in their group and will automatically be picked up for the next transmit.</p>\n      </td>\n    </tr>\n  </tbody>\n</table> <p><strong>Request &ndash; Detailed View of Simple Fields</strong></p> <table border=\"1\">\n  <thead>\n    <tr>\n      <th>Field Name</th>\n      <th>Type</th>\n      <th>Required / Optional</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>groupId</p>\n      </td>\n      <td>String</td>\n      <td>required</td>\n      <td>\n        <p>(Character String &ndash; up to 32 characters)</p>\n        <p>Contained within groupIds.</p>\n        <p>May occur 1 &hellip; N times.</p>\n        <p>The groupId of any group, whose shipments are to be included in the Transmit Shipments action.</p>\n        <p>The purpose of a groupId is to group several shipments together to include on the same manifest. For example, grouping is useful in the following scenarios:</p>\n        <ul>\n          <li>You have multiple fulfillment locations.</li>\n          <li>You want all shipments in a group to be shipped on the same day.</li>\n          <li>You want to group shipments together for internal reference or billing purposes.</li>\n        </ul>\n        <p><strong>Note:</strong> domestic, U.S., and international shipments will be placed on separate manifests even if they contain the same groupId.</p>\n        <p><strong>Performance limitations</strong><br>To avoid a timeout of our servers, please follow these recommendations:</p>\n        <ul>\n          <li>Do not include more than 30 groups per manifest (i.e., maximum of 30 groupIds in one Transmit Shipments request.)</li>\n          <li>Do not put more than 5,000 shipments in one group.</li>\n        </ul>\n        <p><strong>System limitations</strong><br>To avoid an error, please do not exceed the following limits before performing a Transmit Shipments call:</p>\n        <ul>\n          <li>Maximum of 50 groups per manifest (error 9109 if exceeded).</li>\n          <li>Maximum of 10,000 shipments in one group (error 9110 if exceeded).</li>\n          <li>Maximum of 10,000 shipments across multiple groups (error 9108 if exceeded).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>manifestName</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Optional</p>\n      </td>\n      <td>\n        <p>(Character String up to 44 characters)</p>\n        <p>Contact name for the manifest address.</p>\n        <p>This is printed on the manifest document.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>manifestCompany</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character String up to 44 characters)</p>\n        <p>Contained within manifestAddress.</p>\n        <p>The company name of the manifest address.</p>\n        <p>This is printed on the manifest document.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>phoneNumber</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character String &ndash; up to 32 characters)</p>\n        <p>Contained within manifestAddress.</p>\n        <p>Phone number to be printed on the manifest.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>\n        <p>Object</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>Contained within manifestAddress.</p>\n        <p>This structure contains the address details for the manifest address.</p>\n        <p>The address is printed on the manifest document.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character String up to 44 characters)</p>\n        <p>Contained within addressDetails.</p>\n        <p>address line 1 for the manifest address.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Optional</p>\n      </td>\n      <td>\n        <p>(Character String up to 44 characters)</p>\n        <p>Contained within addressDetails.</p>\n        <p>address line 2 for the manifest address.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character String up to 40 characters)</p>\n        <p>Contained within addressDetails.</p>\n        <p>City for the manifest address.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>(Character String &ndash; up to 20 characters)</p>\n        <p>Contained within addressDetails.</p>\n        <p>Province (or state) for the manifest address.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Conditionally<br>Required</p>\n      </td>\n      <td>\n        <p>(2-character string)</p>\n        <p>Contained within addressDetails.</p>\n        <p>Country code for the manifest address; CA and US are accepted.</p>\n        <p>Required if US. Optional if CA.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Required</p>\n      </td>\n      <td>\n        <p>Can be:</p>\n        <ol class=\"lowerRoman\">\n          <li>6-character alphanumeric for Canada (A9A9A9) <p>Pattern is [A-Z]\\d[A-Z]\\d[A-Z]\\d <strong>or</strong></p>\n          </li>\n          <li>5-digit or 5-4 digit numeric code for US) <p>Pattern is \\d{5}(-\\d{4})?</p>\n          </li>\n        </ol>\n        <p>Contained within addressDetails.</p>\n        <p>Postal Code or zip code for the manifest address.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>shipmentId</p>\n      </td>\n      <td>\n        <p>String</p>\n      </td>\n      <td>\n        <p>Optional</p>\n      </td>\n      <td>\n        <p>(Alphanumeric String &ndash; up to 32 letters/digits)</p>\n        <p>Contained within excludedShipments.</p>\n        <p>This is an identification number representing an existing shipment that is to be excluded from the Transmit Shipments.</p>\n        <p><strong>Note:</strong> If this feature is to be used, your system must store shipment ids from prior Create Shipment or Get Shipment calls and have a mechanism for selecting the ones to be excluded from transmit.</p>\n      </td>\n    </tr>\n  </tbody>\n</table>"
                x-ibm-languages:
                    description:
                        fr: "<p><strong>Demande &ndash; Aper&ccedil;u g&eacute;n&eacute;ral des champs</strong></p> <p>La&nbsp;pr&eacute;sente section offre un aper&ccedil;u g&eacute;n&eacute;ral des champs (Complexe) faisant partie des donn&eacute;es d'entr&eacute;e pour ce service.</p> <table>\n  <thead>\n    <tr>\n      <th>Nom du champ</th>\n      <th>Type</th>\n      <th>Requis/Facultatif</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>customerRequestId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>\n        <p>Facultatif</p>\n      </td>\n      <td>\n        <p>Pour utilisation future.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>groupIds</td>\n      <td>Tableau de cha&icirc;nes de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>Il s'agit d'une liste de num&eacute;ros d'identification de groupe. Le service Transmettre les envois cr&eacute;era un manifeste pour chaque groupe. Le manifeste comprendra la liste des envois compris dans le groupe (&agrave; l'exception des envois que vous excluez).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>requestedShippingPoint</td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis sous condition</td>\n      <td>\n        <p>(Cha&icirc;ne de six caract&egrave;res alphanum&eacute;riques)</p>\n        <p>Doit &ecirc;tre dans un format de code postal valide.</p>\n        <p>Exemple : A9A9A9</p>\n        <p>Le format est [A-Z]\\d[A-Z]\\d[A-Z]\\d.</p>\n        <p>Si vous d&eacute;posez vous-m&ecirc;me vos envois, vous avez deux choix :</p>\n        <ul>\n          <li>ne pas r&eacute;gler ce champ, et indiquer le num&eacute;ro d'identification de l'emplacement d'exp&eacute;dition dans shippingPointId (option recommand&eacute;e);</li>\n          <li>fournir le code postal de votre lieu d'exp&eacute;dition ici et ne pas r&eacute;gler le champ shippingPointId.</li>\n        </ul>\n        <p><strong>Nota :</strong> L'utilisation de le champ requestedShippingPoint pour indiquer le code postal de votre lieu d'exp&eacute;dition ne sera plus possible dans une version future. Si vous d&eacute;posez vous-m&ecirc;me vos envois, nous vous recommandons d'utiliser le champ shippingPointId.</p>\n        <p>Ce champ est obligatoire lorsque l'indicateur de ramassage de la SCP (cpcPickupIndicator) est fourni.</p>\n        <p>Option s'excluant mutuellement avec le champ shippingPointId.</p>\n        <p>Si vous fournissez ici le m&ecirc;me code postal que vous avez utilis&eacute; dans vos demandes de service &laquo; Cr&eacute;er l'envoi &raquo;, aucun rajustement tarifaire ne sera associ&eacute; au point de d&eacute;part pour l'exp&eacute;dition. Si vous utilisez ici un code postal diff&eacute;rent de celui utilis&eacute; dans les demandes de service &laquo; Cr&eacute;er l'envoi &raquo;, un rajustement tarifaire pourrait &ecirc;tre effectu&eacute; selon la distance entre le point d'exp&eacute;dition initial (dans la demande de service &laquo; Cr&eacute;er l'envoi &raquo;) et le point d'exp&eacute;dition final (dans la demande de service &laquo; Transmettre les envois &raquo;).</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>cpcPickupIndicator</p>\n      </td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>\n        <p>Facultatif</p>\n      </td>\n      <td>\n        <p>(true)</p>\n        <p>R&eacute;glez ce champ &agrave; &laquo; true &raquo; si vos envois sont ramass&eacute;s par Postes Canada ou par une tierce partie. Ne fournissez pas ce champ si le champ est r&eacute;gl&eacute; &agrave; &laquo; false &raquo;. Fournissez le code postal de votre lieu de ramassage dans le champ requestedShippingPoint. Si vous utilisez le m&ecirc;me indicateur et le m&ecirc;me point d'exp&eacute;dition demand&eacute; (requestedShippingPoint) que ceux utilis&eacute;s dans la demande de service &laquo; Cr&eacute;er l'envoi &raquo;, il n'y aura aucun rajustement tarifaire; consultez les d&eacute;tails dans le champ requestedShippingPoint.</p>\n        <p>Ne fournissez pas ce renseignement si vous d&eacute;posez vous-m&ecirc;me vos envois.</p>\n        <p>Option s'excluant mutuellement avec le champ shippingPointId.</p>\n        <p><strong>Nota :</strong> Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramass&eacute; par Postes Canada (en fournissant &agrave; la fois cet indicateur et le champ requestedShippingPoint) ou d&eacute;pos&eacute; &agrave; un emplacement de Postes Canada (en fournissant le champ shippingPointId).</p>\n        <p>Nous vous recommandons de vous pr&eacute;parer &agrave; ce changement en offrant cet indicateur (et le champ requestedShippingPoint) si votre envoi est ramass&eacute; par Postes Canada.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>shippingPointId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>\n        <p>Requis sous condition</p>\n      </td>\n      <td>\n        <p>(Cha&icirc;ne de quatre caract&egrave;res alphanum&eacute;riques)</p>\n        <p>Si vous d&eacute;posez vos articles &agrave; un bureau de poste ou &agrave; une autre installation de Postes Canada, fournissez le num&eacute;ro d'emplacement de ce lieu de d&eacute;p&ocirc;t. Recherchez le num&eacute;ro d'emplacement en question &agrave; l'aide de la fonction <a href=\"../../../../information/app/fdl/entreprise/trouverunlieudedepot\" aria-invalid=\"true\">Trouver un lieu de d&eacute;p&ocirc;t</a>. Cette information est utilis&eacute;e pour la tarification.</p>\n        <p>Si vous saisissez un num&eacute;ro d'emplacement diff&eacute;rent de celui fourni dans votre demande de service &laquo; Cr&eacute;er l'envoi &raquo;, des ajustements tarifaires peuvent s'imposer.</p>\n        <p>Option s'excluant mutuellement avec l'option requestedShippingPoint; cependant, l'une des deux doit &ecirc;tre saisie.</p>\n        <p><strong>Nota :</strong> Si vous d&eacute;posez vous-m&ecirc;me vos envois, nous vous recommandons d'utiliser ce champ plut&ocirc;t que le champ requestedShippingPoint pour indiquer votre lieu d'exp&eacute;dition.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>methodOfPayment</td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>{Cha&icirc;ne de 15 caract&egrave;res}</p>\n        <p>Cela d&eacute;signe le mode de paiement utilis&eacute; pour les manifestes devant &ecirc;tre g&eacute;n&eacute;r&eacute;s.</p>\n        <p>Les modes de paiement valides sont les suivants :</p>\n        <ul>\n          <li>CreditCard = Le paiement sera effectu&eacute; par carte de cr&eacute;dit.</li>\n          <li>Account = Le paiement se fera par l'interm&eacute;diaire d'une convention en vigueur qui aura &eacute;t&eacute; conclue avec le payeur.</li>\n          <li>SupplierAccount = le paiement se fera par l&rsquo;interm&eacute;diaire du compte de fournisseur d&eacute;sign&eacute; comme valeur par d&eacute;faut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).</li>\n        </ul>\n        <p>Nota : Diff&eacute;rents payeurs pourraient &ecirc;tre associ&eacute;s &agrave; diff&eacute;rents envois. Des manifestes distincts seront g&eacute;n&eacute;r&eacute;s pour les envois dont les payeurs sont diff&eacute;rents.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>manifestAddress</td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>Cette structure contient l'adresse imprim&eacute;e sur l'&eacute;tiquette du manifeste.</td>\n    </tr>\n    <tr>\n      <td>detailedManifests</td>\n      <td>\n        <p>Bool&eacute;en</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>{vrai, faux}</p> Cela indique si une version r&eacute;sum&eacute;e ou tr&egrave;s d&eacute;taill&eacute;e du manifeste sera produite.\n      </td>\n    </tr>\n    <tr>\n      <td>customerReference</td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne alphanum&eacute;rique &ndash; Jusqu'&agrave; 12 lettres/chiffres)</p>\n        <p>Le num&eacute;ro de r&eacute;f&eacute;rence du client peut &ecirc;tre fourni &agrave; Postes Canada, puis inscrit sur le manifeste et affich&eacute; dans une demande de service Obtenir les d&eacute;tails du manifeste.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>excludedShipments</p>\n      </td>\n      <td>\n        <p>Tableau de cha&icirc;nes de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>Il s'agit de la liste de shipmentIds devant &ecirc;tre exclus de la transmission. Ces envois demeureront dans leur groupe et ils seront automatiquement ramass&eacute;s au cours de la prochaine transmission.</td>\n    </tr>\n  </tbody>\n</table> <p><strong>Demande &ndash; Aper&ccedil;u d&eacute;taill&eacute; des champs simples</strong></p> <table summary=\"Transmettre les envois\n              &ndash; Aper&ccedil;u d&eacute;taill&eacute;\n                            des champs de la demande\" cellspacing=\"0\">\n  <thead>\n    <tr>\n      <th>Nom du champ</th>\n      <th>Type</th>\n      <th>Requis/Facultatif</th>\n      <th>Description</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>\n        <p>groupId</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 32 caract&egrave;res)</p>\n        <p>Fait partie de groupIds.</p>\n        <p>Occurrence (1&nbsp;&agrave; N fois)</p>\n        <p>Il s'agit du groupId de tout groupe dont les envois doivent &ecirc;tre inclus dans le proc&eacute;d&eacute; de transmission.</p>\n        <p>Un groupId a pour but de regrouper plusieurs envois ensemble afin de les inclure sur le m&ecirc;me manifeste. Par exemple, le regroupement est utile dans les sc&eacute;narios suivants :</p>\n        <ul>\n          <li>Vous avez plusieurs emplacements de service.</li>\n          <li>Vous souhaitez que tous les envois dans un groupe soient exp&eacute;di&eacute;s le m&ecirc;me jour.</li>\n          <li>Vous voulez regrouper les envois ensemble aux fins de r&eacute;f&eacute;rence interne ou de facturation.</li>\n        </ul>\n        <p><strong>Remarque :</strong> Les envois du r&eacute;gime int&eacute;rieur, &agrave; destination des &Eacute;tats-Unis et du r&eacute;gime international seront plac&eacute;s sur des manifestes s&eacute;par&eacute;s, m&ecirc;me s'ils contiennent le m&ecirc;me <br>groupId.</p>\n        <p><strong>Limites du rendement</strong><br>Afin d'&eacute;viter un d&eacute;lai de temporisation de nos serveurs, veuillez suivre ces recommandations :</p>\n        <ul>\n          <li>Ne pas inclure plus de 30 groupes par manifeste (p. ex. un maximum de 30 groupIds dans une seule demande de service Transmettre les envois).</li>\n          <li>Ne pas placer plus de 5 000 envois dans un groupe.</li>\n        </ul>\n        <p><strong>Limites du syst&egrave;me</strong><br>Pour &eacute;viter une erreur, veuillez ne pas d&eacute;passer les limites suivantes avant d'effectuer une demande de service Transmettre les envois :</p>\n        <ul>\n          <li>Maximum de 50 groupes par manifeste (erreur 9109 si la limite est d&eacute;pass&eacute;e).</li>\n          <li>Maximum de 10 000 envois dans un groupe (erreur 9110 si la limite est d&eacute;pass&eacute;e).</li>\n          <li>Maximum de 10 000 envois dans l'ensemble de plusieurs groupes (erreur 9108 si la limite est d&eacute;pass&eacute;e).</li>\n        </ul>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>manifestName</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Nom de la personne-ressource figurant dans l'adresse du manifeste</p> Le nom est imprim&eacute; sur le manifeste.\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>manifestCompany</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>\n        <p>Requis</p>\n      </td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Fait partie de manifestAddress.</p>\n        <p>Nom de l'entreprise figurant dans l'adresse du manifeste</p> Le nom est imprim&eacute; sur le manifeste.\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>phoneNumber</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 32 caract&egrave;res)</p>\n        <p>Fait partie de manifestAddress.</p> Num&eacute;ro de t&eacute;l&eacute;phone devant &ecirc;tre imprim&eacute; sur le manifeste\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressDetails</p>\n      </td>\n      <td>Objet</td>\n      <td>Requis</td>\n      <td>\n        <p>Fait partie de manifestAddress.</p>\n        <p>Cette structure contient les d&eacute;tails de l'adresse pour l'adresse du manifeste.</p> L'adresse est imprim&eacute;e sur le manifeste.\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine1</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Fait partie des addressDetails.</p> Ligne d'adresse 1 pour l'adresse du manifeste\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>addressLine2</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 44 caract&egrave;res)</p>\n        <p>Fait partie des addressDetails.</p> Ligne d'adresse 2 pour l'adresse du manifeste\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>city</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 40 caract&egrave;res)</p>\n        <p>Fait partie des addressDetails.</p> Ville pour l'adresse du manifeste\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>provState</p>\n      </td>\n      <td>Cha&icirc;ne de caract&egrave;res</td>\n      <td>Requis</td>\n      <td>\n        <p>(Cha&icirc;ne de caract&egrave;res &ndash; Jusqu'&agrave; 20 caract&egrave;res)</p>\n        <p>Fait partie des addressDetails.</p> Province (ou &Eacute;tat) pour l'adresse du manifeste\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>countryCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis<br>sous condition</td>\n      <td>\n        <p>(deux caract&egrave;res)</p>\n        <p>Fait partie des addressDetails.</p>\n        <p>Code&nbsp;de pays pour l&rsquo;adresse du manifeste; CA et US sont accept&eacute;s.</p>\n        <p>Obligatoire si US. Facultatif si CA.</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>postalZipCode</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Requis</td>\n      <td>\n        <p>Peut &ecirc;tre :</p>\n        <ol class=\"lowerRoman\">\n          <li>(Six caract&egrave;res alphanum&eacute;riques pour le Canada [A9A9A9]) <p>Le format est [A-Z]\\d[A-Z]\\d[A-Z]\\d.</p>\n          </li>\n          <li>(Code num&eacute;rique &agrave; cinq chiffres ou &agrave; neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les &Eacute;tats-Unis) <p>Le format est \\d{5}(-\\d{4})?.</p>\n          </li>\n        </ol>\n        <p>Fait partie des addressDetails.</p>\n        <p>Code postal (ou ZIP) pour l'adresse du manifeste</p>\n      </td>\n    </tr>\n    <tr>\n      <td>\n        <p>shipmentId</p>\n      </td>\n      <td>\n        <p>Cha&icirc;ne de caract&egrave;res</p>\n      </td>\n      <td>Facultatif</td>\n      <td>\n        <p>(Cha&icirc;ne alphanum&eacute;rique &ndash; Jusqu'&agrave; 32 lettres/chiffres)</p>\n        <p>Fait partie des excluded-shipments.</p>\n        <p>Il s'agit d'un num&eacute;ro d'identification repr&eacute;sentant un envoi existant qui doit &ecirc;tre exclu du service Transmettre les envois.</p>\n        <strong>Nota :</strong> S'il faut utiliser cette fonction, votre syst&egrave;me doit conserver les num&eacute;ros d'identification des envois des demandes pr&eacute;c&eacute;dentes pour le service Cr&eacute;er l'envoi ou Obtenir l'envoi et disposer d'un m&eacute;canisme pour s&eacute;lectionner les envois &agrave; exclure de la transmission.\n      </td>\n    </tr>\n  </tbody>\n</table>"
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/manifestList'
                            example:
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/123'
                                    mediaType: application/json
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/456'
                                    mediaType: application/json
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/789'
                                    mediaType: application/json
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '7313', message: 'Supplier Account payment can only be submitted by the account provider or an authorized user.' }
                                            - { errorCode: '9122', message: 'All groups in the transmit request were empty or all shipments were excluded; there was nothing to transmit.' }
                                            - { errorCode: '7317', message: 'The issuer of the default Supplier Account in your Canada Post online profile does not match the platform you are using.' }
                                            - { errorCode: '9118', message: 'Group id: "99" was not found for transmission. Please remove or correct.' }
                                            - { errorCode: '9119', message: 'Shipment id: "12373264234" was not found for exclusion. Please remove or correct.' }
                                            - { errorCode: '9186', message: 'Only one of shippingPointId or cpcPickupIndicator can be provided.' }
                                            - { errorCode: '9187', message: 'requestedShippingPoint is mandatory when cpcPickupIndicator is provided.' }
                                            - { errorCode: '9188', message: 'shippingPointId is not valid.' }
                                            - { errorCode: '9189', message: 'requestedShippingPoint and shippingPointId are mutually exclusive.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '7313', message: 'Le paiement par compte de fournisseur peut uniquement être soumis par le fournisseur du compte ou un utilisateur autorisé.' }
                                            - { errorCode: '9122', message: "Tous les groupes de la demande de transmission étaient vides ou tous les envois étaient exclus. Il n'y avait rien à transmettre." }
                                            - { errorCode: '7317', message: "L'émetteur du compte de fournisseur par défaut dans votre profil de Postes Canada en ligne ne correspond pas à la plateforme que vous utilisez." }
                                            - { errorCode: '9118', message: 'ID du groupe : La valeur « 99 » est introuvable pour la transmission. Veuillez la supprimer ou la corriger.' }
                                            - { errorCode: '9119', message: "La valeur « 12373264234 » est introuvable pour l'exclusion. Veuillez la supprimer ou la corriger." }
                                            - { errorCode: '9186', message: "Seulement un numéro d'identification d'expédition (shippingPointId) ou un indicateur de ramassage de la SCP (cpcPickupIndicator) peut être fourni." }
                                            - { errorCode: '9187', message: "L'élément requestedShippingPoint est obligatoire lorsque l'indicateur de ramassage de la SCP (cpcPickupIndicator) est fourni." }
                                            - { errorCode: '9188', message: "L'élément shippingPointId n'est pas valide." }
                                            - { errorCode: '9189', message: "Les éléments requestedShippingPoint et shippingPointId s'excluent mutuellement." }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: TransmitShipmentsManifest
            tags:
                - Manifest
            summary: 'Transmit Shipments'
            description: 'The Transmit Shipment call triggers the billing process and specifies shipments to be included in the manifest.'
            x-ibm-languages:
                summary:
                    fr: 'Transmettre les envois'
                description:
                    fr: "L'appel de transmission de l'envoi déclenche le procédé de facturation et précise les envois qui doivent être inclus dans le manifeste."
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/language'
                -
                    name: from
                    in: query
                    description: 'Start date in format YYYYMMDD.'
                    x-ibm-languages:
                        description:
                            fr: 'Date de début au format AAAAMMJJ.'
                    schema:
                        type: string
                    example: 20231026
                -
                    name: to
                    in: query
                    description: 'End date in format YYYYMMDD.'
                    x-ibm-languages:
                        description:
                            fr: 'Date de fin au format AAAAMMJJ.'
                    schema:
                        type: string
                    example: 20231126
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/manifestList'
                            example:
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/123'
                                    mediaType: application/json
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/456'
                                    mediaType: application/json
                                -
                                    rel: manifest
                                    href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/7023210/7023210/manifests/789'
                                    mediaType: application/json
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '9105', message: 'A required query parameter was not provided in the request.' }
                                            - { errorCode: '9116', message: 'The startDate cannot be a later date than the endDate.' }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '9105', message: "Un paramètre de requête requis n'a pas été fourni dans la demande." }
                                            - { errorCode: '9116', message: 'La « startDate » ne peut pas être postérieure à la « endDate ».' }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: GetManifests
            tags:
                - Manifest
            summary: 'Get Manifests'
            description: 'Retrieves a list of previously transmitted manifests within a given date range.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir les manifestes'
                description:
                    fr: 'Récupérer une liste de manifestes transmis précédemment dans une plage de dates donnée.'
    '/{mailedBy}/{mobo}/manifests/{id}':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/manifestId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/manifestInfo'
                            example:
                                poNumber: D906402103
                                links:
                                    -
                                        rel: artifact
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/artifacts/D906402103/shipping/10001469957/0'
                                        mediaType: application/json
                                    -
                                        rel: details
                                        href: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1/12345678901234567890/9876543210/manifests/D906402103/details'
                                        mediaType: application/json
                400:
                    description: 'The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax). There will be diagnostic message text in the preferred language (English or French).'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 400 (Mauvaise demande) indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison d’une erreur de la clientèle (p. ex., syntaxe de demande mal formée). Il y aura un message de diagnostic dans la langue de préférence (français ou anglais).'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/messages'
                            examples:
                                English:
                                    value:
                                        title: 'Validation failed'
                                        detail: 'Errors occurred while processing the request.'
                                        errors:
                                            - { errorCode: '1653', message: 'Method of payment Account is not available. Please select another method of payment.' }
                                            - { errorCode: '9153', message: "The transmit process has not completed yet. Please try again\nlater." }
                                Français:
                                    value:
                                        title: 'Validation échouée'
                                        detail: 'Une erreur est survenue lors du traitement de la demande.'
                                        errors:
                                            - { errorCode: '1653', message: "La méthode de paiement Porte au Compte n'est pas disponible. Veuillez choisir une autre méthode de paiement." }
                                            - { errorCode: '9153', message: "Le processus de transmission n'est pas encore complété. Veuillez essayer de nouveau." }
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: GetManifestById
            summary: 'Get Manifest'
            tags:
                - Manifest
            description: 'Confirms that a manifest has been created and retrieves the manifest details.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir le manifeste'
                description:
                    fr: "Confirmer qu'un manifeste a été créé et récupérer les détails du manifeste."
    '/{mailedBy}/{mobo}/manifests/{id}/details':
        get:
            parameters:
                -
                    $ref: '#/components/parameters/mailedBy'
                -
                    $ref: '#/components/parameters/mobo'
                -
                    $ref: '#/components/parameters/platformID'
                -
                    $ref: '#/components/parameters/manifestId'
                -
                    $ref: '#/components/parameters/language'
            responses:
                200:
                    description: 'The 200 (OK) status code indicates that the request has succeeded. The response payload is returned.'
                    x-ibm-languages:
                        description:
                            fr: 'Le code d’état 200 (OK) indique que la demande a été traitée avec succès. La charge utile de réponse est retournée.'
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/manifestDetails'
                            example:
                                poNumber: P200639602
                                finalShippingPoint: K2W0C0
                                shippingPointName: "MORGAN'S GRANT PO"
                                shippingPointId: A636
                                cpcPickupIndicator: true
                                mailedByCustomer: '0007023210'
                                mailed-on-behalf-of: '0007023210'
                                paidByCustomer: '0007023210'
                                manifestDate: '2021-02-12'
                                manifestTime: '13:37 EST'
                                contractId: '0040662505'
                                methodOfPayment: creditCard
                                ccReceiptDetails:
                                    merchantName: 'Canada Post'
                                    merchantUrl: www.canadapost.ca
                                    nameOnCard: 'Zuhur test'
                                    authCode: '159190'
                                    authTimestamp: '2021-02-12T13:37:50-05:00'
                                    cardType: VIS
                                    currency: CAD
                                    transactionType: Sale
                                manifestPricingInfo:
                                    baseCost: 16.88
                                    automationDiscount: 0
                                    optionsAndSurcharges: 1.35
                                    gst: 0
                                    pst: 0
                                    hst: 2.73
                                    totalDueCpc: 20.96
                                manifestAddress:
                                    manifestCompany: ABC
                                    manifestName: MajorShop
                                    phoneNumber: 902-444-4444
                                    addressDetails:
                                        addressLine1: '1 Main St'
                                        addressLine2: string
                                        city: Halifax
                                        provState: NS
                                        postalZipCode: B3L2C2
                                        mediaType: application/json
                401:
                    $ref: '#/components/responses/401'
                404:
                    $ref: '#/components/responses/404'
                500:
                    $ref: '#/components/responses/500'
                503:
                    $ref: '#/components/responses/503'
                504:
                    $ref: '#/components/responses/504'
            operationId: GetManifestIdDetails
            tags:
                - Manifest
            summary: 'Get Manifest Details'
            description: 'Retrieves all cost details associated with a given manifest.'
            x-ibm-languages:
                summary:
                    fr: 'Obtenir les détails du manifeste'
                description:
                    fr: 'Récupérer tous les détails des coûts associés à un manifeste donné.'
components:
    parameters:
        mailedBy:
            name: mailedBy
            in: path
            description: 'Your customer number.'
            x-ibm-languages:
                description:
                    fr: 'Votre numéro de client.'
            required: true
            schema:
                $ref: '#/components/schemas/workgroupID'
        platformID:
            name: platform-id
            in: header
            description: 'ID associated with the platform.'
            x-ibm-languages:
                description:
                    fr: 'Identifiant associé à la plateforme.'
            required: false
            schema:
                $ref: '#/components/schemas/customerNumber'
        mobo:
            name: mobo
            in: path
            description: 'The mailed on behalf of customer number or repeat your customer number.'
            x-ibm-languages:
                description:
                    fr: 'Le numéro de client « Expédié au nom de » ou indiquez de nouveau votre numéro de client.'
            required: true
            schema:
                $ref: '#/components/schemas/customerNumber'
        language:
            name: Accept-Language
            in: header
            description: "Indicates your language preference for receiving error messages.\n\n- en-CA = English\n- fr-CA = French"
            x-ibm-languages:
                description:
                    fr: "Indique votre langue de préférence pour recevoir les messages d'erreur.\n- en-CA = Anglais - fr-CA = Français"
            schema:
                type: string
                enum:
                    - en-CA
                    - fr-CA
                example: en-CA
                default: en-CA
        zonosAccountId:
            name: X-CPC-Zonos-Key
            in: header
            description: 'This is the account key available in the Zonos platform (Settings → Integrations), that you obtained when you registered with Zonos. This is only required if you are planning to ship to the U.S. and want to submit shipments without pre-existing declaration IDs.'
            x-ibm-languages:
                description:
                    fr: 'Il s’agit de la clé de compte disponible dans la plateforme Zonos (Paramètres → Intégrations) que vous avez obtenue lors de votre inscription à Zonos. Elle n’est requise que si vous prévoyez expédier vers les États-Unis et souhaitez soumettre des envois sans ID de déclaration préexistant.'
            required: false
            schema:
                $ref: '#/components/schemas/zonosAccountId'
        shipmentId:
            name: id
            in: path
            description: 'An unique identifier for the shipment.'
            x-ibm-languages:
                description:
                    fr: "Il s'agit d'un numéro d'identification unique pour l'envoi."
            required: true
            schema:
                $ref: '#/components/schemas/shipmentId'
        trackingPin:
            name: id
            in: path
            description: 'This is the tracking PIN for the shipment.'
            x-ibm-languages:
                description:
                    fr: "Il s'agit du numéro d'identification du produit (NIP) pour l'envoi."
            required: true
            schema:
                $ref: '#/components/schemas/trackingPin'
        manifestId:
            name: id
            in: path
            description: 'ID of the manifest to retrieve.'
            x-ibm-languages:
                description:
                    fr: 'Identifiant du manifeste à récupérer.'
            required: true
            schema:
                type: string
            example: '949771771416148042'
    responses:
        202:
            description: 'The 202 (Accepted) status code indicates that the request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.'
            x-ibm-languages:
                description:
                    fr: 'Le code d’état 202 (Acceptée) indique que la demande a été acceptée aux fins de traitement, mais que le traitement n’a pas été effectué. La demande pourrait éventuellement être traitée ou non, car elle pourrait être refusée au moment du traitement.'
        204:
            description: 'The 204 (No Content) status code indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response content.'
            x-ibm-languages:
                description:
                    fr: 'Le code d’état 204 (Aucun contenu) indique que le serveur a bien traité la demande et qu’il n’y a pas de contenu supplémentaire à envoyer dans le contenu de la réponse.'
        401:
            description: 'The 401 (Unauthorized) status code indicates that the server understood the request but refuses to fulfill it.'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 401 (Non autorisé) indique que le serveur a compris la requête mais refuse de la satisfaire."
            content:
                application/json:
                    schema:
                        $ref: '#/components/schemas/unauthorizedError'
                    example:
                        -
                            httpCode: 401
                            httpMessage: Unauthorized
                            moreInformation: 'Cannot pass the security checks that are required by the target API or operation, Enable debug headers for more details.'
        403:
            description: "The HTTP 403 (Forbidden) error means the web server received your request but denies you access to the requested resource because you don't have permission."
            x-ibm-languages:
                description:
                    fr: "L'erreur HTTP 403 (Interdit) signifie que le serveur Web a reçu votre requête mais vous refuse l'accès à la ressource demandée car vous n'en avez pas l'autorisation."
        404:
            description: 'The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 404 (Introuvable) indique que le serveur d'origine n'a pas trouvé de représentation actuelle pour la ressource cible ou ne souhaite pas divulguer son existence."
            content:
                application/json:
                    schema:
                        $ref: '#/components/schemas/messages'
        412:
            description: 'The 412 (Precondition Failed) status code indicates that one or more conditions given in the request header fields evaluated to false when tested on the server (Section 13).'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 412 (Échec de la condition préalable) indique qu'une ou plusieurs conditions données dans les champs d'en-tête de la requête ont été évaluées à faux lors du test sur le serveur (Section 13)."
        500:
            description: 'The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. Passed through from backend.'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 500 (Erreur interne du serveur) indique que le serveur a rencontré une condition inattendue l'empêchant de traiter la requête. Transmis par le serveur d'arrière-plan."
        501:
            description: 'The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request.'
            x-ibm-languages:
                description:
                    fr: 'Le code d’état 501 (non mis en œuvre) indique que le serveur ne prend pas en charge les fonctions nécessaires pour traiter la demande.'
        503:
            description: 'The 503 (Service Unavailable) status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. Passed through from backend.'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 503 (Service indisponible) indique que le serveur est actuellement indisponible en raison d'une surcharge temporaire ou d'une maintenance planifiée, qui devrait être résolue après un certain délai. Message transmis par le serveur d'arrière-plan."
        504:
            description: 'The 504 (Gateway Timeout) status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. May be passed through from backend.'
            x-ibm-languages:
                description:
                    fr: "Le code d'état 504 (Délai d'attente de la passerelle) indique que le serveur, agissant comme passerelle ou proxy, n'a pas reçu de réponse dans un délai raisonnable d'un serveur en amont auquel il devait accéder pour traiter la requête. Ce code peut provenir du serveur principal."
    schemas:
        shipmentId:
            description: "An unique identifier for the shipment.\n\n---\n\nIl s'agit d'un numéro d'identification unique pour l'envoi."
            type: string
            maxLength: 32
            example: '949771771413547546'
        customerRequestId:
            description: "A unique ID that you can define for this shipment. It must be unique or the request will be rejected.\n\nSupplier Account vendors must use this field to provide a unique identifier for any shipment that is a pre-authorized payment request.\n\nYou can also use this ID recover shipment details, such as the label, without the need for the information provided in the generate Shipment response. Instead, just use this ID in a request to Get Shipments.        \n\n---\n\nUn numéro d'identification unique que vous pouvez définir pour cet envoi. Il doit être unique ou la demande sera rejetée.\n\nLes fournisseurs de compte de fournisseur doivent utiliser ce champ pour indiquer un numéro d'identification unique pour tout envoi associé à une demande de paiement préautorisé.\n\nVous pouvez également utiliser ce numéro d'identification pour récupérer les détails relatifs à l'envoi, tels que l'étiquette, sans avoir à fournir d'information dans la réponse « Créer l'envoi ». Au lieu de cela, il suffit d'utiliser ce numéro d'identification dans les demandes Obtenir l'envoi.                "
            type: string
            maxLength: 35
        customerNumber:
            type: string
            minLength: 7
            maxLength: 18
            example: '0007271592'
        workgroupID:
            type: string
            pattern: '^[0-9]{1,10}(-[0-9]{1,10})?$'
            example: '0007271592'
        zonosAccountId:
            type: string
            minLength: 1
            maxLength: 30
            example: credential_live_9a97e2a3-7491-0326-4a9f-7e4a5297c2a5
        mailedByCustomer:
            allOf:
                -
                    $ref: '#/components/schemas/customerNumber'
            description: "Customer number of the mailedBy.\n\n---\n\nNuméro de client de « Expédié au nom de »."
        mailed-on-behalf-of:
            allOf:
                -
                    $ref: '#/components/schemas/customerNumber'
            description: "Customer number of the mail owner.\n\n---\n\nNuméro de client du propriétaire du courrier."
        paidByCustomer:
            allOf:
                -
                    $ref: '#/components/schemas/customerNumber'
            description: "The customer number of the customer who will be billed for the shipment. This is typically the same as the \"mailed on behalf of\" customer unless a Central Payer relationship has been identified to Canada Post. If it is not supplied, it defaults to mailed-on-behalf-of.\n\n---\n\nIl s'agit du numéro du client qui recevra la facture pour l'envoi. Il correspond habituellement au même numéro de client « Expédié au nom de », à moins qu'une relation de payer central n'ait été signalée à Postes Canada. S'il n'est pas fourni, le numéro de client « Expédié au nom de » s'affiche par défaut."
        contractId:
            description: "Contract Id numbers are 10 digits. If the number you provide has fewer than 10 digits, the system will add leading zeros to increase the length to 10.\n\nRequired to identify contract discounts if the intended method of payment is Account.        \n\n---\n\nLes numéros d'identification de convention comptent 10 chiffres. Si le numéro fourni est inférieur à 10 chiffres, le système ajoutera des zéros au début jusqu'à ce qu'il y ait 10 chiffres.\n\nRequis pour déterminer les rabais consentis par convention si le mode de paiement voulu est « Compte ».            "
            type: string
            pattern: '^\d{1,10}$'
        shipmentStatus:
            description: "Valid values are\n\n- created\n- transmitted\n- suspended\n\nIndicates the current status of the shipment.\n\n---\n\nLes valeurs valides sont les suivantes :\n\n - created \n - transmitted\n - suspended \n\nIndique l'état actuel de l'envoi.            "
            type: string
            maxLength: 14
        trackingPin:
            description: "This is the tracking PIN for the shipment. \n\n---\n\nIl s'agit du numéro d'identification du produit (NIP) pour l'envoi."
            type: string
            minLength: 11
            maxLength: 16
        returnTrackingPin:
            description: "This is the tracking PIN for the return shipment.\n\n---\n\nIl s'agit du numéro d'identification du produit (NIP) pour l'envoi de retour."
            allOf:
                -
                    $ref: '#/components/schemas/trackingPin'
        poNumber:
            description: "The Canada Post Purchase Order number; only applicable and returned on a shipment where no manifest is required for proof of payment.\n\n---\n\nIl s'agit du numéro de bon de commande de Postes Canada. Il ne s'applique et n'est affiché que pour pour lequel un manifeste n'est pas requis à titre de preuve de paiement.            "
            type: string
            pattern: '^[a-zA-Z0-9]{1,10}$'
        poNumberManifest:
            allOf:
                -
                    $ref: '#/components/schemas/poNumber'
            description: "This is the PO number for the manifest, except for an empty manifest where it is always set to EMPTY.\n\n---\n\nIl s'agit du numéro de bon de commande associé au manifeste, sauf dans le cas des manifestes vides, qui sont toujours réglés à « EMPTY »."
        shippingPointId:
            description: "If you deposit your items at a Post Office or other Canada Post facility, provide the site number of the deposit location. Look up the site number using [Find a Deposit Location](https://www.canadapost-postescanada.ca/information/app/fdl/business/findDepositLocation). This information is used for pricing.\n\nYou will also be asked to provide the shippingPointId in your Transmit Shipments request. Enter the same site number or pricing may be affected.\n\nMutually exclusive with requestedShippingPoint but one of the two must be provided.\n\n**Note:** If you deposit your items yourself, we recommend using this field rather than the requestedShippingPoint field to indicate your deposit location.\n\n---\n\nSi vous déposez vos articles à un bureau de poste ou à une autre installation de Postes Canada, fournissez le numéro d'emplacement de ce lieu de dépôt. Recherchez le numéro d'emplacement en question à l'aide de la fonction [Trouver un lieu de dépôt](https://www.canadapost-postescanada.ca/information/app/fdl/entreprise/trouverunlieudedepot). Cette information est utilisée pour la tarification.\n\nVous devrez aussi fournir de nouveau le numéro d'identification du lieu d'expédition (shippingPointId) dans votre demande de service Transmettre les envois. Si vous n'entrez pas le même numéro d'emplacement, des ajustements tarifaires peuvent s'imposer.\n\nOption s'excluant mutuellement avec l'option requestedShippingPoint; cependant, l'une des deux doit être saisie.\n\n**Nota :** Si vous déposez vous-même vos envois, nous vous recommandons d'utiliser cet élément plutôt que le champ requestedShippingPoint pour indiquer votre lieu d'expédition."
            type: string
            maxLength: 4
        expectedMailingDate:
            description: "**Note:** You can omit this field. It will be used in a future release.\n\nAll shipments are priced as per the current shipment date and are re-priced at time of transmit if transmitted at a later date.\n\n---\n\n**Nota :** Vous pouvez omettre ce champ. Il sera utilisé dans une version future.\n\nLe tarif de tous les envois est établi en fonction de la date d'expédition actuelle, puis il est rajusté au moment de la transmission (si l'envoi est transmis à une date ultérieure)."
            type: string
            format: date
        groupId:
            description: "This is the name of the group specified by your system in a prior Create Shipment call.\n\nGroups may be empty of shipments due to a prior Transmit Shipments call since they can persist for up to 24 hours while empty.\n\n**Performance limitations**\n\nTo avoid a timeout of our servers, please follow these recommendations:\n\n- Do not include more than 30 groups per manifest (i.e., maximum of 30 group-ids in one Transmit Shipments request.)\n- Do not put more than 5,000 shipments in one group.\n\n**System limitations**\n\nTo avoid an error, please do not exceed the following limits before performing a Transmit Shipments call:\n\n- Maximum of 50 groups per manifest (error 9109 if exceeded).\n- Maximum of 10,000 shipments in one group (error 9110 if exceeded).\n- Maximum of 10,000 shipments across multiple groups (error 9108 if exceeded).\n\n---\n\nIl s'agit du nom du groupe précisé par le système dans une demande de service précédente pour créer l'envoi.\n\nLes groupes peuvent ne contenir aucun envoi en raison d'une demande de service précédente pour transmettre les envois puisqu'ils peuvent persister jusqu'à 24 heures lorsqu'ils sont vides.\n\n**Limites du rendement**  \n\nAfin d'éviter un délai de temporisation de nos serveurs, veuillez suivre ces recommandations :\n\n- Ne pas inclure plus de 30 groupes par manifeste (p. ex. un maximum de 30 group-ids dans une seule demande de service Transmettre les envois).\n- Ne pas placer plus de 5 000 envois dans un groupe.\n\n**Limites du système**  \n\nPour éviter une erreur, veuillez ne pas dépasser les limites suivantes avant d'effectuer une demande de service Transmettre les envois :\n\n- Maximum de 50 groupes par manifeste (erreur 9109 si la limite est dépassée).\n- Maximum de 10 000 envois dans un groupe (erreur 9110 si la limite est dépassée).\n- Maximum de 10 000 envois dans l'ensemble de plusieurs groupes (erreur 9108 si la limite est dépassée)."
            type: string
            minLength: 1
            maxLength: 32
        transmitShipment:
            description: "This field identifies a shipment where no manifest is required for proof of payment.\n\nThis shipment will be transmitted immediately and a subsequent Transmit Shipments call is not required.\n\nUse this field if you ship fewer than 50 parcels per day from multiple locations using one of these business models:\n\n- Consumer-to-consumer shipping (e.g. online auction websites)\n- Distributed order management\n- Third-party direct fulfillment\n\nWhen this field is set to true, you will be charged immediately once your Create Shipment request is complete. Your shipment cannot be voided.\n\n**Important:** If you use traditional contract shipping and manifest processes (e.g. you ship more than 50 parcels per day from a central warehouse), this process is not for you. You must continue to use the regular manifest process. Failure to do so will result in refusal of your shipment until you produce the required manifests.\n\nIf you are a non-contract shipping customer who uses contract shipping web services, you must provide this field.\n\n---\n\nCe champ désigne un envoi pour lequel un manifeste n'est pas requis à titre de preuve de paiement.\n\nCet envoi sera transmis immédiatement et une demande de service « Transmettre les envois » n'est pas requise.\n\nUtilisez ce champ si vous expédiez moins de 50 colis par jour à partir de différents endroits à l'aide de l'un des modèles opérationnels ci-dessous.\n\n-   Expédition de consommateur à consommateur (p. ex. sites Web de vente aux enchères en ligne)\n-   Gestion de la distribution des commandes\n-   Livraison directe par une tierce partie\n\nLorsque ce champ est réglé à « Vrai », la facturation sera effectuée immédiatement après la présentation d'une demande de création d'un envoi. Votre envoi ne peut pas être annulé.\n\n**Important :** Si vous utilisez les procédés traditionnels liés à l'expédition avec convention et aux manifestes (p. ex. si vous expédiez plus de 50 colis par jour à partir d'un entrepôt central), ce procédé ne vous convient pas. Vous devez continuer à utiliser le procédé habituel lié aux manifestes. Le non-respect de cette consigne entraînera le refus de votre envoi jusqu'à ce que vous produisiez les manifestes requis.\n\nSi vous êtes un client des services d'expédition sans convention qui utilise des services Web d'expédition avec convention, vous devez fournir ce champ.             "
            type: boolean
            enum:
                - true
        quickshipLabelRequested:
            description: "Use this field if you already have a domestic parcel with the recipient's name and address on it, but you want to generate an additional label to affix to the parcel for tracking purposes.\n\nSet this field to true, and, for billing purposes, provide the country code (must be CA)  and the postal code, in the destination structure. A label that contains a tracking barcode and the words \"Quick Ship – Refer to Address Label/Expédition rapide – Reportez-vous à l'étiquette d'adresse\" will be generated.\n\nOnly provide this parameter when you want a Quick Ship label (i.e. do not provide when false).\n\n---\n\nUtilisez ce champ si vous avez déjà un colis du régime intérieur indiquant le nom et l'adresse du destinataire, mais que vous voulez créer une étiquette supplémentaire aux fins de suivi.\n\nRéglez ce champ à « true » et, à des fins de facturation, fournissez le code du pays (doit être CA) et le code postal dans la structure de destination. Une étiquette comprenant un code à barres de repérage et la mention « Quick Ship – Refer to Address Label/Expédition rapide – Reportez-vous à l'étiquette d'adresse » sera créée.\n\nFournissez uniquement ce paramètre lorsque vous souhaitez créer une étiquette d'expédition rapide (ne fournissez pas ce paramètre lorsque l'élément est réglé à « false »)."
            type: boolean
        cpcPickupIndicator:
            description: "Set this field to true if your shipments are picked up by Canada Post or a third party. Provide the Postal Code of your pickup location in requestedShippingPoint.\n\nOmit this field if you deposit your shipments yourself.\n\nMutually exclusive with shippingPointId.\n\nYou must also set this field to true in your Transmit Shipments request.\n\n**Note:** In a future release it will become mandatory to explicitly identify whether your shipment is picked up by Canada Post  (by providing both this indicator and requestedShippingPoint) or deposited at a Canada Post site (by providing shippingPointId).\n\nWe recommend preparing for this change by providing this indicator (and requestedShippingPoint) if your shipment is picked up by Canada Post.\n\n---\n\nRéglez cet élément à « true » si vos envois sont ramassés par Postes Canada ou par une tierce partie. Fournissez le code postal de votre lieu de ramassage dans le champ requestedShippingPoint.\n\nNe fournissez pas ce renseignement si vous déposez vous-même vos envois.\n\nOption s'excluant mutuellement avec le champ shippingPointId.\n\nVous devez aussi régler ce champ à « true » dans votre demande Transmettre les envois.\n\n**Nota :** Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramassé par Postes Canada (en fournissant à la fois cet indicateur et le champ requestedShippingPoint) ou déposé à un emplacement de Postes Canada (en fournissant le champ shippingPointId).\n\nNous vous recommandons de vous préparer à ce changement en offrant cet indicateur (et le champ requestedShippingPoint) si votre envoi est ramassé par Postes Canada."
            type: boolean
            enum:
                - true
        requestedShippingPoint:
            description: "Postal Code of the location where your shipments are picked up. The Postal Code you provide is used for pricing purposes.\n\nIf you deposit your shipments yourself, you have 2 choices:\n\n- Omit this field and provide the site number of your deposit location in shippingPointId. (recommended), or\n\n- Provide the postal code of your deposit location here and omit shippingPointId.\n\n**Note:** Using requestedShippingPoint to indicate your deposit location postal code will be discontinued in a future release.  If you deposit your shipments yourself, we recommend using the shippingPointId field.\n\nMandatory when cpcPickupIndicator is provided.\n\nMutually exclusive with shippingPointId, but one of the two must be provided.\n\nYou will be asked to provide the requestedShippingPoint again in your Transmit Shipments request. If you use a different Postal Code, it may result in a price adjustment depending on the difference in distance between the two locations.\n\n---\n\nIl s'agit du code postal de l'emplacement où vos envois sont ramassés. Le code postal fourni est utilisé aux fins de tarification.\n\nSi vous déposez vous-même vos envois, vous avez deux choix :\n\nne pas régler ce champ, et indiquer le numéro d'identification de l'emplacement d'expédition dans shippingPointId (option recommandée); fournir le code postal de votre lieu d'expédition ici et ne pas régler le champ shippingPointId. Nota : L'utilisation de le champ requestedShippingPoint pour indiquer le code postal de votre lieu d'expédition ne sera plus possible dans une version future. Si vous déposez vous-même vos envois, nous vous recommandons d'utiliser l'élément shippingPointId.\n\nCet élément est obligatoire lorsque l'indicateur de ramassage de la SCP (cpcPickupIndicator) est fourni.\n\nOption s'excluant mutuellement avec le champ shippingPointId; cependant, l'une des deux doit être saisie."
            type: string
            pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
        serviceCode:
            description: "Must be a valid code representing the Canada Post delivery service used\nfor shipping the item.  The most frequently used codes are listed below:\n\nService-Code  | Description\n--------------|------------\nDOM.RP        | Regular Parcel\nDOM.EP        | Expedited Parcel\nDOM.XP        | Xpresspost\nDOM.PC        | Priority\nDOM.LIB       | Library Books\nUSA.EP        | Expedited Parcel USA\nUSA.SP.AIR    | Small Packet USA Air\nUSA.TP        | Tracked Packet – USA\nUSA.TP.LVM    | Tracked Packet – USA (LVM)<br>(large volume mailers)<br><br>Note: To use this option, it must be specified in your\ncontract.\nUSA.XP        | Xpresspost USA\nINT.XP        | Xpresspost International\nINT.IP.AIR    | International Parcel Air\nINT.IP.SURF   | International Parcel Surface\nINT.SP.AIR    | Small Packet International Air\nINT.SP.SURF   | Small Packet International Surface\nINT.TP        | Tracked Packet – International\n\n**Note:** These delivery services and their codes can be discovered by calling the Get Rates and Discover Services web services described in *Rating*.\n\n---\n\nDoit être un code valide correspondant au service de livraison de Postes Canada utilisé pour expédier l'article. Les codes les plus fréquemment utilisés sont énumérés ci-dessous.\n\nCode de service | Description\n----------------|------------\nDOM.RP          | Colis standard\nDOM.EP          | Colis accélérés\nDOM.XP          | Xpresspost\nDOM.PC          | Priorité\nDOM.LIB         | Livres de bibliothèque\nUSA.EP          | Colis accélérés É.-U.\nUSA.SP.AIR      | Petits paquets-avion à destination des É.-U.\nUSA.TP          | Paquet repérable – É.-U.\nUSA.TP.LVM      | Paquet repérable – É.-U. (GEC)<br>(gros expéditeur de courrier)<br><br>Nota : Cette option doit figurer dans votre convention pour pouvoir être utilisée.\nUSA.XP          | Xpresspost É.-U.\nINT.XP          | Xpresspost – International\nINT.IP.AIR      | Colis-avion du régime international\nINT.IP.SURF     | Colis de surface du régime international\nINT.SP.AIR      | Petits paquets-avion du régime international\nINT.SP.SURF     | Petits paquets de surface du régime international\nINT.TP          | Paquet repérable – International\n\n**Nota :** Les services de livraison et leurs codes peuvent être obtenus en faisant appel aux services « Obtenir les tarifs » et « Découvrir les services » décrits dans la section *Tarification*."
            type: string
            minLength: 1
            maxLength: 32
        optionCode:
            description: "This is the option code indicating an option that applies to this shipment.\n\nValid option codes are as follows\n\n- SO - Signature\n- COV - Coverage\n- COD - Collect on delivery\n- PA18 - Proof of Age Required - 18\n- PA19 - Proof of Age Required - 19\n- HFP - Card for pickup\n- DNS - Do not safe drop\n- LAD - Leave at door - do not card\n- D2PO - Deliver to Post Office\n\n**Note:** The D2PO option indicates that the parcel will be delivered directly to a nearby Post Office. For the D2PO option, the following fieldss are required:\n\n- name (under destination)\n- clientVoiceNumber (under destination)\n- notification\n- optionQualifier2\n\n**Note:** If you select Collect on Delivery (COD), specify Card for Pickup (HFP) or Deliver to Post Office (D2PO). This is to facilitate the collection of COD funds at a post office. If not specified, the system will default to HFP.\n\n**Non-delivery handling codes**\n\n(required for some U.S.A. and international shipments)\n\n- RASE - Return at Sender's Expense\n- RTS - Return to Sender\n- ABAN - Abandon\n\n---\n\nRequis si le champ parent correspondant « option » existe.\n\nIl s'agit du code d'option indiquant l'option qui s'applique à l'envoi.\n\nLes codes d'option valides sont les suivants :\n\n- SO – Signature\n- COV – Couverture\n- COD – Contre remboursement\n- PA18 – Preuve d'âge requise (18 ans)\n- PA19 – Preuve d'âge requise (19 ans)\n- HFP – Annoncer par carte\n- DNS – Ne pas laisser en lieu sûr\n- LAD – Laisser à la porte – Pas d'avis\n- D2PO – Livrer au bureau de poste\n\n**Nota :** L'option « D2PO » indique que le colis sera livré directement à un bureau de poste proche. Le champ suivants sont requis pour l'option « D2PO » :\n\n- name (sous destination)\n- clientVoiceNumber (sous destination)\n- notification\n- optionQualifier2\n\n**Remarque :** Si vous choisissez l'option de contre remboursement (COD), l'option Annoncer par carte (HFP) ou l'option Livrer au bureau de poste (D2PO). La perception de fonds pour des envois contre remboursement est ainsi facilitée au bureau de poste. Si aucune option n'est choisie, le système sélectionnera par défaut l'option HFP.\n\n**Codes de traitement pour la non-livraison**\n\n(requis pour certains envois à destination des É.-U. et du régime international)\n\n- RASE – Retourner aux frais de l'expéditeur\n- RTS – Renvoi à l'expéditeur\n- ABAN – Abandon            "
            type: string
            minLength: 1
            maxLength: 10
        methodOfPayment:
            description: "This indicates what the method of payment is for the manifests that are to be generated.\n\nValid methods of payment are as follows:\n\n- CreditCard = the payment will be by credit card.\n- Account = the payment will be via an existing contract with the paid-by-customer.\n- SupplierAccount = the payment will be through the Supplier Account identified as default in the customer profile (only available to Supplier Account providers).\n\n**Note:** Different shipments may have different paid-by-customers. Separate manifests will be generated for shipments with different paid-by-customers.\n\n---\n\nCela désigne le mode de paiement utilisé pour les manifestes devant être générés.\n\nLes modes de paiement valides sont les suivants :\n\n- CreditCard = Le paiement sera effectué par carte de crédit.\n- Account = Le paiement se fera par l'intermédiaire d'une convention en vigueur qui aura été conclue avec le payeur.\n- SupplierAccount = le paiement se fera par l'intermédiaire du compte de fournisseur désigné comme valeur par défaut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).\n\n**Nota :** Différents payeurs pourraient être associés à différents envois. Des manifestes distincts seront générés pour les envois dont les payeurs sont différents.            "
            type: string
            maxLength: 15
        baseAmount:
            description: "This is the base amount cost for shipping in $CAD.\n\n---\n\nIl s'agit du coût de base pour l'expédition en dollars canadiens."
            type: number
            exclusiveMinimum: true
            minimum: 0
            maximum: 999999.99
            multipleOf: 0.01
        costNonZero:
            type: number
            exclusiveMinimum: true
            minimum: 0
            maximum: 999999.99
            multipleOf: 0.01
        costAllowsZero:
            type: number
            minimum: 0
            maximum: 999999.99
            multipleOf: 0.01
        costAllowsNegative:
            type: number
            minimum: -999999.99
            maximum: 999999.99
            multipleOf: 0.01
        phoneNumber:
            type: string
            description: "Phone number to be printed on the manifest.        \n\n---\n\nNuméro de téléphone devant être imprimé sur le manifeste            "
            maxLength: 25
        returnRecipient:
            type: object
            description: "The returnRecipient structure provides the shipping details (e.g. address) for the return delivery as it shows on the return label.\n\n---\n\nLa structure de l'élément « returnRecipient » fournit les détails d'expédition (p. ex. adresse) pour la livraison d'un envoi retourné, tels qu'ils figurent sur l'étiquette du Service de retour."
            properties:
                name:
                    $ref: '#/components/schemas/name'
                company:
                    $ref: '#/components/schemas/company'
                addressDetails:
                    $ref: '#/components/schemas/addressDomestic'
        returnNotification:
            description: "The email address that an on-delivery notification will be sent to when the return shipment is delivered.\n\n---\n\nIl s'agit de l'adresse électronique à laquelle un avis de livraison sera envoyé lorsque les envois retournés seront livrés."
            type: string
            pattern: '^([''_A-Za-z0-9\-+]+)(\.[''_A-Za-z0-9\-+]+)*@([A-Za-z0-9-]+)(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,})$'
            maxLength: 60
        dimensionMeasurement:
            type: number
            exclusiveMinimum: true
            minimum: 0
            maximum: 999.9
            multipleOf: 0.1
        parcelCharacteristics:
            description: "Describes the characteristics of the parcel.\n\n---\n\nDécrit les caractéristiques du colis."
            type: object
            properties:
                weight:
                    description: "Total package weight in kg.\n\n---\n\nPoids total du colis en kilogrammes."
                    type: number
                    exclusiveMinimum: true
                    minimum: 0
                    maximum: 999.999
                    multipleOf: 0.001
                dimensions:
                    description: "Contains the physical dimensions of the parcel, which can be used to make a more accurate determination of shipping cost.\n---\nContient les dimensions physiques du colis qui peuvent être utilisées pour déterminer les frais d'expédition de façon plus précise."
                    type: object
                    properties:
                        length:
                            description: "Length of parcel in cm.\n\n---\n\nLongueur du colis en centimètres."
                            $ref: '#/components/schemas/dimensionMeasurement'
                        width:
                            description: "Width of parcel in cm.\n\n---\n\nLargeur du colis en centimètres."
                            $ref: '#/components/schemas/dimensionMeasurement'
                        height:
                            description: "Height of parcel in cm.\n\n---\n\nHauteur du colis en centimètres."
                            $ref: '#/components/schemas/dimensionMeasurement'
                    required:
                        - length
                        - width
                        - height
                unpackaged:
                    description: "Indicates whether a shipment is unpackaged or not. For example, auto tires may be an example of an unpackaged shipment.\n\n---\n\nIndique si un envoi est emballé ou non. Par exemple, les pneus d'une voiture peuvent constituer un envoi non emballé."
                    type: boolean
                mailingTube:
                    description: "Indicates whether a shipment is contained in a mailing tube. e.g. a poster tube\n---\nIndique si un envoi est inséré dans un tube d'expédition (p. ex. tube contenant une affiche)."
                    type: boolean
                oversized:
                    description: "Indicates whether the parcel is oversized or not.\n\n**Note:** If parcel dimensions have been provided, then this field will be automatically determined (as either true or false) based on the parcel dimensions (regardless of whether you include a value for the \"oversized\" field). However, if no dimensions are provided, then you can specify that a parcel is oversized (or not) using this field.\n\n---\n\nIndique si le colis est surdimensionné ou non.\n\nNota : Si les dimensions du colis ont été fournies, ce champ sera donc automatiquement défini (comme étant vrai ou faux) en fonction de ces dimensions (peu importe si vous ajoutez une valeur dans le champ « oversized »). Toutefois, si aucune dimension n'est fournie, vous pouvez préciser que le colis est surdimensionné (ou non) à l'aide de ce champ."
                    type: boolean
            required:
                - weight
        name:
            description: "Contact name.\n\n---\n\nNom du contact."
            type: string
            maxLength: 44
        company:
            description: "Company name.\n\n---\n\nNom de l'entrepris."
            type: string
            maxLength: 44
        additionalAddressInfo:
            description: "Additional address information for the destination.\n\nThis information is printed directly above address line 1 on the shipping label.\n\n---\n\nDonnées d'adressage supplémentaires pour la destination.\n\nCes renseignements sont imprimés directement au-dessus de la ligne d'adresse 1 sur l'étiquette d'expédition."
            type: string
            maxLength: 44
        contactPhone:
            description: "Contact phone number.\n\n---\n\nNuméro de téléphone du contact."
            type: string
            maxLength: 25
        clientVoiceNumber:
            description: "Phone number at the destination. Not required for domestic shipments unless the Deliver to Post Office option has been selected.\n\n**Note:** In addition to numbers, the following characters are also accepted in this field:\n\n- A plus sign (+), but only as the first character in the string.\n- Period (.), hyphen (-), open and close brackets, space, and x or p to indicate an extension.\n\n---\n\nNuméro de téléphone du destinataire. Il n'est pas requis pour les envois du régime intérieur, sauf si l'option « Livrer au bureau de poste » a été sélectionnée.\n\n**Remarque :** En plus des chiffres, les caractères suivants sont acceptés dans ce champ :\n\n- Un symbole d'addition (+), mais seulement tout au début de la chaîne de caractères.\n- Un point (.), un tiret (-), des parenthèses ou une espace suivie d'un « x » ou d'un « p » pour indiquer un numéro de poste."
            type: string
            maxLength: 25
        addressLine1:
            description: "Address line 1.\n\n---\n\nLigne d'adresse 1."
            type: string
            minLength: 1
            maxLength: 44
        addressLine2:
            description: "Address line 2.\n\n---\n\nLigne d'adresse 2.                           "
            type: string
            maxLength: 44
        city:
            description: "City.\n\n---\n\nVille."
            type: string
            minLength: 1
            maxLength: 40
        provStateDomestic:
            type: string
            description: "Standard Canadian province code.            \n\n---\n\nCode de province standard pour les provinces au Canada."
            minLength: 2
            maxLength: 2
        provState:
            description: "Province or state.            \n\n---\n\nProvince ou État."
            type: string
            minLength: 1
            maxLength: 20
        countryCode:
            description: "Country code for the manifest address; CA and US are accepted.\n\nRequired if US. Optional if CA.\n\n---\n\nCode de pays pour l'adresse du manifeste; CA et US sont acceptés.\n\nObligatoire si US. Facultatif si CA."
            type: string
            pattern: '^[a-zA-Z][a-zA-Z]$'
        postalZipCodeDomestic:
            type: string
            description: "Canadian Postal Code.\n\n---\n\nCode postal canadien."
            pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
        postalZipCodeDomesticUs:
            type: string
            description: "Postal Code or zip code:\n\n- 6-character alphanumeric for Canada (A9A9A9).\n\n- 5-digit or 5-4 digit numeric code for US.\n\n---\n\nCode postal ou ZIP:\n\n- Six caractères alphanumériques pour le Canada [A9A9A9].\n\n- Code numérique à cinq chiffres ou à neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les États-Unis."
            anyOf:
                -
                    pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
                -
                    pattern: '^\d{5}(-\d{4})?$'
        postalZipCodeAll:
            type: string
            description: "Postal Code or zip code:\n\n- 6-character alphanumeric for Canada (A9A9A9).\n- 5-digit or 5-4 digit numeric code for US.\n- Up to 14 characters (free format) for other countries.\n\n---\n\nCode postal ou ZIP:\n\n- Six caractères alphanumériques pour le Canada [A9A9A9].\n- Code numérique à cinq chiffres ou à neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les États-Unis.\n- Jusqu'à 14 caractères (tout format) pour les autres pays."
            anyOf:
                -
                    pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
                -
                    pattern: '^\d{5}(-\d{4})?$'
                -
                    pattern: '^.{1,14}$'
            minLength: 1
            maxLength: 14
        addressDomestic:
            type: object
            description: "Domestic address data.\n\nBlank address fields will be removed for formatting the labels.   \n\n---\n\nDonnées d'adresses du régime intérieur.\n\nLes champs d'adresse vides seront retirés pendant le formatage des étiquettes.         "
            properties:
                addressLine1:
                    $ref: '#/components/schemas/addressLine1'
                addressLine2:
                    $ref: '#/components/schemas/addressLine2'
                city:
                    $ref: '#/components/schemas/city'
                provState:
                    $ref: '#/components/schemas/provStateDomestic'
                postalZipCode:
                    $ref: '#/components/schemas/postalZipCodeDomestic'
            required:
                - addressLine1
                - city
                - provState
                - postalZipCode
        manifestAddress:
            description: "This structure contains the address that is printed on the manifest label.\n\n---\n\nCette structure contient l'adresse imprimée sur l'étiquette du manifeste."
            type: object
            properties:
                manifestCompany:
                    description: "The company name of the manifest address.\n\nThis is printed on the manifest document.\n\n---\n\nNom de l'entreprise figurant dans l'adresse du manifeste.\n\nLe nom est imprimé sur le manifeste."
                    type: string
                    minLength: 1
                    maxLength: 44
                manifestName:
                    description: "Contact name for the manifest address.\n\nThis is printed on the manifest document.\n\n---\n\nNom de la personne-ressource figurant dans l'adresse du manifeste\n\nLe nom est imprimé sur le manifeste."
                    type: string
                    minLength: 1
                    maxLength: 44
                phoneNumber:
                    $ref: '#/components/schemas/phoneNumber'
                addressDetails:
                    description: "This structure contains the address that is printed on the manifest label.\n\n---\n\nCette structure contient l'adresse imprimée sur l'étiquette du manifeste."
                    type: object
                    properties:
                        addressLine1:
                            $ref: '#/components/schemas/addressLine1'
                        addressLine2:
                            $ref: '#/components/schemas/addressLine2'
                        city:
                            $ref: '#/components/schemas/city'
                        provState:
                            $ref: '#/components/schemas/provState'
                        countryCode:
                            $ref: '#/components/schemas/countryCode'
                        postalZipCode:
                            $ref: '#/components/schemas/postalZipCodeDomesticUs'
                    required:
                        - addressLine1
                        - city
                        - provState
                        - postalZipCode
            required:
                - manifestCompany
                - phoneNumber
                - addressDetails
        addressDestination:
            description: "Contains the address data the destination of the shipment.\n\nBlank fields will be removed for formatting the labels.\n\n---\n\nContient les données d'adressage liées à la destination de l'envoi.\n\nLes champs vides seront retirés pendant le formatage des étiquettes."
            type: object
            properties:
                addressLine1:
                    allOf:
                        -
                            $ref: '#/components/schemas/addressLine1'
                    description: "Address at the destination.\n\nNot required when quickshipLabelRequested is true; mandatory\notherwise.\n\n---\n\nAdresse de l'expéditeur.\n\nN'est pas requis lorsque quickshipLabelRequested est réglé à « true »; obligatoire sinon.               "
                addressLine2:
                    $ref: '#/components/schemas/addressLine2'
                city:
                    allOf:
                        -
                            $ref: '#/components/schemas/city'
                    description: "Destination city.\n\nOptional for international shipments. Required for domestic and\nU.S.A. shipments.\n\nNot required when quickshipLabelRequested is true.            \n\n---\n\nVille de destination.\n\nOptionnel pour les envois du régime international. Requis pour\nles envois à destination des États-Unis et du régime intérieur.\n\nN'est pas requis lorsque quickshipLabelRequested est réglé à «\ntrue »."
                provState:
                    allOf:
                        -
                            $ref: '#/components/schemas/provState'
                    description: "Province or state.\n\n- Standard province code for provinces within Canada.\n- Standard state code for U.S. states.\n- Free form for states and provinces of other countries.\n\nOptional for international shipments. Required for domestic and U.S.A. shipments (except when quickshipLabelRequested is true).\n\n---\n\nProvince ou État.\n\nIl faut utiliser l'un des codes suivants :  \n\n- Code de province standard pour les provinces au Canada.\n- Code d'état standard pour les États américains.\n- Format non structuré pour les États et les provinces des autres pays.\n\nOptionnel pour les envois du régime international. Requis pour les envois à destination des États-Unis et du régime intérieur. (Sauf lorsque quickshipLabelRequested est réglé à « true ».)"
                countryCode:
                    $ref: '#/components/schemas/countryCode'
                postalZipCode:
                    $ref: '#/components/schemas/postalZipCodeAll'
            required:
                - countryCode
        sender:
            description: "This structure contains data about the sender that will appear in the \"From\" address of the label.  Blank fields will be removed for address formatting.\n\n---\n\nCette structure contient des données sur l'expéditeur correspondant à l'adresse de l'expéditeur figurant sur l'étiquette. Les champs vides seront retirés pendant le formatage des adresses.                 "
            type: object
            properties:
                name:
                    $ref: '#/components/schemas/name'
                company:
                    $ref: '#/components/schemas/company'
                contactPhone:
                    $ref: '#/components/schemas/contactPhone'
                addressDetails:
                    allOf:
                        -
                            $ref: '#/components/schemas/addressDomestic'
                        -
                            type: object
                            properties:
                                countryCode:
                                    allOf:
                                        -
                                            $ref: '#/components/schemas/countryCode'
                                        -
                                            description: "Country code of sender. Must be CA.\n\n---\n\nCode de pays de l'expéditeur. Doit être CA."
                                            enum: [CA]
                            required:
                                - countryCode
            required:
                - company
                - contactPhone
                - addressDetails
        destination:
            description: "This field should always contain the address of the mail recipient, even if you are using the Deliver to Post Office option.\n\n- For regular shipments, this data will appear in the \"To\" address of the label.\n- For Deliver to Post Office shipments, the system will substitute the Post Office address on the label.\n- For Quick Ship shipments (quickshipLabelRequested = true), this is only used for rating purposes and only the destination countryCode (CA) and postalCode fields must be provided.\n\nBlank fields will be removed in the address formatting.\n\nWhen shipping outside of Canada, at least one of name or company is required to comply with international customs regulations.\n\n---\n\nCe champ doit toujours contenir l'adresse du destinataire du courrier, et ce, même si vous utilisez l'option « Livrer au bureau de poste ».\n\n- Pour les envois réguliers, ces données s'afficheront dans l'adresse de destination figurant sur l'étiquette.\n- Pour les envois assortis de l'option « Livrer au bureau de poste », le système remplacera l'adresse du bureau de poste sur l'étiquette.\n- Pour les envois d'expédition rapide (quickshipLabelRequested = true), le champ est seulement utilisé aux fins de tarification, et seuls les champs de destination countryCode (CA) et postalCode doivent être fournis.\n\nLes champs vides seront retirés pendant le formatage des adresses.\n\nSi l'expédition se fait à l'extérieur du Canada, au moins un des champs « name » ou « company » est requis pour respecter les règlements douaniers internationaux."
            type: object
            properties:
                name:
                    $ref: '#/components/schemas/name'
                company:
                    $ref: '#/components/schemas/company'
                additionalAddressInfo:
                    $ref: '#/components/schemas/additionalAddressInfo'
                clientVoiceNumber:
                    $ref: '#/components/schemas/clientVoiceNumber'
                addressDetails:
                    $ref: '#/components/schemas/addressDestination'
            required:
                - addressDetails
            anyOf:
                -
                    properties:
                        addressDetails:
                            properties:
                                countryCode:
                                    pattern: '^[Cc][Aa]$'
                    anyOf:
                        -
                            required:
                                - name
                        -
                            required:
                                - company
                -
                    not:
                        properties:
                            addressDetails:
                                properties:
                                    countryCode:
                                        pattern: '^[Cc][Aa]$'
        options:
            description: "Contains options for the delivery service code such as insurance, COD, etc.\n\n---\n\nContient les options liées au code du service de livraison (p. ex. couverture, CR)."
            type: array
            items:
                description: "A selection of a shipping option (e.g. COD, insurance, etc.)\n\n---\n\nSélection d'une option d'expédition (p. ex. CR, couverture)."
                type: object
                properties:
                    optionCode:
                        $ref: '#/components/schemas/optionCode'
                    optionAmount:
                        allOf:
                            -
                                $ref: '#/components/schemas/costNonZero'
                        description: "Required depending on the value of optionCode.\n\n\ne.g., For COV option, this is the amount of insurance coverage to be purchased.\n\n\nFor COD option, this is the base amount to collect on delivery (shipping costs may also be added by the system as described below in optionQualifier1).\n\n\nOn U.S. and international shipments, do not provide if you want the system to calculate the maximum allowable coverage (see optionQualifier1 below).\n\n---\n\nRequis selon la valeur du code d'option.\n\nExemple : Pour l'option « COV », il s'agit du montant de la couverture à acheter.\n\nPour l'option « COD », il s'agit du montant de base pour les envois contre remboursement (les frais d'expédition peuvent aussi être ajoutés par le système, tel qu'il est décrit ci-dessous pour le champ « optionQualifier1 »).\n\nNe pas fournir dans le cas des envois à destination des États-Unis ou du régime international si vous voulez que le système calcule la couverture maximale permise (voir le champ optionQualifier1 ci-dessous)."
                    optionQualifier1:
                        description: "Can be used to provide a qualifier for the COD or COV options.\n\nTo indicate if the COD amount is to include the shipping cost or not:\n\n- true = Shipping costs will be added to the COD amount you provided in option amount.\n\n- false = The COD amount to collect is specified in option amount (i.e. Shipping costs are not to be added).\n\nTo use with the COV option on U.S. and international shipments to indicate that the system can apply the maximum allowable coverage amount, which would equal the total value of your goods, up to the allowable maximum for product and country:\n\n- true = Use maximum allowable coverage; when used, there is no need to provide option amount.\n\n- false (the default) = Use the amount of coverage as provided in option amount.\n\n\nFalse is the default if the qualifier is not provided.\n\n---\n\nPeut être utilisé pour fournir un qualificatif pour les options CR ou COV.\n\nPour indiquer si le montant du paiement CR comprend les frais d'expédition ou non :\n\n- Vrai = Les frais d'expédition seront ajoutés au montant CR que vous avez indiqué dans l'option.\n\n- Faux = Le montant CR à percevoir est indiqué dans l'option (c.-à-d. que les frais d'expédition ne seront pas ajoutés).\n\nÀ utiliser avec l'option COV pour les envois à destination des États-Unis ou du régime international pour indiquer que le système peut appliquer le montant de la couverture maximale permise, qui devrait correspondre à la valeur totale de vos articles, jusqu'à la limite maximale permise pour le produit et le pays en question :\n\n  - Vrai = Utiliser la couverture maximale permise; lorsqu'elle est utilisée, il n'est pas nécessaire de fournir le montant de l'option.\n\n  - Faux (par défaut) = Utiliser le montant de couverture indiqué dans le montant de l'option.\n\nSi le qualificatif n'est pas fourni, le champ « Faux » est sélectionné par défaut."
                        type: boolean
                    optionQualifier2:
                        description: "Required if option code requires a 2nd qualifier.\n\nCurrently, the options requiring a 2nd qualifier are:\n\n- **Deliver to Post Office**\n\n  For the Deliver to Post Office option, this field must contain the office id of the destination Post Office.\n\n---\n\nRequis si le code d'option nécessite un second qualificateur.\n\nÀ l'heure actuelle, les options nécessitant un deuxième qualificatif sont les suivants :\n\n- **Livrer au bureau de poste**\n\n  Pour l'option « Livrer au bureau de poste », ce champ doit contenir le numéro d'identification du bureau de poste de destination."
                        type: string
                        maxLength: 12
                required:
                    - optionCode
            minItems: 1
            maxItems: 20
        deliverySpec:
            description: "Provides a description of the delivery request details, including recipient, service code, sender, options, item specification, notification info and reference ids.\n\n---\n\nFournit une description des détails de la demande de livraison, y compris le destinataire, le code de service, l'expéditeur, les options, les spécifications de l'envoi, les renseignements liés à l'avis et les numéros d'identification de référence."
            type: object
            properties:
                serviceCode:
                    $ref: '#/components/schemas/serviceCode'
                sender:
                    $ref: '#/components/schemas/sender'
                destination:
                    $ref: '#/components/schemas/destination'
                options:
                    $ref: '#/components/schemas/options'
                parcelCharacteristics:
                    $ref: '#/components/schemas/parcelCharacteristics'
                notification:
                    $ref: '#/components/schemas/notification'
                printPreferences:
                    $ref: '#/components/schemas/printPreferences'
                preferences:
                    $ref: '#/components/schemas/preferences'
                references:
                    $ref: '#/components/schemas/references'
                customs:
                    $ref: '#/components/schemas/customs'
                settlementInfo:
                    $ref: '#/components/schemas/settlementInfo'
            required:
                - serviceCode
                - sender
                - destination
                - parcelCharacteristics
                - preferences
                - settlementInfo
        returnSpec:
            description: "Contains the return delivery request details, including return\nrecipient, label count, service code and reference ids.  If this\nfield is absent, no return shipping label is required.\n\n---\n\nContient les détails liés à la demande de livraison d'un envoi\nretourné, y compris le destinataire de l'envoi retourné, le\nnombre d'étiquettes, le code du service et les numéros\nd'identification de référence. Si ce champ est absent, aucune\nétiquette d'expédition du Service de retour n'est requise"
            type: object
            properties:
                serviceCode:
                    allOf:
                        -
                            $ref: '#/components/schemas/serviceCode'
                    description: "Must be a valid code representing the Canada Post delivery service used for shipping the item. The most frequently used codes are listed below.\n\n Service-Code | Description\n--------------|------------------\n DOM.RP       | Regular Parcel\n DOM.EP       | Expedited Parcel\n DOM.XP       | Xpresspost\n DOM.PC       | Priority\n DOM.LIB      | Library Books\n\nNote - These delivery services and their codes can be discovered by calling the Get Rates and Discover Services web services described in Rating.\n\n---\n\nDoit être un code valide correspondant au service de livraison de Postes Canada utilisé pour expédier l'article. Les codes les plus fréquemment utilisés sont énumérés ci-dessous.\n\nCode de service | Description\n--------------- | -----------\nDOM.RP          | Colis standard\nDOM.EP          | Colis accélérés\nDOM.XP          | Xpresspost\nDOM.PC          | Priorité\nDOM.LIB         | Livres de bibliothèque\n\nNota : Les services de livraison et leurs codes peuvent être obtenus en faisant appel aux services « Obtenir les tarifs » et « Découvrir les services » décrits dans la section Tarification."
                returnRecipient:
                    $ref: '#/components/schemas/returnRecipient'
                returnNotification:
                    $ref: '#/components/schemas/returnNotification'
            required:
                - serviceCode
                - returnRecipient
        email:
            type: string
            description: "Email address to receive automatic tracking updates.\n\n---\n\nAdresse électronique pour recevoir des mises à jour de suivi automatiques."
            pattern: '^([''_A-Za-z0-9\-+]+)(\.[''_A-Za-z0-9\-+]+)*@([A-Za-z0-9-]+)(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,})$'
            maxLength: 60
        notification:
            description: "Contains client preferences with respect to email notification for tracking events e.g. delivery.\n\nThis field is required if the Deliver to Post Office (D2PO) option has been selected.  For Deliver to Post Office, the email indicated within notification will be used to notify the customer that their parcel is ready for pickup.\n\n---\n\nContient les préférences des clients quant à la fonction d'avis électronique pour les activités de suivi (p. ex. livraison).\n\nCe champ est requis si l'option « Livrer au bureau de poste » (D2PO) a été sélectionnée. Pour la livraison au bureau de poste, le courriel désigné dans le champ « notification » sera utilisé pour aviser le client qu'il peut ramasser son colis."
            type: object
            properties:
                email:
                    $ref: '#/components/schemas/email'
                onShipment:
                    description: "Indicates whether you wish to receive an email notification upon shipment of the parcel.\n\n---\n\nIndique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi."
                    type: boolean
                onException:
                    description: "Indicates whether you wish to receive an email notification on exceptions.\n---\nIndique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi."
                    type: boolean
                onDelivery:
                    description: "Indicates whether you wish to receive an email notification upon delivery of the parcel.\n\n---\n\nIndique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi."
                    type: boolean
            required:
                - email
                - onShipment
                - onException
                - onDelivery
        printPreferences:
            description: "Contains print preferences for the labels.\n\n---\n\nContient les préférences d'impression pour les étiquettes."
            type: object
            properties:
                outputFormat:
                    description: "8.5x11 indicates paper and 4x6 indicates thermal.\n\n---\n\nLe format du papier ordinaire est de 8 ½ po sur 11 po alors que celui du papier thermosensible est de 4 po sur 6 po."
                    type: string
                    enum:
                        - 8.5x11
                        - 4x6
                encoding:
                    description: "Use this field to specify the output format for your shipping label: PDF or ZPL II. If not provided, PDF will be selected by default.\n\nIf you choose ZPL, the response from a Get Artifact call will include a file containing ZPL II printer commands. You will then need to either code a solution or use an application to stream the commands directly to a thermal printer.\n\nFor ZPL II labels, your printer must support truncation. Use our sample code to test your printer's ability to truncate text.\n\nZPL is only available on thermal paper so \"output-format\" must be 4x6.\n\n---\n\nServez-vous de ce champ pour préciser le format de sortie pour votre étiquette d'expédition : PDF ou ZPL II. Si le champ est vide, le format PDF sera sélectionné par défaut.\n\nSi vous choisissez le format ZPL, la réponse du service « Obtenir l'artefact » inclura un fichier contenant des commandes d'impression ZPL II. Vous devrez ensuite coder une solution ou utiliser une application afin d'envoyer les commandes directement à une imprimante thermique.\n\nPour les étiquettes de format ZPL II, votre imprimante doit permettre la troncature. Utilisez notre exemple de code pour tester la capacité de votre imprimante à tronquer du texte.\n\nLe format ZPL est uniquement disponible sur du papier thermosensible, alors l'élément « output-format » doit être de 4 po sur 6 po."
                    type: string
                    enum:
                        - PDF
                        - ZPL
        preferences:
            description: "Contains a number of preferences with respect to printing labels, etc.\n\n---\n\nContient un certain nombre de préférences en ce qui a trait à l'impression des étiquettes, etc."
            type: object
            properties:
                showPackingInstructions:
                    description: "Indicates whether packing instructions are to be rendered on the label.\n\n---\n\nIndique si les directives d'emballage doivent être inscrites sur l'étiquette."
                    type: boolean
                showPostageRate:
                    description: "Indicates whether the postal rate is to be shown on the label.\n\nThis field is required only for U.S.A. and international shipments.\n\n---\n\nIndique si le tarif postal doit être inscrit sur l'étiquette.\n\nCe champ est seulement requis pour les envois à destination des États-Unis et du régime international."
                    type: boolean
                showInsuredValue:
                    description: "Indicates whether the insured value is to be shown on the label.\n\nThis field is required only for insured U.S.A. and international shipments.\n\n---\n\nIndique si la valeur assurée doit être inscrite sur l'étiquette.\n\nCe champ est seulement requis pour les envois assurés à destination des États-Unis et du régime international."
                    type: boolean
            required:
                - showPackingInstructions
        references:
            description: "Contains reference fields that you assign. You can assign these alternate (possibly unique) identification numbers to the shipment for any purpose useful to you.\n\n---\n\nContient des champs de référence que vous pouvez attribuer. Vous pouvez attribuer ces autres numéros d'identification (pouvant être uniques) à l'envoi pour une raison quelconque utile pour vous."
            type: object
            properties:
                costCentre:
                    type: string
                    description: "This is a value you assign for use by your applications. The value you enter here will appear on your invoice and in the PosteCS secure email that we use to send your invoice.        \n\n---\n\nIl s'agit d'une valeur que vous pouvez attribuer pour vos applications. La valeur que vous saisissez ici apparaîtra sur votre facture et dans le courriel sécurisé PosteCS que nous utilisons pour envoyer votre facture.            "
                    maxLength: 30
                customerRef1:
                    description: "This is a user-defined value available for use by your applications. (e.g. you could use this field as an internal \"order id\"). The value you enter here will appear on the shipping label, in Track and – for customers who subscribe to our Automated Parcel Tracking service – in your APT file.\n\n---\n\nIl s'agit d'une valeur définie par l'utilisateur disponible pour vos applications (p. ex. vous pourriez utiliser ce champ pour le numéro d'identification d'une commande interne). La valeur que vous saisissez ici apparaîtra sur l'étiquette d'expédition, dans l'outil Repérer et, pour les clients qui sont inscrits à notre service de suivi automatisé des colis, dans votre fichier SAC."
                    type: string
                    maxLength: 35
                customerRef2:
                    description: "This is a user-defined value available for use by your applications. The value you enter here will appear on the shipping label, in Track and – for customers who subscribe to our Automated Parcel Tracking service – in your APT file.\n\n---\n\nIl s'agit d'une valeur définie par l'utilisateur disponible pour vos applications. La valeur que vous saisissez ici apparaîtra sur l'étiquette d'expédition, dans l'outil Repérer et, pour les clients qui sont inscrits à notre service de suivi automatisé des colis, dans votre fichier SAC"
                    type: string
                    maxLength: 35
        customs:
            description: "Contains information to be printed on the label to facilitate passing through customs at international borders.\n\n---\n\nContient des renseignements qui doivent être imprimés sur l'étiquette pour faciliter le dédouanement transfrontalier."
            type: object
            properties:
                usdeclarationid:
                    description: "A declaration ID is required when shipping items to the US if a Zonos account key is not included in the header. Please provide your Zonos declaration id here when it is being generated directly from their APIs. Each declaration ID is unique to a single shipment.\n\n---\n\nUn ID de déclaration est requis lors de l’expédition d’articles vers  les États-Unis si une clé de compte Zonos n’est pas incluse dans  l’en-tête. Veuillez saisir votre ID de déclaration Zonos ici lorsqu’il  est généré directement à partir de leurs API. Chaque envoi doit avoir  son propre ID de déclaration."
                    type: string
                    minLength: 1
                    maxLength: 30
                currency:
                    description: "This is the currency of the receiving country. The currency code is converted to uppercase, if not already. Value must be:\n\n- CAD for Canadian currency\n- USD for U.S. currency\n- Other valid ISO currency code\n\nRequired if the corresponding parent field \"customs\" exists.\n\n---\n\nIl s'agit de la devise du pays de destination. Le code de devise est converti en majuscules, s'il ne l'est pas déjà. La valeur doit être :\n\n- « CAD » pour une devise canadienne;\n- « USD » pour une devise américaine;\n- Autre code de devise ISO valide\n\nRequis si le champ parent correspondant « customs » existe."
                    type: string
                    minLength: 1
                    maxLength: 3
                conversionFromCad:
                    description: "The conversion rate from the Canadian dollar to the currency you entered in the currency field above;  for example, if you used USD as the target currency and $1.00 CAD = $0.85 USD, the conversion rate is 0.85.\n\nRequired if the corresponding parent field \"customs\" exists and the currency is not CAD.\n\n---\n\nLe taux de conversion du dollar canadien à la devise que vous avez entrée dans le champ de devise ci-dessus; par exemple, si vous entré les dollars américains comme devise cible et que 1,00 $ CAD = 0,85 $ US, le taux de conversion est de 0,85.\n\nRequis si le champ parent correspondant « customs » existe et si la devise n'est pas canadienne."
                    type: number
                    exclusiveMinimum: true
                    minimum: 0
                    maximum: 9999.999999
                    pattern: '^\d{1,4}(?:\.\d{1,6})?$'
                reasonForExport:
                    description: "A code that represents the reason for export, which assists\nwith border crossing.\n\nThe codes and their meanings are as follows:\n\n- DOC = document\n- SAM = commercial sample\n- REP = repair or warranty\n- SOG = sale of goods\n- OTH = other\n\nRequired if the corresponding parent field \"customs\"\nexists.\n\n---\n\nCode représentant la raison de l'exportation, lequel facilite le passage transfrontalier.\n\nVoici les codes et leurs significations :\n\n- DOC = Document  \n- SAM = Échantillon commercial  \n- REP = Réparation ou garantie  \n- SOG = Vente de biens  \n- OTH = Autre\n\nRequis si le champ parent correspondant « customs » existe."
                    type: string
                    minLength: 3
                    maxLength: 3
                otherReason:
                    description: "Contains the reason for export.\n\nRequired if the field reasonForExport is \"other\".\n\n---\n\nRequis si le champ « reasonForExport » est « Autre »."
                    type: string
                    minLength: 4
                    maxLength: 44
                skuList:
                    description: "Contains the list of unique types of items that are contained within this shipment,  as well as information about them. Each item type may have a quantity of 1 or more.  This information is printed on the manifest label to assist with processing of the parcel at customs.\n\n---\n\nContient la liste de types d'articles uniques inclus dans cet envoi ainsi que les renseignements connexes. Une quantité de un ou plus peut être associée à chaque type d'article. Ces renseignements sont imprimés sur l'étiquette du manifeste pour faciliter le traitement du colis aux douanes."
                    type: array
                    items:
                        description: "Contains the information about the item type (number of units, value per unit, etc.) that are contained in this shipment.\n\n---\n\nContient les renseignements sur le type d'article (nombre d'unités, valeur par unité, etc.) que comprend l'envoi."
                        type: object
                        properties:
                            customsNumberOfUnits:
                                description: "The number of units in the parcel.\n\n---\n\nNombre d'unités dans le colis. "
                                type: integer
                                minimum: 1
                                maximum: 9999
                            customsDescription:
                                description: "A customs description of the item.\n\n---\n\nDescription pour douanes de l'article."
                                type: string
                                minLength: 1
                                maxLength: 45
                            sku:
                                description: "A customs sku number or sku name for the item.\n\n**Note:** Only permits up to 15 characters. The length limitations are necessary to comply with international customs regulations.\n\n---\n\nNom ou numéro de l'article aux fins de dédouanement.\n\n**Nota :** Permet un maximum de 15 caractères. Les limites de longueur sont nécessaires à des fins de conformité aux règlements douaniers internationaux.                        "
                                type: string
                                maxLength: 15
                            hsTariffCode:
                                description: "(Numeric field of the general form 9999.99.99.99)\n\nThe tariff code for the item.\n\n---\n\n(Champ numérique de format général 9999.99.99.99)\n\nCode de tarification de l'article."
                                type: string
                                pattern: '^\d{4}(\.\d{2}(\.\d{2}(\.\d{2})?)?)?$'
                            unitWeight:
                                description: "The unit weight of the item in kg.\n\n---\n\nPoids unitaire de l'article en kilogrammes."
                                type: number
                                exclusiveMinimum: true
                                minimum: 0
                                maximum: 99.999
                                multipleOf: 0.001
                            customsValuePerUnit:
                                description: "The value per unit in Canadian currency of the item.\n\n---\n\nValeur unitaire de l'article en devise canadienne.\n"
                                type: number
                                exclusiveMinimum: true
                                minimum: 0
                                maximum: 99999.99
                                multipleOf: 0.01
                            customsUnitOfMeasure:
                                description: "(Three-character ISO code)\n\nIdentifies the unit of measure for the customsNumberOfUnits.\n\n- PCE – Piece\n- NMB – Number\n- PAR – Pair\n- PKG – Package\n- ENV – Envelope\n- LTR – Litre\n- MLT – Millilitre\n- BOX – Box\n- BAG – Bag\n- MTR – Metre\n- MMT – Millimetre\n- DZN – Dozen\n- GRM – Gram\n- KGM – Kilogram\n- CTN – Carton\n- BIN – Bin\n- SET – Number of sets\n- BOT – Bottle\n- TBE – Tube\n- KIT – Kit        \n\n---\n\n(Code de pays ISO à trois caractères)\n\nIndique l'unité de mesure pour le champ customsNumberOfUnits.\n\n- PCE – Article\n- NMB – Numéro\n- PAR – Paire\n- PKG – Paquet\n- ENV – Enveloppe\n- LTR – Litre\n- MLT – Millilitre\n- BOX – Boîte\n- BAG – Sac\n- MTR – Mètre\n- MMT – Millimètre\n- DZN – Douzaine\n- GRM – Gramme\n- KGM – Kilogramme\n- CTN – Carton\n- BIN – Bac\n- SET – Nombre de séries\n- BOT – Bouteille\n- TBE – Tube\n- KIT – Trousse"
                                type: string
                                maxLength: 3
                            countryOfOrigin:
                                description: "(2-character valid country code)\n\nThe country of origin of the corresponding item.\n\nIf the country of origin is not known, the field can be omitted.\n\n---\n\n(Code de pays valide à deux caractères)\n\nPays d'origine de l'article correspondant.\n\nSi le pays d'origine n'est pas connu, le champ peut être omis."
                                type: string
                                minLength: 2
                                maxLength: 2
                                pattern: '^[a-zA-Z][a-zA-Z]$'
                            provinceOfOrigin:
                                description: "(2-character valid province code)\n\nRequired if country of origin is Canada.\n\nThe province of origin of the goods.\n\n---\n\n(Code de province valide à deux caractères)\n\nRequis si le pays d'origine est le Canada.\n\nProvince d'origine des biens."
                                type: string
                                minLength: 2
                                maxLength: 2
                        required:
                            - customsNumberOfUnits
                            - customsDescription
                            - unitWeight
                            - customsValuePerUnit
                    minItems: 1
                    maxItems: 500
                dutiesAndTaxesPrepaid:
                    description: "Reserved for future use.\n\n---\n\nRéservé aux fins d'utilisation ultérieure."
                    type: number
                    exclusiveMinimum: true
                    minimum: 0
                    maximum: 99999.99
                    multipleOf: 0.01
                certificateNumber:
                    description: "If required by customs at the destination, the number of the government/agency certificate or permit.\n\n---\n\nSi requis par les douanes du pays de destination, le numéro du certificat ou du permis du gouvernement ou de l'organisme."
                    type: string
                    maxLength: 10
                licenseNumber:
                    description: "If required by customs at the destination, the number of the government/agency import or export licence.\n\n---\n\nSi requis par les douanes du pays de destination, le numéro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme."
                    type: string
                    maxLength: 10
                invoiceNumber:
                    description: "If required by customs at the destination, the commercial invoice number.\n\n---\n\nSi requis par les douanes du pays de destination, le numéro de la facture commerciale."
                    type: string
                    maxLength: 10
                usDeclarationId:
                    description: "Optional field to enter a US customs reference number.  This number is returned if you directly submit customs data to Zonos, instead of allowing the create-shipment API to send customs data to Zonos.  This field is not used unless the destination country is US.\n---\nChamp facultatif pour saisir un numéro de référence douanier américain. Ce numéro est retourné si vous soumettez directement les données douanières à Zonos, au lieu d'utiliser l'API de création d'expédition. Ce champ n'est utilisé que si le pays de destination est les États-Unis."
                    type: string
                    maxLength: 30
                iossId:
                    description: "Optional field to enter Tax Registration Numbers or IDs (e.g. Tax ID, IRS No., VAT, IOSS number)  for electronic transmission to the receiving post. Note: IOSS should be entered as IMxxxxxxxxxx.\n\n---\n\nChamp facultatif pour la saisie des numéros ou ID d'inscription à l'impôt (p. ex., ID d'inscription à l'impôt, numéro IRS, TVA, numéro IOSS) aux fins de transmission électronique au poste de réception. Remarque : Le numéro IOSS doit être saisi selon le format « IMxxxxxxxxxx »."
                    type: string
                    maxLength: 13
            required:
                - currency
                - reasonForExport
                - skuList
        settlementInfo:
            description: "This structure contains the customer details for settlement of payment, including payment method, customer, mailed-on-behalf-of-customer.\n\n---\n\nCette structure comprend les détails sur le client pour le règlement des paiements, y compris le mode de paiement, le client et le client « Expédié au nom de »."
            type: object
            properties:
                paidByCustomer:
                    $ref: '#/components/schemas/paidByCustomer'
                contractId:
                    $ref: '#/components/schemas/contractId'
                cifShipment:
                    description: "If you have shipments that originate outside of Canada, but are being delivered directly to a Canada Post plant, use this field to identify these shipments as continuous inbound freight (CIF). This option allows you to be eligible for Canadian sales tax exemptions. You will need to provide Canada Post with documentation that shows proof of origin, such as a Canadian customs document or bill of lading.\n\nOnly provide this parameter when the shipment is CIF (i.e. do not provide when false).\n\n---\n\nSi vous avez des envois qui proviennent de l'extérieur du Canada, mais qui sont livrés directement à un établissement de Postes Canada, servez-vous de ce champ pour indiquer que ces envois sont un acheminement continu de marchandises d'arrivée (ACMA). Cette option vous permet d'être admissible à une exemption de la taxe de vente du Canada. Vous devrez fournir à Postes Canada des documents comprenant une preuve d'origine, tels qu'un document émis par les douanes canadiennes ou un connaissement.\n\nFournissez uniquement ce paramètre lorsque l'envoi est un ACMA (ne fournissez pas ce paramètre lorsque le champ est réglé à « false »)."
                    type: boolean
                    enum:
                        - true
                intendedMethodOfPayment:
                    description: "This field indicates the customer's method of payment for a shipment where no manifest is required (transmitShipments=true), or the intended method of payment otherwise (the actual method of payment being in the subsequent Transmit Shipments).\nValid values for intendedMethodOfPayment are:\n- CreditCard = the payment will be by credit card. This must be saved and defaulted on your Canada Post profile.\n- Account = the payment will be by an existing contract with the paid-by-customer.\n- SupplierAccount = the payment will be through the Supplier Account specified in preAuthorizedPayment or identified as default in the customer profile (only available to Supplier Account providers).\n---\nCet élément indique le mode de paiement du client pour un article n'exigeant pas de manifeste (« transmitShipments=true »), ou lorsque la méthode de paiement voulue est différente (le mode de paiement est indiqué dans la demande de service « Transmettre les envois » subséquente).\nLes valeurs valides pour le mode de paiement voulu sont les suivantes :\n- CreditCard = Le paiement sera effectué carte de crédit cela doit être enregistré et faites-en ma carte de crédit par défaut.\n- Account = Le paiement se fera par l'entremise d'une convention en vigueur qui aura été conclue avec le payeur.\n- SupplierAccount = le paiement se fera par l'intermédiaire du compte de fournisseur précisé dans l'élément « preAuthorizedPayment » ou sera désigné comme valeur par défaut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur)."
                    type: string
                    maxLength: 15
                promoCode:
                    description: "Promotional discount code. Note that a promotion code is only valid for a certain period and product.\n\nYour entry will be converted to uppercase (i.e, you can use lowercase or a mix of lower or upper case and will get the same result).\n\n**Note:** Promotion Code DEVPROTEST can be used to test this functionality in the sandbox environment. This promo code is only valid in the sandbox environment and for the following products:\n\n- Xpresspost (DOM.XP)\n- Xpresspost International (INT.XP)\n\n---\n\nChaîne de caractères – Jusqu'à 10 caractères.\n\nCode de réduction promotionnelle. Veuillez noter que les codes promotionnels sont uniquement valides pour une certaine période et pour certains produits.\n\nVotre bulletin de participation sera converti en majuscules (p. ex., vous pouvez utiliser des lettres minuscules ou un mélange de minuscules et de majuscules et obtenir le même résultat).\n\n**Remarque :** Le code promotionnel DEVPROTEST peut être utilisé pour la mise à l'essai des fonctions dans l'environnement « bac à sable ». Ce code promotionnel est uniquement valide dans l'environnement « bac à sable » et pour les produits suivants :\n\n- Xpresspost (DOM.XP)\n- Xpresspost International (INT.XP)"
                    type: string
                    maxLength: 10
            required:
                - intendedMethodOfPayment
        ccReceiptDetails:
            description: "This structure will be provided if the manifest was paid for by credit card through the Transmit Shipments request.\n\nThis structure contains the fields required for a hardcopy credit card receipt.\n\n---\n\nCette structure sera fournie si le manifeste a été payé par carte de crédit dans le cadre d'une demande de service « Transmettre les envois ».\n\nCette structure contient les champs requis pour une copie papier du reçu de carte de crédit."
            type: object
            properties:
                merchantName:
                    $ref: '#/components/schemas/merchantName'
                merchantUrl:
                    $ref: '#/components/schemas/merchantUrl'
                nameOnCard:
                    $ref: '#/components/schemas/nameOnCard'
                authCode:
                    description: "The authorization code received from the credit card issuer.\n\n---\n\nCode d'autorisation reçu de la société émettrice de la carte de crédit."
                    type: string
                    minLength: 1
                    maxLength: 10
                authTimestamp:
                    description: "The date and time that the credit card company authorized the transaction.\n\n---\n\nDate et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit."
                    type: string
                    format: date-time
                cardType:
                    description: "The type of credit card used for the purchase.\n\n---\n\nType de carte de crédit utilisé pour l'achat."
                    enum:
                        - MC
                        - VIS
                        - AME
                        - DC
                        - DIS
                        - ER
                currency:
                    $ref: '#/components/schemas/currency'
                transactionType:
                    $ref: '#/components/schemas/transactionType'
            required:
                - merchantName
                - merchantUrl
                - authCode
                - authTimestamp
                - cardType
                - currency
                - transactionType
        supplierAccountReceiptDetails:
            description: "This structure will be provided if the manifest was paid for by Supplier Account in the Transmit Shipments request.\n\nThis structure is not returned in the sandbox environment.\n\n---\n\nCette structure sera offerte si le manifeste a été payé par compte de fournisseur dans la demande Transmettre les envois.\n\nCette structure n'est pas retournée dans l'environnement « bac à sable »."
            type: object
            properties:
                merchantName:
                    $ref: '#/components/schemas/merchantName'
                merchantUrl:
                    $ref: '#/components/schemas/merchantUrl'
                authCode:
                    description: "The authorization code received from the supplier.\n\n---\n\nLe code d'autorisation reçu du fournisseur."
                    type: string
                    minLength: 1
                    maxLength: 16
                authTimestamp:
                    description: "The date and time the supplier authorized the transaction.\n\n---\n\nDate et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit."
                    type: string
                    format: date-time
                supplierId:
                    description: "The supplier that authorized the transaction. Values are:\n\n- FP = FrancoTyp Postalia\n- NE = Neopost\n- PB = Pitney Bowes\n\n---\n\nLe fournisseur qui a autorisé la transaction. Les valeurs\nsont :\n\n- FP = FrancoTyp Postalia\n- NE = Neopost\n- PB = Pitney Bowes"
                    type: string
                currency:
                    $ref: '#/components/schemas/currency'
                transactionType:
                    $ref: '#/components/schemas/transactionType'
            required:
                - merchantName
                - merchantUrl
                - authCode
                - authTimestamp
                - supplierId
                - currency
                - transactionType
        merchantName:
            description: "Will have the value: \"Canada Post\"\n\n---\n\nLa valeur sera la suivante : « Canada Post »."
            type: string
            minLength: 1
            maxLength: 40
        merchantUrl:
            description: "Will have the value: \"www.canadapost.ca\"\n\n---\n\nLa valeur sera la suivante : « www.canadapost.ca »."
            type: string
            maxLength: 60
        nameOnCard:
            description: "The name on the default credit card stored by Canada Post.\n\n---\n\nNom figurant sur la carte de crédit par défaut sauvegardée par Postes Canada."
            type: string
            minLength: 1
            maxLength: 40
        transactionType:
            description: "Will have the value: \"Sale\".\n\n---\n\nLa valeur sera la suivante : « Sale »."
            type: string
            maxLength: 44
        currency:
            type: string
            description: "The currency of the transaction: CAD.\n\n---\n\nDevise de la transaction : CAD."
            minLength: 1
            maxLength: 3
        links:
            description: "This structure represents a list of links to information relating to the shipment that was generated.\n\n---\n\nCette structure représente une liste de liens vers les renseignements concernant l'envoi créé. "
            type: array
            items:
                $ref: '#/components/schemas/link'
        link:
            description: "Several links will be returned and each will have a unique rel.\ntype:\n\n\n1.  rel=\"self\"\n\n    This indicates that the link represents the shipment just generated. In this case, the href field can be used as an endpoint to the Get Shipment service for the shipment just generated. (See **Get Shipment** for information on how to invoke that service). As the Get Shipment service returns all the same information as the generate Shipment service, it can be used to re-generate (at a later time) all the information provided as part of the generate Shipment\n\n    The href field can also be used to delete the shipment (via an invocation of the empty Shipment service - See **empty Shipment** for information on how to invoke that service).\n\n    The mediaType field will indicate the API version to be followed when calling either the Get Shipment or Transmit Shipments service.\n\n2.  rel=\"label\"\n\n    This indicates that the link represents one of the labels rendered as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Artifact service for that label. (See **Get Artifact** for information on how to invoke that service). The mediaType field will indicate the format of the graphics file (PDF or ZPL).\n\n    Note, for links of type rel=\"label\", the additional field index:\"n\" (e.g. index:\"1\") is also required. This accommodates the situation where a multi-page label is spread over a number of separate artifacts (one for each page). In most cases, there will be only one page, so index=\"1\" will be used.\n\n3.  rel=\"returnLabel\"\n\n    This indicates that the link represents the return label rendered as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Artifact service for that label. (See **Get Artifact** for information on how to invoke that service). The mediaType field will indicate the format of the graphics file (PDF or ZPL).\n\n4.  rel=\"commercialInvoice\"\n\n    This only exists in the case of a US or International shipment where a commercial invoice is required to show to border customs.\n\n    This indicates that the link represents the commercial invoice rendered as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Artifact service for that label. (See the section **Get Artifact** for information on how to invoke that service). The mediaType field will indicate the format of the graphics file (PDF or ZPL).\n\n5.  rel=\"details\"\n\n    This indicates that the link represents additional details that were generated as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Shipment Details service to retrieve that information. (See **Get Shipment Details** for information on how to invoke that service). The mediaType field will indicate the API version to be followed when calling the Get Shipment Details service.\n\n6.  rel=\"price\"\n\n    This indicates that the link represents a price estimation generated as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Shipment Price service to retrieve that information. (See **Get Shipment Price** for information on how to invoke that service). The mediaType field will indicate the API version to be followed when calling the Get Shipment Price service. Not returned when providePricingInfo was set to true in the request.\n\n7.  rel=\"group\"\n\n    This indicates that the link represents the group that the shipment was generated under as part of the generate Shipment process. In this case, the href field is an endpoint to the Get Shipments service to retrieve that information. (See **Get Shipments** for information on how to invoke that service). The mediaType field will indicate the API version to be followed when calling the Get Shipments service.\n\n8.  rel=\"receipt\"\n\n    This link is used to access a credit card receipt that was generated by a generate Shipment process where no manifest is required for proof of payment (See **Get Shipment Receipt** for information on how to obtain the receipt). The mediaType field indicates the API version that will be returned.\n\n    Not returned when provideReceiptInfo was set to true in the request.\n\n9.  rel=\"refund\"\n\n    This link is used to request the refund of a shipment where no manifest is required. A refund can be issued if you have printed a label that you are not going to use, such one that has become spoiled or damaged. See **Request Shipment Refund** for details on how to request a refund. This link is only returned on shipment where no manifest is required.\n\n    In all of the above cases, the value of the mediaType field should be included as an HTTP Accept header in any of the calls to other services pointed to by the href.\n\n---\n\nPlusieurs liens s'afficheront. Un type unique de rel sera associé à chacun d'eux.\n\n1.  rel=\"self\"\n    \n    Indique que le lien représente l'envoi qui vient tout juste d'être créé. Dans ce cas, le champ « href » peut être utilisé comme point final propre au service Obtenir l'envoi pour l'envoi créé. (Consultez la section **Obtenir l'envoi** pour obtenir des renseignements sur la façon de présenter une demande pour ce service.) Étant donné que les renseignements liés au service Obtenir l'envoi sont les mêmes que ceux du service Créer l'envoi, il est possible d'utiliser cet élément pour générer de nouveau (plus tard) tous les renseignements fournis pour le service Créer l'envoi.\n    \n    Le champ « href » peut également être utilisé pour supprimer l'envoi (en présentant une demande de service Annuler l'envoi). Consultez la section **Annuler l'envoi** pour obtenir des renseignements sur la façon de faire.\n    \n    Le champ lié au type de média désignera la version de l'API qu'il faut respecter en présentant une demande de service Obtenir l'envoi ou Transmettre les envois.\n    \n2.  rel=\"label\"\n    \n    Cela indique que le lien représente une des étiquettes produites dans le cadre du procédé de création d'un envoi. Dans ce cas, le champ « href » correspond au point final du service Obtenir l'artefact pour cette étiquette. (Consultez la section **Obtenir l'artefact** pour obtenir des renseignements sur la façon de faire.) Le champ mediaType désignera le format du fichier graphique (PDF ou ZPL).\n    \n    Nota : Pour les liens de type rel=\"label\", le champ supplémentaire index=\"n\" (p. ex., index=\"1\") est aussi requis. Il convient à une situation où une étiquette de plusieurs pages est apposée sur un certain nombre d'artefacts distincts (une pour chaque page). Dans la plupart des cas, il y aura seulement une page, alors le champ index=\"1\" sera utilisé.\n    \n3.  rel=\"returnLabel\"\n\n    Cela indique que le lien représente l'étiquette Service de retour produite dans le cadre du procédé de création d'un envoi. Dans ce cas, le champ « href » correspond au point final du service Obtenir l'artefact pour cette étiquette. (Consultez la section **Obtenir l'artefact** pour obtenir des renseignements sur la façon de faire.) Le champ mediaType désignera le format du fichier graphique (PDF ou ZPL).\n\n5.  rel=\"commercialInvoice\"\n    \n    Il existe seulement dans le cas d'un envoi à destination des États-Unis ou du régime international pour lequel il faut présenter une facture commerciale aux douanes.\n    \n    Cela indique que le lien représente la facture commerciale produite dans le cadre du procédé de création d'un envoi. Dans ce cas, le champ « href » correspond au point final du service Obtenir l'artefact pour cette étiquette. (Consultez la section **Obtenir l'artefact** pour obtenir des renseignements sur la façon de faire.) Le champ mediaType désignera le format du fichier graphique (PDF ou ZPL).\n    \n6.  rel=\"details\"\n    \n    Cela indique que le lien représente les détails supplémentaires produits dans le cadre du procédé de création d'un envoi. Dans ce cas, le champ « href » correspond au point final du service Obtenir les détails de l'envoi pour récupérer ces renseignements. (Consultez la section **Obtenir les détails de l'envoi** pour obtenir des renseignements sur la façon de présenter une demande de service.) Le champ lié au type de média désignera la version de l'API qu'il faut respecter en présentant une demande de service Obtenir les détails de l'envoi.\n    \n7.  rel=\"price\"\n    \n    Cela indique que le lien représente une estimation de prix générée dans le cadre du procédé de création d'un envoi. Dans ce cas, le champ « href » correspond au point final du service Obtenir le tarif de l'envoi pour récupérer ces renseignements. (Consultez la section **Obtenir le tarif de l'envoi** pour obtenir des renseignements sur la façon de présenter une demande de service.) Le champ mediaType désignera la version de l'API qu'il faut respecter en présentant une demande de service Obtenir le tarif de l'envoi. Ne sera pas retourné lorsque le champ « providePricingInfo » est réglé à « true » dans la demande.\n    \n8.  rel=\"group\"\n    \n    Cela indique que le lien représente le groupe en fonction duquel l'envoi a été créé dans le cadre du procédé de création. Dans ce cas, le champ « href » correspond au point final du service Obtenir les envois pour récupérer ces renseignements. (Consultez la section **Obtenir les envois** pour obtenir des renseignements sur la façon de présenter une demande de service.) Le champ mediaType désignera la version de l'API qu'il faut respecter en présentant une demande de service Obtenir les envois.\n    \n    Dans tous les cas susmentionnés, la valeur de le champ mediaType doit être incluse dans l'en-tête HTTP Accept lorsqu'il faut présenter toute autre demande de service désignée par le champ « href ».\n    \n9.  rel=\"receipt\"\n    \n    Ce lien est utilisé pour accéder au reçu de la carte de crédit qui a été généré par le procédé de création d'un envoi pour lequel un manifeste n'est pas requis à titre de preuve de paiement (voir le document sur le service **Obtenir le reçu de l'envoi** pour consulter les renseignements sur la façon d'obtenir le reçu). Le champ lié au type de média désigne la version de l'API qui s'affichera.\n    \n    Ne sera pas retourné lorsque l'élément « provideReceiptInfo » est réglé à « true » dans la demande.\n    \n10. rel=\"refund\"\n    \n    Ce lien sert à demander le remboursement d'un envoi lorsqu'un manifeste n'est pas requis. Un remboursement peut être fait si vous avez imprimé une étiquette que vous n'allez pas utiliser, laquelle a été abîmée ou endommagée. Consulter la section **Demander le remboursement d'un envoi** pour obtenir plus de détails sur la façon de demander un remboursement. Ce lien s'affiche seulement pour les envois pour lesquels aucun manifeste n'est requis.\n    \n    Dans tous les cas susmentionnés, la valeur de le champ mediaType doit être incluse dans l'en-tête HTTP Accept lorsqu'il faut présenter toute autre demande de service désignée par le champ « href ».\n    \n11. rel=\"publicLabel\"\n    \n    Ce lien est à l'URL non-authentifiée à l'étiquette.\n    \n12. rel=\"publicKeyInfo\"\n    \n    Ce lien est utilisé pour demander des détails sur l'étiquette publique (date d'expiration et potentiellement code QR, si demandé)"
            type: object
            properties:
                href:
                    description: "Indicates the endpoint to be used to call the web service. It contains the URL and may also contain a query string.\n\n---\n\nDésigne le point final à utiliser pour présenter une demande de service en ligne. Il contient l'adresse URL et peut également contenir une chaîne de requête."
                    type: string
                rel:
                    description: "Indicates the resource related to the current response.\n\n---\n\nIndique la ressource associée à la réponse actuelle."
                    type: string
                index:
                    description: "Present on links to formatted output such as labels. The value starts at 0 for the first page and subsequent pages (if extant) count up by 1.\n\n---\n\nFait partie des liens vers les données de sortie formatées, comme les étiquettes. La valeur de la première page est de « 0 », et cette valeur augmente de un pour chaque page subséquente (le cas échéant)."
                    type: integer
                    minimum: 0
                mediaType:
                    description: "A character string that indicates the format and version of the data to expect when the web service is invoked. The value in this field should be copied to the HTTP header variable \"Accept\" when the href link is invoked.\n\n---\n\nIl s'agit d'une chaîne de caractères indiquant le format et la version des données prévus lorsqu'un service Internet est utilisé.\nLa valeur de cet attribut doit être copiée dans la variable de l'en-tête HTTP « Accept » lorsque le lien href est utilisé."
                    type: string
            required:
                - href
                - rel
                - mediaType
        messages:
            type: object
            properties:
                title:
                    type: string
                    description: "Type of error.\n\n---\n\nType d'erreur."
                detail:
                    type: string
                    description: "Detailed description of type of error.\n\n---\n\nDescription détaillée du type d'erreur."
                errors:
                    type: array
                    description: "List of errors.\n\n---\n\nListe des erreurs."
                    items:
                        type: object
                        properties:
                            errorCode:
                                type: string
                                description: "Error code related to error.\n\n---\n\nCode d'erreur lié à l'erreur."
                            message:
                                type: string
                                description: "Detailed message for the error that occured.\n\n---\n\nMessage détaillé concernant l'erreur survenue."
                        required:
                            - message
                            - errorCode
                        additionalProperties: false
            required:
                - title
                - detail
                - errors
            additionalProperties: false
            example:
                title: 'Validation failed'
                detail: 'Errors occurred while processing the request.'
                errors:
                    -
                        errorCode: '002'
                        message: 'Duplicate Pin.'
        unauthorizedError:
            type: object
            properties:
                httpCode:
                    type: string
                    description: "Code associated with the unauthorized error.\n  ---\n\nCode associé à l'erreur d'autorisation."
                httpMessage:
                    type: string
                    description: "Error message.\n  ---\n\nmessage d'erreur."
                moreInformation:
                    type: string
                    description: "Detailed error message.\n  ---\n\nMessage d'erreur détaillé."
        createShipmentRequest:
            description: "Create Shipment - Request\n\n---\n\nCréer l'envoi - Demande"
            type: object
            additionalProperties: false
            properties:
                customerRequestId:
                    $ref: '#/components/schemas/customerRequestId'
                groupId:
                    allOf:
                        -
                            $ref: '#/components/schemas/groupId'
                    description: "This field represents the groupId number (or group name) in which to place the created shipment. The group will be created by the Canada Post service if it does not exist.\n\nThe groupId field is required unless transmitShipment is provided, in which case groupId must not be provided.\n\nDo not generate a unique group for each individual shipment. The purpose of a groupId is to group several shipments together to include on the same manifest. For example, grouping is useful in the following scenarios:\n\n- You have multiple fulfillment locations.\n- You want all shipments in a group to be shipped on the same day.\n- You want to group shipments together for internal reference or billing purposes.\n\n**Note:** domestic, U.S., and international shipments will be placed on separate manifests even if they contain the same groupId.\n\n**Performance limitations**\n\nTo avoid a timeout of our servers, please follow these recommendations:\n\n- Do not include more than 30 groups per manifest (i.e., maximum of 30 groupIds in one Transmit Shipments request.)\n- Do not put more than 5,000 shipments in one group.\n\n**System limitations**\n\nTo avoid an error, please do not exceed the following limits before performing a Transmit Shipments call:\n\n- Maximum of 50 groups per manifest (error 9109 if exceeded).\n- Maximum of 10,000 shipments in one group (error 9110 if exceeded).\n- Maximum of 10,000 shipments across multiple groups (error 9108 if exceeded).\n\n---\n\nCe champ correspond au numéro d'identification du groupe (ou au nom du groupe) dans lequel il faut placer l'envoi créé. Le groupe sera créé par le service de Postes Canada s'il n'existe pas.\n\nLe champ groupId est requis, à moins que l'élément transmitShipment soit fourni; dans un tel cas, l'élément groupId ne doit par être fourni.\n\nIl ne faut pas créer un groupe unique pour chaque envoi individuel. Un groupId a pour but de regrouper plusieurs envois ensemble afin de les inclure sur le même manifeste. Par exemple, le regroupement est utile dans les scénarios suivants :\n\n- Vous avez plusieurs emplacements de service.\n- Vous souhaitez que tous les envois dans un groupe soient expédiés le même jour.\n- Vous voulez regrouper les envois ensemble aux fins de référence interne ou de facturation.\n\n**Remarque :** Les envois du régime intérieur, à destination des États-Unis et du régime international seront placés sur des manifestes séparés, même s'ils contiennent le même groupId.\n\n**Limites du rendement**  \n\nAfin d'éviter un délai de temporisation de nos serveurs, veuillez suivre ces recommandations :\n\n- Ne pas inclure plus de 30 groupes par manifeste (p. ex. un maximum de 30 groupIds dans une seule demande de service Transmettre les envois).\n- Ne pas placer plus de 5 000 envois dans un groupe.\n\n**Limites du système**  \n\nPour éviter une erreur, veuillez ne pas dépasser les limites suivantes avant d'effectuer une demande de service Transmettre les envois :\n\n- Maximum de 50 groupes par manifeste (erreur 9109 si la limite est dépassée).\n- Maximum de 10 000 envois dans un groupe (erreur 9110 si la limite est dépassée).\n- Maximum de 10 000 envois dans l'ensemble de plusieurs groupes (erreur 9108 si la limite est dépassée)."
                transmitShipment:
                    $ref: '#/components/schemas/transmitShipment'
                quickshipLabelRequested:
                    $ref: '#/components/schemas/quickshipLabelRequested'
                cpcPickupIndicator:
                    $ref: '#/components/schemas/cpcPickupIndicator'
                requestedShippingPoint:
                    $ref: '#/components/schemas/requestedShippingPoint'
                shippingPointId:
                    $ref: '#/components/schemas/shippingPointId'
                expectedMailingDate:
                    $ref: '#/components/schemas/expectedMailingDate'
                providePricingInfo:
                    description: "This field identifies that you want the shipmentPrice structure included in the response to this call. It will result in a larger payload but eliminates the need for a subsequent call to *Get Shipment Price*.\n\nOnly applicable to a shipment where transmitShipment=true.\n\nOnly provide this parameter if you want pricing details in the response (i.e., do not provide when false).\n\n---\n\nCe champ indique que vous voulez que la structure tarifaire des envois soit incluse dans la réponse à cette demande. Cela entraîne une plus grande charge, mais élimine la nécessité de soumettre une autre demande Obtenir le tarif de l'envoi.\n\nS'applique uniquement aux envois où l'élément « transmitShipment » est réglé à « true ».\n\nFournir ce paramètre uniquement si vous voulez obtenir des détails sur la tarification dans la réponse (ne pas le fournir lorsque l'élément est réglé à « false »)."
                    type: boolean
                    enum:
                        - true
                provideReceiptInfo:
                    description: "This field identifies that you want the shipmentReceipt structure included in the response to this call. It will result in a larger payload but eliminates the need for a subsequent call to *Get Shipment Receipt*.\n\nOnly applicable to a shipment where transmitShipment=true that is paid by credit card or Supplier Account.\n\nOnly provide this parameter if you want receipt details in the response (i.e., do not provide when false).\n\n---\n\nCe champ indique que vous voulez que la structure « shipmentReceipt » soit incluse dans la réponse à cette demande. Il en résulte une plus grande charge, mais cela élimine la nécessité de soumettre une autre demande Obtenir le reçu de l'envoi.\n\nNe s'applique qu'à un envoi où l'élément « transmitShipment=true » est payé par carte de crédit ou par compte de fournisseur.\n\nFournir ce paramètre uniquement si vous voulez que les détails du reçu soient indiqués dans la réponse (c.-à-d. qu'il ne faut pas le fournir lorsque l'élément est réglé à « false »)."
                    type: boolean
                    enum:
                        - true
                deliverySpec:
                    allOf:
                        -
                            $ref: '#/components/schemas/deliverySpec'
                returnSpec:
                    $ref: '#/components/schemas/returnSpec'
                preAuthorizedPayment:
                    description: "Supplier Account providers can pre-authorize payment using the Supplier Account of their customer.\n\n**Important:** This functionality can only be used by Canada Post approved Supplier Account providers, and only on a shipment where no manifest is required.\n\n---\n\nLes fournisseurs de comptes de fournisseur peuvent préautoriser les paiements à l'aide du compte de fournisseur de leurs clients.\n\n**Important :** Cette fonction ne peut être utilisée que par les fournisseurs de comptes de fournisseur approuvés par Postes Canada, et ce, uniquement pour les envois n'exigeant pas de manifeste."
                    type: object
                    properties:
                        accountNumber:
                            description: "The account number from which the amount will be withdrawn; will\nbe used for reconciliation.\n\n---\n\nLe numéro de compte à partir duquel le montant sera retiré;\nsera utilisé aux fins de rapprochement."
                            type: string
                            minLength: 1
                            maxLength: 16
                        authCode:
                            description: "The authorization code from the supplier; will be used for reconciliation.\n\n---\n\nLe code d'autorisation du fournisseur; sera utilisé aux fins de rapprochement."
                            type: string
                            minLength: 1
                            maxLength: 16
                        authTimestamp:
                            description: "The authorization date and time; will be used for reconciliation.\n\n---\n\nLa date et l'heure d'autorisation; seront utilisés aux fins de rapprochement."
                            type: string
                            format: date-time
                        chargeAmount:
                            description: "The amount authorized in Canadian dollars; must match the total charges that will be calculated.\n\n---\n\nLe montant autorisé en dollars canadiens; doit correspondre au total des frais qui seront calculés."
                            type: number
                            minimum: 0
                            maximum: 9999999.99
                            multipleOf: 0.01
                    required:
                        - accountNumber
                        - authCode
                        - authTimestamp
                        - chargeAmount
                createPublicKey:
                    description: "This is an optional field, used to request the public key label URL, and expiry date.\n\nIf true, two new links are provided: publicLabel and publicKeyInfo\n\nNote: Only applicable to 8 1/2 X 11 paper encoded in pdf.\n\n---\n\nIl s'agit d'un champ facultatif, utilisé pour demander l'URL de l'étiquette de clé publique et la date d'expiration.\n\nSi c'est vrai, deux nouveaux liens sont fournis : publicLabel et publicKeyInfo\n\nRemarque : Applicable uniquement à 8 1/2 X 11 papier codé en pdf."
                    type: boolean
                createQrCode:
                    description: "This is an optional field, used to request the QR code image of\nthe public label in base64 format, along with contains public key\nlabel URL, and expiry date.\n\nIf true, two new links are provided: publicLabel and publicKeyInfo.\n\nNote: Only applicable to 8 1/2 X 11 paper encoded in pdf.\n\n---\n\nIl s'agit d'un champ facultatif, utilisé pour demander l'image\nde code QR de l'étiquette publique au format base64, ainsi que\ncontient l'URL de l'étiquette de clé publique et la date\nd'expiration.\n\nc'est vrai, deux nouveaux liens sont fournis : publicLabel et\npublicKeyInfo.\n\nRemarque : Applicable uniquement à 8 1/2 X 11 papier codé en pdf."
                    type: boolean
                    default: false
            allOf:
                -
                    required:
                        - deliverySpec
                -
                    anyOf:
                        -
                            required:
                                - transmitShipment
                            not:
                                required:
                                    - groupId
                        -
                            required:
                                - groupId
                            not:
                                required:
                                    - transmitShipment
            example: "{\n  \"customerRequestId\": \"tc92025\",\n  \"groupId\": \"testGroup\",\n  \"cpcPickupIndicator\": true,\n  \"requestedShippingPoint\": \"K2B8J6\",\n  \"expectedMailingDate\": \"2025-04-26\",\n  \"deliverySpec\": {\n    \"serviceCode\": \"DOM.EP\",\n    \"sender\": {\n      \"name\": \"Russ\",\n      \"company\": \"Toys\",\n      \"contactPhone\": \"1(450)823-8432\",\n      \"addressDetails\": {\n        \"addressLine1\": \"502 MAIN ST N\",\n        \"addressLine2\": \"502 MAIN ST N\",\n        \"city\": \"MONTREAL\",\n        \"provState\": \"QC\",\n        \"countryCode\": \"CA\",\n        \"postalZipCode\": \"H2B1A0\"\n      }\n    },\n    \"destination\": {\n      \"name\": \"Jain\",\n      \"company\": \"Store\",\n      \"additionalAddressInfo\": \"addinfo\",\n      \"clientVoiceNumber\": \"123-123-1234\",\n      \"addressDetails\": {\n        \"addressLine1\": \"23 jardin private\",\n        \"addressLine2\": \"23 jardin private\",\n        \"city\": \"Ottawa\",\n        \"provState\": \"ON\",\n        \"countryCode\": \"CA\",\n        \"postalZipCode\": \"K1K4T3\"\n      }\n    },\n    \"options\": [\n      {\n        \"optionCode\": \"DC\"\n      }\n    ],\n    \"parcelCharacteristics\": {\n      \"weight\": 30,\n      \"dimensions\": {\n        \"length\": 6,\n        \"width\": 12,\n        \"height\": 9\n      },\n      \"unpackaged\": false,\n      \"mailingTube\": false,\n      \"oversized\": false\n    },\n    \"notification\": {\n      \"email\": \"john.doe@yahoo.com\",\n      \"onShipment\": true,\n      \"onException\": false,\n      \"onDelivery\": true\n    },\n    \"printPreferences\": {\n      \"outputFormat\": \"8.5x11\",\n      \"encoding\": \"PDF\"\n    },\n    \"preferences\": {\n      \"showPackingInstructions\": true,\n      \"showPostageRate\": false,\n      \"showInsuredValue\": true\n    },\n    \"references\": {\n      \"costCentre\": \"cost-center\",\n      \"customerRef1\": \"customer-ref-1\",\n      \"customerRef2\": \"customer-ref-2\"\n    },\n    \"settlementInfo\": {\n      \"paidByCustomer\": \"7023210\",\n      \"contractId\": \"40662505\",\n      \"intendedMethodOfPayment\": \"Account\",\n    }\n  }\n}"
        createShipmentResponse:
            description: "Create Shipment - Response\n\n---\n\nCréer l'envoi - Réponse"
            type: object
            properties:
                customerRequestId:
                    $ref: '#/components/schemas/customerRequestId'
                shipmentId:
                    $ref: '#/components/schemas/shipmentId'
                shipmentStatus:
                    $ref: '#/components/schemas/shipmentStatus'
                trackingPin:
                    $ref: '#/components/schemas/trackingPin'
                returnTrackingPin:
                    $ref: '#/components/schemas/returnTrackingPin'
                poNumber:
                    $ref: '#/components/schemas/poNumber'
                shipmentPrice:
                    allOf:
                        -
                            $ref: '#/components/schemas/shipmentPrice'
                    description: "This structure will only be returned on a shipment where no manifest is required and where the providePricingInfo field was set to true in the request.\n\n---\n\nCette structure ne sera renvoyée que pour une expédition pour laquelle aucun manifeste n'est requis et où le champ providePricingInfo a été défini sur true dans la requête."
                shipmentReceipt:
                    allOf:
                        -
                            $ref: '#/components/schemas/shipmentReceipt'
                    description: "This structure will only be returned on a shipment where no manifest is required and was paid for by credit card or Supplier Account.\n\nIt contains the same fields provided in the response to **Get Shipment Receipt**.\n\nPlease note that the same dummy values are always returned in the sandbox environment (AA1111 for auth-code, for example).\n\n---\n\nCette structure ne sera renvoyée que pour les expéditions pour lesquelles aucun manifeste n'est requis et payées par carte de crédit ou compte fournisseur.\n\nElle contient les mêmes champs que ceux fournis dans la réponse à **Obtenir le reçu d'expédition**.\n\nVeuillez noter que les mêmes valeurs fictives sont toujours renvoyées dans l'environnement sandbox (AA1111 pour le code d'autorisation, par exemple)."
                links:
                    $ref: '#/components/schemas/links'
            required:
                - shipmentId
                - shipmentStatus
                - links
        shipmentPrice:
            description: "Get Shipment Price - Response\n\n---\n\nObtenir le tarif de l'envoi - Réponse"
            properties:
                serviceCode:
                    $ref: '#/components/schemas/serviceCode'
                baseAmount:
                    $ref: '#/components/schemas/baseAmount'
                pricedOptions:
                    description: "This structure contains the list of options applied to this shipment and the associated price impact.\n\nThis will be absent if there are no options applied to the price of this shipment.\n\n---\n\nCette structure contient la liste d'options appliquées à cet envoi et l'incidence tarifaire connexe.\n\nCet élément sera absent s'il n'y a aucune option appliquée au tarif de cet envoi."
                    type: array
                    items:
                        type: object
                        properties:
                            optionCode:
                                $ref: '#/components/schemas/optionCode'
                            optionPrice:
                                allOf:
                                    -
                                        $ref: '#/components/schemas/costAllowsNegative'
                                description: "This is the total component of the price that is attributable to the option. Units are $CAD.\n\n---\n\nIl s'agit de la composante totale du tarif attribuable à l'option. Les unités s'affichent en dollars canadiens."
                        required:
                            - optionCode
                adjustments:
                    description: "This structure contains the list of adjustments applied to this shipment and the associated price impact.\n\nThis will be absent if there are no adjustments applied to the price of this shipment.\n\n---\n\nCette structure contient la liste de rajustements appliqués à cet envoi et l'incidence tarifaire connexe.\n\nCet élément sera absent s'il n'y a aucun rajustement appliqué au tarif de cet envoi."
                    type: array
                    items:
                        properties:
                            adjustmentCode:
                                description: "The code indicating which adjustment is applied to this shipment:\n\n- AUTDISC – Automation discount\n- FUELSC – Fuel surcharge\n- NCNTGST – Non-contiguous state fee (applies to Priority Worldwide products sent to Alaska and Hawaii)\n- V1DISC – Solutions for Small Business savings\n- PROMODISC – Promotional discount (if the promo code is invalid or expired, the discount amount will show as zero under adjustment-amount)\n- PLATFMDISC – Discount for using an e-commerce platform\n- NEWREGDISC – Discount for joining the Developer Program\n- ORIGSC – Service area adjustment (at origin)\n- DESTSC – Service area adjustment (at destination)\n- PURFEE – Fee charged for using a label before it was paid for (i.e., before performing **Transmit Shipments**)\n- SAADJ – Service area adjustment (rate adjustment up or down for specific source and destination postal code combinations)\n\n---\n\nIl s'agit du code de rajustement désignant le rajustement appliqué à cet envoi.\n\n- AUTDISC – Réduction à l'automatisation\n- FUELSC – Supplément pour carburant\n- V1DISC – Économies du programme Solutions pour petites entreprises\n- PROMODISC – Réduction promotionnelle (si le code de promotion est invalide ou expiré, le montant de la réduction sera indiqué comme étant zéro sous adjustment-amount).\n- PLATFMDISC – Réduction pour utilisation d'une plateforme de cybercommerce\n- NEWREGDISC – Réduction accordée lors de l'inscription au Programme pour développeurs\n- ORIGSC – Rajustement en fonction de la zone de service (origine)\n- DESTSC – Rajustement en fonction de la zone de service (destination)\n- PURFEE – Frais facturés pour avoir utilisé une étiquette avant qu'elle ait été payée (c.-à-d. avant d'exécuter le service **Transmettre les envois**\n- SAADJ – Ajustement pour zone de service (rajustement tarifaire à la hausse ou à la baisse pour des combinaisons précises de codes postaux d'origine et de destination)"
                                type: string
                            adjustmentAmount:
                                allOf:
                                    -
                                        $ref: '#/components/schemas/costAllowsNegative'
                                description: "This is the total cost attributable to the adjustment.\n\n---\n\nIl s'agit du coût total attribuable au rajustement."
                        required:
                            - adjustmentCode
                            - adjustmentAmount
                preTaxAmount:
                    allOf:
                        -
                            $ref: '#/components/schemas/costAllowsNegative'
                    description: "This is the pre-tax total amount of the shipment cost.\n\n---\n\nIl s'agit du montant total avant les taxes pour le tarif d'expédition."
                gstAmount:
                    allOf:
                        -
                            $ref: '#/components/schemas/costAllowsNegative'
                    description: "This is the amount of the GST added to the base cost.\n\n---\n\nIl s'agit du montant de TPS ajouté au prix de base."
                pstAmount:
                    allOf:
                        -
                            $ref: '#/components/schemas/costAllowsNegative'
                    description: "This is the amount of the PST added to the base cost.\n\n---\n\nIl s'agit du montant de TVP ajouté au prix de base."
                hstAmount:
                    allOf:
                        -
                            $ref: '#/components/schemas/costAllowsNegative'
                    description: "This is the amount of the HST added to the base cost.\n\n---\n\nIl s'agit du montant de TVH ajouté au prix de base."
                dueAmount:
                    allOf:
                        -
                            $ref: '#/components/schemas/costAllowsNegative'
                    description: "This is the total amount due for the shipment.\n\n---\n\nIl s'agit du montant total dû pour l'envoi."
                serviceStandard:
                    description: "This structure represents the service standard to which this shipment will be delivered.\n---\nCette structure représente la norme de service selon laquelle cet envoi sera livré."
                    type: object
                    properties:
                        amDelivery:
                            description: "This indicates whether morning delivery is part of the service standard.\n\n---\n\nCela indique si la livraison le matin fait partie de la norme de service."
                            type: boolean
                        guaranteedDelivery:
                            description: "This indicates whether guaranteed delivery is part of the service standard.\n\n---\n\nCela indique si la garantie de livraison fait partie de la norme de service."
                            type: boolean
                        expectedTransitTime:
                            description: "This indicates the number of days the package is expected to be in the mail stream from induction to delivery.\n\n---\n\nIl s'agit du nombre de jours pendant lesquels le paquet devrait se trouver dans le flot du courrier, c'est-à-dire depuis le dépôt jusqu'à la livraison."
                            type: integer
                            minimum: 0
                            maximum: 99
                        expectedDeliveryDate:
                            description: "This indicates the estimated delivery date based from the creation date of the shipment or the expected mailing date provided in the \"create\" request if greater.\n\n---\n\nIl s'agit de la date de livraison approximative en fonction de la date de création de l'envoi ou de la date de dépôt prévue fournie dans la demande de création si elle dépasse la date de livraison prévue."
                            type: string
                            format: date
                    required:
                        - amDelivery
                        - guaranteedDelivery
                ratedWeight:
                    allOf:
                        -
                            $ref: '#/components/schemas/parcelCharacteristics/properties/weight'
                    description: "This indicates the actual weight or volumetric equivalent used to determine the base price, within the prescribed weight  and size limits of the specific product, on the greater of actual weight or volumetric equivalent of actual weight.\n\n---\n\nIl désigne le poids réel ou l'équivalent volumétrique utilisé pour déterminer le tarif de base, dans le cadre des limites prescrites en matière de poids et de dimensions pour le produit concerné, à partir du poids réel et l'équivalent volumétrique du poids réel, selon la plus élevée des deux valeurs."
            required:
                - serviceCode
                - baseAmount
                - preTaxAmount
                - gstAmount
                - pstAmount
                - hstAmount
                - dueAmount
                - serviceStandard
                - ratedWeight
        shipmentReceipt:
            description: "Get Shipment Receipt - Response\n\n---\n\nObtenir le reçu de l'envoi - Réponse"
            type: object
            anyOf:
                -
                    properties:
                        ccReceiptDetails:
                            description: "This structure contains details required for a credit card receipt.\n\n---\n\nCette structure contient les détails requis pour un reçu de carte de crédit."
                            allOf:
                                -
                                    $ref: '#/components/schemas/ccReceiptDetails'
                                -
                                    type: object
                                    properties:
                                        chargeAmount:
                                            description: "The total amount charged to the credit card.\n\n---\n\nMontant total facturé sur la carte de crédit."
                                            type: number
                                    required:
                                        - chargeAmount
                    required:
                        - ccReceiptDetails
                -
                    properties:
                        supplierAccountReceiptDetails:
                            description: "This structure will be provided only if the shipment was paid by Supplier Account.\n\nThis structure is not returned in the sandbox environment.\n\n---\n\nCette structure sera fournie uniquement si l'envoi a été payé par compte de fournisseur.\n\nCette structure n'est pas retournée dans l'environnement « bac à sable »."
                            allOf:
                                -
                                    $ref: '#/components/schemas/supplierAccountReceiptDetails'
                                -
                                    type: object
                                    properties:
                                        chargeAmount:
                                            description: "The total amount charged to the account.\n\n---\n\nLe montant total facturé au compte."
                                            type: number
                                    required:
                                        - chargeAmount
                    required:
                        - supplierAccountReceiptDetails
        shipmentInfo:
            description: "Get Shipment - Response\n\n---\n\nObtenir l'envoi - Réponse"
            type: object
            properties:
                customerRequestId:
                    $ref: '#/components/schemas/customerRequestId'
                shipmentId:
                    $ref: '#/components/schemas/shipmentId'
                shipmentStatus:
                    $ref: '#/components/schemas/shipmentStatus'
                trackingPin:
                    $ref: '#/components/schemas/trackingPin'
                returnTrackingPin:
                    $ref: '#/components/schemas/returnTrackingPin'
                poNumber:
                    $ref: '#/components/schemas/poNumber'
                links:
                    $ref: '#/components/schemas/links'
            required:
                - shipmentId
                - shipmentStatus
                - links
        shipmentDetails:
            description: "Get Shipment Details - Response\n\n---\n\nObtenir les détails de l'envoi - Réponse"
            type: object
            properties:
                customerRequestId:
                    $ref: '#/components/schemas/customerRequestId'
                shipmentStatus:
                    $ref: '#/components/schemas/shipmentStatus'
                finalShippingPoint:
                    description: "This field is used for pricing purposes.\n\nIf you provided a requestedShippingPoint field in your Create Shipment request, this is the Postal Code of the Canada Post facility that is closest to your pickup location.\n\nIf you provided a shippingPointId in your Create Shipment request, this is the Postal Code of the deposit location you chose. \n\n---\n\nCe champ est utilisé pour la tarification.\n\nSi vous fournissez un champ requestedShippingPoint dans votre demande de service « Créer l'envoi », il faut saisir le code postal de l'installation de Postes Canada qui est la plus près de votre lieu de ramassage.\n\nSi vous avez réglé le champ shippingPointId dans votre demande de service « Créer l'envoi », il s'agit du code postal du lieu de dépôt que vous avez choisi."
                    type: string
                    pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
                trackingPin:
                    $ref: '#/components/schemas/trackingPin'
                poNumber:
                    $ref: '#/components/schemas/poNumber'
                shippingPointId:
                    $ref: '#/components/schemas/shippingPointId'
                cpcPickupIndicator:
                    allOf:
                        -
                            $ref: '#/components/schemas/cpcPickupIndicator'
                    description: "Returned if you requested your shipments be picked up.\n\n---\n\nCet élément s'affiche si vous avez demandé que vos envois soient ramassés."
                shipmentDetail:
                    description: "Shipment details.\n---\nLes détails de l'envoi."
                    type: object
                    properties:
                        groupId:
                            $ref: '#/components/schemas/groupId'
                        transmitShipment:
                            $ref: '#/components/schemas/transmitShipment'
                        quickshipLabelRequested:
                            $ref: '#/components/schemas/quickshipLabelRequested'
                        expectedMailingDate:
                            $ref: '#/components/schemas/expectedMailingDate'
                        deliverySpec:
                            allOf:
                                -
                                    $ref: '#/components/schemas/deliverySpec'
                                -
                                    properties:
                                        recipient:
                                            allOf: [{ $ref: '#/components/schemas/destination' }, { description: "This field appears in the response only if you selected the Deliver to Post Office (D2PO) option when you Generated the shipment. It contains the mail recipient's address that you provided in the destination field in your request.\n\n---\n\nCe champ s'affiche seulement dans la réponse si vous sélectionnez l'option « Livrer au bureau de poste » (D2PO) lorsque vous créez l'envoi. Il contient l'adresse du destinataire du courrier que vous avez indiquée dans le champ destination » de votre demande." }]
                        returnSpec:
                            $ref: '#/components/schemas/returnSpec'
                        refundRequestInfo:
                            description: "This structure is present only if a refund request was submitted for this shipment.\n\n---\n\nThis structure is present only if a refund request was submitted for this shipment."
                            allOf:
                                -
                                    $ref: '#/components/schemas/refundInfo'
                    allOf:
                        -
                            required:
                                - deliverySpec
                        -
                            anyOf:
                                -
                                    required:
                                        - transmitShipment
                                    not:
                                        required:
                                            - groupId
                                -
                                    required:
                                        - groupId
                                    not:
                                        required:
                                            - transmitShipment
        publicKeyInfo:
            description: "Get Shipment Public Key Info - Response\n\n---\n\nObtenir les informations sur la clé publique de l'expédition - Réponse"
            type: object
            properties:
                expiryDate:
                    description: "Provides when the public URL is valid till.\n\n---\n\nIndique quand l'URL publique est valide jusqu'à."
                    type: string
                    format: date-time
                url:
                    description: "Provides un-authenticated url to the label.\n\n---\n\nFournit une URL non authentifiée à l'étiquette"
                    type: string
                qrCode:
                    description: "It encodes the public url (base64 encode).\n\n---\n\nIl encode l'URL publique (encodage base64)"
                    type: string
            required:
                - expiryDate
                - url
        groups:
            description: "Get Groups - Response\n\n---\n\nObtenir les groupes - Réponse"
            type: array
            items:
                type: object
                properties:
                    groupId:
                        $ref: '#/components/schemas/groupId'
                    link:
                        description: "See **Get Shipments** for information about this link. The group id is automatically provided as a query string in each link.\n\n---\n\nConsultez la section **Obtenir les envois** pour obtenir de plus amples renseignements sur ce lien. L'ID du groupe est automatiquement fourni comme chaîne de requête pour chaque lien."
                        allOf:
                            -
                                $ref: '#/components/schemas/link'
                required:
                    - groupId
                    - link
        shipments:
            description: "Get Shipments - Response\n\n---\n\nObtenir les envois - Réponse"
            type: array
            items:
                description: "The href field can be used as an endpoint to the **Get Shipment** service for the shipment.\n\nThe href field can also be used to delete the shipment via an invocation of the **Void Shipment** service.\n\n---\n\nLe champ href peut être utilisé comme point final propre au service **Obtenir l'envoi** pour l'envoi en question.\n\nLe champ href peut également être utilisé pour supprimer l'envoi à l'aide du service **Annuler l'envoi**."
                allOf:
                    -
                        $ref: '#/components/schemas/link'
        refundRequest:
            description: "Request Shipment Refund - Request\n\n---\n\nDemander le remboursement d'un envoi - Demande"
            type: object
            properties:
                email:
                    allOf:
                        -
                            $ref: '#/components/schemas/email'
                    description: "Email address used to create the service ticket.\n\n---\n\nAdresse courriel utilisée pour créer le billet de service."
            required:
                - email
            example: '{"email": "joesmith@home.com"}'
        refundInfo:
            description: "Request Shipment Refund - Response\n\n---\n\nDemande de remboursement d'un envoi - Réponse"
            type: object
            properties:
                serviceTicketDate:
                    description: "Date when the refund request was submitted.\n\n---\n\nDate à laquelle la demande de remboursement a été soumise"
                    type: string
                    format: date
                serviceTicketId:
                    description: "The service ticket ID number for your refund request. Please use this number in any communications with Canada Post regarding this refund request.\n\n**Note:** In the sandbox (development) environment, the same test value (0123456789) is always returned.\n\n---\n\nNuméro d'identification du billet de service associé à votre demande de remboursement. Veuillez utiliser ce numéro dans toutes les communications que vous entretenez avec Postes Canada au sujet de cette demande de remboursement.\n\nRemarque : Dans l'environnement (de développement) « Bac à sable », la même valeur d'essai (0123456789) est toujours retournée."
                    type: string
            required:
                - serviceTicketDate
                - serviceTicketId
        transmitRequest:
            description: "Transmit Shipments - Request\n\n---\n\nTransmettre les envois - Demande"
            type: object
            properties:
                customerRequestId:
                    allOf:
                        -
                            $ref: '#/components/schemas/customerRequestId'
                    description: "For Future Use.\n\n---\n\nPour utilisation future."
                groupIds:
                    description: "This is a list of groupIds. The Transmit Shipments service will generate a manifest for each group. The manifest will list the shipments included in the group (with the exception of shipments you exclude).\n\n---\n\nIl s'agit d'une liste de numéros d'identification de groupe. Le service Transmettre les envois créera un manifeste pour chaque groupe. Le manifeste comprendra la liste des envois compris dans le groupe (à l'exception des envois que vous excluez)."
                    type: array
                    items:
                        $ref: '#/components/schemas/groupId'
                    minItems: 1
                cpcPickupIndicator:
                    $ref: '#/components/schemas/cpcPickupIndicator'
                requestedShippingPoint:
                    $ref: '#/components/schemas/requestedShippingPoint'
                shippingPointId:
                    $ref: '#/components/schemas/shippingPointId'
                detailedManifests:
                    description: "This indicates whether a full detailed manifest document will be\nrendered, or a summarized manifest document will be rendered.\n\n---\n\nCela indique si une version résumée ou très détaillée du\nmanifeste sera produite. "
                    type: boolean
                methodOfPayment:
                    $ref: '#/components/schemas/methodOfPayment'
                manifestAddress:
                    $ref: '#/components/schemas/manifestAddress'
                customerReference:
                    description: "A customer reference number may be provided to Canada Post which is placed on the manifest and returned in a Get Manifest Details request.\n\n---\n\nLe numéro de référence du client peut être fourni à Postes Canada, puis inscrit sur le manifeste et affiché dans une demande de service Obtenir les détails du manifeste."
                    type: string
                    maxLength: 12
                excludedShipments:
                    description: "The list of shipmentIds that are to be excluded from transmission. These shipments will remain in their group and will automatically be picked up for the next transmit.\n\n---\n\nIl s'agit de la liste de shipmentIds devant être exclus de la transmission. Ces envois demeureront dans leur groupe et ils seront automatiquement ramassés au cours de la prochaine transmission."
                    type: array
                    items:
                        $ref: '#/components/schemas/shipmentId'
                    minItems: 1
            required:
                - groupIds
                - detailedManifests
                - methodOfPayment
                - manifestAddress
            example: "{\n  \"groupIds\": [\n    \"testGroup\"\n  ],\n  \"requestedShippingPoint\": \"K0A1W0\",\n  \"cpcPickupIndicator\": true,\n  \"detailedManifests\": true,\n  \"methodOfPayment\": \"Account\",\n  \"customerReference\": \"reference\",\n  \"excludedShipments\": {\n    \"shipmentId\": \"750721708399395444\"\n  },\n  \"manifestAddress\": {\n    \"manifestCompany\": \"my company\",\n    \"manifestName\": \"MajorShop\",\n    \"phoneNumber\": \"555 555 5555\",\n    \"addressDetails\": {\n      \"addressLine1\": \"1230 Tako RD.\",\n      \"city\": \"Ottawa\",\n      \"provState\": \"ON\",\n      \"postalZipCode\": \"K1A1A1\"\n    }\n  }\n}"
        manifestList:
            description: "Response:\n\n- Transmit Shipments\n- Get Manifests\n\n---\n\nRéponse :\n\n- Transmettre les expéditions\n- Obtenir les manifestes"
            type: array
            items:
                allOf:
                    -
                        $ref: '#/components/schemas/link'
                description: "The system will generate separate manifests:\n\n- by Canadian vs. international shipments.\n- by mobo\n- by paid-by-customer\n- by contract number\n\nIf you attempt to transmit shipments that we billed you for automatically (in cases where you inducted shipments before performing a Transmit Shipments call), you will receive a link to an empty manifest. The empty manifest informs you that you were billed automatically and provides details about how to avoid this in the future.\n\nThe empty manifest does not contain shipments or details, cannot be retrieved through Get Manifests and cannot be used to induct mail. The detailed manifest we created for you with the shipments that you were billed for automatically will be sent to the email address provided in your online Canada Post profile.\n\n---\n\nLe système produira des manifestes séparés en fonction des éléments suivants :\n\n- Envois canadiens par rapport aux envois internationaux\n- Client « Expédié au nom de »\n- Payeur\n- Numéro de convention\n\nSi vous tentez de transmettre des envois que nous avons facturés automatiquement (dans les cas où vous avez déposé des envois avant deffectuer une demande de service Transmettre les envois), vous recevrez un lien vers un manifeste vide. Le manifeste vide vous informe que vos envois ont été facturés automatiquement et fournit des détails sur la façon déviter que cela ne se reproduise.\n\nLe manifeste vide ne contient pas les envois ou les détails et ne peut pas être récupéré au moyen du paramètre Obtenir les manifestes ni utilisé pour déposer du courrier. Le manifeste détaillé que nous avons créé pour vous au moyen des envois qui vous ont été facturés automatiquement sera envoyé à ladresse courriel qui figure dans votre profil de PostesCanada en ligne."
        manifestInfo:
            description: "Get Manifest - Response\n\n---\n\nObtenir le manifeste - Réponse"
            type: object
            properties:
                customerRequestId:
                    allOf:
                        -
                            $ref: '#/components/schemas/customerRequestId'
                    description: "For Future Use.\n\n---\n\nPour utilisation future."
                poNumber:
                    $ref: '#/components/schemas/poNumberManifest'
                links:
                    type: array
                    items:
                        allOf:
                            -
                                $ref: '#/components/schemas/link'
                        description: "May occur 1 … N times. However, at the current time, there are four links:\n\n1.  rel=\"self\"\n2.  rel=\"artifact\"\n3.  rel=\"details\"\n4.  rel=\"manifestShipments\"\n\nEach link allows you to retrieve different information about the manifest.\n\n1.  rel=\"self\"\n    \n    This represents a repeat of the original Get Manifest call used to get this list of links. It can be stored for later use.\n    \n2.  rel = \"artifact\"\n    \n    This link will return a PDF file to be printed to allow pickup or drop-off of the associated physical shipments. See **Get Artifact**.\n    \n3.  rel = \"details\"\n    \n    This link returns details found on the hardcopy manifest such as a summary of shipments and the total cost of the manifest. See **Get Manifest Details**.\n    \n    **Note:** This link would not be returned for an empty manifest (see **Transmit Shipments** for details).\n    \n4.  rel – \"manifestShipments\"\n    \n    This link will return links to every shipment in the manifest. See **Get Shipments**.\n    \n    **Note:** This link would not be returned for an empty manifest (see **Transmit Shipments** for details).\n\n---\n\nOccurrence (1 à N fois). Toutefois, à l'heure actuelle, il y a quatre liens :\n\n1.  rel=\"self\"\n2.  rel=\"artifact\"\n3.  rel=\"details\"\n4.  rel=\"manifestShipments\"\n\nChaque lien vous permet de récupérer différents renseignements sur le manifeste.\n\n1.  rel=\"self\"\n    \n    Cela représente une répétition de la demande de service Obtenir le manifeste initial utilisé pour obtenir cette liste de liens. On peut le garder pour plus tard.\n    \n2.  rel = \"artifact\"\n    \n    Ce lien affichera un fichier PDF à imprimer pour permettre le ramassage ou le dépôt des envois physiques associés. Voir **Obtenir l'artefact**.\n    \n3.  rel = \"details\"\n    \n    Ce lien fournit des détails qui se trouvent dans le manifeste papier, notamment le sommaire des envois et le coût total du manifeste. Voir **Obtenir les détails du manifeste**.\n    \n    **Remarque :** Ce lien ne serait pas retourné pour un manifeste vide (consultez la page **Transmettre les envois** pour obtenir plus de détails).\n    \n4.  rel – \"manifestShipments\"\n    \n    Ce lien fournira des liens vers chaque envoi inclus dans le manifeste. Voir **Obtenir les envois**.\n    \n    **Remarque :** Ce lien ne serait pas retourné pour un manifeste vide (consultez la page **Transmettre les envois** pour obtenir plus de détails)."
            required:
                - poNumber
                - links
        manifestDetails:
            description: "Get Manifest Details - Response\n\n---\n\nObtenir les détails du manifeste - Réponse"
            type: object
            properties:
                poNumber:
                    $ref: '#/components/schemas/poNumberManifest'
                finalShippingPoint:
                    description: "This is the Postal Code of the Post Office where the shipment is to be dropped off.\n\n---\n\nIl s'agit du code postal du bureau de poste où l'envoi doit être déposé."
                    type: string
                    pattern: '^[A-Z]\d[A-Z]\d[A-Z]\d$'
                shippingPointName:
                    description: "This is the descriptive name of the shipping point.\n\n---\n\nIl s'agit du nom descriptif du point d'expédition.   "
                    type: string
                    maxLength: 35
                shippingPointId:
                    allOf:
                        -
                            $ref: '#/components/schemas/shippingPointId'
                    description: "This is the Canada Post identification number of the shipping point.\n\n---\n\nIl s'agit du numéro d'identification de Postes Canada pour le point d'expédition."
                cpcPickupIndicator:
                    allOf:
                        -
                            $ref: '#/components/schemas/cpcPickupIndicator'
                    description: "Returned if you specified that your mail is picked up by Canada Post at your site.\n\n---\n\nAffiché si vous avez mentionné que votre courrier est ramassé par Postes Canada à votre emplacement."
                mailedByCustomer:
                    $ref: '#/components/schemas/mailedByCustomer'
                mailed-on-behalf-of:
                    $ref: '#/components/schemas/mailed-on-behalf-of'
                paidByCustomer:
                    allOf:
                        -
                            $ref: '#/components/schemas/paidByCustomer'
                    description: "Customer number of the customer who is paying for the shipment. This is often the same as the mailed-on-behalf-of customer number.\n\n---\n\nNuméro de client du client qui paie l'envoi. Ce numéro est souvent le même que celui du client « Expédié au nom de »."
                customerRef:
                    description: "This is the reference field provided by the client in the transmit request.\n\n---\n\nIl s'agit du champ de référence fourni par le client dans la demande de transfert."
                    type: string
                    maxLength: 12
                manifestDate:
                    description: "This is the date the manifest was generated.\n\nNote: on the printed manifest, there is both a \"manifest date\" and a \"shipment date\" printed.  The shipment date is the same as the manifest date.\n\n---\n\nIl s'agit de la date à laquelle le manifeste a été généré.\n\nNota : Sur le manifeste imprimé, on trouve à la fois la « date du manifeste » et la « date d'expédition ». La date d'expédition est la même que la date du manifeste."
                    type: string
                    format: date
                manifestTime:
                    description: "(HH:MM TZ) where\n\n- HH = the 24-hour based hour\n- MM = the minutes\n- TZ = the time zone abbreviation (for the server)\n\nThis is the time when the manifest was generated.\n\n---\n\n(HH:MM TZ) :\n\n- HH = Heure au format 24 heures\n- MM = Minutes\n- TZ = Abréviation pour le fuseau horaire (du serveur)\n\nIl s'agit de l'heure à laquelle le manifeste a été généré."
                    type: string
                    pattern: '^\d{2}:\d{2} [a-zA-Z ]+$'
                contractId:
                    allOf:
                        -
                            $ref: '#/components/schemas/contractId'
                    description: "This is the contract number that was used for pricing this manifest, if applicable (i.e. if you are using a service not on your contract, contract id is not required).\n\n---\n\nIl s'agit du numéro de la convention utilisée pour la tarification de ce manifeste, s'il y a lieu (p. ex., si vous utilisez un service qui n'est pas indiqué dans votre convention, il n'est pas nécessaire d'indiquer le numéro de cette dernière)."
                methodOfPayment:
                    allOf:
                        -
                            $ref: '#/components/schemas/methodOfPayment'
                    description: "This indicates the method of payment by the customer.\n\n---\n\nCela indique le mode de paiement du client."
                ccReceiptDetails:
                    allOf:
                        -
                            $ref: '#/components/schemas/ccReceiptDetails'
                supplierAccountReceiptDetails:
                    allOf:
                        -
                            $ref: '#/components/schemas/supplierAccountReceiptDetails'
                manifestPricingInfo:
                    description: "This structure contains the information about the total pricing of\nall items on the manifest.\n\n---\n\nCette structure comprend l'information sur la tarification totale\nde tous les envois inclus dans le manifeste."
                    type: object
                    properties:
                        baseCost:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsZero'
                            description: "This is the total pre-tax pricing of all items on the manifest.\n\n---\n\nIl s'agit du total des coûts de base pour tous les envois figurant sur le manifeste."
                        automationDiscount:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsNegative'
                            description: "This is the total pre-tax automation discount of all items on the manifest.\n\n---\n\nIl s'agit du total de la réduction à l'automatisation pour tous les envois figurant sur le manifeste. "
                        optionsAndSurcharges:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsNegative'
                            description: "This is the total pre-tax options and surcharges amount for all items on the manifest.\n\n---\n\nIl s'agit du total pour les options et les suppléments pour tous les envois figurant sur le manifeste"
                        gst:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsZero'
                            description: "This is the GST total for all shipments on the manifest.\n\n---\n\nIl s'agit du total de la TPS pour tous les envois figurant sur le manifeste."
                        pst:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsZero'
                            description: "This is the GST total for all shipments on the manifest.\n\n---\n\nIl s'agit du total de la TVP pour tous les envois figurant sur le manifeste."
                        hst:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsZero'
                            description: "This is the GST total for all shipments on the manifest.\n\n---\n\nIl s'agit du total de la TVH pour tous les envois figurant sur le manifeste."
                        totalDueCpc:
                            allOf:
                                -
                                    $ref: '#/components/schemas/costAllowsZero'
                            description: "This is the total due amount for all items on the manifest.\n\n---\n\nIl s'agit du total dû à Postes Canada pour tous les envois figurant sur le manifeste."
                    required:
                        - baseCost
                        - automationDiscount
                        - optionsAndSurcharges
                        - gst
                        - pst
                        - hst
                        - totalDueCpc
                manifestAddress:
                    $ref: '#/components/schemas/manifestAddress'
            required:
                - poNumber
                - finalShippingPoint
                - shippingPointName
                - shippingPointId
                - mailedByCustomer
                - mailed-on-behalf-of
                - paidByCustomer
                - manifestDate
                - manifestTime
                - methodOfPayment
                - manifestPricingInfo
                - manifestAddress
    securitySchemes:
        Oauth2:
            type: oauth2
            x-ibm-oauth-provider: cpc-api-native-oauth-provider
            flows:
                clientCredentials:
                    tokenUrl: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/cpc-api-native-oauth-provider/oauth2/token'
                    scopes:
                        merchant: 'default description'
                        platform: ''
x-ibm-configuration:
    cors:
        enabled: true
    type: rest
    phase: realized
    enforced: true
    testable: true
    oauth-servers:
        Oauth2:
            clientCredentials:
                tokenUrls:
                    - 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/cpc-api-native-oauth-provider/oauth2/token'
                authorizationUrls: {  }
                refreshUrls: {  }
x-ibm-endpoints:
    -
        url: 'https://api.canadapost-postescanada.ca/prod/devportal-portaildesdeveloppeurs/shipping/v1'
security:
    -
        Oauth2:
            - merchant
