HomeGuidesAPI Reference
Log In
API Reference
errorstatus codedescription
Missing/Invalid required input parameter: <parameter>400This error is returned when a required parameter like user_phone isn't provided.
Parameter user_phone is invalid: phone number must be 10 digits or 11 digits with country code400This error is returned if the input user_phone has an invalid number of digits (i.e. 140431322)
Parameter driver_tip_cents is required for delivery orders400This error is returned when pickup is false and driver_tip_cents isn't provided.
Parameter pickup_tip_cents only applies to pickup orders400This error is returned when pickup is false and pickup_tip_cents is provided.
Parameter pickup_tip_cents isn't supported for this store400This error is returned when pickup_tip_cents is provided and quote.accepts_pickup_note is false from the Get Inventory response.
This store is closed406This error is returned when the store is closed according to its listed open hours.
Delivery is currently unavailable for this store406This error is returned when the store either doesn't support delivery or currently isn't accepting delivery orders.
Pickup is currently unavailable for this store406This error is returned when the store either doesn't support pickup or currently isn't accepting pickup orders.
This store is out of range for the provided address406This error is returned when the user address provided is not within the delivery range, as determined by the underlying DSP.
Scheduled id is not valid or not available406This error is returned when the scheduled_id provided either isn't a valid one or has expired.
Checkout Error: Invalid Products. Either product_id is invalid or product is no longer available420This error is returned when at least one item corresponding to an input product_id is no longer in stock.
Checkout Error: Customization requirements have not been met422This error is returned when at least one input item has unmet customization requirements.
Checkout Error: Does not meet order minimum requirement422Checkout Error: Does not meet order minimum requirement
Checkout Error: Does not meet order maximum requirement422This error is returned when the order subtotal is greater than quote.order_maximum from the Get Inventory response.
Checkout Error: Invalid option_id -> <option_id>422This error is returned when at least one input option_id isn't a valid one and is unprocessable.
Invalid product ID(s) provided422This error is returned when at least one input product_id isn't a valid one and is unprocessable.
Product quantity must be greater than zero422This error is returned if the input quantity for at least one item is less than zero.