Get Fees

You call vGrubs

POSThttps://sandbox.vgrubs.com/partner/get-fees/{partner-name}

{partner-name} Your partner identifier, provisioned by vGrubs during onboarding.

Use this endpoint to retrieve the delivery fee, service charge, and tax amounts for a specific order before charging the customer. You call our endpoint.

For delivery orders, at least one of delivery_address or delivery_coordinates must be provided - both cannot be omitted simultaneously. For pickup orders, omit both fields.

The production URL is provided by vGrubs once the integration is fully tested and ready to go live.

Request body

merchant_idstringrequired

The partner's store ID.

order_subtotalnumberrequired

Order subtotal in cents.

delivery_addressstring / undefined

Delivery address as a string. Required for delivery orders if delivery_coordinates is not provided.

delivery_coordinatesobject / undefined

Delivery coordinates. Required for delivery orders if delivery_address is not provided. Takes priority over delivery_address when both are present.

Responses

200OK

service_chargenumber

Service charge in cents.

delivery_feenumber

Delivery fee in cents.

tax_amountnumber

Tax amount in cents.

tax_percentagenumber

Applied state tax percentage (0.00-100.00).

cash_pickup_allowedboolean

Whether this store accepts cash for pickup orders. When true, you may offer "Pay at pickup" and send the order with order.paid: false and payment.method: "cash". When false, do not offer cash. Independent of supported_order_types: a store can accept pickup and still answer false, which means pickup must be prepaid.

supported_order_typesstring[]

Order types the store accepts. Never empty. Treat it as a list and check whether it contains a type - do not compare it to a fixed array, as more values may be added later. Hide the order types a store does not accept: a new order with an unsupported order.type is rejected.

pickupThe store accepts pickup orders (physical locations only)

deliveryThe store accepts delivery orders

400Bad Request

Missing or invalid fields in the request body.

401Unauthorized

Invalid or missing x-api-key header.