AI Functions3

Annotate2

Batch Job4

Billing1

Contracts1

Couriers2

Delivery Windows17

Dispatch plans15

Dispatch Strategies5

Driver Scheduling1

Embed Sessions1

Feedback2

Files2

Fleet6

Hub Scanning6

Inventory1

Job20

Launchpad3

Messaging1

Miscellaneous1

Notifications8

Optimization Activities1

Optimization Fleet Projection1

Optimization Run Comparison1

Optimization Run Re-solve1

Optimization Strategies5

Order22

Order Intake6

Organizations1

Provider1

Route10

Route Restrictions6

Rule Books14

Shifts5

Shipping2

Signup2

Store Catalog6

Store Locations12

Templates1

Users9

Vehicles2

Webhooks4

Widgets7

Workflow8

Workflow Execution3

Zones13

Store Locations

Set the weekly default capacity for a store location

Configure the default weekly capacity schedule for a store location. Defines how many orders the location can handle per day of the week.

post/v1/set_store_location_default_capacity

Request

Base URL
https://api.sandbox.usenash.com
Auth
none declared

Request body

storeLocationIdstring required

The store location for which to set capacity.

defaultCapacityobject required

The default weekly capacity.

Example request

{
  "storeLocationId": "stl_1234567890",
  "defaultCapacity": {
    "friday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "monday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "saturday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "sunday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "thursday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "tuesday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    },
    "wednesday": {
      "isActive": true,
      "shiftCapacity": {
        "00:00": 0,
        "01:00": 0,
        "02:00": 0,
        "03:00": 0,
        "04:00": 0,
        "05:00": 0,
        "06:00": 0,
        "07:00": 0,
        "08:00": 4,
        "09:00": 4,
        "10:00": 4,
        "11:00": 4,
        "12:00": 4,
        "13:00": 4,
        "14:00": 6,
        "15:00": 6,
        "16:00": 6,
        "17:00": 6,
        "18:00": 0,
        "19:00": 0,
        "20:00": 0,
        "21:00": 0,
        "22:00": 0,
        "23:00": 0
      }
    }
  }
}

Response

externalIdstring nullable

Store location unique identifier from an external system.

operatingHoursobject nullable

[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.

prepTimeMinutesinteger nullable

[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.

blackoutDatesstring[] nullable

The blackout dates of the store location.

firstNamestring nullable

First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.

lastNamestring nullable

Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.

emailstring nullable

The email of the person at the store location.

pickupInstructionsstring nullable

The pickup instructions of the store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]

idstring required

The ID of the store location.

namestring required

The name of the store location.

phoneNumberstring required

The phone number of the person at the store location.

zoneIdsstring[] nullable required

The zone ids of the store location.

zoneAssociationsobject[] nullable required

The zone associations of the store location.

tagsstring[] nullable required

The tags of the store location.

integrationMetadataobject nullable required

The integration metadata of the store location.

Example response

{
  "externalId": "40123",
  "operatingHours": {
    "friday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    },
    "monday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    },
    "saturday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    },
    "sunday": {
      "active": true,
      "shifts": [
        [
          "11:00",
          "18:00"
        ]
      ]
    },
    "thursday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    },
    "tuesday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    },
    "wednesday": {
      "active": true,
      "shifts": [
        [
          "10:00",
          "19:00"
        ]
      ]
    }
  },
  "blackoutDates": [
    "2024-01-01",
    "2024-01-02"
  ],
  "firstName": "Taylor",
  "lastName": "Swift",
  "email": "taylor@swift.com",
  "pickupInstructions": "Once you arrive at the store, please click above to let us know you are here. Then, go ahead and find a sales associate inside - they'll be happy to help you!",
  "id": "stl_01234567890123456789",
  "name": "White House",
  "phoneNumber": "+1234567890",
  "location": {
    "number": "1600",
    "street": "Pennsylvania Avenue NW",
    "county": "Washington",
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "zoneIds": [
    "zone_01234567890123456789",
    "zone_01234567890123456789"
  ],
  "zoneAssociations": [
    {
      "end_date": "2025-01-01",
      "start_date": "2024-01-01",
      "store_location_id": "stl_01234567890123456789",
      "zone_id": "zone_01234567890123456789"
    }
  ],
  "integrationMetadata": {
    "integration_name": "ABC"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.