{
  "aid": "swaggerhub.smartersorting:boss-location-management-1.3.0",
  "name": "BOSS Location Management API",
  "type": "Index",
  "description": "Manage locations and disposal for the Back of Store System, including available\ndisposal, recycling, and donation options.\n\nUnless otherwise noted, the following limits apply to fields in URL path\nand query params:\n- Date/time strings must be provided in ISO 8601 format. All values converted to\n  UTC, no time zone info will be retained.\n- All string fields, path and query parameters are limited to 127 characters or\n  fewer\n- All UUIDs are UUIDv4. These will be generated initially by SmarterX, and used in\n  subsequent requests to identify options.\n\n# General Features\n\nEndpoints that return a list of resources will include pagination info in the\nresponse body, and paging may be controlled with query parameters. These endpoints\nwill also typically include query parameters to filter the list of items by name,\ndescription, location or other fields.\n\nFor items that support DELETE operations, these are considered \"soft deletes\" which\nwill prevent the item from being returned in GET requests, but will not remove it\nfrom the database. The items may be restored by performing a PATCH with the body\n`{\"discarded\": false}`.\n\n# Location Management\n\nThe following use cases are supported:\n- Creating new locations\n- Updating existing locations\n- Removing locations\n- Retrieving one or more locations, with optional parameters to filter by name,\n  description or location\n- Enabling or disabling single or multiple disposal options at a location\n\n*Note*: API users are responsible for enforcing validity of options for a \nlocation. For example, assigning a State Toxic disposal option for a \nlocation in a state that does not have state-level regulations may result\nin undesirable recommendation results.\n\n# Option Management\n\nThe following use cases are supported:\n- Updating existing option names and descriptions\n- Retrieving one or more options, with optional parameters to filter by name,\n  description, or category\n- Enabling or disabling an option for multiple locations\n- Removing options (soft delete)\n\nWith the exception of Donation Partners, new options must be created by \nSmarterX, since they often require new rule sets and other configuration\nbehind the scenes to ensure proper bin results. Our future roadmap includes\nself-service rule writing for retail customers via Smarter-1, but this is\nout of scope for v1 of Location Management.\n\n# Donation Option Management\n\nThe following use cases are supported:\n- Creating new donation options\n- Updating existing donation options (names, descriptions, tax IDs, POC info, etc.)\n- Retrieving one or more donation options, with optional parameters to filter by name,\n  description, or location\n- Removing donation options (soft delete)\n\nDonation options contain additional fields for linking to MealConnect, and for\nstoring contact info and other details about the donation partner.",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.smartersorting/boss-location-management/1.3.0/apis.json",
  "tags": [
    "swaggerhub.smartersorting",
    "boss-location-management"
  ],
  "created": "2026-04-02",
  "modified": "2026-04-02",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.smartersorting:boss-location-management-1.3.0",
      "name": "BOSS Location Management API",
      "description": "Manage locations and disposal for the Back of Store System, including available\ndisposal, recycling, and donation options.\n\nUnless otherwise noted, the following limits apply to fields in URL path\nand query params:\n- Date/time strings must be provided in ISO 8601 format. All values converted to\n  UTC, no time zone info will be retained.\n- All string fields, path and query parameters are limited to 127 characters or\n  fewer\n- All UUIDs are UUIDv4. These will be generated initially by SmarterX, and used in\n  subsequent requests to identify options.\n\n# General Features\n\nEndpoints that return a list of resources will include pagination info in the\nresponse body, and paging may be controlled with query parameters. These endpoints\nwill also typically include query parameters to filter the list of items by name,\ndescription, location or other fields.\n\nFor items that support DELETE operations, these are considered \"soft deletes\" which\nwill prevent the item from being returned in GET requests, but will not remove it\nfrom the database. The items may be restored by performing a PATCH with the body\n`{\"discarded\": false}`.\n\n# Location Management\n\nThe following use cases are supported:\n- Creating new locations\n- Updating existing locations\n- Removing locations\n- Retrieving one or more locations, with optional parameters to filter by name,\n  description or location\n- Enabling or disabling single or multiple disposal options at a location\n\n*Note*: API users are responsible for enforcing validity of options for a \nlocation. For example, assigning a State Toxic disposal option for a \nlocation in a state that does not have state-level regulations may result\nin undesirable recommendation results.\n\n# Option Management\n\nThe following use cases are supported:\n- Updating existing option names and descriptions\n- Retrieving one or more options, with optional parameters to filter by name,\n  description, or category\n- Enabling or disabling an option for multiple locations\n- Removing options (soft delete)\n\nWith the exception of Donation Partners, new options must be created by \nSmarterX, since they often require new rule sets and other configuration\nbehind the scenes to ensure proper bin results. Our future roadmap includes\nself-service rule writing for retail customers via Smarter-1, but this is\nout of scope for v1 of Location Management.\n\n# Donation Option Management\n\nThe following use cases are supported:\n- Creating new donation options\n- Updating existing donation options (names, descriptions, tax IDs, POC info, etc.)\n- Retrieving one or more donation options, with optional parameters to filter by name,\n  description, or location\n- Removing donation options (soft delete)\n\nDonation options contain additional fields for linking to MealConnect, and for\nstoring contact info and other details about the donation partner.",
      "image": "",
      "baseURL": "https://api-staging.smartersorting.com/v1",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.smartersorting/boss-location-management/1.3.0",
      "version": "1.3.0",
      "tags": [
        "swaggerhub.smartersorting",
        "boss-location-management"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.smartersorting/boss-location-management/1.3.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.smartersorting/boss-location-management/1.3.0"
        }
      ]
    }
  ]
}