Detritus Site Services: Get a Quote

Check whether Detritus serves a US ZIP code and list the dumpster sizes, portable sanitation products, disposal materials, and other jobsite services (temporary fencing, storage containers, water, power) available there. Read-only.

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "pattern": "^\\d{5}(?:-\\d{4})?$",
      "description": "Delivery ZIP code (5 digits, optional +4)."
    }
  },
  "required": [
    "zip"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    },
    "zip": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "enum": [
        "invalid_zip",
        "outside_service_area"
      ]
    },
    "message": {
      "type": "string"
    },
    "dumpsterSizes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      }
    },
    "products": {
      "type": "array",
      "items": {
        "$ref": "#/properties/dumpsterSizes/items"
      }
    },
    "disposalMaterials": {
      "type": "array",
      "items": {
        "$ref": "#/properties/dumpsterSizes/items"
      }
    },
    "portaPottyRentalTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Allowed rentalType values for porta-potty or mixed jobs."
    },
    "dumpsterRentalTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Allowed rentalType values for dumpster-only jobs."
    },
    "siteServices": {
      "type": "array",
      "items": {
        "$ref": "#/properties/dumpsterSizes/items"
      },
      "description": "Other jobsite services (fencing, storage, water, power) to include on the same request."
    }
  },
  "required": [
    "available",
    "zip"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Submit one quote request to Detritus for dumpster, portable sanitation, and/or other jobsite services. All items for one job go in a single request and produce a single quote. Creates a customer record and quote request at Detritus and sends the customer a text and/or email with their quote. Requires the customer's first name, last name, email, phone, full delivery address, delivery date, and selected products, and customerConfirmed: true after the customer has reviewed those details. Not safe to retry: calling it again for the same job creates a duplicate request. Returns serviceRequestId.

{
  "type": "object",
  "properties": {
    "customerConfirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true. Set only after the user reviewed and confirmed first name, last name, email, phone, full delivery address, products, and delivery date."
    },
    "request": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string",
          "minLength": 1,
          "description": "Customer's first name."
        },
        "lastName": {
          "type": "string",
          "minLength": 1,
          "description": "Customer's last name."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Customer's email address."
        },
        "phone": {
          "type": "string",
          "minLength": 10,
          "description": "Customer's phone number, at least 10 digits."
        },
        "address": {
          "type": "string",
          "minLength": 1,
          "description": "Full delivery address: street, city, state, and ZIP."
        },
        "deliveryDate": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
          "description": "Delivery date, YYYY-MM-DD."
        },
        "duration": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ],
          "description": "How long the rental is needed, such as 7 days or 2 weeks."
        },
        "projectDetails": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ],
          "description": "Required when requesting more than one product (e.g. porta + dumpster). Goes on the Form Lead as Project Details."
        },
        "rentalType": {
          "type": "string",
          "enum": [
            "construction",
            "event",
            "personal",
            "commercial"
          ],
          "description": "Job type. Dumpster-only must be construction or personal. Porta + dumpster may use construction (typical job site)."
        },
        "products": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "porta-potty",
              "holding-tanks",
              "ada-porta-potty",
              "flushable",
              "restroom-trailer",
              "potty-with-sink",
              "handwash-station",
              "other"
            ]
          },
          "description": "Porta-potty / sanitation product ids from get_service_availability. Include every sanitation product the customer wants, on this same request as any dumpster or siteServices[]."
        },
        "units": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ],
          "description": "How many units to deliver, if the customer specified a count."
        },
        "crewSize": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ],
          "description": "Approximate crew size, used to size sanitation for the job."
        },
        "projectType": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ],
          "description": "Kind of project, such as roofing, remodel, or event."
        },
        "dumpsterSize": {
          "type": "string",
          "enum": [
            "10-yard-roll-off-dumpster",
            "12-yard-roll-off-dumpster",
            "20-yard-roll-off-dumpster",
            "30-yard-roll-off-dumpster",
            "40-yard-roll-off-dumpster"
          ],
          "description": "Dumpster size id from get_service_availability. Put this on the SAME request as products[] when the customer also wants a porta potty."
        },
        "disposalMaterial": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "mixed-debris",
                "construction-debris",
                "yard-waste",
                "concrete-dirt-asphalt",
                "roofing-shingles",
                "household-junk"
              ]
            },
            {
              "type": "null"
            }
          ],
          "description": "Required whenever dumpsterSize is set."
        },
        "dumpsterRentalOption": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "construction-dumpster-rentals",
                "yard-waste-dumpster-rentals",
                "residential-dumpster-rentals",
                "roofing-dumpster-rentals",
                "commercial-dumpster-rentals",
                "emergency-dumpster-rentals"
              ]
            },
            {
              "type": "null"
            }
          ],
          "description": "Dumpster rental category, when the customer named one."
        },
        "siteServices": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "temporary-fencing",
              "storage-containers",
              "water",
              "power",
              "other-site-services"
            ]
          },
          "description": "Other jobsite services from get_service_availability siteServices (fencing, storage, water, power). Put them on this same request as dumpster and sanitation."
        }
      },
      "required": [
        "firstName",
        "lastName",
        "email",
        "phone",
        "address",
        "deliveryDate",
        "rentalType"
      ],
      "additionalProperties": false,
      "description": "One quote request: contact, full delivery address, delivery date, and every product for the job."
    }
  },
  "required": [
    "customerConfirmed",
    "request"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "serviceRequestId": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "received",
        "assigned",
        "building",
        "sent"
      ]
    },
    "message": {
      "type": "string"
    },
    "duplicate": {
      "type": "boolean"
    }
  },
  "required": [
    "serviceRequestId",
    "status",
    "message"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the status of an existing Detritus quote request (received, assigned, building, sent). Requires serviceRequestId and the phone or email used on the request. "building" is normal while the quote is prepared; if keepPolling is true, tell the user it's in progress rather than calling again in the same turn. When status is sent, returns the quote link and price summary. Read-only.

{
  "type": "object",
  "properties": {
    "serviceRequestId": {
      "type": "string",
      "minLength": 15,
      "maxLength": 18,
      "description": "Id returned by make_service_request."
    },
    "phone": {
      "type": "string",
      "description": "Phone used on the service request (preferred if ≥10 digits)."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email used on the service request."
    }
  },
  "required": [
    "serviceRequestId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "serviceRequestId": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "keepPolling": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "quote": {
      "type": "object",
      "properties": {
        "quoteNumber": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "quoteUrl": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "total": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "currency": {
          "type": "string"
        },
        "breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "productType": {
                "type": "string"
              },
              "amount": {
                "type": "number"
              }
            },
            "required": [
              "productType",
              "amount"
            ],
            "additionalProperties": false
          }
        },
        "paymentDueBy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "serviceRequestId",
    "status",
    "keepPolling",
    "message"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the customer-facing quote for an existing Detritus request: totals, price breakdown by product type, and quote link. Requires serviceRequestId and the phone or email used on the request. Returns customer pricing only (no vendor cost). Read-only.

{
  "type": "object",
  "properties": {
    "serviceRequestId": {
      "type": "string",
      "minLength": 15,
      "maxLength": 18,
      "description": "Id returned by make_service_request."
    },
    "phone": {
      "type": "string",
      "description": "Phone used on the service request (preferred if ≥10 digits)."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email used on the service request."
    }
  },
  "required": [
    "serviceRequestId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "serviceRequestId": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "keepPolling": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "quote": {
      "type": "object",
      "properties": {
        "quoteNumber": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "quoteUrl": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 0
            },
            {
              "type": "null"
            }
          ]
        },
        "total": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "currency": {
          "type": "string"
        },
        "breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "productType": {
                "type": "string"
              },
              "amount": {
                "type": "number"
              }
            },
            "required": [
              "productType",
              "amount"
            ],
            "additionalProperties": false
          }
        },
        "paymentDueBy": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "serviceRequestId",
    "status",
    "keepPolling",
    "message"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}