Body
application/json
Common schema for inputting a dispatch strategy.
Maximum length:
80Response
OK
Common schema for inputting a dispatch strategy.
Maximum length:
80API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- Order Requirements
- Order Validations
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- POSTCreate or Update Orders 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
- PATCHUnarchive order
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- POSTCreate or update store location by external identifier
- 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
- DELDelete a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task
- 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
Templates
Store Catalog
Miscellaneous
Create dispatch strategy
Copy
Ask AI
curl --request POST \
--url https://api.sandbox.usenash.com/v1/options_group \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"label": "<string>",
"allowedProviders": [
"<string>"
],
"enableAutoDispatch": true,
"providerSelectionStrategy": "<string>",
"reassignOnFailure": true,
"enableMaxDeliveryFee": true,
"maxDeliveryFeeCents": 123,
"costSplitStrategy": "<string>",
"costSplitMaxPercentage": 123,
"costSplitMaxFixedPriceCents": 123,
"smartReassignment": true
}'Copy
Ask AI
{
"id": "<string>",
"label": "<string>",
"allowedProviders": [
"<string>"
],
"enableAutoDispatch": true,
"providerSelectionStrategy": "<string>",
"reassignOnFailure": true,
"enableMaxDeliveryFee": true,
"maxDeliveryFeeCents": 123,
"costSplitStrategy": "<string>",
"costSplitMaxPercentage": 123,
"costSplitMaxFixedPriceCents": 123,
"smartReassignment": true
}Dispatch Strategies
Create dispatch strategy
POST
/
v1
/
options_group
Create dispatch strategy
Copy
Ask AI
curl --request POST \
--url https://api.sandbox.usenash.com/v1/options_group \
--header 'Content-Type: application/json' \
--data '{
"id": "<string>",
"label": "<string>",
"allowedProviders": [
"<string>"
],
"enableAutoDispatch": true,
"providerSelectionStrategy": "<string>",
"reassignOnFailure": true,
"enableMaxDeliveryFee": true,
"maxDeliveryFeeCents": 123,
"costSplitStrategy": "<string>",
"costSplitMaxPercentage": 123,
"costSplitMaxFixedPriceCents": 123,
"smartReassignment": true
}'Copy
Ask AI
{
"id": "<string>",
"label": "<string>",
"allowedProviders": [
"<string>"
],
"enableAutoDispatch": true,
"providerSelectionStrategy": "<string>",
"reassignOnFailure": true,
"enableMaxDeliveryFee": true,
"maxDeliveryFeeCents": 123,
"costSplitStrategy": "<string>",
"costSplitMaxPercentage": 123,
"costSplitMaxFixedPriceCents": 123,
"smartReassignment": true
}⌘I