CreateShipmentFromQuoteRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateShipmentFromQuoteRequest",
  "title": "CreateShipmentFromQuoteRequest",
  "type": "object",
  "properties": {
    "additionalOptions": {
      "type": "array",
      "description": "Supply a list of one or more shipping options that the seller wants to purchase for this shipment.  <br><br>The <b>baseShippingCost</b> field that's associated with the selected shipping rate is the cost of the base service offered in the rate. In addition to the base service, sellers can add additional shipping services to the base service. Shipping options include things such as shipping insurance or a recipient's signature upon delivery. The cost of any added services is summed with the base shipping cost to determine the final cost for the shipment. All options added to the shipment must be chosen from the set of shipping options offered with the selected rate.",
      "items": {
        "$ref": "#/components/schemas/AdditionalOption"
      }
    },
    "labelCustomMessage": {
      "type": "string",
      "description": "Optional text to be printed on the shipping label if the selected shipping carrier supports custom messages on their labels."
    },
    "labelSize": {
      "type": "string",
      "description": "The seller's desired label size. Any supplied value is applied only if the shipping carrier supports multiple label sizes, otherwise the carrier's default label size is used.  <br><br>Currently, the only valid value is: <code>4\"x6\"</code>"
    },
    "rateId": {
      "type": "string",
      "description": "The unique eBay-assigned identifier of the shipping rate that the seller selected for the shipment. This value is generated by using the <a href=\"/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote\" target=\"_blank\">createShippingQuote</a> method and is returned in the <b>rates.rateId</b> field."
    },
    "returnTo": {
      "description": "The optional return address and contact details for the shipment. The return address is printed on the shipping label. If not specified, the return address defaults to the <b>shipFrom</b> address returned in shipping quote. ",
      "$ref": "#/components/schemas/Contact"
    },
    "shippingQuoteId": {
      "type": "string",
      "description": "The unique eBay-assigned identifier of the shipping quote that was generated by the <a href=\"/api-docs/sell/logistics/resources/shipping_quote/methods/createShippingQuote\" target=\"_blank\">createShippingQuote</a> method."
    }
  },
  "description": "This complex type contains the request payload for the <b>createFromShippingQuote</b> method."
}