Zapiet Pickup + Delivery Widget API

https://docs.zapiet.com
Admin
Zapiet Pickup + Delivery offers solutions for managing store pickup and local delivery options, and...
Tokens:32,076
Snippets:73
Trust Score:9.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Preparation Times (API Response Example)

Source: https://docs.zapiet.com/reference/preparation-times

This snippet shows an example JSON response for the GET /v1.0/:checkoutMethod/location/:locationId/preparation_times endpoint. It details general preparation times for each day of the week and product-specific preparation settings.

```javascript
{
    "general": {
        "enabled": true,
        "monday": {
            "breakpoint": {
                "enabled": false,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "tuesday": {
            "breakpoint": {
                "enabled": false,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "wednesday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "thursday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "friday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "minutes",
                "value": 30
            },
            "after": {
                "format": "minutes",
                "value": 30
            }
        },
        "saturday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "days",
                "value": 1
            },
            "after": {
                "format": "days",
                "value": 2
            }
        },
        "sunday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "days",
                "value": 1
            },
            "after": {
                "format": "days",
                "value": 3
            }
        }
    },
    "product_based": [
        {
            "product_external_id": "8184259576032",
            "preparation_enabled": 1,
            "preperation_value": 300,
            "preparation_format": "hours"
        },
        {
            "product_external_id": "8184259674336",
            "preparation_enabled": 1,
            "preperation_value": 2880,
            "preparation_format": "days"
        },
        {
            "product_external_id": "8184259346656",
            "preparation_enabled": 1,
            "preperation_value": 30,
            "preparation_format": "minutes"
        }
    ]
}
```

--------------------------------

### Get Conditional Activation - Response Example (JavaScript)

Source: https://docs.zapiet.com/reference/conditional-activation

This snippet demonstrates a successful response (200 OK) from the conditional activation endpoint. It details whether certain conditions like price-based rules are enabled and valid, and whether the checkout method should be hidden or if the shopping cart is considered valid. This information helps in determining checkout availability.

```javascript
{
    "weight_price": {
        "enabled": true,
        "valid": true,
        "condition": "price",
        "operator": "morethan",
        "value": 0
    },
    "property_based": {
        "enabled": false,
        "valid": true
    },
    "hide_checkout_method": false,
    "valid_shopping_cart": true
}
```

--------------------------------

### Get Conditional Activation - Request Body Example (JavaScript)

Source: https://docs.zapiet.com/reference/conditional-activation

This snippet shows an example of the request body structure for the conditional activation endpoint. It includes details about the shopping cart, such as original price, total weight, and individual items with their properties. This data is used to determine checkout method validity.

```javascript
{
    "shoppingCart": {
        "original_total_price": 599,
        "total_weight": 10000,
        "items": [
            {
                "collections": "Adidas Shoes",
                "vendor": "Adidas",
                "product_type": "Sneaker",
                "tags": "Adidas, Pickup Only"
            },
            {
                "collections": "New Balance Shoes",
                "vendor": "New Balance",
                "product_type": "Sneaker",
                "tags": "New Balance, Pickup Only"
            }
        ]
    }
}
```

--------------------------------

### Get Regions - JavaScript Example

Source: https://docs.zapiet.com/reference/store-pickup/regions

This snippet demonstrates how to retrieve a list of regions from the Zapiet API. It requires the 'shop' query parameter, which is the merchant's myshopify.com store URL. The response is an array of strings representing region names.

```javascript
[
	"Boston",
	"New York",
	"Washington DC"
]
```

--------------------------------

### GET /v1.0/settings

Source: https://docs.zapiet.com/reference/settings

Retrieve a store's settings, including configurations for pickup, delivery, and shipping.

