{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sign In Solutions VMS AuditLogs Packages API",
    "version": "0.21.0"
  },
  "items": [
    {
      "info": {
        "name": "Packages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get packages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/packages",
            "params": [
              {
                "name": "location_ids",
                "value": "",
                "type": "query",
                "description": "A comma separated list of Location ids for filtering. i.e. '1,2,3'\nWill return all packages from all locations if none are specified"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the results to a specified number, defaults to 50"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offsets the results to a specified number, defaults to 0"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include. Possible values: 'recipient', 'location', 'image'"
              },
              {
                "name": "picked_up",
                "value": "",
                "type": "query",
                "description": "Filters packages by their \"picked_up\" state.."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Searches for packages by recipient name"
              }
            ]
          },
          "docs": "Gets a list of [Package] entities."
        },
        {
          "info": {
            "name": "Create package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{domain}/packages",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [Package] entity by extracting information about the recipient and carrier from the given image file."
        },
        {
          "info": {
            "name": "Get Package",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{domain}/packages/:package_id",
            "params": [
              {
                "name": "package_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "A list of comma-separated related models to include\n"
              }
            ]
          },
          "docs": "Gets the details of a single instance of a Package"
        },
        {
          "info": {
            "name": "Update Package",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{domain}/packages/:package_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "package_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update/Edit information about a Package.\n\npicked_up - changes the package_state to picked up and assigns non null value to picked_up_at\n\nrecipient_id - update the package's intended recipient. Changes package_state to 'recipient_matched' if a match hasn't been found and notifies host about their package via email. A previous recipient will stop getting notifications\n\ncarrier_name - change/update the package's carrier/courier information\n"
        },
        {
          "info": {
            "name": "Delete Package",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{domain}/packages/:package_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "package_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a pacakge"
        }
      ]
    }
  ],
  "bundled": true
}