Templates
Upsert multiple templates
API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- Order Requirements
- 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
- PATCHUnarchive 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
- 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
Routes
Templates
Miscellaneous
Templates
Upsert multiple templates
POST
/
v1
/
templates
/
upsert
curl --request POST \
--url https://api.sandbox.usenash.com/v1/templates/upsert \
--header 'Content-Type: application/json' \
--data '{
"templates": [
{
"type": "DELIVERY_WINDOW",
"deliveryWindowTemplatePayload": {
"key": "value"
},
"externalId": "ext_01234567890123456789",
"name": "Monday Delivery Window",
"startDatetime": "2024-01-01T12:00:00",
"endDatetime": "2024-01-01T12:00:00",
"daysOfWeek": [
"MONDAY",
"TUESDAY"
],
"generationFrequencyValue": 1,
"generationFrequencyUnit": "DAY",
"createInstancesUpToValue": 1,
"createInstancesUpToUnit": "DAY",
"overrideExistingInstances": true
}
]
}'
{
"templates": [
{
"id": "tpl_01234567890123456789",
"type": "DELIVERY_WINDOW",
"payload": {},
"externalId": "<string>",
"name": "<string>",
"startDatetime": "2024-01-01T12:00:00",
"endDatetime": "2024-01-01T12:00:00",
"daysOfWeek": [
"MONDAY",
"TUESDAY"
],
"generationFrequencyValue": 1,
"generationFrequencyUnit": "DAY",
"createInstancesUpToValue": 1,
"createInstancesUpToUnit": "DAY",
"overrideExistingInstances": true
}
]
}
Body
application/json
Expected payload for creating multiple templates.
Response
200
application/json
OK
Response for a list of templates.
curl --request POST \
--url https://api.sandbox.usenash.com/v1/templates/upsert \
--header 'Content-Type: application/json' \
--data '{
"templates": [
{
"type": "DELIVERY_WINDOW",
"deliveryWindowTemplatePayload": {
"key": "value"
},
"externalId": "ext_01234567890123456789",
"name": "Monday Delivery Window",
"startDatetime": "2024-01-01T12:00:00",
"endDatetime": "2024-01-01T12:00:00",
"daysOfWeek": [
"MONDAY",
"TUESDAY"
],
"generationFrequencyValue": 1,
"generationFrequencyUnit": "DAY",
"createInstancesUpToValue": 1,
"createInstancesUpToUnit": "DAY",
"overrideExistingInstances": true
}
]
}'
{
"templates": [
{
"id": "tpl_01234567890123456789",
"type": "DELIVERY_WINDOW",
"payload": {},
"externalId": "<string>",
"name": "<string>",
"startDatetime": "2024-01-01T12:00:00",
"endDatetime": "2024-01-01T12:00:00",
"daysOfWeek": [
"MONDAY",
"TUESDAY"
],
"generationFrequencyValue": 1,
"generationFrequencyUnit": "DAY",
"createInstancesUpToValue": 1,
"createInstancesUpToUnit": "DAY",
"overrideExistingInstances": true
}
]
}