```APIDOC
## GET /v1.0/settings

### Description
This endpoint allows you to retrieve a store's settings, including configurations for pickup, delivery, and shipping.

### Method
GET

### Endpoint
https://api.zapiet.com/v1.0/settings

### Parameters
#### Query Parameters
- **shop** (string) - Required - The merchant's myshopify.com store url.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **base_country_name** (string) - The base country of the store.
- **measurement_format** (string) - The preferred unit of measurement (e.g., kilometers, miles).
- **pickup** (object) - Configuration object for pickup settings.
  - **enabled** (boolean) - Whether pickup is enabled.
  - **pagination_limit** (integer) - The number of items to display per page for pickup settings.
  - **sort_order** (string) - The order in which pickup options are sorted.
  - **discount_code** (string) - A discount code applicable to pickup orders.
  - **prepopulate_shipping_address** (boolean) - Whether to prepopulate the shipping address for pickup.
  - **filter_by_region** (boolean) - Whether to filter pickup options by region.
  - **preselect_first_available_location** (boolean) - Whether to preselect the first available pickup location.
  - **preselect_first_available_time** (boolean) - Whether to preselect the first available pickup time.
  - **noted_enabled** (boolean) - Whether a note is enabled for pickup orders.
  - **note_required** (boolean) - Whether a note is required for pickup orders.
- **delivery** (object) - Configuration object for delivery settings.
  - **enabled** (boolean) - Whether delivery is enabled.
  - **validation_mode** (string) - The mode for validating delivery addresses.
  - **driving_distance_preferences** (null) - Preferences for driving distance calculation (currently null).
  - **driving_distance_route** (string) - The preferred route for driving distance calculation (e.g., fastest).
  - **discount_code** (string) - A discount code applicable to delivery orders.
  - **prepopulate_shipping_address** (boolean) - Whether to prepopulate the shipping address for delivery.
  - **noted_enabled** (boolean) - Whether a note is enabled for delivery orders.
  - **note_required** (boolean) - Whether a note is required for delivery orders.
  - **preselect_first_available_time** (boolean) - Whether to preselect the first available delivery time.
- **shipping** (object) - Configuration object for shipping settings.
  - **enabled** (boolean) - Whether shipping is enabled.
  - **blackout_dates** (array) - A list of dates when shipping is not available.
  - **monday_enabled** (boolean) - Whether shipping is enabled on Mondays.
  - **tuesday_enabled** (boolean) - Whether shipping is enabled on Tuesdays.
  - **wednesday_enabled** (boolean) - Whether shipping is enabled on Wednesdays.
  - **thursday_enabled** (boolean) - Whether shipping is enabled on Thursdays.
  - **friday_enabled** (boolean) - Whether shipping is enabled on Fridays.
  - **saturday_enabled** (boolean) - Whether shipping is enabled on Saturdays.
  - **sunday_enabled** (boolean) - Whether shipping is enabled on Sundays.
  - **timezone** (string) - The timezone configured for the store.
  - **discount_code** (string) - A discount code applicable to shipping orders.
  - **preparation_time** (object) - Configuration for order preparation time.
    - **enabled** (boolean) - Whether preparation time is enabled.
    - **monday** (object) - Preparation time settings for Monday.
      - **value** (integer) - The preparation time value.
      - **format** (string) - The unit of preparation time (e.g., days).
      - **cutoff_time** (object) - Cutoff time for preparation time.
        - **enabled** (boolean) - Whether cutoff time is enabled.
        - **time** (string) - The cutoff time (e.g., "12:00").
        - **value** (integer) - The value associated with the cutoff time.
    - **tuesday** (object) - Similar structure for Tuesday.
    - **wednesday** (object) - Similar structure for Wednesday.
    - **thursday** (object) - Similar structure for Thursday.
    - **friday** (object) - Similar structure for Friday.
    - **saturday** (object) - Similar structure for Saturday.
    - **sunday** (object) - Similar structure for Sunday.
  - **maximum_date** (object) - Configuration for the maximum date for shipping.
    - **enabled** (boolean) - Whether maximum date is enabled.
    - **metric** (string) - The metric for the maximum date (e.g., days).
    - **value** (integer) - The maximum date value.
  - **order_limits** (object) - Limits on the number of orders per day.
    - **enabled** (boolean) - Whether order limits are enabled.
    - **monday** (integer) - Order limit for Monday.
    - **tuesday** (integer) - Order limit for Tuesday.
    - **wednesday** (integer) - Order limit for Wednesday.
    - **thursday** (integer) - Order limit for Thursday.
    - **friday** (integer) - Order limit for Friday.
    - **saturday** (integer) - Order limit for Saturday.
    - **sunday** (integer) - Order limit for Sunday.
  - **note_enabled** (boolean) - Whether a note is enabled for shipping orders.
  - **note_required** (boolean) - Whether a note is required for shipping orders.

#### Response Example
```json
{
	"base_country_name": "United Kingdom",
	"measurement_format": "kilometers",
	"pickup": {
		"enabled": true,
		"pagination_limit": 10,
		"sort_order": "manual",
		"discount_code": "10STOCKPICKUP",
		"prepopulate_shipping_address": true,
		"filter_by_region": false,
		"preselect_first_available_location": true,
		"preselect_first_available_time": true,
		"noted_enabled": false,
		"note_required": false
	},
	"delivery": {
		"enabled": true,
		"validation_mode": "within_max_radius",
		"driving_distance_preferences": null,
		"driving_distance_route": "fastest",
		"discount_code": null,
		"prepopulate_shipping_address": true,
		"noted_enabled": false,
		"note_required": false,
		"preselect_first_available_time": true
	},
	"shipping": {
		"enabled": true,
		"blackout_dates": [],
		"monday_enabled": true,
		"tuesday_enabled": true,
		"wednesday_enabled": true,
		"thursday_enabled": true,
		"friday_enabled": true,
		"saturday_enabled": true,
		"sunday_enabled": true,
		"timezone": "America/New_York",
		"discount_code": null,
		"preparation_time": {
			"enabled": false,
			"monday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"tuesday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"wednesday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"thursday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"friday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"saturday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"sunday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			}
		},
		"maximum_date": {
			"enabled": false,
			"metric": "days",
			"value": 14
		},
		"order_limits": {
			"enabled": false,
			"monday": 2,
			"tuesday": 1,
			"wednesday": 0,
			"thursday": 0,
			"friday": 0,
			"saturday": 0,
			"sunday": 0
		},
		"note_enabled": false,
		"note_required": false
	}
}
```
```

