Batch Jobs
Refresh Quotes (Batch)
API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- GETGet Store Location
- GETGet Store Locations
- GETGet store location by external identifier
- DELDelete store location
- GETGet store locations that cover specified location (latitude & longitude, city_zipcode)
- POSTCreate a zone
- PATCHUpdate a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- Package Requirements
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task in a Job
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
- GETGet Refund Requests
- GETGet Refund Request
Batch Jobs
Providers
Miscellaneous
Batch Jobs
Refresh Quotes (Batch)
Refresh the quotes for a batch job.
POST
/
v1
/
jobs
/
{jobId}
/
batch
/
{batchId}
/
refresh_quotes
curl --request POST \
--url https://api.sandbox.usenash.com/v1/jobs/{jobId}/batch/{batchId}/refresh_quotes
{
"jobId": "<string>",
"quotes": [
{
"id": "qot_01234567890",
"type": "<string>",
"providerId": "uber_standard_mini_mart",
"providerName": "Nash",
"providerLogo": "https://nash.com/logo.png",
"providerIsInternal": true,
"createdTime": "2021-01-01T00:00:00Z",
"expireTime": "2021-01-01T00:00:00Z",
"priceCents": 1000,
"taxAmountCents": 100,
"tollFeeCents": 100,
"nashFeeCents": 100,
"insuranceFeeCents": 100,
"currency": "USD",
"pickupWindow": "2021-01-01T00:00:00Z",
"dropoffEta": "2021-01-01T00:00:00Z",
"tags": [
"tag1",
"tag2"
],
"costSplitCustomerCents": 100,
"costSplitBusinessCents": 100,
"totalPriceBreakdown": {
"subtotal": 1000,
"tax": 100,
"total": 1100
},
"totalPriceCents": 1000,
"price": 1000,
"isSuccessful": true,
"errorMessage": "Error message"
}
]
}
Response
200
application/json
OK
Expected output after refreshing quotes for a batch job.
Generic serializer for quotes used in many endpoints.
Quote ID
Provider ID
Provider name
Created time
Price in cents
Quote type
Provider logo
Is the provider internal
Expire time
Tax amount in cents
Toll fee in cents
Nash fee in cents
Insurance fee in cents
Currency
Pickup window
Dropoff ETA
Tags
Cost split customer in cents
Cost split business in cents
Total price breakdown
Total price in cents
Price
Is successful
Error message
curl --request POST \
--url https://api.sandbox.usenash.com/v1/jobs/{jobId}/batch/{batchId}/refresh_quotes
{
"jobId": "<string>",
"quotes": [
{
"id": "qot_01234567890",
"type": "<string>",
"providerId": "uber_standard_mini_mart",
"providerName": "Nash",
"providerLogo": "https://nash.com/logo.png",
"providerIsInternal": true,
"createdTime": "2021-01-01T00:00:00Z",
"expireTime": "2021-01-01T00:00:00Z",
"priceCents": 1000,
"taxAmountCents": 100,
"tollFeeCents": 100,
"nashFeeCents": 100,
"insuranceFeeCents": 100,
"currency": "USD",
"pickupWindow": "2021-01-01T00:00:00Z",
"dropoffEta": "2021-01-01T00:00:00Z",
"tags": [
"tag1",
"tag2"
],
"costSplitCustomerCents": 100,
"costSplitBusinessCents": 100,
"totalPriceBreakdown": {
"subtotal": 1000,
"tax": 100,
"total": 1100
},
"totalPriceCents": 1000,
"price": 1000,
"isSuccessful": true,
"errorMessage": "Error message"
}
]
}