{
  "opencollection": "1.0.0",
  "info": {
    "name": "Skydropx Pro Address Templates Shipments API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://pro.skydropx.com/api/v1/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Shipments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List shipments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.skydropx.com/api/v1/shipments",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Lists shipments, optionally filtered by status and date range."
        },
        {
          "info": {
            "name": "Create a shipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.skydropx.com/api/v1/shipments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a shipment from a quotation and a selected rate, purchasing the label and debiting the prepaid account balance. Requires SAT consignment-note (Carta Porte) codes for applicable Mexican shipments."
        },
        {
          "info": {
            "name": "Retrieve a shipment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.skydropx.com/api/v1/shipments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the resource."
              }
            ]
          },
          "docs": "Retrieves a shipment by id, including its label URL and tracking data."
        },
        {
          "info": {
            "name": "Cancel a shipment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.skydropx.com/api/v1/shipments/:id/cancellations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the resource."
              }
            ]
          },
          "docs": "Requests cancellation of a shipment and refund of the label where eligible."
        },
        {
          "info": {
            "name": "Add shipment protection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.skydropx.com/api/v1/shipments/:id/protect",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds optional parcel protection / insurance coverage to a shipment."
        }
      ]
    }
  ],
  "bundled": true
}