--------------------------------

### Get Delivery Times by Date (JavaScript Example)

Source: https://docs.zapiet.com/reference/local-delivery/times

This JavaScript snippet demonstrates a successful response from the Zapiet API for retrieving delivery times. It shows the structure of the returned JSON, including time slot IDs, days of the week, availability windows, and whether the slots are limited.

```javascript
[
	{
		"id": 2408,
		"day_of_week": "thursday",
		"available_from": "10:00",
		"available_until": "12:00",
		"limited": true,
		"limit": 10
	}, {
		"id": 402223,
		"day_of_week": "thursday",
		"available_from": "12:00",
		"available_until": "14:00",
		"limited": true,
		"limit": 10
	}, {
		"id": 402224,
		"day_of_week": "thursday",
		"available_from": "13:00",
		"available_until": "14:00",
		"limited": true,
		"limit": 10
	}
]
```

--------------------------------

### Get Minimum Date Slots (JavaScript)

Source: https://docs.zapiet.com/reference/store-pickup/pickup-calendar

This section provides an example of the response when a merchant has pickup order limits. The 'minDateSlots' array contains available time slots for the specified minimum date, including details like availability start and end times, and order limits.

```javascript
{
    "minDate": "2024-01-16",
    "minDateSlots": [
        {
            "id": 1,
            "location_id": 1,
            "day_of_week": "tuesday",
            "available_from": "11:30",
            "available_until": "12:00",
            "limited": true,
            "limit": 10
        },
        {
            "id": 2,
            "location_id": 1,
            "day_of_week": "tuesday",
            "available_from": "12:00",
            "available_until": "12:30",
            "limited": true,
            "limit": 10
        }
    ]
}
```

--------------------------------

### Listen to Zapiet Events with jQuery

Source: https://docs.zapiet.com/javascript-api/events

Example of how to listen for Zapiet events using JavaScript and jQuery. It demonstrates subscribing to the 'selected_method' event and executing different logic based on the checkout method (pickup, delivery, shipping). Requires jQuery to be included.

```javascript
$(document).ready(function() {
  window.ZapietEvent.listen('selected_method', function(checkout_method) {
    switch (checkout_method) {
      case "pickup":
        // Do something when pickup is selected
        break;
      case "delivery":
        // Do something when delivery is selected
        break;
      case "shipping":
        // Do something when shipping is selected
        break;
    }
  });
});
```

--------------------------------

### Get Store Settings

Source: https://docs.zapiet.com/reference/settings

Retrieves a store's configuration settings. Requires the myshopify.com store URL as a query parameter. Returns a JSON object containing various settings for pickup, delivery, and shipping.

