v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Store Locations

Upsert multiple store locations

Create or update multiple store locations in a single request. Each store location is matched by external identifier for upsert logic.

post/v1/store_locations/upsert/bulk

Response

OK

Example response

{
  "storeLocations": [
    {
      "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"
      }
    }
  ]
}