{
  "opencollection": "1.0.0",
  "info": {
    "name": "eBay Account Advertising_eligibility Shipment API",
    "version": "v1.9.2"
  },
  "items": [
    {
      "info": {
        "name": "Shipment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "cancelShipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/shipment/:shipmentId/cancel",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "This path parameter specifies the unique eBay-assigned ID of the shipment to be canceled.<br><br>The <b>shipmentId</b> value is generated and returned by the <a href=\"/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote\" target=\"_blank\">createFromShippingQuote</a> method."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method cancels the shipment associated with the specified shipment ID and the associated shipping label is deleted. When you cancel a shipment, the <b>totalShippingCost</b> of the canceled shipment is refunded to the account established by the user's billing agreement.  <br><br>Note that you cannot cancel a shipment if you have used the associated shipping label."
        },
        {
          "info": {
            "name": "createFromShippingQuote",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ebay.com{basePath}/shipment/create_from_shipping_quote",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method creates a shipment based on the <b>shippingQuoteId</b> and <b>rateId</b> values supplied in the request. The rate identified by the <b>rateId</b> value specifies the carrier and service for the package shipment, and the rate ID must be contained in the shipping quote identified by the <b>shippingQuoteId</b> value. Call <b>createShippingQuote</b> to retrieve a set of live shipping rates.<br><br><span class=\"tablenote\"><b>Note:</b> The Logistics API only supports USPS shipping rates an"
        },
        {
          "info": {
            "name": "downloadLabelFile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/shipment/:shipmentId/download_label_file",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "This path parameter specifies the unique eBay-assigned identifier of the shipment associated with the shipping label you want to download.<br><br> The <b>shipmentId</b> value is generated and returned by the <a href=\"/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote\" target=\"_blank\">createFromShippingQuote</a> method."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method returns the shipping label file that was generated for the <b>shipmentId</b> value specified in the request. Call <b>createFromShippingQuote</b> to generate a shipment ID.<br><br><span class=\"tablenote\"><b>Note:</b> The Logistics API only supports USPS shipping rates and labels.</span><br>Use the <code>Accept</code> HTTP header to specify the format of the returned file. The default file format is a PDF file. <!-- Are other options available? -->"
        },
        {
          "info": {
            "name": "getShipment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/shipment/:shipmentId",
            "params": [
              {
                "name": "shipmentId",
                "value": "",
                "type": "path",
                "description": "This path parameter specifies the unique eBay-assigned identifier of the shipment you want to retrieve.<br><br>The <b>shipmentId</b> value is generated and returned by the <a href=\"/api-docs/sell/logistics/resources/shipment/methods/createFromShippingQuote\" target=\"_blank\">createFromShippingQuote</a> method."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method retrieves the shipment details for the specified shipment ID. Call <b>createFromShippingQuote</b> to generate a shipment ID."
        }
      ]
    }
  ],
  "bundled": true
}