```javascript
{
	"base_country_name": "United Kingdom",
	"measurement_format": "kilometers",
	"pickup": {
		"enabled": true,
		"pagination_limit": 10,
		"sort_order": "manual",
		"discount_code": "10STOCKPICKUP",
		"prepopulate_shipping_address": true,
		"filter_by_region": false,
		"preselect_first_available_location": true,
		"preselect_first_available_time": true,
		"noted_enabled": false,
		"note_required": false
	},
	"delivery": {
		"enabled": true,
		"validation_mode": "within_max_radius",
		"driving_distance_preferences": null
		"driving_distance_route": "fastest",
		"discount_code": null,
		"prepopulate_shipping_address": true,
		"noted_enabled": false,
		"note_required": false,
		"preselect_first_available_time": true
	},
	"shipping": {
		"enabled": true,
		"blackout_dates": [],
		"monday_enabled": true,
		"tuesday_enabled": true,
		"wednesday_enabled": true,
		"thursday_enabled": true,
		"friday_enabled": true,
		"saturday_enabled": true,
		"sunday_enabled": true,
		"timezone": "America\/New_York",
		"discount_code": null,
		"preparation_time": {
			"enabled": false,
			"monday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"tuesday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"wednesday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"thursday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"friday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"saturday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			},
			"sunday": {
				"value": 10,
				"format": "days",
				"cutoff_time": {
					"enabled": false,
					"time": "12:00",
					"value": 2
				}
			}
		},
		"maximum_date": {
			"enabled": false,
			"metric": "days",
			"value": 14
		},
		"order_limits": {
			"enabled": false,
			"monday": 2,
			"tuesday": 1,
			"wednesday": 0,
			"thursday": 0,
			"friday": 0,
			"saturday": 0,
			"sunday": 0
		},
		"note_enabled": false,
		"note_required": false
	}
}
```

--------------------------------

### GET /v1.0/:checkoutMethod/location/:locationId/preparation_times

Source: https://docs.zapiet.com/reference/preparation-times

This endpoint returns a list of preparation times for a given location and checkout method. It allows for both general preparation time settings and product-specific overrides.

```APIDOC
## GET /v1.0/:checkoutMethod/location/:locationId/preparation_times

### Description
This endpoint will return a list of preparation times. It allows for configuring general preparation times based on the day of the week, or product-specific preparation times.

### Method
GET

### Endpoint
`https://api.zapiet.com/v1.0/:checkoutMethod/location/:locationId/preparation_times`

### Parameters
#### Path Parameters
- **checkoutMethod** (string) - Required - The checkout method you would like to validate against. Valid values are; pickup, delivery, and shipping.
- **locationId** (numeric) - Required - The Zapiet location ID.

#### Query Parameters
- **shop** (string) - Required - The merchant's myshopify.com store url.

### Request Example
```json
{
  "example": "(No request body for this GET request)"
}
```

### Response
#### Success Response (200)
- **general** (object) - Contains general preparation time settings for each day of the week.
  - **enabled** (boolean) - Indicates if general preparation times are enabled.
  - **[day_of_week]** (object) - Settings for a specific day (e.g., monday, tuesday).
    - **breakpoint** (object) - Settings for a breakpoint time.
      - **enabled** (boolean) - Indicates if the breakpoint is enabled.
      - **value** (string) - The breakpoint time in HH:MM format.
    - **before** (object) - Settings for preparation time before the breakpoint.
      - **format** (string) - The unit of time (e.g., hours, minutes, days).
      - **value** (numeric) - The duration of preparation time.
    - **after** (object) - Settings for preparation time after the breakpoint.
      - **format** (string) - The unit of time (e.g., hours, minutes, days).
      - **value** (numeric) - The duration of preparation time.
- **product_based** (array) - An array of product-specific preparation time overrides.
  - **product_external_id** (string) - The unique identifier for the product.
  - **preparation_enabled** (numeric) - Indicates if product-specific preparation is enabled (1 for enabled, 0 for disabled).
  - **preperation_value** (numeric) - The duration of preparation time for the product.
  - **preparation_format** (string) - The unit of time for the product preparation (e.g., hours, minutes, days).

#### Response Example
```json
{
    "general": {
        "enabled": true,
        "monday": {
            "breakpoint": {
                "enabled": false,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "tuesday": {
            "breakpoint": {
                "enabled": false,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "wednesday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "thursday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "hours",
                "value": 1
            },
            "after": {
                "format": "hours",
                "value": 2
            }
        },
        "friday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "minutes",
                "value": 30
            },
            "after": {
                "format": "minutes",
                "value": 30
            }
        },
        "saturday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "days",
                "value": 1
            },
            "after": {
                "format": "days",
                "value": 2
            }
        },
        "sunday": {
            "breakpoint": {
                "enabled": true,
                "value": "14:00"
            },
            "before": {
                "format": "days",
                "value": 1
            },
            "after": {
                "format": "days",
                "value": 3
            }
        }
    },
    "product_based": [
        {
            "product_external_id": "8184259576032",
            "preparation_enabled": 1,
            "preperation_value": 300,
            "preparation_format": "hours"
        },
        {
            "product_external_id": "8184259674336",
            "preparation_enabled": 1,
            "preperation_value": 2880,
            "preparation_format": "days"
        },
        {
            "product_external_id": "8184259346656",
            "preparation_enabled": 1,
            "preperation_value": 30,
            "preparation_format": "minutes"
        }
    ]
}
```
```

--------------------------------

### Zapiet API Response: Local Delivery Available (200)

Source: https://docs.zapiet.com/reference/local-delivery/locations

Example of a successful response (HTTP 200 OK) from the Zapiet API, indicating that local delivery is available. This response includes detailed information about the delivery location and available time slots.

```json
{
	"id": 433,
	"external_id": "72950677728",
	"distance": null,
	"driving_distance": null,
	"company_name": "Apple",
	"address_line_1": "767 5th Ave",
	"address_line_2": null,
	"city": "New York",
	"postal_code": "10153",
	"region": "New York",
	"country": "United States",
	"latitude": 40.7638414,
	"longitude": -73.9729718,
	"timezone": "America/New_York",
	"custom_attribute_1": null,
	"custom_attribute_2": null,
	"custom_attribute_3": null,
	"delivery": {
		"flip_blackout_dates": false,
		"blackouts": ["2023-11-21", "2023-11-28"],
		"monday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 831969,
					"day_of_week": "monday",
					"from": "10:15",
					"until": "12:45",
					"limited": true,
					"limit": 12
				}, {
					"id": 831970,
					"day_of_week": "monday",
					"from": "12:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 831971,
					"day_of_week": "monday",
					"from": "13:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}]
			}
		},
		"tuesday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 2406,
					"day_of_week": "tuesday",
					"from": "10:45",
					"until": "12:30",
					"limited": true,
					"limit": 15
				}, {
					"id": 402219,
					"day_of_week": "tuesday",
					"from": "12:00",
					"until": "14:00",
					"limited": true,
					"limit": 6
				}, {
					"id": 402220,
					"day_of_week": "tuesday",
					"from": "13:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}]
			}
		},
		"wednesday": {
			"blackout_dates": ["2020-11-21", "2020-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 2407,
					"day_of_week": "wednesday",
					"from": "10:00",
					"until": "12:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 846035,
					"day_of_week": "wednesday",
					"from": "11:00",
					"until": "12:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402221,
					"day_of_week": "wednesday",
					"from": "12:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402222,
					"day_of_week": "wednesday",
					"from": "13:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}]
			}
		},
		"thursday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 2408,
					"day_of_week": "thursday",
					"from": "10:00",
					"until": "12:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402223,
					"day_of_week": "thursday",
					"from": "12:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402224,
					"day_of_week": "thursday",
					"from": "13:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}]
			}
		},
		"friday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 2409,
					"day_of_week": "friday",
					"from": "10:00",
					"until": "12:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402225,
					"day_of_week": "friday",
					"from": "12:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}, {
					"id": 402226,
					"day_of_week": "friday",
					"from": "13:00",
					"until": "14:00",
					"limited": true,
					"limit": 10
				}]
			}
		},
		"saturday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
					"id": 2410,
					"day_of_week": "saturday",
					"from": "10:00",

```

--------------------------------

### Get Pickup Times API Request

Source: https://docs.zapiet.com/reference/store-pickup/pickup-calendar/times

This snippet demonstrates how to make a POST request to the Zapiet API to retrieve available pickup times for a given date and location. It requires the date, location ID, and shop URL as parameters. The response is a JSON array of available time slots.

```JSON
[
  {
    "id": 1,
    "location_id": 1,
    "day_of_week": "wednesday",
    "available_from": "09:00",
    "available_until": "09:30",
    "limited": true,
    "limit": 10
  },
  {
    "id": 2,
    "location_id": 1,
    "day_of_week": "wednesday",
    "available_from": "09:30",
    "available_until": "10:00",
    "limited": true,
    "limit": 10
  }
]
```

--------------------------------

### Get Pickup Locations

Source: https://docs.zapiet.com/reference/store-pickup/pickup-locations

Fetches a list of available pickup locations. If no locations are configured or available for the given context, an empty array will be returned.

```APIDOC
## GET /websites/zapiet/pickup_locations

### Description
Retrieves a list of available pickup locations. If no pickup locations are found, an empty array is returned.

### Method
GET

### Endpoint
/websites/zapiet/pickup_locations

### Parameters
This endpoint does not have any path or query parameters.

### Request Body
This endpoint does not accept a request body.

### Request Example
(No request body for this GET request)

### Response
#### Success Response (200)
- **locations** (array) - An array of pickup location objects. If no locations are found, this will be an empty array.

#### Response Example
```json
{
	"locations": []
}
```
```

--------------------------------

### Combine Allowed Dates and Days for Pickup

Source: https://docs.zapiet.com/reference/store-pickup/pickup-calendar

Combines specifically allowed pickup dates with allowed days of the week. The array starts with `true`, followed by integers for days (1=Sunday) and strings for dates ('YYYY-MM-DD'). Months are zero-based.

```javascript
/** 
Pickup is only available on:

Sundays
Mondays 
13th May 2021
25th December 2021 
**/

{
	"disabled": [
		true,
		1,
		2,
		"2021-04-13",
		"2021-11-25"
	]
}
```

--------------------------------

### GET /v1.0/pickup/regions

Source: https://docs.zapiet.com/reference/store-pickup/regions

Retrieves an array of regions based on the 'region' field of a store's active pickup locations. Requires the merchant's myshopify.com store URL.

```APIDOC
## GET /v1.0/pickup/regions

### Description
Returns an array of regions based on the "region" field of a store's active pickup locations.

### Method
GET

### Endpoint
https://api.zapiet.com/v1.0/pickup/regions

### Parameters
#### Query Parameters
- **shop** (string) - Required - The merchant's myshopify.com store url.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- Array of strings representing region names.

#### Response Example
```json
[
	"Boston",
	"New York",
	"Washington DC"
]
```
```

--------------------------------

### Get Shipping Dates (JavaScript)

Source: https://docs.zapiet.com/reference/shipping/dates

Retrieves available shipping dates for a given store and shopping cart. Requires the store's myshopify.com URL and optionally accepts a shopping cart for date filtering. Returns a JSON object with minimum and maximum shipping dates, disabled dates, and timezone.

```javascript
{
	"minDate": "2021-05-14",
	"maxDate": "2021-05-27",
	"disabled": [
		[2020, 11, 25],
		[2020, 11, 26], 1
	],
	"timezone": "Europe\/London"
}
```

```javascript
{
    "shoppingCart": [
        {
            "variant_id": 9226255761451,
            "product_id": 852798275627,
            "quantity": 5
        },
        {
            "variant_id": 9226255761452,
            "product_id": 852798275628,
            "quantity": 2
        }
    ]
}
```

```javascript
{
	"minDate": "2021-05-14",
	"maxDate": "2021-05-27",
	"disabled": [
		[2020, 11, 25],
		[2020, 11, 26], 1
	],
	"timezone": "Europe\/London"
}
```

--------------------------------

### Zapiet Delivery/Pickup Configuration

Source: https://docs.zapiet.com/reference/local-delivery/locations

This JSON object represents the configuration for Zapiet's delivery and pickup service. It defines operating hours, blackout dates, and booking slot availability for specific days of the week, including options for limiting the number of orders per slot.

```json
{
	"delivery": {
		"saturday": {
			"blackout_dates": [],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [
					{
						"id": 2410,
						"day_of_week": "saturday",
						"from": "10:00",
						"until": "12:00",
						"limited": true,
						"limit": 10
					}, {
						"id": 402227,
						"day_of_week": "saturday",
						"from": "12:00",
						"until": "14:00",
						"limited": true,
						"limit": 10
					}, {
						"id": 402228,
						"day_of_week": "saturday",
						"from": "13:00",
						"until": "14:00",
						"limited": true,
						"limit": 10
					}
				]
			}
		},
		"sunday": {
			"blackout_dates": ["2023-11-21", "2023-11-28"],
			"breakpoint": "14:00",
			"useBreakpoint": false,
			"before": {
				"value": 24,
				"format": "days"
			},
			"after": {
				"value": 24,
				"format": "days"
			},
			"slots": {
				"enabled": true,
				"slots": [{
						"id": 2411,
						"day_of_week": "sunday",
						"from": "10:00",
						"until": "12:00",
						"limited": true,
						"limit": 10
					}, {
						"id": 402229,
						"day_of_week": "sunday",
						"from": "12:00",
						"until": "14:00",
						"limited": true,
						"limit": 10
					}, {
						"id": 402230,
						"day_of_week": "sunday",
						"from": "13:00",
						"until": "14:00",
						"limited": true,
						"limit": 10
					}]
			}
		}
	},
	"current_time": "2024-02-13 08:54:24"
}
```
Tokens:
Raw